blob: 0fd8d53a24e8f6b28ff599bc7aa5442c987b0fee [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
10#include "lldb/Target/Process.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000011#include "lldb/Breakpoint/StoppointCallbackContext.h"
12#include "lldb/Breakpoint/BreakpointLocation.h"
13#include "lldb/Core/Event.h"
14#include "lldb/Core/Debugger.h"
15#include "lldb/Core/Log.h"
Greg Clayton1f746072012-08-29 21:13:06 +000016#include "lldb/Core/Module.h"
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +000017#include "lldb/Core/ModuleSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000018#include "lldb/Core/PluginManager.h"
19#include "lldb/Core/State.h"
Greg Clayton44d93782014-01-27 23:43:24 +000020#include "lldb/Core/StreamFile.h"
Greg Claytoneb0103f2011-04-07 22:46:35 +000021#include "lldb/Expression/ClangUserExpression.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000022#include "lldb/Expression/IRDynamicChecks.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000023#include "lldb/Host/ConnectionFileDescriptor.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000024#include "lldb/Host/Host.h"
Zachary Turner39de3112014-09-09 20:54:56 +000025#include "lldb/Host/HostInfo.h"
Greg Clayton100eb932014-07-02 21:10:39 +000026#include "lldb/Host/Pipe.h"
Greg Clayton44d93782014-01-27 23:43:24 +000027#include "lldb/Host/Terminal.h"
Zachary Turner39de3112014-09-09 20:54:56 +000028#include "lldb/Host/ThreadLauncher.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000029#include "lldb/Interpreter/CommandInterpreter.h"
Zachary Turner633a29c2015-03-04 01:58:01 +000030#include "lldb/Interpreter/OptionValueProperties.h"
Jason Molenda484900b2015-08-10 07:55:25 +000031#include "lldb/Symbol/Function.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000032#include "lldb/Symbol/Symbol.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000033#include "lldb/Target/ABI.h"
Greg Clayton8f343b02010-11-04 01:54:29 +000034#include "lldb/Target/DynamicLoader.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000035#include "lldb/Target/InstrumentationRuntime.h"
Andrew MacPherson17220c12014-03-05 10:12:43 +000036#include "lldb/Target/JITLoader.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000037#include "lldb/Target/JITLoaderList.h"
Kuba Breckaa51ea382014-09-06 01:33:13 +000038#include "lldb/Target/MemoryHistory.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000039#include "lldb/Target/MemoryRegionInfo.h"
Greg Clayton56d9a1b2011-08-22 02:49:39 +000040#include "lldb/Target/OperatingSystem.h"
Jim Ingham22777012010-09-23 02:01:19 +000041#include "lldb/Target/LanguageRuntime.h"
42#include "lldb/Target/CPPLanguageRuntime.h"
43#include "lldb/Target/ObjCLanguageRuntime.h"
Greg Claytone996fd32011-03-08 22:40:15 +000044#include "lldb/Target/Platform.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000045#include "lldb/Target/RegisterContext.h"
Greg Claytonf4b47e12010-08-04 01:40:35 +000046#include "lldb/Target/StopInfo.h"
Jason Molendaeef51062013-11-05 03:57:19 +000047#include "lldb/Target/SystemRuntime.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000048#include "lldb/Target/Target.h"
49#include "lldb/Target/TargetList.h"
50#include "lldb/Target/Thread.h"
51#include "lldb/Target/ThreadPlan.h"
Jim Ingham076b3042012-04-10 01:21:57 +000052#include "lldb/Target/ThreadPlanBase.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000053#include "lldb/Target/UnixSignals.h"
Zachary Turner50232572015-03-18 21:31:45 +000054#include "lldb/Utility/NameMatches.h"
Jim Ingham1460e4b2014-01-10 23:46:59 +000055#include "Plugins/Process/Utility/InferiorCallPOSIX.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000056
57using namespace lldb;
58using namespace lldb_private;
59
Greg Clayton67cc0632012-08-22 17:17:09 +000060
61// Comment out line below to disable memory caching, overriding the process setting
62// target.process.disable-memory-cache
63#define ENABLE_MEMORY_CACHING
64
65#ifdef ENABLE_MEMORY_CACHING
66#define DISABLE_MEM_CACHE_DEFAULT false
67#else
68#define DISABLE_MEM_CACHE_DEFAULT true
69#endif
70
71class ProcessOptionValueProperties : public OptionValueProperties
72{
73public:
74 ProcessOptionValueProperties (const ConstString &name) :
75 OptionValueProperties (name)
76 {
77 }
78
79 // This constructor is used when creating ProcessOptionValueProperties when it
80 // is part of a new lldb_private::Process instance. It will copy all current
81 // global property values as needed
82 ProcessOptionValueProperties (ProcessProperties *global_properties) :
83 OptionValueProperties(*global_properties->GetValueProperties())
84 {
85 }
86
87 virtual const Property *
88 GetPropertyAtIndex (const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const
89 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +000090 // When getting the value for a key from the process options, we will always
Greg Clayton67cc0632012-08-22 17:17:09 +000091 // try and grab the setting from the current process if there is one. Else we just
92 // use the one from this instance.
93 if (exe_ctx)
94 {
95 Process *process = exe_ctx->GetProcessPtr();
96 if (process)
97 {
98 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
99 if (this != instance_properties)
100 return instance_properties->ProtectedGetPropertyAtIndex (idx);
101 }
102 }
103 return ProtectedGetPropertyAtIndex (idx);
104 }
105};
106
107static PropertyDefinition
108g_properties[] =
109{
110 { "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 +0000111 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used. "
112 "For instance, to turn on debugserver logging set this to \"QSetLogging:bitmask=LOG_DEFAULT;\"" },
Jim Inghamafc1b122013-01-31 19:48:57 +0000113 { "ignore-breakpoints-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, breakpoints will be ignored during expression evaluation." },
114 { "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 +0000115 { "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 +0000116 { "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 +0000117 { "detach-keeps-stopped" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, detach will attempt to keep the process stopped." },
Jason Molendaf0340c92014-09-03 22:30:54 +0000118 { "memory-cache-line-size" , OptionValue::eTypeUInt64, false, 512, NULL, NULL, "The memory cache line size" },
Jason Molendaef7d6412015-08-06 03:27:10 +0000119 { "optimization-warnings" , OptionValue::eTypeBoolean, false, true, NULL, NULL, "If true, warn when stopped in code that is optimized where stepping and variable availability may not behave as expected." },
Greg Clayton67cc0632012-08-22 17:17:09 +0000120 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
121};
122
123enum {
124 ePropertyDisableMemCache,
Greg Claytonc9d645d2012-10-18 22:40:37 +0000125 ePropertyExtraStartCommand,
Jim Ingham184e9812013-01-15 02:47:48 +0000126 ePropertyIgnoreBreakpointsInExpressions,
127 ePropertyUnwindOnErrorInExpressions,
Jim Ingham29950772013-01-26 02:19:28 +0000128 ePropertyPythonOSPluginPath,
Jim Inghamacff8952013-05-02 00:27:30 +0000129 ePropertyStopOnSharedLibraryEvents,
Jason Molendaf0340c92014-09-03 22:30:54 +0000130 ePropertyDetachKeepsStopped,
Jason Molendaef7d6412015-08-06 03:27:10 +0000131 ePropertyMemCacheLineSize,
132 ePropertyWarningOptimization
Greg Clayton67cc0632012-08-22 17:17:09 +0000133};
134
Greg Clayton332e8b12015-01-13 21:13:08 +0000135ProcessProperties::ProcessProperties (lldb_private::Process *process) :
136 Properties (),
137 m_process (process) // Can be NULL for global ProcessProperties
Greg Clayton67cc0632012-08-22 17:17:09 +0000138{
Greg Clayton332e8b12015-01-13 21:13:08 +0000139 if (process == NULL)
Greg Clayton67cc0632012-08-22 17:17:09 +0000140 {
Greg Clayton332e8b12015-01-13 21:13:08 +0000141 // Global process properties, set them up one time
Greg Clayton67cc0632012-08-22 17:17:09 +0000142 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
143 m_collection_sp->Initialize(g_properties);
144 m_collection_sp->AppendProperty(ConstString("thread"),
Jim Ingham29950772013-01-26 02:19:28 +0000145 ConstString("Settings specific to threads."),
Greg Clayton67cc0632012-08-22 17:17:09 +0000146 true,
147 Thread::GetGlobalProperties()->GetValueProperties());
148 }
149 else
Greg Clayton332e8b12015-01-13 21:13:08 +0000150 {
Greg Clayton67cc0632012-08-22 17:17:09 +0000151 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
Greg Clayton332e8b12015-01-13 21:13:08 +0000152 m_collection_sp->SetValueChangedCallback(ePropertyPythonOSPluginPath, ProcessProperties::OptionValueChangedCallback, this);
153 }
Greg Clayton67cc0632012-08-22 17:17:09 +0000154}
155
156ProcessProperties::~ProcessProperties()
157{
158}
159
Greg Clayton332e8b12015-01-13 21:13:08 +0000160void
161ProcessProperties::OptionValueChangedCallback (void *baton, OptionValue *option_value)
162{
163 ProcessProperties *properties = (ProcessProperties *)baton;
164 if (properties->m_process)
165 properties->m_process->LoadOperatingSystemPlugin(true);
166}
167
Greg Clayton67cc0632012-08-22 17:17:09 +0000168bool
169ProcessProperties::GetDisableMemoryCache() const
170{
171 const uint32_t idx = ePropertyDisableMemCache;
172 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
173}
174
Jason Molendaf0340c92014-09-03 22:30:54 +0000175uint64_t
176ProcessProperties::GetMemoryCacheLineSize() const
177{
178 const uint32_t idx = ePropertyMemCacheLineSize;
179 return m_collection_sp->GetPropertyAtIndexAsUInt64 (NULL, idx, g_properties[idx].default_uint_value);
180}
181
Greg Clayton67cc0632012-08-22 17:17:09 +0000182Args
183ProcessProperties::GetExtraStartupCommands () const
184{
185 Args args;
186 const uint32_t idx = ePropertyExtraStartCommand;
187 m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
188 return args;
189}
190
191void
192ProcessProperties::SetExtraStartupCommands (const Args &args)
193{
194 const uint32_t idx = ePropertyExtraStartCommand;
195 m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
196}
197
Greg Claytonc9d645d2012-10-18 22:40:37 +0000198FileSpec
199ProcessProperties::GetPythonOSPluginPath () const
200{
201 const uint32_t idx = ePropertyPythonOSPluginPath;
202 return m_collection_sp->GetPropertyAtIndexAsFileSpec(NULL, idx);
203}
204
205void
206ProcessProperties::SetPythonOSPluginPath (const FileSpec &file)
207{
208 const uint32_t idx = ePropertyPythonOSPluginPath;
209 m_collection_sp->SetPropertyAtIndexAsFileSpec(NULL, idx, file);
210}
211
Jim Ingham184e9812013-01-15 02:47:48 +0000212
213bool
214ProcessProperties::GetIgnoreBreakpointsInExpressions () const
215{
216 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
217 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
218}
219
220void
221ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore)
222{
223 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
224 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
225}
226
227bool
228ProcessProperties::GetUnwindOnErrorInExpressions () const
229{
230 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
231 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
232}
233
234void
235ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore)
236{
237 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
238 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
239}
240
Jim Ingham29950772013-01-26 02:19:28 +0000241bool
242ProcessProperties::GetStopOnSharedLibraryEvents () const
243{
244 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
245 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
246}
247
248void
249ProcessProperties::SetStopOnSharedLibraryEvents (bool stop)
250{
251 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
252 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
253}
254
Jim Inghamacff8952013-05-02 00:27:30 +0000255bool
256ProcessProperties::GetDetachKeepsStopped () const
257{
258 const uint32_t idx = ePropertyDetachKeepsStopped;
259 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
260}
261
262void
263ProcessProperties::SetDetachKeepsStopped (bool stop)
264{
265 const uint32_t idx = ePropertyDetachKeepsStopped;
266 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
267}
268
Jason Molendaef7d6412015-08-06 03:27:10 +0000269bool
270ProcessProperties::GetWarningsOptimization () const
271{
272 const uint32_t idx = ePropertyWarningOptimization;
273 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
274}
275
Greg Clayton32e0a752011-03-30 18:16:51 +0000276void
Greg Clayton8b82f082011-04-12 05:54:46 +0000277ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000278{
279 const char *cstr;
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000280 if (m_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malead01b2952012-11-29 21:49:15 +0000281 s.Printf (" pid = %" PRIu64 "\n", m_pid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000282
283 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malead01b2952012-11-29 21:49:15 +0000284 s.Printf (" parent = %" PRIu64 "\n", m_parent_pid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000285
286 if (m_executable)
287 {
288 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
289 s.PutCString (" file = ");
290 m_executable.Dump(&s);
291 s.EOL();
292 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000293 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000294 if (argc > 0)
295 {
296 for (uint32_t i=0; i<argc; i++)
297 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000298 const char *arg = m_arguments.GetArgumentAtIndex(i);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000299 if (i < 10)
Greg Clayton8b82f082011-04-12 05:54:46 +0000300 s.Printf (" arg[%u] = %s\n", i, arg);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000301 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000302 s.Printf ("arg[%u] = %s\n", i, arg);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000303 }
304 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000305
306 const uint32_t envc = m_environment.GetArgumentCount();
307 if (envc > 0)
308 {
309 for (uint32_t i=0; i<envc; i++)
310 {
311 const char *env = m_environment.GetArgumentAtIndex(i);
312 if (i < 10)
313 s.Printf (" env[%u] = %s\n", i, env);
314 else
315 s.Printf ("env[%u] = %s\n", i, env);
316 }
317 }
318
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000319 if (m_arch.IsValid())
320 s.Printf (" arch = %s\n", m_arch.GetTriple().str().c_str());
321
Greg Clayton8b82f082011-04-12 05:54:46 +0000322 if (m_uid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000323 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000324 cstr = platform->GetUserName (m_uid);
325 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000326 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000327 if (m_gid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000328 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000329 cstr = platform->GetGroupName (m_gid);
330 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000331 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000332 if (m_euid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000333 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000334 cstr = platform->GetUserName (m_euid);
335 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000336 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000337 if (m_egid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000338 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000339 cstr = platform->GetGroupName (m_egid);
340 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000341 }
342}
343
344void
Greg Clayton8b82f082011-04-12 05:54:46 +0000345ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
Greg Clayton32e0a752011-03-30 18:16:51 +0000346{
Greg Clayton8b82f082011-04-12 05:54:46 +0000347 const char *label;
348 if (show_args || verbose)
349 label = "ARGUMENTS";
350 else
351 label = "NAME";
352
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000353 if (verbose)
354 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000355 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000356 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
357 }
358 else
359 {
Jim Ingham368ac222014-08-15 17:05:27 +0000360 s.Printf ("PID PARENT USER TRIPLE %s\n", label);
361 s.PutCString ("====== ====== ========== ======================== ============================\n");
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000362 }
Greg Clayton32e0a752011-03-30 18:16:51 +0000363}
364
365void
Greg Clayton8b82f082011-04-12 05:54:46 +0000366ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000367{
368 if (m_pid != LLDB_INVALID_PROCESS_ID)
369 {
370 const char *cstr;
Daniel Malead01b2952012-11-29 21:49:15 +0000371 s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000372
Greg Clayton32e0a752011-03-30 18:16:51 +0000373
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000374 if (verbose)
375 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000376 cstr = platform->GetUserName (m_uid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000377 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
378 s.Printf ("%-10s ", cstr);
379 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000380 s.Printf ("%-10u ", m_uid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000381
Greg Clayton8b82f082011-04-12 05:54:46 +0000382 cstr = platform->GetGroupName (m_gid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000383 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
384 s.Printf ("%-10s ", cstr);
385 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000386 s.Printf ("%-10u ", m_gid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000387
Greg Clayton8b82f082011-04-12 05:54:46 +0000388 cstr = platform->GetUserName (m_euid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000389 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
390 s.Printf ("%-10s ", cstr);
391 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000392 s.Printf ("%-10u ", m_euid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000393
Greg Clayton8b82f082011-04-12 05:54:46 +0000394 cstr = platform->GetGroupName (m_egid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000395 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
396 s.Printf ("%-10s ", cstr);
397 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000398 s.Printf ("%-10u ", m_egid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000399 s.Printf ("%-24s ", m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
400 }
401 else
402 {
Jim Ingham368ac222014-08-15 17:05:27 +0000403 s.Printf ("%-10s %-24s ",
Greg Clayton8b82f082011-04-12 05:54:46 +0000404 platform->GetUserName (m_euid),
Jim Ingham368ac222014-08-15 17:05:27 +0000405 m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000406 }
407
Greg Clayton8b82f082011-04-12 05:54:46 +0000408 if (verbose || show_args)
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000409 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000410 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000411 if (argc > 0)
412 {
413 for (uint32_t i=0; i<argc; i++)
414 {
415 if (i > 0)
416 s.PutChar (' ');
Greg Clayton8b82f082011-04-12 05:54:46 +0000417 s.PutCString (m_arguments.GetArgumentAtIndex(i));
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000418 }
419 }
420 }
421 else
422 {
423 s.PutCString (GetName());
424 }
425
426 s.EOL();
Greg Clayton32e0a752011-03-30 18:16:51 +0000427 }
428}
429
Greg Clayton8b82f082011-04-12 05:54:46 +0000430Error
Greg Claytonf6b8b582011-04-13 00:18:08 +0000431ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
Greg Clayton8b82f082011-04-12 05:54:46 +0000432{
433 Error error;
Greg Clayton3bcdfc02012-12-04 00:32:51 +0000434 const int short_option = m_getopt_table[option_idx].val;
Greg Clayton8b82f082011-04-12 05:54:46 +0000435
436 switch (short_option)
437 {
438 case 's': // Stop at program entry point
439 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
440 break;
441
Greg Clayton8b82f082011-04-12 05:54:46 +0000442 case 'i': // STDIN for read only
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000443 {
444 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000445 if (action.Open(STDIN_FILENO, FileSpec{option_arg, false}, true, false))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000446 launch_info.AppendFileAction (action);
Greg Clayton8b82f082011-04-12 05:54:46 +0000447 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000448 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000449
450 case 'o': // Open STDOUT for write only
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000451 {
452 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000453 if (action.Open(STDOUT_FILENO, FileSpec{option_arg, false}, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000454 launch_info.AppendFileAction (action);
Greg Clayton9845a8d2012-03-06 04:01:04 +0000455 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000456 }
Greg Clayton9845a8d2012-03-06 04:01:04 +0000457
458 case 'e': // STDERR for write only
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000459 {
460 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000461 if (action.Open(STDERR_FILENO, FileSpec{option_arg, false}, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000462 launch_info.AppendFileAction (action);
Greg Clayton8b82f082011-04-12 05:54:46 +0000463 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000464 }
Greg Clayton9845a8d2012-03-06 04:01:04 +0000465
Greg Clayton8b82f082011-04-12 05:54:46 +0000466 case 'p': // Process plug-in name
467 launch_info.SetProcessPluginName (option_arg);
468 break;
469
470 case 'n': // Disable STDIO
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000471 {
472 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000473 const FileSpec dev_null{"/dev/null", false};
474 if (action.Open(STDIN_FILENO, dev_null, true, false))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000475 launch_info.AppendFileAction (action);
Chaoren Lind3173f32015-05-29 19:52:29 +0000476 if (action.Open(STDOUT_FILENO, dev_null, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000477 launch_info.AppendFileAction (action);
Chaoren Lind3173f32015-05-29 19:52:29 +0000478 if (action.Open(STDERR_FILENO, dev_null, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000479 launch_info.AppendFileAction (action);
Greg Clayton8b82f082011-04-12 05:54:46 +0000480 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000481 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000482
483 case 'w':
Chaoren Lind3173f32015-05-29 19:52:29 +0000484 launch_info.SetWorkingDirectory(FileSpec{option_arg, false});
Greg Clayton8b82f082011-04-12 05:54:46 +0000485 break;
486
487 case 't': // Open process in new terminal window
488 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
489 break;
490
491 case 'a':
Greg Clayton70512312012-05-08 01:45:38 +0000492 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
493 launch_info.GetArchitecture().SetTriple (option_arg);
Greg Clayton8b82f082011-04-12 05:54:46 +0000494 break;
495
Todd Fiala51637922014-08-19 17:40:43 +0000496 case 'A': // Disable ASLR.
497 {
498 bool success;
499 const bool disable_aslr_arg = Args::StringToBoolean (option_arg, true, &success);
500 if (success)
501 disable_aslr = disable_aslr_arg ? eLazyBoolYes : eLazyBoolNo;
502 else
503 error.SetErrorStringWithFormat ("Invalid boolean value for disable-aslr option: '%s'", option_arg ? option_arg : "<null>");
Greg Clayton8b82f082011-04-12 05:54:46 +0000504 break;
Todd Fiala51637922014-08-19 17:40:43 +0000505 }
506
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000507 case 'X': // shell expand args.
Enrico Granatad7a83a92015-02-10 03:06:24 +0000508 {
509 bool success;
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000510 const bool expand_args = Args::StringToBoolean (option_arg, true, &success);
Enrico Granatad7a83a92015-02-10 03:06:24 +0000511 if (success)
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000512 launch_info.SetShellExpandArguments(expand_args);
Enrico Granatad7a83a92015-02-10 03:06:24 +0000513 else
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000514 error.SetErrorStringWithFormat ("Invalid boolean value for shell-expand-args option: '%s'", option_arg ? option_arg : "<null>");
Enrico Granatad7a83a92015-02-10 03:06:24 +0000515 break;
516 }
517
Todd Fiala51637922014-08-19 17:40:43 +0000518 case 'c':
Greg Clayton144f3a92011-11-15 03:53:30 +0000519 if (option_arg && option_arg[0])
Zachary Turner10687b02014-10-20 17:46:43 +0000520 launch_info.SetShell (FileSpec(option_arg, false));
Greg Clayton144f3a92011-11-15 03:53:30 +0000521 else
Zachary Turner10687b02014-10-20 17:46:43 +0000522 launch_info.SetShell (HostInfo::GetDefaultShell());
Greg Clayton982c9762011-11-03 21:22:33 +0000523 break;
524
Greg Clayton8b82f082011-04-12 05:54:46 +0000525 case 'v':
526 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
527 break;
528
529 default:
Greg Clayton86edbf42011-10-26 00:56:27 +0000530 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
Greg Clayton8b82f082011-04-12 05:54:46 +0000531 break;
Greg Clayton8b82f082011-04-12 05:54:46 +0000532 }
533 return error;
534}
535
536OptionDefinition
537ProcessLaunchCommandOptions::g_option_table[] =
538{
Zachary Turnerd37221d2014-07-09 16:31:49 +0000539{ 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."},
Todd Fiala51637922014-08-19 17:40:43 +0000540{ LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Set whether to disable address space layout randomization when launching a process."},
Zachary Turnerd37221d2014-07-09 16:31:49 +0000541{ LLDB_OPT_SET_ALL, false, "plugin", 'p', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
542{ 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."},
543{ LLDB_OPT_SET_ALL, false, "arch", 'a', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
544{ 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."},
Enrico Granatad7a83a92015-02-10 03:06:24 +0000545{ LLDB_OPT_SET_1|LLDB_OPT_SET_2|LLDB_OPT_SET_3, false, "shell", 'c', OptionParser::eOptionalArgument, NULL, NULL, 0, eArgTypeFilename, "Run the process in a shell (not supported on all platforms)."},
Greg Clayton8b82f082011-04-12 05:54:46 +0000546
Zachary Turnerd37221d2014-07-09 16:31:49 +0000547{ LLDB_OPT_SET_1 , false, "stdin", 'i', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdin for the process to <filename>."},
548{ LLDB_OPT_SET_1 , false, "stdout", 'o', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdout for the process to <filename>."},
549{ 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 +0000550
Zachary Turnerd37221d2014-07-09 16:31:49 +0000551{ 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 +0000552
Zachary Turnerd37221d2014-07-09 16:31:49 +0000553{ 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."},
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000554{ LLDB_OPT_SET_4, false, "shell-expand-args", 'X', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Set whether to shell expand arguments to the process when launching."},
Zachary Turnerd37221d2014-07-09 16:31:49 +0000555{ 0 , false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
Greg Clayton8b82f082011-04-12 05:54:46 +0000556};
557
558
559
560bool
561ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000562{
563 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
564 return true;
565 const char *match_name = m_match_info.GetName();
566 if (!match_name)
567 return true;
568
569 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
570}
571
572bool
Greg Clayton8b82f082011-04-12 05:54:46 +0000573ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000574{
575 if (!NameMatches (proc_info.GetName()))
576 return false;
577
578 if (m_match_info.ProcessIDIsValid() &&
579 m_match_info.GetProcessID() != proc_info.GetProcessID())
580 return false;
581
582 if (m_match_info.ParentProcessIDIsValid() &&
583 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
584 return false;
585
Greg Clayton8b82f082011-04-12 05:54:46 +0000586 if (m_match_info.UserIDIsValid () &&
587 m_match_info.GetUserID() != proc_info.GetUserID())
Greg Clayton32e0a752011-03-30 18:16:51 +0000588 return false;
589
Greg Clayton8b82f082011-04-12 05:54:46 +0000590 if (m_match_info.GroupIDIsValid () &&
591 m_match_info.GetGroupID() != proc_info.GetGroupID())
Greg Clayton32e0a752011-03-30 18:16:51 +0000592 return false;
593
594 if (m_match_info.EffectiveUserIDIsValid () &&
595 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
596 return false;
597
598 if (m_match_info.EffectiveGroupIDIsValid () &&
599 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
600 return false;
601
602 if (m_match_info.GetArchitecture().IsValid() &&
Sean Callananbf4b7be2012-12-13 22:07:14 +0000603 !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture()))
Greg Clayton32e0a752011-03-30 18:16:51 +0000604 return false;
605 return true;
606}
607
608bool
Greg Clayton8b82f082011-04-12 05:54:46 +0000609ProcessInstanceInfoMatch::MatchAllProcesses () const
Greg Clayton32e0a752011-03-30 18:16:51 +0000610{
611 if (m_name_match_type != eNameMatchIgnore)
612 return false;
613
614 if (m_match_info.ProcessIDIsValid())
615 return false;
616
617 if (m_match_info.ParentProcessIDIsValid())
618 return false;
619
Greg Clayton8b82f082011-04-12 05:54:46 +0000620 if (m_match_info.UserIDIsValid ())
Greg Clayton32e0a752011-03-30 18:16:51 +0000621 return false;
622
Greg Clayton8b82f082011-04-12 05:54:46 +0000623 if (m_match_info.GroupIDIsValid ())
Greg Clayton32e0a752011-03-30 18:16:51 +0000624 return false;
625
626 if (m_match_info.EffectiveUserIDIsValid ())
627 return false;
628
629 if (m_match_info.EffectiveGroupIDIsValid ())
630 return false;
631
632 if (m_match_info.GetArchitecture().IsValid())
633 return false;
634
635 if (m_match_all_users)
636 return false;
637
638 return true;
639
640}
641
642void
Greg Clayton8b82f082011-04-12 05:54:46 +0000643ProcessInstanceInfoMatch::Clear()
Greg Clayton32e0a752011-03-30 18:16:51 +0000644{
645 m_match_info.Clear();
646 m_name_match_type = eNameMatchIgnore;
647 m_match_all_users = false;
648}
Greg Clayton58be07b2011-01-07 06:08:19 +0000649
Greg Claytonc3776bf2012-02-09 06:16:32 +0000650ProcessSP
Zachary Turner7529df92015-09-01 20:02:29 +0000651Process::FindPlugin (lldb::TargetSP target_sp, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000652{
Greg Clayton949e8222013-01-16 17:29:04 +0000653 static uint32_t g_process_unique_id = 0;
654
Greg Claytonc3776bf2012-02-09 06:16:32 +0000655 ProcessSP process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000656 ProcessCreateInstance create_callback = NULL;
657 if (plugin_name)
658 {
Greg Clayton57abc5d2013-05-10 21:47:16 +0000659 ConstString const_plugin_name(plugin_name);
660 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (const_plugin_name);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000661 if (create_callback)
662 {
Zachary Turner7529df92015-09-01 20:02:29 +0000663 process_sp = create_callback(target_sp, listener, crash_file_path);
Greg Claytonc3776bf2012-02-09 06:16:32 +0000664 if (process_sp)
665 {
Zachary Turner7529df92015-09-01 20:02:29 +0000666 if (process_sp->CanDebug(target_sp, true))
Greg Clayton949e8222013-01-16 17:29:04 +0000667 {
668 process_sp->m_process_unique_id = ++g_process_unique_id;
669 }
670 else
Greg Claytonc3776bf2012-02-09 06:16:32 +0000671 process_sp.reset();
672 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000673 }
674 }
675 else
676 {
Greg Claytonc982c762010-07-09 20:39:50 +0000677 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000678 {
Zachary Turner7529df92015-09-01 20:02:29 +0000679 process_sp = create_callback(target_sp, listener, crash_file_path);
Greg Claytonc3776bf2012-02-09 06:16:32 +0000680 if (process_sp)
681 {
Zachary Turner7529df92015-09-01 20:02:29 +0000682 if (process_sp->CanDebug(target_sp, false))
Greg Clayton949e8222013-01-16 17:29:04 +0000683 {
684 process_sp->m_process_unique_id = ++g_process_unique_id;
Greg Claytonc3776bf2012-02-09 06:16:32 +0000685 break;
Greg Clayton949e8222013-01-16 17:29:04 +0000686 }
687 else
688 process_sp.reset();
Greg Claytonc3776bf2012-02-09 06:16:32 +0000689 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000690 }
691 }
Greg Claytonc3776bf2012-02-09 06:16:32 +0000692 return process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000693}
694
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000695ConstString &
696Process::GetStaticBroadcasterClass ()
697{
698 static ConstString class_name ("lldb.process");
699 return class_name;
700}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000701
702//----------------------------------------------------------------------
703// Process constructor
704//----------------------------------------------------------------------
Zachary Turner7529df92015-09-01 20:02:29 +0000705Process::Process(lldb::TargetSP target_sp, Listener &listener) :
706 Process(target_sp, listener, UnixSignals::Create(HostInfo::GetArchitecture()))
Todd Fiala4ceced32014-08-29 17:35:57 +0000707{
708 // This constructor just delegates to the full Process constructor,
709 // defaulting to using the Host's UnixSignals.
710}
711
Zachary Turner7529df92015-09-01 20:02:29 +0000712Process::Process(lldb::TargetSP target_sp, Listener &listener, const UnixSignalsSP &unix_signals_sp) :
Greg Clayton332e8b12015-01-13 21:13:08 +0000713 ProcessProperties (this),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000714 UserID (LLDB_INVALID_PROCESS_ID),
Zachary Turner7529df92015-09-01 20:02:29 +0000715 Broadcaster (&(target_sp->GetDebugger()), Process::GetStaticBroadcasterClass().AsCString()),
716 m_target_sp (target_sp),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000717 m_public_state (eStateUnloaded),
718 m_private_state (eStateUnloaded),
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000719 m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
720 m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000721 m_private_state_listener ("lldb.process.internal_state_listener"),
722 m_private_state_control_wait(),
Jim Ingham4b536182011-08-09 02:12:22 +0000723 m_mod_id (),
Greg Clayton949e8222013-01-16 17:29:04 +0000724 m_process_unique_id(0),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000725 m_thread_index_id (0),
Han Ming Ongc2c423e2013-01-08 22:10:01 +0000726 m_thread_id_to_index_id_map (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000727 m_exit_status (-1),
728 m_exit_string (),
Todd Fiala7b0917a2014-09-15 20:07:33 +0000729 m_exit_status_mutex(),
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000730 m_thread_mutex (Mutex::eMutexTypeRecursive),
731 m_thread_list_real (this),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000732 m_thread_list (this),
Jason Molenda864f1cc2013-11-11 05:20:44 +0000733 m_extended_thread_list (this),
Jason Molenda4ff13262013-11-20 00:31:38 +0000734 m_extended_thread_stop_id (0),
Jason Molenda5e8dce42013-12-13 00:29:16 +0000735 m_queue_list (this),
736 m_queue_list_stop_id (0),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000737 m_notifications (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000738 m_image_tokens (),
739 m_listener (listener),
740 m_breakpoint_site_list (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000741 m_dynamic_checkers_ap (),
Todd Fiala4ceced32014-08-29 17:35:57 +0000742 m_unix_signals_sp (unix_signals_sp),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000743 m_abi_sp (),
Caroline Ticeef5c6d02010-11-16 05:07:41 +0000744 m_process_input_reader (),
Greg Clayton3e06bd92011-01-09 21:07:35 +0000745 m_stdio_communication ("process.stdio"),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000746 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
Vince Harrondf3f00f2015-02-10 21:09:04 +0000747 m_stdin_forward (false),
Greg Clayton58be07b2011-01-07 06:08:19 +0000748 m_stdout_data (),
Greg Clayton93e86192011-11-13 04:45:22 +0000749 m_stderr_data (),
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000750 m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive),
751 m_profile_data (),
Pavel Labath44464872015-05-27 12:40:32 +0000752 m_iohandler_sync (0),
Greg Claytond495c532011-05-17 03:37:42 +0000753 m_memory_cache (*this),
754 m_allocated_memory_cache (*this),
Greg Claytone24c4ac2011-11-17 04:46:02 +0000755 m_should_detach (false),
Sean Callanan90539452011-09-20 23:01:51 +0000756 m_next_event_action_ap(),
Greg Clayton96249852013-04-18 16:57:27 +0000757 m_public_run_lock (),
Greg Clayton96249852013-04-18 16:57:27 +0000758 m_private_run_lock (),
Jim Inghamaacc3182012-06-06 00:29:30 +0000759 m_currently_handling_event(false),
Greg Claytona97c4d22014-12-09 23:31:02 +0000760 m_stop_info_override_callback (NULL),
Greg Claytonc00ca312015-04-02 18:44:58 +0000761 m_finalizing (false),
762 m_finalize_called (false),
Greg Claytonf9b57b92013-05-10 23:48:10 +0000763 m_clear_thread_plans_on_stop (false),
Greg Claytonc00ca312015-04-02 18:44:58 +0000764 m_force_next_event_delivery (false),
Jim Ingham0161b492013-02-09 01:29:05 +0000765 m_last_broadcast_state (eStateInvalid),
Jason Molenda69b6b632013-03-05 03:33:59 +0000766 m_destroy_in_process (false),
Ewan Crawford90ff7912015-07-14 10:56:58 +0000767 m_can_interpret_function_calls(false),
Jason Molendaef7d6412015-08-06 03:27:10 +0000768 m_warnings_issued (),
Jason Molenda69b6b632013-03-05 03:33:59 +0000769 m_can_jit(eCanJITDontKnow)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000770{
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000771 CheckInWithManager ();
Caroline Tice1559a462010-09-27 00:30:10 +0000772
Greg Clayton5160ce52013-03-27 23:08:40 +0000773 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000774 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000775 log->Printf ("%p Process::Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000776
Todd Fiala4ceced32014-08-29 17:35:57 +0000777 if (!m_unix_signals_sp)
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000778 m_unix_signals_sp = std::make_shared<UnixSignals>();
Todd Fiala4ceced32014-08-29 17:35:57 +0000779
Greg Claytoncfd1ace2010-10-31 03:01:06 +0000780 SetEventName (eBroadcastBitStateChanged, "state-changed");
781 SetEventName (eBroadcastBitInterrupt, "interrupt");
782 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
783 SetEventName (eBroadcastBitSTDERR, "stderr-available");
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000784 SetEventName (eBroadcastBitProfileData, "profile-data-available");
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000785
Greg Clayton35a4cc52012-10-29 20:52:08 +0000786 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" );
787 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
788 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
789
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000790 listener.StartListeningForEvents (this,
791 eBroadcastBitStateChanged |
792 eBroadcastBitInterrupt |
793 eBroadcastBitSTDOUT |
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000794 eBroadcastBitSTDERR |
795 eBroadcastBitProfileData);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000796
797 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +0000798 eBroadcastBitStateChanged |
799 eBroadcastBitInterrupt);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000800
801 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
802 eBroadcastInternalStateControlStop |
803 eBroadcastInternalStateControlPause |
804 eBroadcastInternalStateControlResume);
Todd Fiala4ceced32014-08-29 17:35:57 +0000805 // We need something valid here, even if just the default UnixSignalsSP.
806 assert (m_unix_signals_sp && "null m_unix_signals_sp after initialization");
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000807}
808
809//----------------------------------------------------------------------
810// Destructor
811//----------------------------------------------------------------------
812Process::~Process()
813{
Greg Clayton5160ce52013-03-27 23:08:40 +0000814 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000815 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000816 log->Printf ("%p Process::~Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000817 StopPrivateStateThread();
Zachary Turner39de3112014-09-09 20:54:56 +0000818
819 // ThreadList::Clear() will try to acquire this process's mutex, so
820 // explicitly clear the thread list here to ensure that the mutex
821 // is not destroyed before the thread list.
822 m_thread_list.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000823}
824
Greg Clayton67cc0632012-08-22 17:17:09 +0000825const ProcessPropertiesSP &
826Process::GetGlobalProperties()
827{
828 static ProcessPropertiesSP g_settings_sp;
829 if (!g_settings_sp)
Greg Clayton332e8b12015-01-13 21:13:08 +0000830 g_settings_sp.reset (new ProcessProperties (NULL));
Greg Clayton67cc0632012-08-22 17:17:09 +0000831 return g_settings_sp;
832}
833
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000834void
835Process::Finalize()
836{
Greg Claytonc00ca312015-04-02 18:44:58 +0000837 m_finalizing = true;
838
Ilia Kc7efd562015-03-26 07:40:40 +0000839 // Destroy this process if needed
840 switch (GetPrivateState())
841 {
842 case eStateConnected:
843 case eStateAttaching:
844 case eStateLaunching:
845 case eStateStopped:
846 case eStateRunning:
847 case eStateStepping:
848 case eStateCrashed:
849 case eStateSuspended:
Jason Molendaede31932015-04-17 05:01:58 +0000850 Destroy(false);
Ilia Kc7efd562015-03-26 07:40:40 +0000851 break;
852
853 case eStateInvalid:
854 case eStateUnloaded:
855 case eStateDetached:
856 case eStateExited:
857 break;
858 }
Greg Claytone24c4ac2011-11-17 04:46:02 +0000859
Greg Clayton1ed54f52011-10-01 00:45:15 +0000860 // Clear our broadcaster before we proceed with destroying
861 Broadcaster::Clear();
862
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000863 // Do any cleanup needed prior to being destructed... Subclasses
864 // that override this method should call this superclass method as well.
Jim Inghamd0a3e122011-02-16 17:54:55 +0000865
866 // We need to destroy the loader before the derived Process class gets destroyed
867 // since it is very likely that undoing the loader will require access to the real process.
Greg Clayton894f82f2012-01-20 23:08:34 +0000868 m_dynamic_checkers_ap.reset();
869 m_abi_sp.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +0000870 m_os_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +0000871 m_system_runtime_ap.reset();
Greg Clayton894f82f2012-01-20 23:08:34 +0000872 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +0000873 m_jit_loaders_ap.reset();
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000874 m_thread_list_real.Destroy();
Greg Claytone1cd1be2012-01-29 20:56:30 +0000875 m_thread_list.Destroy();
Jason Molenda864f1cc2013-11-11 05:20:44 +0000876 m_extended_thread_list.Destroy();
Jason Molenda5e8dce42013-12-13 00:29:16 +0000877 m_queue_list.Clear();
878 m_queue_list_stop_id = 0;
Greg Clayton894f82f2012-01-20 23:08:34 +0000879 std::vector<Notifications> empty_notifications;
880 m_notifications.swap(empty_notifications);
881 m_image_tokens.clear();
882 m_memory_cache.Clear();
883 m_allocated_memory_cache.Clear();
884 m_language_runtimes.clear();
Kuba Breckaafdf8422014-10-10 23:43:03 +0000885 m_instrumentation_runtimes.clear();
Greg Clayton894f82f2012-01-20 23:08:34 +0000886 m_next_event_action_ap.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +0000887 m_stop_info_override_callback = NULL;
Greg Clayton08765fa2015-05-28 03:24:30 +0000888 // Clear the last natural stop ID since it has a strong
889 // reference to this process
890 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
Greg Clayton35a4cc52012-10-29 20:52:08 +0000891//#ifdef LLDB_CONFIGURATION_DEBUG
892// StreamFile s(stdout, false);
893// EventSP event_sp;
894// while (m_private_state_listener.GetNextEvent(event_sp))
895// {
896// event_sp->Dump (&s);
897// s.EOL();
898// }
899//#endif
900 // We have to be very careful here as the m_private_state_listener might
901 // contain events that have ProcessSP values in them which can keep this
902 // process around forever. These events need to be cleared out.
903 m_private_state_listener.Clear();
Ed Maste64fad602013-07-29 20:58:06 +0000904 m_public_run_lock.TrySetRunning(); // This will do nothing if already locked
905 m_public_run_lock.SetStopped();
906 m_private_run_lock.TrySetRunning(); // This will do nothing if already locked
907 m_private_run_lock.SetStopped();
Jim Ingham4fc6cb92012-08-22 21:34:33 +0000908 m_finalize_called = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000909}
910
911void
912Process::RegisterNotificationCallbacks (const Notifications& callbacks)
913{
914 m_notifications.push_back(callbacks);
915 if (callbacks.initialize != NULL)
916 callbacks.initialize (callbacks.baton, this);
917}
918
919bool
920Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
921{
922 std::vector<Notifications>::iterator pos, end = m_notifications.end();
923 for (pos = m_notifications.begin(); pos != end; ++pos)
924 {
925 if (pos->baton == callbacks.baton &&
926 pos->initialize == callbacks.initialize &&
927 pos->process_state_changed == callbacks.process_state_changed)
928 {
929 m_notifications.erase(pos);
930 return true;
931 }
932 }
933 return false;
934}
935
936void
937Process::SynchronouslyNotifyStateChanged (StateType state)
938{
939 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
940 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
941 {
942 if (notification_pos->process_state_changed)
943 notification_pos->process_state_changed (notification_pos->baton, this, state);
944 }
945}
946
947// FIXME: We need to do some work on events before the general Listener sees them.
948// For instance if we are continuing from a breakpoint, we need to ensure that we do
949// the little "insert real insn, step & stop" trick. But we can't do that when the
950// event is delivered by the broadcaster - since that is done on the thread that is
951// waiting for new events, so if we needed more than one event for our handling, we would
952// stall. So instead we do it when we fetch the event off of the queue.
953//
954
955StateType
956Process::GetNextEvent (EventSP &event_sp)
957{
958 StateType state = eStateInvalid;
959
960 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
961 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
962
963 return state;
964}
965
Pavel Labath44464872015-05-27 12:40:32 +0000966void
967Process::SyncIOHandler (uint32_t iohandler_id, uint64_t timeout_msec)
Todd Fialaa3b89e22014-08-12 14:33:19 +0000968{
Todd Fialaa3b89e22014-08-12 14:33:19 +0000969 // don't sync (potentially context switch) in case where there is no process IO
Pavel Labath44464872015-05-27 12:40:32 +0000970 if (! m_process_input_reader)
971 return;
Todd Fialaa3b89e22014-08-12 14:33:19 +0000972
Pavel Labath44464872015-05-27 12:40:32 +0000973 TimeValue timeout = TimeValue::Now();
974 timeout.OffsetWithMicroSeconds(timeout_msec*1000);
975 uint32_t new_iohandler_id = 0;
976 m_iohandler_sync.WaitForValueNotEqualTo(iohandler_id, new_iohandler_id, &timeout);
Todd Fialaa3b89e22014-08-12 14:33:19 +0000977
Pavel Labath44464872015-05-27 12:40:32 +0000978 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
979 if (log)
980 log->Printf("Process::%s waited for m_iohandler_sync to change from %u, new value is %u", __FUNCTION__, iohandler_id, new_iohandler_id);
Todd Fialaa3b89e22014-08-12 14:33:19 +0000981}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000982
983StateType
Greg Claytondc6224e2014-10-21 01:00:42 +0000984Process::WaitForProcessToStop (const TimeValue *timeout,
985 EventSP *event_sp_ptr,
986 bool wait_always,
987 Listener *hijack_listener,
988 Stream *stream)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000989{
Jim Ingham4b536182011-08-09 02:12:22 +0000990 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
991 // We have to actually check each event, and in the case of a stopped event check the restarted flag
992 // on the event.
Greg Clayton85fb1b92012-09-11 02:33:37 +0000993 if (event_sp_ptr)
994 event_sp_ptr->reset();
Jim Ingham4b536182011-08-09 02:12:22 +0000995 StateType state = GetState();
996 // If we are exited or detached, we won't ever get back to any
997 // other valid state...
998 if (state == eStateDetached || state == eStateExited)
999 return state;
1000
Daniel Malea9e9919f2013-10-09 16:56:28 +00001001 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1002 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001003 log->Printf ("Process::%s (timeout = %p)", __FUNCTION__,
1004 static_cast<const void*>(timeout));
Daniel Malea9e9919f2013-10-09 16:56:28 +00001005
1006 if (!wait_always &&
1007 StateIsStoppedState(state, true) &&
Jim Ingham5b4c5eb2015-04-22 17:48:24 +00001008 StateIsStoppedState(GetPrivateState(), true))
1009 {
Daniel Malea9e9919f2013-10-09 16:56:28 +00001010 if (log)
1011 log->Printf("Process::%s returning without waiting for events; process private and public states are already 'stopped'.",
1012 __FUNCTION__);
Pavel Labath78521ef2015-03-06 10:52:47 +00001013 // We need to toggle the run lock as this won't get done in
1014 // SetPublicState() if the process is hijacked.
1015 if (hijack_listener)
1016 m_public_run_lock.SetStopped();
Daniel Malea9e9919f2013-10-09 16:56:28 +00001017 return state;
1018 }
1019
Jim Ingham4b536182011-08-09 02:12:22 +00001020 while (state != eStateInvalid)
1021 {
Greg Clayton85fb1b92012-09-11 02:33:37 +00001022 EventSP event_sp;
Greg Clayton44d93782014-01-27 23:43:24 +00001023 state = WaitForStateChangedEvents (timeout, event_sp, hijack_listener);
Greg Clayton85fb1b92012-09-11 02:33:37 +00001024 if (event_sp_ptr && event_sp)
1025 *event_sp_ptr = event_sp;
1026
Greg Claytondc6224e2014-10-21 01:00:42 +00001027 bool pop_process_io_handler = hijack_listener != NULL;
1028 Process::HandleProcessStateChangedEvent (event_sp, stream, pop_process_io_handler);
1029
Jim Ingham4b536182011-08-09 02:12:22 +00001030 switch (state)
1031 {
1032 case eStateCrashed:
1033 case eStateDetached:
1034 case eStateExited:
1035 case eStateUnloaded:
Greg Clayton44d93782014-01-27 23:43:24 +00001036 // We need to toggle the run lock as this won't get done in
1037 // SetPublicState() if the process is hijacked.
1038 if (hijack_listener)
1039 m_public_run_lock.SetStopped();
Jim Ingham4b536182011-08-09 02:12:22 +00001040 return state;
1041 case eStateStopped:
1042 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1043 continue;
1044 else
Greg Clayton44d93782014-01-27 23:43:24 +00001045 {
1046 // We need to toggle the run lock as this won't get done in
1047 // SetPublicState() if the process is hijacked.
1048 if (hijack_listener)
1049 m_public_run_lock.SetStopped();
Jim Ingham4b536182011-08-09 02:12:22 +00001050 return state;
Greg Clayton44d93782014-01-27 23:43:24 +00001051 }
Jim Ingham4b536182011-08-09 02:12:22 +00001052 default:
1053 continue;
1054 }
1055 }
1056 return state;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001057}
1058
Greg Claytondc6224e2014-10-21 01:00:42 +00001059bool
1060Process::HandleProcessStateChangedEvent (const EventSP &event_sp,
1061 Stream *stream,
1062 bool &pop_process_io_handler)
1063{
1064 const bool handle_pop = pop_process_io_handler == true;
1065
1066 pop_process_io_handler = false;
1067 ProcessSP process_sp = Process::ProcessEventData::GetProcessFromEvent(event_sp.get());
1068
1069 if (!process_sp)
1070 return false;
1071
1072 StateType event_state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
1073 if (event_state == eStateInvalid)
1074 return false;
1075
1076 switch (event_state)
1077 {
1078 case eStateInvalid:
1079 case eStateUnloaded:
Greg Claytondc6224e2014-10-21 01:00:42 +00001080 case eStateAttaching:
1081 case eStateLaunching:
1082 case eStateStepping:
1083 case eStateDetached:
1084 {
1085 if (stream)
1086 stream->Printf ("Process %" PRIu64 " %s\n",
1087 process_sp->GetID(),
1088 StateAsCString (event_state));
1089
1090 if (event_state == eStateDetached)
1091 pop_process_io_handler = true;
1092 }
1093 break;
1094
Stephane Sezerf2ef94e2014-12-13 05:23:51 +00001095 case eStateConnected:
Greg Claytondc6224e2014-10-21 01:00:42 +00001096 case eStateRunning:
1097 // Don't be chatty when we run...
1098 break;
1099
1100 case eStateExited:
1101 if (stream)
1102 process_sp->GetStatus(*stream);
1103 pop_process_io_handler = true;
1104 break;
1105
1106 case eStateStopped:
1107 case eStateCrashed:
1108 case eStateSuspended:
1109 // Make sure the program hasn't been auto-restarted:
1110 if (Process::ProcessEventData::GetRestartedFromEvent (event_sp.get()))
1111 {
1112 if (stream)
1113 {
1114 size_t num_reasons = Process::ProcessEventData::GetNumRestartedReasons(event_sp.get());
1115 if (num_reasons > 0)
1116 {
1117 // FIXME: Do we want to report this, or would that just be annoyingly chatty?
1118 if (num_reasons == 1)
1119 {
1120 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), 0);
1121 stream->Printf ("Process %" PRIu64 " stopped and restarted: %s\n",
1122 process_sp->GetID(),
1123 reason ? reason : "<UNKNOWN REASON>");
1124 }
1125 else
1126 {
1127 stream->Printf ("Process %" PRIu64 " stopped and restarted, reasons:\n",
1128 process_sp->GetID());
1129
1130
1131 for (size_t i = 0; i < num_reasons; i++)
1132 {
1133 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), i);
1134 stream->Printf("\t%s\n", reason ? reason : "<UNKNOWN REASON>");
1135 }
1136 }
1137 }
1138 }
1139 }
1140 else
1141 {
1142 // Lock the thread list so it doesn't change on us, this is the scope for the locker:
1143 {
1144 ThreadList &thread_list = process_sp->GetThreadList();
1145 Mutex::Locker locker (thread_list.GetMutex());
1146
1147 ThreadSP curr_thread (thread_list.GetSelectedThread());
1148 ThreadSP thread;
1149 StopReason curr_thread_stop_reason = eStopReasonInvalid;
1150 if (curr_thread)
1151 curr_thread_stop_reason = curr_thread->GetStopReason();
1152 if (!curr_thread ||
1153 !curr_thread->IsValid() ||
1154 curr_thread_stop_reason == eStopReasonInvalid ||
1155 curr_thread_stop_reason == eStopReasonNone)
1156 {
1157 // Prefer a thread that has just completed its plan over another thread as current thread.
1158 ThreadSP plan_thread;
1159 ThreadSP other_thread;
Jim Inghamce400d92015-07-08 00:06:30 +00001160
Greg Claytondc6224e2014-10-21 01:00:42 +00001161 const size_t num_threads = thread_list.GetSize();
1162 size_t i;
1163 for (i = 0; i < num_threads; ++i)
1164 {
1165 thread = thread_list.GetThreadAtIndex(i);
1166 StopReason thread_stop_reason = thread->GetStopReason();
1167 switch (thread_stop_reason)
1168 {
1169 case eStopReasonInvalid:
1170 case eStopReasonNone:
1171 break;
1172
Jim Inghamce400d92015-07-08 00:06:30 +00001173 case eStopReasonSignal:
1174 {
1175 // Don't select a signal thread if we weren't going to stop at that
1176 // signal. We have to have had another reason for stopping here, and
1177 // the user doesn't want to see this thread.
1178 uint64_t signo = thread->GetStopInfo()->GetValue();
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00001179 if (process_sp->GetUnixSignals()->GetShouldStop(signo))
Jim Inghamce400d92015-07-08 00:06:30 +00001180 {
1181 if (!other_thread)
1182 other_thread = thread;
1183 }
1184 break;
1185 }
Greg Claytondc6224e2014-10-21 01:00:42 +00001186 case eStopReasonTrace:
1187 case eStopReasonBreakpoint:
1188 case eStopReasonWatchpoint:
Greg Claytondc6224e2014-10-21 01:00:42 +00001189 case eStopReasonException:
1190 case eStopReasonExec:
1191 case eStopReasonThreadExiting:
1192 case eStopReasonInstrumentation:
1193 if (!other_thread)
1194 other_thread = thread;
1195 break;
1196 case eStopReasonPlanComplete:
1197 if (!plan_thread)
1198 plan_thread = thread;
1199 break;
1200 }
1201 }
1202 if (plan_thread)
1203 thread_list.SetSelectedThreadByID (plan_thread->GetID());
1204 else if (other_thread)
1205 thread_list.SetSelectedThreadByID (other_thread->GetID());
1206 else
1207 {
1208 if (curr_thread && curr_thread->IsValid())
1209 thread = curr_thread;
1210 else
1211 thread = thread_list.GetThreadAtIndex(0);
1212
1213 if (thread)
1214 thread_list.SetSelectedThreadByID (thread->GetID());
1215 }
1216 }
1217 }
1218 // Drop the ThreadList mutex by here, since GetThreadStatus below might have to run code,
1219 // e.g. for Data formatters, and if we hold the ThreadList mutex, then the process is going to
1220 // have a hard time restarting the process.
1221 if (stream)
1222 {
1223 Debugger &debugger = process_sp->GetTarget().GetDebugger();
1224 if (debugger.GetTargetList().GetSelectedTarget().get() == &process_sp->GetTarget())
1225 {
1226 const bool only_threads_with_stop_reason = true;
1227 const uint32_t start_frame = 0;
1228 const uint32_t num_frames = 1;
1229 const uint32_t num_frames_with_source = 1;
1230 process_sp->GetStatus(*stream);
1231 process_sp->GetThreadStatus (*stream,
1232 only_threads_with_stop_reason,
1233 start_frame,
1234 num_frames,
1235 num_frames_with_source);
1236 }
1237 else
1238 {
1239 uint32_t target_idx = debugger.GetTargetList().GetIndexOfTarget(process_sp->GetTarget().shared_from_this());
1240 if (target_idx != UINT32_MAX)
1241 stream->Printf ("Target %d: (", target_idx);
1242 else
1243 stream->Printf ("Target <unknown index>: (");
1244 process_sp->GetTarget().Dump (stream, eDescriptionLevelBrief);
1245 stream->Printf (") stopped.\n");
1246 }
1247 }
1248
1249 // Pop the process IO handler
1250 pop_process_io_handler = true;
1251 }
1252 break;
1253 }
1254
1255 if (handle_pop && pop_process_io_handler)
1256 process_sp->PopProcessIOHandler();
1257
1258 return true;
1259}
1260
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001261
1262StateType
1263Process::WaitForState
1264(
1265 const TimeValue *timeout,
Greg Clayton44d93782014-01-27 23:43:24 +00001266 const StateType *match_states,
1267 const uint32_t num_match_states
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001268)
1269{
1270 EventSP event_sp;
1271 uint32_t i;
Greg Clayton05faeb72010-10-07 04:19:01 +00001272 StateType state = GetState();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001273 while (state != eStateInvalid)
1274 {
Greg Clayton05faeb72010-10-07 04:19:01 +00001275 // If we are exited or detached, we won't ever get back to any
1276 // other valid state...
1277 if (state == eStateDetached || state == eStateExited)
1278 return state;
1279
Greg Clayton44d93782014-01-27 23:43:24 +00001280 state = WaitForStateChangedEvents (timeout, event_sp, NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001281
1282 for (i=0; i<num_match_states; ++i)
1283 {
1284 if (match_states[i] == state)
1285 return state;
1286 }
1287 }
1288 return state;
1289}
1290
Jim Ingham30f9b212010-10-11 23:53:14 +00001291bool
1292Process::HijackProcessEvents (Listener *listener)
1293{
1294 if (listener != NULL)
1295 {
Jim Inghamcfc09352012-07-27 23:57:19 +00001296 return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham30f9b212010-10-11 23:53:14 +00001297 }
1298 else
1299 return false;
1300}
1301
1302void
1303Process::RestoreProcessEvents ()
1304{
1305 RestoreBroadcaster();
1306}
1307
Jim Ingham0f16e732011-02-08 05:20:59 +00001308bool
1309Process::HijackPrivateProcessEvents (Listener *listener)
1310{
1311 if (listener != NULL)
1312 {
Jim Inghamcfc09352012-07-27 23:57:19 +00001313 return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham0f16e732011-02-08 05:20:59 +00001314 }
1315 else
1316 return false;
1317}
1318
1319void
1320Process::RestorePrivateProcessEvents ()
1321{
1322 m_private_state_broadcaster.RestoreBroadcaster();
1323}
1324
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001325StateType
Greg Clayton44d93782014-01-27 23:43:24 +00001326Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, Listener *hijack_listener)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001327{
Greg Clayton5160ce52013-03-27 23:08:40 +00001328 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001329
1330 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001331 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1332 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001333
Greg Clayton44d93782014-01-27 23:43:24 +00001334 Listener *listener = hijack_listener;
1335 if (listener == NULL)
1336 listener = &m_listener;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001337
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001338 StateType state = eStateInvalid;
Greg Clayton44d93782014-01-27 23:43:24 +00001339 if (listener->WaitForEventForBroadcasterWithType (timeout,
1340 this,
1341 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1342 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001343 {
1344 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1345 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1346 else if (log)
1347 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1348 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001349
1350 if (log)
1351 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001352 __FUNCTION__, static_cast<const void*>(timeout),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001353 StateAsCString(state));
1354 return state;
1355}
1356
1357Event *
1358Process::PeekAtStateChangedEvents ()
1359{
Greg Clayton5160ce52013-03-27 23:08:40 +00001360 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001361
1362 if (log)
1363 log->Printf ("Process::%s...", __FUNCTION__);
1364
1365 Event *event_ptr;
Greg Clayton3fcbed62010-10-19 03:25:40 +00001366 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1367 eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001368 if (log)
1369 {
1370 if (event_ptr)
1371 {
1372 log->Printf ("Process::%s (event_ptr) => %s",
1373 __FUNCTION__,
1374 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1375 }
1376 else
1377 {
1378 log->Printf ("Process::%s no events found",
1379 __FUNCTION__);
1380 }
1381 }
1382 return event_ptr;
1383}
1384
1385StateType
1386Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1387{
Greg Clayton5160ce52013-03-27 23:08:40 +00001388 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001389
1390 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001391 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1392 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001393
1394 StateType state = eStateInvalid;
Greg Clayton6779606a2011-01-22 23:43:18 +00001395 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1396 &m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +00001397 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton6779606a2011-01-22 23:43:18 +00001398 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001399 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1400 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001401
1402 // This is a bit of a hack, but when we wait here we could very well return
1403 // to the command-line, and that could disable the log, which would render the
1404 // log we got above invalid.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001405 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001406 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1407 __FUNCTION__, static_cast<const void *>(timeout),
1408 state == eStateInvalid ? "TIMEOUT" : StateAsCString(state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001409 return state;
1410}
1411
1412bool
1413Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1414{
Greg Clayton5160ce52013-03-27 23:08:40 +00001415 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001416
1417 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001418 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1419 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001420
1421 if (control_only)
1422 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1423 else
1424 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1425}
1426
1427bool
1428Process::IsRunning () const
1429{
1430 return StateIsRunningState (m_public_state.GetValue());
1431}
1432
1433int
1434Process::GetExitStatus ()
1435{
Todd Fiala7b0917a2014-09-15 20:07:33 +00001436 Mutex::Locker locker (m_exit_status_mutex);
1437
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001438 if (m_public_state.GetValue() == eStateExited)
1439 return m_exit_status;
1440 return -1;
1441}
1442
Greg Clayton85851dd2010-12-04 00:10:17 +00001443
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001444const char *
1445Process::GetExitDescription ()
1446{
Todd Fiala7b0917a2014-09-15 20:07:33 +00001447 Mutex::Locker locker (m_exit_status_mutex);
1448
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001449 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1450 return m_exit_string.c_str();
1451 return NULL;
1452}
1453
Greg Clayton6779606a2011-01-22 23:43:18 +00001454bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001455Process::SetExitStatus (int status, const char *cstr)
1456{
Greg Clayton81e2b6b2015-06-01 23:14:09 +00001457 // Use a mutex to protect setting the exit status.
1458 Mutex::Locker locker (m_exit_status_mutex);
1459
Greg Clayton5160ce52013-03-27 23:08:40 +00001460 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Greg Clayton414f5d32011-01-25 02:58:48 +00001461 if (log)
1462 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1463 status, status,
1464 cstr ? "\"" : "",
1465 cstr ? cstr : "NULL",
1466 cstr ? "\"" : "");
1467
Greg Clayton6779606a2011-01-22 23:43:18 +00001468 // We were already in the exited state
1469 if (m_private_state.GetValue() == eStateExited)
Greg Clayton414f5d32011-01-25 02:58:48 +00001470 {
Greg Clayton385d6032011-01-26 23:47:29 +00001471 if (log)
1472 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton6779606a2011-01-22 23:43:18 +00001473 return false;
Greg Clayton414f5d32011-01-25 02:58:48 +00001474 }
Todd Fiala7b0917a2014-09-15 20:07:33 +00001475
Greg Clayton81e2b6b2015-06-01 23:14:09 +00001476 m_exit_status = status;
1477 if (cstr)
1478 m_exit_string = cstr;
1479 else
1480 m_exit_string.clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001481
Pavel Labatha9a43372015-09-03 09:30:17 +00001482 // When we exit, we don't need the input reader anymore
Greg Clayton5df78fa2015-05-23 03:54:53 +00001483 if (m_process_input_reader)
1484 {
1485 m_process_input_reader->SetIsDone(true);
1486 m_process_input_reader->Cancel();
1487 m_process_input_reader.reset();
1488 }
Greg Clayton10177aa2010-12-08 05:08:21 +00001489
Greg Clayton08765fa2015-05-28 03:24:30 +00001490 // Clear the last natural stop ID since it has a strong
1491 // reference to this process
1492 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
1493
Greg Clayton6779606a2011-01-22 23:43:18 +00001494 SetPrivateState (eStateExited);
Greg Clayton5df78fa2015-05-23 03:54:53 +00001495
1496 // Allow subclasses to do some cleanup
1497 DidExit ();
1498
Greg Clayton6779606a2011-01-22 23:43:18 +00001499 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001500}
1501
1502// This static callback can be used to watch for local child processes on
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00001503// the current host. The child process exits, the process will be
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001504// found in the global target list (we want to be completely sure that the
1505// lldb_private::Process doesn't go away before we can deliver the signal.
1506bool
Greg Claytone4e45922011-11-16 05:37:56 +00001507Process::SetProcessExitStatus (void *callback_baton,
1508 lldb::pid_t pid,
1509 bool exited,
1510 int signo, // Zero for no signal
1511 int exit_status // Exit value of process if signal is zero
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001512)
1513{
Greg Clayton5160ce52013-03-27 23:08:40 +00001514 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytone4e45922011-11-16 05:37:56 +00001515 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001516 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
Greg Claytone4e45922011-11-16 05:37:56 +00001517 callback_baton,
1518 pid,
1519 exited,
1520 signo,
1521 exit_status);
1522
1523 if (exited)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001524 {
Greg Clayton66111032010-06-23 01:19:29 +00001525 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001526 if (target_sp)
1527 {
1528 ProcessSP process_sp (target_sp->GetProcessSP());
1529 if (process_sp)
1530 {
1531 const char *signal_cstr = NULL;
1532 if (signo)
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00001533 signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001534
1535 process_sp->SetExitStatus (exit_status, signal_cstr);
1536 }
1537 }
1538 return true;
1539 }
1540 return false;
1541}
1542
1543
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001544void
1545Process::UpdateThreadListIfNeeded ()
1546{
1547 const uint32_t stop_id = GetStopID();
1548 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1549 {
Greg Clayton2637f822011-11-17 01:23:07 +00001550 const StateType state = GetPrivateState();
1551 if (StateIsStoppedState (state, true))
1552 {
1553 Mutex::Locker locker (m_thread_list.GetMutex ());
Greg Claytone24c4ac2011-11-17 04:46:02 +00001554 // m_thread_list does have its own mutex, but we need to
1555 // hold onto the mutex between the call to UpdateThreadList(...)
1556 // and the os->UpdateThreadList(...) so it doesn't change on us
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001557 ThreadList &old_thread_list = m_thread_list;
1558 ThreadList real_thread_list(this);
Greg Clayton2637f822011-11-17 01:23:07 +00001559 ThreadList new_thread_list(this);
1560 // Always update the thread list with the protocol specific
Greg Clayton9fc13552012-04-10 00:18:59 +00001561 // thread list, but only update if "true" is returned
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001562 if (UpdateThreadList (m_thread_list_real, real_thread_list))
Greg Clayton9fc13552012-04-10 00:18:59 +00001563 {
Jim Ingham09437922013-03-01 20:04:25 +00001564 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since
1565 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is
1566 // shutting us down, causing a deadlock.
1567 if (!m_destroy_in_process)
1568 {
1569 OperatingSystem *os = GetOperatingSystem ();
1570 if (os)
Greg Claytonb3ae8762013-04-12 20:07:46 +00001571 {
1572 // Clear any old backing threads where memory threads might have been
1573 // backed by actual threads from the lldb_private::Process subclass
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001574 size_t num_old_threads = old_thread_list.GetSize(false);
Greg Claytonb3ae8762013-04-12 20:07:46 +00001575 for (size_t i=0; i<num_old_threads; ++i)
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001576 old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread();
Greg Claytonb3ae8762013-04-12 20:07:46 +00001577
Greg Clayton15484402015-05-15 18:40:24 +00001578 // Turn off dynamic types to ensure we don't run any expressions. Objective C
1579 // can run an expression to determine if a SBValue is a dynamic type or not
1580 // and we need to avoid this. OperatingSystem plug-ins can't run expressions
1581 // that require running code...
1582
1583 Target &target = GetTarget();
1584 const lldb::DynamicValueType saved_prefer_dynamic = target.GetPreferDynamicValue ();
1585 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1586 target.SetPreferDynamicValue(lldb::eNoDynamicValues);
1587
Greg Claytonb3ae8762013-04-12 20:07:46 +00001588 // Now let the OperatingSystem plug-in update the thread list
Greg Clayton15484402015-05-15 18:40:24 +00001589
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001590 os->UpdateThreadList (old_thread_list, // Old list full of threads created by OS plug-in
1591 real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass
1592 new_thread_list); // The new thread list that we will show to the user that gets filled in
Greg Clayton15484402015-05-15 18:40:24 +00001593
1594 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1595 target.SetPreferDynamicValue(saved_prefer_dynamic);
Greg Claytonb3ae8762013-04-12 20:07:46 +00001596 }
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001597 else
1598 {
1599 // No OS plug-in, the new thread list is the same as the real thread list
1600 new_thread_list = real_thread_list;
1601 }
Jim Ingham09437922013-03-01 20:04:25 +00001602 }
Jim Ingham02ff8e02013-06-22 00:55:02 +00001603
1604 m_thread_list_real.Update(real_thread_list);
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001605 m_thread_list.Update (new_thread_list);
1606 m_thread_list.SetStopID (stop_id);
Jason Molendaa6e91302013-11-19 05:44:41 +00001607
Jason Molenda4ff13262013-11-20 00:31:38 +00001608 if (GetLastNaturalStopID () != m_extended_thread_stop_id)
1609 {
1610 // Clear any extended threads that we may have accumulated previously
1611 m_extended_thread_list.Clear();
1612 m_extended_thread_stop_id = GetLastNaturalStopID ();
Jason Molenda5e8dce42013-12-13 00:29:16 +00001613
1614 m_queue_list.Clear();
1615 m_queue_list_stop_id = GetLastNaturalStopID ();
Jason Molenda4ff13262013-11-20 00:31:38 +00001616 }
Greg Clayton9fc13552012-04-10 00:18:59 +00001617 }
Greg Clayton2637f822011-11-17 01:23:07 +00001618 }
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001619 }
1620}
1621
Jason Molenda5e8dce42013-12-13 00:29:16 +00001622void
1623Process::UpdateQueueListIfNeeded ()
1624{
1625 if (m_system_runtime_ap.get())
1626 {
1627 if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID())
1628 {
1629 const StateType state = GetPrivateState();
1630 if (StateIsStoppedState (state, true))
1631 {
1632 m_system_runtime_ap->PopulateQueueList (m_queue_list);
1633 m_queue_list_stop_id = GetLastNaturalStopID();
1634 }
1635 }
1636 }
1637}
1638
Greg Claytona4d87472013-01-18 23:41:08 +00001639ThreadSP
1640Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1641{
1642 OperatingSystem *os = GetOperatingSystem ();
1643 if (os)
1644 return os->CreateThread(tid, context);
1645 return ThreadSP();
1646}
1647
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001648uint32_t
1649Process::GetNextThreadIndexID (uint64_t thread_id)
1650{
1651 return AssignIndexIDToThread(thread_id);
1652}
1653
1654bool
1655Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1656{
1657 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1658 if (iterator == m_thread_id_to_index_id_map.end())
1659 {
1660 return false;
1661 }
1662 else
1663 {
1664 return true;
1665 }
1666}
1667
1668uint32_t
1669Process::AssignIndexIDToThread(uint64_t thread_id)
1670{
1671 uint32_t result = 0;
1672 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1673 if (iterator == m_thread_id_to_index_id_map.end())
1674 {
1675 result = ++m_thread_index_id;
1676 m_thread_id_to_index_id_map[thread_id] = result;
1677 }
1678 else
1679 {
1680 result = iterator->second;
1681 }
1682
1683 return result;
1684}
1685
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001686StateType
1687Process::GetState()
1688{
1689 // If any other threads access this we will need a mutex for it
1690 return m_public_state.GetValue ();
1691}
1692
Greg Claytondc6224e2014-10-21 01:00:42 +00001693bool
1694Process::StateChangedIsExternallyHijacked()
1695{
1696 if (IsHijackedForEvent(eBroadcastBitStateChanged))
1697 {
1698 if (strcmp(m_hijacking_listeners.back()->GetName(), "lldb.Process.ResumeSynchronous.hijack"))
1699 return true;
1700 }
1701 return false;
1702}
1703
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001704void
Jim Ingham221d51c2013-05-08 00:35:16 +00001705Process::SetPublicState (StateType new_state, bool restarted)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001706{
Greg Clayton5160ce52013-03-27 23:08:40 +00001707 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001708 if (log)
Jim Ingham221d51c2013-05-08 00:35:16 +00001709 log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted);
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001710 const StateType old_state = m_public_state.GetValue();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001711 m_public_state.SetValue (new_state);
Jim Ingham3b8285d2012-04-19 01:40:33 +00001712
1713 // On the transition from Run to Stopped, we unlock the writer end of the
1714 // run lock. The lock gets locked in Resume, which is the public API
1715 // to tell the program to run.
Greg Claytondc6224e2014-10-21 01:00:42 +00001716 if (!StateChangedIsExternallyHijacked())
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001717 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001718 if (new_state == eStateDetached)
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001719 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001720 if (log)
1721 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001722 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001723 }
1724 else
1725 {
1726 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1727 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
Jim Ingham221d51c2013-05-08 00:35:16 +00001728 if ((old_state_is_stopped != new_state_is_stopped))
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001729 {
Jim Ingham221d51c2013-05-08 00:35:16 +00001730 if (new_state_is_stopped && !restarted)
Sean Callanan8b0737f2012-06-02 01:16:20 +00001731 {
1732 if (log)
1733 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001734 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001735 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001736 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001737 }
1738 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001739}
1740
Jim Ingham3b8285d2012-04-19 01:40:33 +00001741Error
1742Process::Resume ()
1743{
Greg Clayton5160ce52013-03-27 23:08:40 +00001744 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Jim Ingham3b8285d2012-04-19 01:40:33 +00001745 if (log)
1746 log->Printf("Process::Resume -- locking run lock");
Ed Maste64fad602013-07-29 20:58:06 +00001747 if (!m_public_run_lock.TrySetRunning())
Jim Ingham3b8285d2012-04-19 01:40:33 +00001748 {
1749 Error error("Resume request failed - process still running.");
1750 if (log)
Ed Maste64fad602013-07-29 20:58:06 +00001751 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
Jim Ingham3b8285d2012-04-19 01:40:33 +00001752 return error;
1753 }
1754 return PrivateResume();
1755}
1756
Greg Claytondc6224e2014-10-21 01:00:42 +00001757Error
1758Process::ResumeSynchronous (Stream *stream)
1759{
1760 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1761 if (log)
1762 log->Printf("Process::ResumeSynchronous -- locking run lock");
1763 if (!m_public_run_lock.TrySetRunning())
1764 {
1765 Error error("Resume request failed - process still running.");
1766 if (log)
1767 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1768 return error;
1769 }
1770
1771 ListenerSP listener_sp (new Listener("lldb.Process.ResumeSynchronous.hijack"));
1772 HijackProcessEvents(listener_sp.get());
1773
1774 Error error = PrivateResume();
Ilia Kd8c14752015-04-30 13:10:32 +00001775 if (error.Success())
1776 {
1777 StateType state = WaitForProcessToStop (NULL, NULL, true, listener_sp.get(), stream);
1778 const bool must_be_alive = false; // eStateExited is ok, so this must be false
1779 if (!StateIsStoppedState(state, must_be_alive))
1780 error.SetErrorStringWithFormat("process not in stopped state after synchronous resume: %s", StateAsCString(state));
1781 }
Greg Claytondc6224e2014-10-21 01:00:42 +00001782
1783 // Undo the hijacking of process events...
1784 RestoreProcessEvents();
1785
Greg Claytondc6224e2014-10-21 01:00:42 +00001786 return error;
1787}
1788
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001789StateType
1790Process::GetPrivateState ()
1791{
1792 return m_private_state.GetValue();
1793}
1794
1795void
1796Process::SetPrivateState (StateType new_state)
1797{
Greg Claytonfb8b37a2014-07-14 23:09:29 +00001798 if (m_finalize_called)
1799 return;
1800
Greg Clayton5160ce52013-03-27 23:08:40 +00001801 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001802 bool state_changed = false;
1803
1804 if (log)
1805 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1806
Andrew Kaylor29d65742013-05-10 17:19:04 +00001807 Mutex::Locker thread_locker(m_thread_list.GetMutex());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001808 Mutex::Locker locker(m_private_state.GetMutex());
1809
1810 const StateType old_state = m_private_state.GetValueNoLock ();
1811 state_changed = old_state != new_state;
Ed Mastec29693f2013-07-02 16:35:47 +00001812
Greg Claytonaa49c832013-05-03 22:25:56 +00001813 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1814 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1815 if (old_state_is_stopped != new_state_is_stopped)
1816 {
1817 if (new_state_is_stopped)
Ed Maste64fad602013-07-29 20:58:06 +00001818 m_private_run_lock.SetStopped();
Greg Claytonaa49c832013-05-03 22:25:56 +00001819 else
Ed Maste64fad602013-07-29 20:58:06 +00001820 m_private_run_lock.SetRunning();
Greg Claytonaa49c832013-05-03 22:25:56 +00001821 }
Andrew Kaylor93132f52013-05-28 23:04:25 +00001822
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001823 if (state_changed)
1824 {
1825 m_private_state.SetValueNoLock (new_state);
Ilia K38810f42015-05-20 10:15:47 +00001826 EventSP event_sp (new Event (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state)));
Greg Clayton2637f822011-11-17 01:23:07 +00001827 if (StateIsStoppedState(new_state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001828 {
Andrew Kaylor29d65742013-05-10 17:19:04 +00001829 // Note, this currently assumes that all threads in the list
1830 // stop when the process stops. In the future we will want to
1831 // support a debugging model where some threads continue to run
1832 // while others are stopped. When that happens we will either need
1833 // a way for the thread list to identify which threads are stopping
1834 // or create a special thread list containing only threads which
1835 // actually stopped.
1836 //
1837 // The process plugin is responsible for managing the actual
1838 // behavior of the threads and should have stopped any threads
1839 // that are going to stop before we get here.
1840 m_thread_list.DidStop();
1841
Jim Ingham4b536182011-08-09 02:12:22 +00001842 m_mod_id.BumpStopID();
Ilia K38810f42015-05-20 10:15:47 +00001843 if (!m_mod_id.IsLastResumeForUserExpression())
1844 m_mod_id.SetStopEventForLastNaturalStopID(event_sp);
Greg Clayton58be07b2011-01-07 06:08:19 +00001845 m_memory_cache.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001846 if (log)
Jim Ingham4b536182011-08-09 02:12:22 +00001847 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001848 }
Ilia K38810f42015-05-20 10:15:47 +00001849
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001850 // Use our target to get a shared pointer to ourselves...
Greg Clayton35a4cc52012-10-29 20:52:08 +00001851 if (m_finalize_called && PrivateStateThreadIsValid() == false)
Ilia K38810f42015-05-20 10:15:47 +00001852 BroadcastEvent (event_sp);
Greg Clayton35a4cc52012-10-29 20:52:08 +00001853 else
Ilia K38810f42015-05-20 10:15:47 +00001854 m_private_state_broadcaster.BroadcastEvent (event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001855 }
1856 else
1857 {
1858 if (log)
Jason Molendafd54b362011-09-20 21:44:10 +00001859 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001860 }
1861}
1862
Jim Ingham0faa43f2011-11-08 03:00:11 +00001863void
1864Process::SetRunningUserExpression (bool on)
1865{
1866 m_mod_id.SetRunningUserExpression (on);
1867}
1868
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001869addr_t
1870Process::GetImageInfoAddress()
1871{
1872 return LLDB_INVALID_ADDRESS;
1873}
1874
Greg Clayton8f343b02010-11-04 01:54:29 +00001875//----------------------------------------------------------------------
1876// LoadImage
1877//
1878// This function provides a default implementation that works for most
1879// unix variants. Any Process subclasses that need to do shared library
1880// loading differently should override LoadImage and UnloadImage and
1881// do what is needed.
1882//----------------------------------------------------------------------
1883uint32_t
1884Process::LoadImage (const FileSpec &image_spec, Error &error)
1885{
Greg Claytonc00ca312015-04-02 18:44:58 +00001886 if (m_finalizing)
1887 {
1888 error.SetErrorString("process is tearing itself down");
1889 return LLDB_INVALID_IMAGE_TOKEN;
1890 }
1891
Greg Claytonac7a3db2012-04-18 00:05:19 +00001892 char path[PATH_MAX];
1893 image_spec.GetPath(path, sizeof(path));
1894
Greg Clayton8f343b02010-11-04 01:54:29 +00001895 DynamicLoader *loader = GetDynamicLoader();
1896 if (loader)
1897 {
1898 error = loader->CanLoadImage();
1899 if (error.Fail())
1900 return LLDB_INVALID_IMAGE_TOKEN;
1901 }
1902
1903 if (error.Success())
1904 {
1905 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton8f343b02010-11-04 01:54:29 +00001906
1907 if (thread_sp)
1908 {
Jason Molendab57e4a12013-11-04 09:33:30 +00001909 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
Greg Clayton8f343b02010-11-04 01:54:29 +00001910
1911 if (frame_sp)
1912 {
1913 ExecutionContext exe_ctx;
1914 frame_sp->CalculateExecutionContext (exe_ctx);
Greg Clayton62afb9f2013-11-04 19:35:17 +00001915 EvaluateExpressionOptions expr_options;
1916 expr_options.SetUnwindOnError(true);
1917 expr_options.SetIgnoreBreakpoints(true);
1918 expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
Jim Ingham4ac04432014-07-19 01:09:16 +00001919 expr_options.SetResultIsInternal(true);
1920
Greg Clayton8f343b02010-11-04 01:54:29 +00001921 StreamString expr;
Jim Ingham6971b862014-07-19 00:37:06 +00001922 expr.Printf(R"(
1923 struct __lldb_dlopen_result { void *image_ptr; const char *error_str; } the_result;
1924 the_result.image_ptr = dlopen ("%s", 2);
1925 if (the_result.image_ptr == (void *) 0x0)
1926 {
1927 the_result.error_str = dlerror();
1928 }
1929 else
1930 {
1931 the_result.error_str = (const char *) 0x0;
1932 }
1933 the_result;
1934 )",
1935 path);
1936 const char *prefix = R"(
1937 extern "C" void* dlopen (const char *path, int mode);
1938 extern "C" const char *dlerror (void);
1939 )";
Jim Inghamf48169b2010-11-30 02:22:11 +00001940 lldb::ValueObjectSP result_valobj_sp;
Greg Clayton62afb9f2013-11-04 19:35:17 +00001941 Error expr_error;
Greg Clayton26ab83d2012-10-31 20:49:04 +00001942 ClangUserExpression::Evaluate (exe_ctx,
Greg Clayton62afb9f2013-11-04 19:35:17 +00001943 expr_options,
Greg Clayton26ab83d2012-10-31 20:49:04 +00001944 expr.GetData(),
1945 prefix,
1946 result_valobj_sp,
Greg Clayton62afb9f2013-11-04 19:35:17 +00001947 expr_error);
1948 if (expr_error.Success())
Greg Clayton8f343b02010-11-04 01:54:29 +00001949 {
Greg Clayton62afb9f2013-11-04 19:35:17 +00001950 error = result_valobj_sp->GetError();
1951 if (error.Success())
Greg Clayton8f343b02010-11-04 01:54:29 +00001952 {
Greg Clayton62afb9f2013-11-04 19:35:17 +00001953 Scalar scalar;
Jim Ingham6971b862014-07-19 00:37:06 +00001954 ValueObjectSP image_ptr_sp = result_valobj_sp->GetChildAtIndex(0, true);
1955 if (image_ptr_sp && image_ptr_sp->ResolveValue (scalar))
Greg Clayton8f343b02010-11-04 01:54:29 +00001956 {
Greg Clayton62afb9f2013-11-04 19:35:17 +00001957 addr_t image_ptr = scalar.ULongLong(LLDB_INVALID_ADDRESS);
1958 if (image_ptr != 0 && image_ptr != LLDB_INVALID_ADDRESS)
1959 {
1960 uint32_t image_token = m_image_tokens.size();
1961 m_image_tokens.push_back (image_ptr);
1962 return image_token;
1963 }
Jim Ingham3ac7cf32014-07-17 18:55:25 +00001964 else if (image_ptr == 0)
1965 {
Jim Ingham6971b862014-07-19 00:37:06 +00001966 ValueObjectSP error_str_sp = result_valobj_sp->GetChildAtIndex(1, true);
1967 if (error_str_sp)
Jim Ingham3ac7cf32014-07-17 18:55:25 +00001968 {
Jim Ingham6971b862014-07-19 00:37:06 +00001969 if (error_str_sp->IsCStringContainer(true))
Jim Ingham3ac7cf32014-07-17 18:55:25 +00001970 {
Enrico Granata2206b482014-10-30 18:27:31 +00001971 DataBufferSP buffer_sp(new DataBufferHeap(10240,0));
1972 size_t num_chars = error_str_sp->ReadPointedString (buffer_sp, error, 10240);
Jim Ingham3ac7cf32014-07-17 18:55:25 +00001973 if (error.Success() && num_chars > 0)
1974 {
1975 error.Clear();
Enrico Granata2206b482014-10-30 18:27:31 +00001976 error.SetErrorStringWithFormat("dlopen error: %s", buffer_sp->GetBytes());
1977 }
1978 else
1979 {
1980 error.Clear();
1981 error.SetErrorStringWithFormat("dlopen failed for unknown reasons.");
Jim Ingham3ac7cf32014-07-17 18:55:25 +00001982 }
1983 }
1984 }
1985 }
Greg Clayton8f343b02010-11-04 01:54:29 +00001986 }
1987 }
1988 }
Jim Ingham6c9ed912014-04-03 01:26:14 +00001989 else
1990 error = expr_error;
Greg Clayton8f343b02010-11-04 01:54:29 +00001991 }
1992 }
1993 }
Greg Claytonac7a3db2012-04-18 00:05:19 +00001994 if (!error.AsCString())
1995 error.SetErrorStringWithFormat("unable to load '%s'", path);
Greg Clayton8f343b02010-11-04 01:54:29 +00001996 return LLDB_INVALID_IMAGE_TOKEN;
1997}
1998
1999//----------------------------------------------------------------------
2000// UnloadImage
2001//
2002// This function provides a default implementation that works for most
2003// unix variants. Any Process subclasses that need to do shared library
2004// loading differently should override LoadImage and UnloadImage and
2005// do what is needed.
2006//----------------------------------------------------------------------
2007Error
2008Process::UnloadImage (uint32_t image_token)
2009{
2010 Error error;
Greg Claytonc00ca312015-04-02 18:44:58 +00002011
2012 if (m_finalizing)
2013 {
2014 error.SetErrorString("process is tearing itself down");
2015 return error;
2016 }
2017
Greg Clayton8f343b02010-11-04 01:54:29 +00002018 if (image_token < m_image_tokens.size())
2019 {
2020 const addr_t image_addr = m_image_tokens[image_token];
2021 if (image_addr == LLDB_INVALID_ADDRESS)
2022 {
2023 error.SetErrorString("image already unloaded");
2024 }
2025 else
2026 {
2027 DynamicLoader *loader = GetDynamicLoader();
2028 if (loader)
2029 error = loader->CanLoadImage();
2030
2031 if (error.Success())
2032 {
2033 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton8f343b02010-11-04 01:54:29 +00002034
2035 if (thread_sp)
2036 {
Jason Molendab57e4a12013-11-04 09:33:30 +00002037 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
Greg Clayton8f343b02010-11-04 01:54:29 +00002038
2039 if (frame_sp)
2040 {
2041 ExecutionContext exe_ctx;
2042 frame_sp->CalculateExecutionContext (exe_ctx);
Greg Clayton62afb9f2013-11-04 19:35:17 +00002043 EvaluateExpressionOptions expr_options;
2044 expr_options.SetUnwindOnError(true);
2045 expr_options.SetIgnoreBreakpoints(true);
2046 expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
Greg Clayton8f343b02010-11-04 01:54:29 +00002047 StreamString expr;
Daniel Malead01b2952012-11-29 21:49:15 +00002048 expr.Printf("dlclose ((void *)0x%" PRIx64 ")", image_addr);
Greg Clayton8f343b02010-11-04 01:54:29 +00002049 const char *prefix = "extern \"C\" int dlclose(void* handle);\n";
Jim Inghamf48169b2010-11-30 02:22:11 +00002050 lldb::ValueObjectSP result_valobj_sp;
Greg Clayton62afb9f2013-11-04 19:35:17 +00002051 Error expr_error;
Greg Clayton26ab83d2012-10-31 20:49:04 +00002052 ClangUserExpression::Evaluate (exe_ctx,
Greg Clayton62afb9f2013-11-04 19:35:17 +00002053 expr_options,
Greg Clayton26ab83d2012-10-31 20:49:04 +00002054 expr.GetData(),
2055 prefix,
2056 result_valobj_sp,
Greg Clayton62afb9f2013-11-04 19:35:17 +00002057 expr_error);
Greg Clayton8f343b02010-11-04 01:54:29 +00002058 if (result_valobj_sp->GetError().Success())
2059 {
2060 Scalar scalar;
Jim Ingham6035b672011-03-31 00:19:25 +00002061 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton8f343b02010-11-04 01:54:29 +00002062 {
2063 if (scalar.UInt(1))
2064 {
2065 error.SetErrorStringWithFormat("expression failed: \"%s\"", expr.GetData());
2066 }
2067 else
2068 {
2069 m_image_tokens[image_token] = LLDB_INVALID_ADDRESS;
2070 }
2071 }
2072 }
2073 else
2074 {
2075 error = result_valobj_sp->GetError();
2076 }
2077 }
2078 }
2079 }
2080 }
2081 }
2082 else
2083 {
2084 error.SetErrorString("invalid image token");
2085 }
2086 return error;
2087}
2088
Greg Clayton31f1d2f2011-05-11 18:39:18 +00002089const lldb::ABISP &
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002090Process::GetABI()
2091{
Greg Clayton31f1d2f2011-05-11 18:39:18 +00002092 if (!m_abi_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00002093 m_abi_sp = ABI::FindPlugin(GetTarget().GetArchitecture());
Greg Clayton31f1d2f2011-05-11 18:39:18 +00002094 return m_abi_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002095}
2096
Jim Ingham22777012010-09-23 02:01:19 +00002097LanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00002098Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00002099{
Greg Claytonc00ca312015-04-02 18:44:58 +00002100 if (m_finalizing)
2101 return nullptr;
2102
Jim Ingham22777012010-09-23 02:01:19 +00002103 LanguageRuntimeCollection::iterator pos;
2104 pos = m_language_runtimes.find (language);
Jim Inghamab175242012-03-10 00:22:19 +00002105 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
Jim Ingham22777012010-09-23 02:01:19 +00002106 {
Jim Inghamab175242012-03-10 00:22:19 +00002107 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
Jim Ingham22777012010-09-23 02:01:19 +00002108
Jim Inghamab175242012-03-10 00:22:19 +00002109 m_language_runtimes[language] = runtime_sp;
2110 return runtime_sp.get();
Jim Ingham22777012010-09-23 02:01:19 +00002111 }
2112 else
2113 return (*pos).second.get();
2114}
2115
2116CPPLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00002117Process::GetCPPLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00002118{
Jim Inghamab175242012-03-10 00:22:19 +00002119 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00002120 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
2121 return static_cast<CPPLanguageRuntime *> (runtime);
2122 return NULL;
2123}
2124
2125ObjCLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00002126Process::GetObjCLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00002127{
Jim Inghamab175242012-03-10 00:22:19 +00002128 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00002129 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
2130 return static_cast<ObjCLanguageRuntime *> (runtime);
2131 return NULL;
2132}
2133
Enrico Granatafd4c84e2012-05-21 16:51:35 +00002134bool
2135Process::IsPossibleDynamicValue (ValueObject& in_value)
2136{
Greg Claytonc00ca312015-04-02 18:44:58 +00002137 if (m_finalizing)
2138 return false;
2139
Enrico Granatafd4c84e2012-05-21 16:51:35 +00002140 if (in_value.IsDynamic())
2141 return false;
2142 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
2143
2144 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
2145 {
2146 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
2147 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
2148 }
2149
2150 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
2151 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
2152 return true;
2153
2154 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
2155 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
2156}
2157
Zachary Turner93749ab2015-03-03 21:51:25 +00002158void
2159Process::SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers)
2160{
2161 m_dynamic_checkers_ap.reset(dynamic_checkers);
2162}
2163
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002164BreakpointSiteList &
2165Process::GetBreakpointSiteList()
2166{
2167 return m_breakpoint_site_list;
2168}
2169
2170const BreakpointSiteList &
2171Process::GetBreakpointSiteList() const
2172{
2173 return m_breakpoint_site_list;
2174}
2175
2176
2177void
2178Process::DisableAllBreakpointSites ()
2179{
Greg Claytond8cf1a12013-06-12 00:46:38 +00002180 m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void {
2181// bp_site->SetEnabled(true);
2182 DisableBreakpointSite(bp_site);
2183 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002184}
2185
2186Error
2187Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
2188{
2189 Error error (DisableBreakpointSiteByID (break_id));
2190
2191 if (error.Success())
2192 m_breakpoint_site_list.Remove(break_id);
2193
2194 return error;
2195}
2196
2197Error
2198Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
2199{
2200 Error error;
2201 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2202 if (bp_site_sp)
2203 {
2204 if (bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00002205 error = DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002206 }
2207 else
2208 {
Daniel Malead01b2952012-11-29 21:49:15 +00002209 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002210 }
2211
2212 return error;
2213}
2214
2215Error
2216Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
2217{
2218 Error error;
2219 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2220 if (bp_site_sp)
2221 {
2222 if (!bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00002223 error = EnableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002224 }
2225 else
2226 {
Daniel Malead01b2952012-11-29 21:49:15 +00002227 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002228 }
2229 return error;
2230}
2231
Stephen Wilson50bd94f2010-07-17 00:56:13 +00002232lldb::break_id_t
Greg Claytone1cd1be2012-01-29 20:56:30 +00002233Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002234{
Jim Ingham1460e4b2014-01-10 23:46:59 +00002235 addr_t load_addr = LLDB_INVALID_ADDRESS;
2236
2237 bool show_error = true;
2238 switch (GetState())
2239 {
2240 case eStateInvalid:
2241 case eStateUnloaded:
2242 case eStateConnected:
2243 case eStateAttaching:
2244 case eStateLaunching:
2245 case eStateDetached:
2246 case eStateExited:
2247 show_error = false;
2248 break;
2249
2250 case eStateStopped:
2251 case eStateRunning:
2252 case eStateStepping:
2253 case eStateCrashed:
2254 case eStateSuspended:
2255 show_error = IsAlive();
2256 break;
2257 }
2258
2259 // Reset the IsIndirect flag here, in case the location changes from
2260 // pointing to a indirect symbol to a regular symbol.
2261 owner->SetIsIndirect (false);
2262
2263 if (owner->ShouldResolveIndirectFunctions())
2264 {
2265 Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol();
2266 if (symbol && symbol->IsIndirect())
2267 {
2268 Error error;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002269 Address symbol_address = symbol->GetAddress();
2270 load_addr = ResolveIndirectFunction (&symbol_address, error);
Jim Ingham1460e4b2014-01-10 23:46:59 +00002271 if (!error.Success() && show_error)
2272 {
Zachary Turner7529df92015-09-01 20:02:29 +00002273 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2274 symbol->GetLoadAddress(&GetTarget()),
2275 owner->GetBreakpoint().GetID(),
2276 owner->GetID(),
2277 error.AsCString() ? error.AsCString() : "unknown error");
Jim Ingham1460e4b2014-01-10 23:46:59 +00002278 return LLDB_INVALID_BREAK_ID;
2279 }
2280 Address resolved_address(load_addr);
Zachary Turner7529df92015-09-01 20:02:29 +00002281 load_addr = resolved_address.GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002282 owner->SetIsIndirect(true);
2283 }
2284 else
Zachary Turner7529df92015-09-01 20:02:29 +00002285 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002286 }
2287 else
Zachary Turner7529df92015-09-01 20:02:29 +00002288 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002289
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002290 if (load_addr != LLDB_INVALID_ADDRESS)
2291 {
2292 BreakpointSiteSP bp_site_sp;
2293
2294 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
2295 // create a new breakpoint site and add it.
2296
2297 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
2298
2299 if (bp_site_sp)
2300 {
2301 bp_site_sp->AddOwner (owner);
2302 owner->SetBreakpointSite (bp_site_sp);
2303 return bp_site_sp->GetID();
2304 }
2305 else
2306 {
Greg Claytonc7bece562013-01-25 18:06:21 +00002307 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002308 if (bp_site_sp)
2309 {
Greg Claytoneb023e72013-10-11 19:48:25 +00002310 Error error = EnableBreakpointSite (bp_site_sp.get());
2311 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002312 {
2313 owner->SetBreakpointSite (bp_site_sp);
2314 return m_breakpoint_site_list.Add (bp_site_sp);
2315 }
Greg Claytoneb023e72013-10-11 19:48:25 +00002316 else
2317 {
Greg Claytonfbb76342013-11-20 21:07:01 +00002318 if (show_error)
2319 {
2320 // Report error for setting breakpoint...
Zachary Turner7529df92015-09-01 20:02:29 +00002321 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2322 load_addr,
2323 owner->GetBreakpoint().GetID(),
2324 owner->GetID(),
2325 error.AsCString() ? error.AsCString() : "unknown error");
Greg Claytonfbb76342013-11-20 21:07:01 +00002326 }
Greg Claytoneb023e72013-10-11 19:48:25 +00002327 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002328 }
2329 }
2330 }
2331 // We failed to enable the breakpoint
2332 return LLDB_INVALID_BREAK_ID;
2333
2334}
2335
2336void
2337Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
2338{
2339 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
2340 if (num_owners == 0)
2341 {
Jim Inghamf1ff3bb2013-04-06 00:16:39 +00002342 // Don't try to disable the site if we don't have a live process anymore.
2343 if (IsAlive())
2344 DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002345 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
2346 }
2347}
2348
2349
2350size_t
2351Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
2352{
2353 size_t bytes_removed = 0;
Jim Ingham20c77192011-06-29 19:42:28 +00002354 BreakpointSiteList bp_sites_in_range;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002355
Jim Ingham20c77192011-06-29 19:42:28 +00002356 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002357 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002358 bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void {
2359 if (bp_site->GetType() == BreakpointSite::eSoftware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002360 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002361 addr_t intersect_addr;
2362 size_t intersect_size;
2363 size_t opcode_offset;
2364 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
Jim Ingham20c77192011-06-29 19:42:28 +00002365 {
2366 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
2367 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002368 assert(opcode_offset + intersect_size <= bp_site->GetByteSize());
Jim Ingham20c77192011-06-29 19:42:28 +00002369 size_t buf_offset = intersect_addr - bp_addr;
Greg Claytond8cf1a12013-06-12 00:46:38 +00002370 ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
Jim Ingham20c77192011-06-29 19:42:28 +00002371 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002372 }
Greg Claytond8cf1a12013-06-12 00:46:38 +00002373 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002374 }
2375 return bytes_removed;
2376}
2377
2378
Greg Claytonded470d2011-03-19 01:12:21 +00002379
2380size_t
2381Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
2382{
Zachary Turner7529df92015-09-01 20:02:29 +00002383 PlatformSP platform_sp (GetTarget().GetPlatform());
Greg Claytonded470d2011-03-19 01:12:21 +00002384 if (platform_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00002385 return platform_sp->GetSoftwareBreakpointTrapOpcode (GetTarget(), bp_site);
Greg Claytonded470d2011-03-19 01:12:21 +00002386 return 0;
2387}
2388
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002389Error
2390Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
2391{
2392 Error error;
2393 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002394 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002395 const addr_t bp_addr = bp_site->GetLoadAddress();
2396 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002397 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002398 if (bp_site->IsEnabled())
2399 {
2400 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002401 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 +00002402 return error;
2403 }
2404
2405 if (bp_addr == LLDB_INVALID_ADDRESS)
2406 {
2407 error.SetErrorString("BreakpointSite contains an invalid load address.");
2408 return error;
2409 }
2410 // Ask the lldb::Process subclass to fill in the correct software breakpoint
2411 // trap for the breakpoint site
2412 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
2413
2414 if (bp_opcode_size == 0)
2415 {
Daniel Malead01b2952012-11-29 21:49:15 +00002416 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002417 }
2418 else
2419 {
2420 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
2421
2422 if (bp_opcode_bytes == NULL)
2423 {
2424 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
2425 return error;
2426 }
2427
2428 // Save the original opcode by reading it
2429 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
2430 {
2431 // Write a software breakpoint in place of the original opcode
2432 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2433 {
2434 uint8_t verify_bp_opcode_bytes[64];
2435 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2436 {
2437 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
2438 {
2439 bp_site->SetEnabled(true);
2440 bp_site->SetType (BreakpointSite::eSoftware);
2441 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002442 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002443 bp_site->GetID(),
2444 (uint64_t)bp_addr);
2445 }
2446 else
Greg Clayton86edbf42011-10-26 00:56:27 +00002447 error.SetErrorString("failed to verify the breakpoint trap in memory.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002448 }
2449 else
2450 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
2451 }
2452 else
2453 error.SetErrorString("Unable to write breakpoint trap to memory.");
2454 }
2455 else
2456 error.SetErrorString("Unable to read memory at breakpoint address.");
2457 }
Stephen Wilson78a4feb2011-01-12 04:20:03 +00002458 if (log && error.Fail())
Daniel Malead01b2952012-11-29 21:49:15 +00002459 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002460 bp_site->GetID(),
2461 (uint64_t)bp_addr,
2462 error.AsCString());
2463 return error;
2464}
2465
2466Error
2467Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2468{
2469 Error error;
2470 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002471 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002472 addr_t bp_addr = bp_site->GetLoadAddress();
2473 lldb::user_id_t breakID = bp_site->GetID();
2474 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00002475 log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002476
2477 if (bp_site->IsHardware())
2478 {
2479 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2480 }
2481 else if (bp_site->IsEnabled())
2482 {
2483 const size_t break_op_size = bp_site->GetByteSize();
2484 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2485 if (break_op_size > 0)
2486 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00002487 // Clear a software breakpoint instruction
Greg Claytonc982c762010-07-09 20:39:50 +00002488 uint8_t curr_break_op[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002489 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002490 bool break_op_found = false;
2491
2492 // Read the breakpoint opcode
2493 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2494 {
2495 bool verify = false;
Bruce Mitchener58ef3912015-06-18 05:27:05 +00002496 // Make sure the breakpoint opcode exists at this address
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002497 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2498 {
2499 break_op_found = true;
2500 // We found a valid breakpoint opcode at this address, now restore
2501 // the saved opcode.
2502 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2503 {
2504 verify = true;
2505 }
2506 else
2507 error.SetErrorString("Memory write failed when restoring original opcode.");
2508 }
2509 else
2510 {
2511 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2512 // Set verify to true and so we can check if the original opcode has already been restored
2513 verify = true;
2514 }
2515
2516 if (verify)
2517 {
Greg Claytonc982c762010-07-09 20:39:50 +00002518 uint8_t verify_opcode[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002519 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002520 // Verify that our original opcode made it back to the inferior
2521 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2522 {
2523 // compare the memory we just read with the original opcode
2524 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2525 {
2526 // SUCCESS
2527 bp_site->SetEnabled(false);
2528 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002529 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 +00002530 return error;
2531 }
2532 else
2533 {
2534 if (break_op_found)
2535 error.SetErrorString("Failed to restore original opcode.");
2536 }
2537 }
2538 else
2539 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2540 }
2541 }
2542 else
2543 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2544 }
2545 }
2546 else
2547 {
2548 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002549 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 +00002550 return error;
2551 }
2552
2553 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002554 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002555 bp_site->GetID(),
2556 (uint64_t)bp_addr,
2557 error.AsCString());
2558 return error;
2559
2560}
2561
Greg Clayton58be07b2011-01-07 06:08:19 +00002562// Uncomment to verify memory caching works after making changes to caching code
2563//#define VERIFY_MEMORY_READS
2564
Sean Callanan64c0cf22012-06-07 22:26:42 +00002565size_t
2566Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2567{
Jason Molendaa7b5afa2013-11-15 00:17:32 +00002568 error.Clear();
Sean Callanan64c0cf22012-06-07 22:26:42 +00002569 if (!GetDisableMemoryCache())
2570 {
Greg Clayton58be07b2011-01-07 06:08:19 +00002571#if defined (VERIFY_MEMORY_READS)
Sean Callanan64c0cf22012-06-07 22:26:42 +00002572 // Memory caching is enabled, with debug verification
2573
2574 if (buf && size)
2575 {
2576 // Uncomment the line below to make sure memory caching is working.
2577 // I ran this through the test suite and got no assertions, so I am
2578 // pretty confident this is working well. If any changes are made to
2579 // memory caching, uncomment the line below and test your changes!
2580
2581 // Verify all memory reads by using the cache first, then redundantly
2582 // reading the same memory from the inferior and comparing to make sure
2583 // everything is exactly the same.
2584 std::string verify_buf (size, '\0');
2585 assert (verify_buf.size() == size);
2586 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2587 Error verify_error;
2588 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2589 assert (cache_bytes_read == verify_bytes_read);
2590 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2591 assert (verify_error.Success() == error.Success());
2592 return cache_bytes_read;
2593 }
2594 return 0;
2595#else // !defined(VERIFY_MEMORY_READS)
2596 // Memory caching is enabled, without debug verification
2597
2598 return m_memory_cache.Read (addr, buf, size, error);
2599#endif // defined (VERIFY_MEMORY_READS)
Greg Clayton58be07b2011-01-07 06:08:19 +00002600 }
Sean Callanan64c0cf22012-06-07 22:26:42 +00002601 else
2602 {
2603 // Memory caching is disabled
2604
2605 return ReadMemoryFromInferior (addr, buf, size, error);
2606 }
Greg Clayton58be07b2011-01-07 06:08:19 +00002607}
Greg Clayton58be07b2011-01-07 06:08:19 +00002608
Greg Clayton4c82d422012-05-18 23:20:01 +00002609size_t
2610Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2611{
Greg Claytonde87c0f2012-05-19 00:18:00 +00002612 char buf[256];
Greg Clayton4c82d422012-05-18 23:20:01 +00002613 out_str.clear();
2614 addr_t curr_addr = addr;
2615 while (1)
2616 {
2617 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2618 if (length == 0)
2619 break;
2620 out_str.append(buf, length);
2621 // If we got "length - 1" bytes, we didn't get the whole C string, we
2622 // need to read some more characters
2623 if (length == sizeof(buf) - 1)
2624 curr_addr += length;
2625 else
2626 break;
2627 }
2628 return out_str.size();
2629}
2630
Greg Clayton58be07b2011-01-07 06:08:19 +00002631
2632size_t
Ashok Thirumurthi6ac9d132013-04-19 15:58:38 +00002633Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error,
2634 size_t type_width)
2635{
2636 size_t total_bytes_read = 0;
2637 if (dst && max_bytes && type_width && max_bytes >= type_width)
2638 {
2639 // Ensure a null terminator independent of the number of bytes that is read.
2640 memset (dst, 0, max_bytes);
2641 size_t bytes_left = max_bytes - type_width;
2642
2643 const char terminator[4] = {'\0', '\0', '\0', '\0'};
2644 assert(sizeof(terminator) >= type_width &&
2645 "Attempting to validate a string with more than 4 bytes per character!");
2646
2647 addr_t curr_addr = addr;
2648 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2649 char *curr_dst = dst;
2650
2651 error.Clear();
2652 while (bytes_left > 0 && error.Success())
2653 {
2654 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2655 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2656 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2657
2658 if (bytes_read == 0)
2659 break;
2660
2661 // Search for a null terminator of correct size and alignment in bytes_read
2662 size_t aligned_start = total_bytes_read - total_bytes_read % type_width;
2663 for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width)
2664 if (::strncmp(&dst[i], terminator, type_width) == 0)
2665 {
2666 error.Clear();
2667 return i;
2668 }
2669
2670 total_bytes_read += bytes_read;
2671 curr_dst += bytes_read;
2672 curr_addr += bytes_read;
2673 bytes_left -= bytes_read;
2674 }
2675 }
2676 else
2677 {
2678 if (max_bytes)
2679 error.SetErrorString("invalid arguments");
2680 }
2681 return total_bytes_read;
2682}
2683
2684// Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find
2685// null terminators.
2686size_t
Greg Claytone91b7952011-12-15 03:14:23 +00002687Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
Greg Clayton8b82f082011-04-12 05:54:46 +00002688{
2689 size_t total_cstr_len = 0;
2690 if (dst && dst_max_len)
2691 {
Greg Claytone91b7952011-12-15 03:14:23 +00002692 result_error.Clear();
Greg Clayton8b82f082011-04-12 05:54:46 +00002693 // NULL out everything just to be safe
2694 memset (dst, 0, dst_max_len);
2695 Error error;
2696 addr_t curr_addr = addr;
2697 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2698 size_t bytes_left = dst_max_len - 1;
2699 char *curr_dst = dst;
2700
2701 while (bytes_left > 0)
2702 {
2703 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2704 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2705 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2706
2707 if (bytes_read == 0)
2708 {
Greg Claytone91b7952011-12-15 03:14:23 +00002709 result_error = error;
Greg Clayton8b82f082011-04-12 05:54:46 +00002710 dst[total_cstr_len] = '\0';
2711 break;
2712 }
2713 const size_t len = strlen(curr_dst);
2714
2715 total_cstr_len += len;
2716
2717 if (len < bytes_to_read)
2718 break;
2719
2720 curr_dst += bytes_read;
2721 curr_addr += bytes_read;
2722 bytes_left -= bytes_read;
2723 }
2724 }
Greg Claytone91b7952011-12-15 03:14:23 +00002725 else
2726 {
2727 if (dst == NULL)
2728 result_error.SetErrorString("invalid arguments");
2729 else
2730 result_error.Clear();
2731 }
Greg Clayton8b82f082011-04-12 05:54:46 +00002732 return total_cstr_len;
2733}
2734
2735size_t
Greg Clayton58be07b2011-01-07 06:08:19 +00002736Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2737{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002738 if (buf == NULL || size == 0)
2739 return 0;
2740
2741 size_t bytes_read = 0;
2742 uint8_t *bytes = (uint8_t *)buf;
2743
2744 while (bytes_read < size)
2745 {
2746 const size_t curr_size = size - bytes_read;
2747 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2748 bytes + bytes_read,
2749 curr_size,
2750 error);
2751 bytes_read += curr_bytes_read;
2752 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2753 break;
2754 }
2755
2756 // Replace any software breakpoint opcodes that fall into this range back
2757 // into "buf" before we return
2758 if (bytes_read > 0)
2759 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2760 return bytes_read;
2761}
2762
Greg Clayton58a4c462010-12-16 20:01:20 +00002763uint64_t
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002764Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
Greg Clayton58a4c462010-12-16 20:01:20 +00002765{
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002766 Scalar scalar;
2767 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2768 return scalar.ULongLong(fail_value);
2769 return fail_value;
2770}
2771
2772addr_t
2773Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2774{
2775 Scalar scalar;
2776 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2777 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2778 return LLDB_INVALID_ADDRESS;
2779}
2780
2781
2782bool
2783Process::WritePointerToMemory (lldb::addr_t vm_addr,
2784 lldb::addr_t ptr_value,
2785 Error &error)
2786{
2787 Scalar scalar;
2788 const uint32_t addr_byte_size = GetAddressByteSize();
2789 if (addr_byte_size <= 4)
2790 scalar = (uint32_t)ptr_value;
Greg Clayton58a4c462010-12-16 20:01:20 +00002791 else
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002792 scalar = ptr_value;
2793 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
Greg Clayton58a4c462010-12-16 20:01:20 +00002794}
2795
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002796size_t
2797Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2798{
2799 size_t bytes_written = 0;
2800 const uint8_t *bytes = (const uint8_t *)buf;
2801
2802 while (bytes_written < size)
2803 {
2804 const size_t curr_size = size - bytes_written;
2805 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2806 bytes + bytes_written,
2807 curr_size,
2808 error);
2809 bytes_written += curr_bytes_written;
2810 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2811 break;
2812 }
2813 return bytes_written;
2814}
2815
2816size_t
2817Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2818{
Greg Clayton58be07b2011-01-07 06:08:19 +00002819#if defined (ENABLE_MEMORY_CACHING)
2820 m_memory_cache.Flush (addr, size);
2821#endif
2822
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002823 if (buf == NULL || size == 0)
2824 return 0;
Jim Ingham78a685a2011-04-16 00:01:13 +00002825
Jim Ingham4b536182011-08-09 02:12:22 +00002826 m_mod_id.BumpMemoryID();
Jim Ingham78a685a2011-04-16 00:01:13 +00002827
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002828 // We need to write any data that would go where any current software traps
2829 // (enabled software breakpoints) any software traps (breakpoints) that we
2830 // may have placed in our tasks memory.
2831
Greg Claytond8cf1a12013-06-12 00:46:38 +00002832 BreakpointSiteList bp_sites_in_range;
2833
2834 if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002835 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002836 // No breakpoint sites overlap
2837 if (bp_sites_in_range.IsEmpty())
2838 return WriteMemoryPrivate (addr, buf, size, error);
2839 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002840 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002841 const uint8_t *ubuf = (const uint8_t *)buf;
2842 uint64_t bytes_written = 0;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002843
Greg Claytond8cf1a12013-06-12 00:46:38 +00002844 bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void {
2845
2846 if (error.Success())
2847 {
2848 addr_t intersect_addr;
2849 size_t intersect_size;
2850 size_t opcode_offset;
2851 const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset);
Bruce Mitchener8a67bf72015-07-24 00:23:29 +00002852 UNUSED_IF_ASSERT_DISABLED(intersects);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002853 assert(intersects);
2854 assert(addr <= intersect_addr && intersect_addr < addr + size);
2855 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2856 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2857
2858 // Check for bytes before this breakpoint
2859 const addr_t curr_addr = addr + bytes_written;
2860 if (intersect_addr > curr_addr)
2861 {
2862 // There are some bytes before this breakpoint that we need to
2863 // just write to memory
2864 size_t curr_size = intersect_addr - curr_addr;
2865 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2866 ubuf + bytes_written,
2867 curr_size,
2868 error);
2869 bytes_written += curr_bytes_written;
2870 if (curr_bytes_written != curr_size)
2871 {
2872 // We weren't able to write all of the requested bytes, we
2873 // are done looping and will return the number of bytes that
2874 // we have written so far.
2875 if (error.Success())
2876 error.SetErrorToGenericError();
2877 }
2878 }
2879 // Now write any bytes that would cover up any software breakpoints
2880 // directly into the breakpoint opcode buffer
2881 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2882 bytes_written += intersect_size;
2883 }
2884 });
2885
2886 if (bytes_written < size)
Jason Molenda8b5f2cf2014-10-16 07:49:27 +00002887 WriteMemoryPrivate (addr + bytes_written,
2888 ubuf + bytes_written,
2889 size - bytes_written,
2890 error);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002891 }
2892 }
2893 else
2894 {
2895 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002896 }
2897
2898 // Write any remaining bytes after the last breakpoint if we have any left
Greg Claytond8cf1a12013-06-12 00:46:38 +00002899 return 0; //bytes_written;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002900}
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002901
2902size_t
Greg Claytonc7bece562013-01-25 18:06:21 +00002903Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002904{
2905 if (byte_size == UINT32_MAX)
2906 byte_size = scalar.GetByteSize();
2907 if (byte_size > 0)
2908 {
2909 uint8_t buf[32];
2910 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2911 if (mem_size > 0)
2912 return WriteMemory(addr, buf, mem_size, error);
2913 else
2914 error.SetErrorString ("failed to get scalar as memory data");
2915 }
2916 else
2917 {
2918 error.SetErrorString ("invalid scalar value");
2919 }
2920 return 0;
2921}
2922
2923size_t
2924Process::ReadScalarIntegerFromMemory (addr_t addr,
2925 uint32_t byte_size,
2926 bool is_signed,
2927 Scalar &scalar,
2928 Error &error)
2929{
Greg Clayton7060f892013-05-01 23:41:30 +00002930 uint64_t uval = 0;
2931 if (byte_size == 0)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002932 {
Greg Clayton7060f892013-05-01 23:41:30 +00002933 error.SetErrorString ("byte size is zero");
2934 }
2935 else if (byte_size & (byte_size - 1))
2936 {
2937 error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size);
2938 }
2939 else if (byte_size <= sizeof(uval))
2940 {
2941 const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002942 if (bytes_read == byte_size)
2943 {
2944 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
Greg Claytonc7bece562013-01-25 18:06:21 +00002945 lldb::offset_t offset = 0;
Greg Clayton7060f892013-05-01 23:41:30 +00002946 if (byte_size <= 4)
2947 scalar = data.GetMaxU32 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002948 else
Greg Clayton7060f892013-05-01 23:41:30 +00002949 scalar = data.GetMaxU64 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002950 if (is_signed)
2951 scalar.SignExtend(byte_size * 8);
2952 return bytes_read;
2953 }
2954 }
2955 else
2956 {
2957 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2958 }
2959 return 0;
2960}
2961
Greg Claytond495c532011-05-17 03:37:42 +00002962#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002963addr_t
2964Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2965{
Jim Inghamf72ce3a2011-06-20 17:32:44 +00002966 if (GetPrivateState() != eStateStopped)
2967 return LLDB_INVALID_ADDRESS;
2968
Greg Claytond495c532011-05-17 03:37:42 +00002969#if defined (USE_ALLOCATE_MEMORY_CACHE)
2970 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2971#else
Greg Claytonb2daec92011-01-23 19:58:49 +00002972 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
Greg Clayton5160ce52013-03-27 23:08:40 +00002973 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002974 if (log)
Greg Clayton45989072013-10-23 18:24:30 +00002975 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 +00002976 (uint64_t)size,
Greg Claytond495c532011-05-17 03:37:42 +00002977 GetPermissionsAsCString (permissions),
Greg Claytonb2daec92011-01-23 19:58:49 +00002978 (uint64_t)allocated_addr,
Jim Ingham4b536182011-08-09 02:12:22 +00002979 m_mod_id.GetStopID(),
2980 m_mod_id.GetMemoryID());
Greg Claytonb2daec92011-01-23 19:58:49 +00002981 return allocated_addr;
Greg Claytond495c532011-05-17 03:37:42 +00002982#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002983}
2984
Sean Callanan90539452011-09-20 23:01:51 +00002985bool
2986Process::CanJIT ()
2987{
Sean Callanana7b443a2012-02-14 22:50:38 +00002988 if (m_can_jit == eCanJITDontKnow)
2989 {
Todd Fialaaf245d12014-06-30 21:05:18 +00002990 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Sean Callanana7b443a2012-02-14 22:50:38 +00002991 Error err;
2992
2993 uint64_t allocated_memory = AllocateMemory(8,
2994 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2995 err);
2996
2997 if (err.Success())
Todd Fialaaf245d12014-06-30 21:05:18 +00002998 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002999 m_can_jit = eCanJITYes;
Todd Fialaaf245d12014-06-30 21:05:18 +00003000 if (log)
3001 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ());
3002 }
Sean Callanana7b443a2012-02-14 22:50:38 +00003003 else
Todd Fialaaf245d12014-06-30 21:05:18 +00003004 {
Sean Callanana7b443a2012-02-14 22:50:38 +00003005 m_can_jit = eCanJITNo;
Todd Fialaaf245d12014-06-30 21:05:18 +00003006 if (log)
3007 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ());
3008 }
Sean Callanana7b443a2012-02-14 22:50:38 +00003009
3010 DeallocateMemory (allocated_memory);
3011 }
3012
Sean Callanan90539452011-09-20 23:01:51 +00003013 return m_can_jit == eCanJITYes;
3014}
3015
3016void
3017Process::SetCanJIT (bool can_jit)
3018{
3019 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
3020}
3021
Ewan Crawford90ff7912015-07-14 10:56:58 +00003022void
3023Process::SetCanRunCode (bool can_run_code)
3024{
3025 SetCanJIT(can_run_code);
3026 m_can_interpret_function_calls = can_run_code;
3027}
3028
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003029Error
3030Process::DeallocateMemory (addr_t ptr)
3031{
Greg Claytond495c532011-05-17 03:37:42 +00003032 Error error;
3033#if defined (USE_ALLOCATE_MEMORY_CACHE)
3034 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
3035 {
Daniel Malead01b2952012-11-29 21:49:15 +00003036 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
Greg Claytond495c532011-05-17 03:37:42 +00003037 }
3038#else
3039 error = DoDeallocateMemory (ptr);
Greg Claytonb2daec92011-01-23 19:58:49 +00003040
Greg Clayton5160ce52013-03-27 23:08:40 +00003041 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00003042 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003043 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 +00003044 ptr,
3045 error.AsCString("SUCCESS"),
Jim Ingham4b536182011-08-09 02:12:22 +00003046 m_mod_id.GetStopID(),
3047 m_mod_id.GetMemoryID());
Greg Claytond495c532011-05-17 03:37:42 +00003048#endif
Greg Claytonb2daec92011-01-23 19:58:49 +00003049 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003050}
3051
Han Ming Ongc811d382012-11-17 00:33:14 +00003052
Greg Claytonc9660542012-02-05 02:38:54 +00003053ModuleSP
Greg Claytonc859e2d2012-02-13 23:10:39 +00003054Process::ReadModuleFromMemory (const FileSpec& file_spec,
Andrew MacPherson17220c12014-03-05 10:12:43 +00003055 lldb::addr_t header_addr,
3056 size_t size_to_read)
Greg Claytonc9660542012-02-05 02:38:54 +00003057{
Jason Molenda08a32582015-07-25 02:39:42 +00003058 Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
3059 if (log)
3060 {
3061 log->Printf ("Process::ReadModuleFromMemory reading %s binary from memory", file_spec.GetPath().c_str());
3062 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00003063 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
Greg Claytonc9660542012-02-05 02:38:54 +00003064 if (module_sp)
3065 {
Greg Claytonc7f09cc2012-02-24 21:55:59 +00003066 Error error;
Andrew MacPherson17220c12014-03-05 10:12:43 +00003067 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read);
Greg Claytonc7f09cc2012-02-24 21:55:59 +00003068 if (objfile)
Greg Claytonc7f09cc2012-02-24 21:55:59 +00003069 return module_sp;
Greg Claytonc9660542012-02-05 02:38:54 +00003070 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00003071 return ModuleSP();
Greg Claytonc9660542012-02-05 02:38:54 +00003072}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003073
Zachary Turner93749ab2015-03-03 21:51:25 +00003074bool
3075Process::GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions)
3076{
3077 MemoryRegionInfo range_info;
3078 permissions = 0;
3079 Error error (GetMemoryRegionInfo (load_addr, range_info));
3080 if (!error.Success())
3081 return false;
3082 if (range_info.GetReadable() == MemoryRegionInfo::eDontKnow
3083 || range_info.GetWritable() == MemoryRegionInfo::eDontKnow
3084 || range_info.GetExecutable() == MemoryRegionInfo::eDontKnow)
3085 {
3086 return false;
3087 }
3088
3089 if (range_info.GetReadable() == MemoryRegionInfo::eYes)
3090 permissions |= lldb::ePermissionsReadable;
3091
3092 if (range_info.GetWritable() == MemoryRegionInfo::eYes)
3093 permissions |= lldb::ePermissionsWritable;
3094
3095 if (range_info.GetExecutable() == MemoryRegionInfo::eYes)
3096 permissions |= lldb::ePermissionsExecutable;
3097
3098 return true;
3099}
3100
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003101Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00003102Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003103{
3104 Error error;
3105 error.SetErrorString("watchpoints are not supported");
3106 return error;
3107}
3108
3109Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00003110Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003111{
3112 Error error;
3113 error.SetErrorString("watchpoints are not supported");
3114 return error;
3115}
3116
3117StateType
3118Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
3119{
3120 StateType state;
3121 // Now wait for the process to launch and return control to us, and then
3122 // call DidLaunch:
3123 while (1)
3124 {
Greg Clayton6779606a2011-01-22 23:43:18 +00003125 event_sp.reset();
3126 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
3127
Greg Clayton2637f822011-11-17 01:23:07 +00003128 if (StateIsStoppedState(state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003129 break;
Greg Clayton6779606a2011-01-22 23:43:18 +00003130
3131 // If state is invalid, then we timed out
3132 if (state == eStateInvalid)
3133 break;
3134
3135 if (event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003136 HandlePrivateEvent (event_sp);
3137 }
3138 return state;
3139}
3140
Greg Clayton332e8b12015-01-13 21:13:08 +00003141void
3142Process::LoadOperatingSystemPlugin(bool flush)
3143{
3144 if (flush)
3145 m_thread_list.Clear();
3146 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
3147 if (flush)
3148 Flush();
3149}
3150
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003151Error
Greg Claytonfbb76342013-11-20 21:07:01 +00003152Process::Launch (ProcessLaunchInfo &launch_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003153{
3154 Error error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003155 m_abi_sp.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003156 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003157 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00003158 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003159 m_os_ap.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003160 m_process_input_reader.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +00003161 m_stop_info_override_callback = NULL;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003162
Zachary Turner7529df92015-09-01 20:02:29 +00003163 Module *exe_module = GetTarget().GetExecutableModulePointer();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003164 if (exe_module)
3165 {
Greg Clayton2289fa42011-04-30 01:09:13 +00003166 char local_exec_file_path[PATH_MAX];
3167 char platform_exec_file_path[PATH_MAX];
3168 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
3169 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003170 if (exe_module->GetFileSpec().Exists())
3171 {
Greg Claytonfbb76342013-11-20 21:07:01 +00003172 // Install anything that might need to be installed prior to launching.
3173 // For host systems, this will do nothing, but if we are connected to a
3174 // remote platform it will install any needed binaries
3175 error = GetTarget().Install(&launch_info);
3176 if (error.Fail())
3177 return error;
3178
Greg Clayton71337622011-02-24 22:24:29 +00003179 if (PrivateStateThreadIsValid ())
3180 PausePrivateStateThread ();
3181
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003182 error = WillLaunch (exe_module);
3183 if (error.Success())
3184 {
Jim Ingham221d51c2013-05-08 00:35:16 +00003185 const bool restarted = false;
3186 SetPublicState (eStateLaunching, restarted);
Greg Claytone24c4ac2011-11-17 04:46:02 +00003187 m_should_detach = false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003188
Ed Maste64fad602013-07-29 20:58:06 +00003189 if (m_public_run_lock.TrySetRunning())
Greg Clayton69fd4be2012-09-04 20:29:05 +00003190 {
3191 // Now launch using these arguments.
3192 error = DoLaunch (exe_module, launch_info);
3193 }
3194 else
3195 {
3196 // This shouldn't happen
3197 error.SetErrorString("failed to acquire process run lock");
3198 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003199
3200 if (error.Fail())
3201 {
3202 if (GetID() != LLDB_INVALID_PROCESS_ID)
3203 {
3204 SetID (LLDB_INVALID_PROCESS_ID);
3205 const char *error_string = error.AsCString();
3206 if (error_string == NULL)
3207 error_string = "launch failed";
3208 SetExitStatus (-1, error_string);
3209 }
3210 }
3211 else
3212 {
3213 EventSP event_sp;
Greg Clayton1a38ea72011-06-22 01:42:17 +00003214 TimeValue timeout_time;
3215 timeout_time = TimeValue::Now();
3216 timeout_time.OffsetWithSeconds(10);
3217 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003218
Greg Clayton1a38ea72011-06-22 01:42:17 +00003219 if (state == eStateInvalid || event_sp.get() == NULL)
3220 {
3221 // We were able to launch the process, but we failed to
3222 // catch the initial stop.
Tamas Berghammer04e63142015-02-23 10:59:54 +00003223 error.SetErrorString ("failed to catch stop after launch");
Greg Clayton1a38ea72011-06-22 01:42:17 +00003224 SetExitStatus (0, "failed to catch stop after launch");
Jason Molendaede31932015-04-17 05:01:58 +00003225 Destroy(false);
Greg Clayton1a38ea72011-06-22 01:42:17 +00003226 }
3227 else if (state == eStateStopped || state == eStateCrashed)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003228 {
Greg Clayton93d3c8332011-02-16 04:46:07 +00003229
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003230 DidLaunch ();
3231
Greg Claytonc859e2d2012-02-13 23:10:39 +00003232 DynamicLoader *dyld = GetDynamicLoader ();
3233 if (dyld)
3234 dyld->DidLaunch();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003235
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003236 GetJITLoaders().DidLaunch();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003237
Jason Molendaeef51062013-11-05 03:57:19 +00003238 SystemRuntime *system_runtime = GetSystemRuntime ();
3239 if (system_runtime)
3240 system_runtime->DidLaunch();
3241
Greg Clayton332e8b12015-01-13 21:13:08 +00003242 LoadOperatingSystemPlugin(false);
Todd Fialaf72fa672014-10-07 16:05:21 +00003243
3244 // Note, the stop event was consumed above, but not handled. This was done
3245 // to give DidLaunch a chance to run. The target is either stopped or crashed.
3246 // Directly set the state. This is done to prevent a stop message with a bunch
3247 // of spurious output on thread status, as well as not pop a ProcessIOHandler.
3248 SetPublicState(state, false);
Greg Clayton71337622011-02-24 22:24:29 +00003249
3250 if (PrivateStateThreadIsValid ())
3251 ResumePrivateStateThread ();
3252 else
3253 StartPrivateStateThread ();
Greg Claytona97c4d22014-12-09 23:31:02 +00003254
3255 m_stop_info_override_callback = GetTarget().GetArchitecture().GetStopInfoOverrideCallback();
Ilia K6af632f2015-02-06 18:15:05 +00003256
3257 // Target was stopped at entry as was intended. Need to notify the listeners
3258 // about it.
Ilia K333fc182015-02-11 11:24:20 +00003259 if (state == eStateStopped && launch_info.GetFlags().Test(eLaunchFlagStopAtEntry))
Ilia K6af632f2015-02-06 18:15:05 +00003260 HandlePrivateEvent(event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003261 }
3262 else if (state == eStateExited)
3263 {
3264 // We exited while trying to launch somehow. Don't call DidLaunch as that's
3265 // not likely to work, and return an invalid pid.
3266 HandlePrivateEvent (event_sp);
3267 }
3268 }
3269 }
3270 }
3271 else
3272 {
Greg Clayton86edbf42011-10-26 00:56:27 +00003273 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003274 }
3275 }
3276 return error;
3277}
3278
Greg Claytonc3776bf2012-02-09 06:16:32 +00003279
3280Error
3281Process::LoadCore ()
3282{
3283 Error error = DoLoadCore();
3284 if (error.Success())
3285 {
Greg Clayton35824e32015-02-20 20:59:47 +00003286 Listener listener ("lldb.process.load_core_listener");
Greg Clayton338d0bd2015-02-20 21:51:06 +00003287 HijackProcessEvents(&listener);
Greg Clayton35824e32015-02-20 20:59:47 +00003288
Greg Claytonc3776bf2012-02-09 06:16:32 +00003289 if (PrivateStateThreadIsValid ())
3290 ResumePrivateStateThread ();
3291 else
3292 StartPrivateStateThread ();
3293
Greg Claytonc859e2d2012-02-13 23:10:39 +00003294 DynamicLoader *dyld = GetDynamicLoader ();
3295 if (dyld)
3296 dyld->DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003297
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003298 GetJITLoaders().DidAttach();
Greg Claytonc859e2d2012-02-13 23:10:39 +00003299
Jason Molendaeef51062013-11-05 03:57:19 +00003300 SystemRuntime *system_runtime = GetSystemRuntime ();
3301 if (system_runtime)
3302 system_runtime->DidAttach();
3303
Greg Claytonc859e2d2012-02-13 23:10:39 +00003304 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Claytonc3776bf2012-02-09 06:16:32 +00003305 // We successfully loaded a core file, now pretend we stopped so we can
3306 // show all of the threads in the core file and explore the crashed
3307 // state.
3308 SetPrivateState (eStateStopped);
Greg Clayton35824e32015-02-20 20:59:47 +00003309
3310 // Wait indefinitely for a stopped event since we just posted one above...
3311 lldb::EventSP event_sp;
3312 listener.WaitForEvent (NULL, event_sp);
3313 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3314
3315 if (!StateIsStoppedState (state, false))
3316 {
3317 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3318 if (log)
3319 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3320 error.SetErrorString ("Did not get stopped event after loading the core file.");
3321 }
Greg Clayton338d0bd2015-02-20 21:51:06 +00003322 RestoreProcessEvents ();
Greg Claytonc3776bf2012-02-09 06:16:32 +00003323 }
3324 return error;
3325}
3326
Greg Claytonc859e2d2012-02-13 23:10:39 +00003327DynamicLoader *
3328Process::GetDynamicLoader ()
3329{
3330 if (m_dyld_ap.get() == NULL)
3331 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
3332 return m_dyld_ap.get();
3333}
Greg Claytonc3776bf2012-02-09 06:16:32 +00003334
Todd Fialaaf245d12014-06-30 21:05:18 +00003335const lldb::DataBufferSP
3336Process::GetAuxvData()
3337{
3338 return DataBufferSP ();
3339}
3340
Andrew MacPherson17220c12014-03-05 10:12:43 +00003341JITLoaderList &
3342Process::GetJITLoaders ()
3343{
3344 if (!m_jit_loaders_ap)
3345 {
3346 m_jit_loaders_ap.reset(new JITLoaderList());
3347 JITLoader::LoadPlugins(this, *m_jit_loaders_ap);
3348 }
3349 return *m_jit_loaders_ap;
3350}
3351
Jason Molendaeef51062013-11-05 03:57:19 +00003352SystemRuntime *
3353Process::GetSystemRuntime ()
3354{
3355 if (m_system_runtime_ap.get() == NULL)
3356 m_system_runtime_ap.reset (SystemRuntime::FindPlugin(this));
3357 return m_system_runtime_ap.get();
3358}
3359
Todd Fiala76e0fc92014-08-27 22:58:26 +00003360Process::AttachCompletionHandler::AttachCompletionHandler (Process *process, uint32_t exec_count) :
3361 NextEventAction (process),
3362 m_exec_count (exec_count)
3363{
3364 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3365 if (log)
3366 log->Printf ("Process::AttachCompletionHandler::%s process=%p, exec_count=%" PRIu32, __FUNCTION__, static_cast<void*>(process), exec_count);
3367}
Greg Claytonc3776bf2012-02-09 06:16:32 +00003368
Jim Inghambb3a2832011-01-29 01:49:25 +00003369Process::NextEventAction::EventActionResult
3370Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003371{
Todd Fiala76e0fc92014-08-27 22:58:26 +00003372 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3373
Jim Inghambb3a2832011-01-29 01:49:25 +00003374 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
Todd Fiala76e0fc92014-08-27 22:58:26 +00003375 if (log)
3376 log->Printf ("Process::AttachCompletionHandler::%s called with state %s (%d)", __FUNCTION__, StateAsCString(state), static_cast<int> (state));
3377
3378 switch (state)
Greg Clayton19388cf2010-10-18 01:45:30 +00003379 {
Zachary Turnerc62733b2015-05-20 18:31:17 +00003380 case eStateAttaching:
3381 return eEventActionSuccess;
3382
Greg Clayton513c26c2011-01-29 07:10:55 +00003383 case eStateRunning:
Greg Clayton71337622011-02-24 22:24:29 +00003384 case eStateConnected:
Greg Clayton513c26c2011-01-29 07:10:55 +00003385 return eEventActionRetry;
3386
3387 case eStateStopped:
3388 case eStateCrashed:
Greg Claytonc9ed4782011-11-12 02:10:56 +00003389 {
3390 // During attach, prior to sending the eStateStopped event,
Jim Inghamb1e2e842012-04-12 18:49:31 +00003391 // lldb_private::Process subclasses must set the new process ID.
Greg Claytonc9ed4782011-11-12 02:10:56 +00003392 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
Jim Ingham221d51c2013-05-08 00:35:16 +00003393 // We don't want these events to be reported, so go set the ShouldReportStop here:
3394 m_process->GetThreadList().SetShouldReportStop (eVoteNo);
3395
Greg Claytonc9ed4782011-11-12 02:10:56 +00003396 if (m_exec_count > 0)
3397 {
3398 --m_exec_count;
Todd Fiala76e0fc92014-08-27 22:58:26 +00003399
3400 if (log)
3401 log->Printf ("Process::AttachCompletionHandler::%s state %s: reduced remaining exec count to %" PRIu32 ", requesting resume", __FUNCTION__, StateAsCString(state), m_exec_count);
3402
Jim Ingham221d51c2013-05-08 00:35:16 +00003403 RequestResume();
Greg Claytonc9ed4782011-11-12 02:10:56 +00003404 return eEventActionRetry;
3405 }
3406 else
3407 {
Todd Fiala76e0fc92014-08-27 22:58:26 +00003408 if (log)
3409 log->Printf ("Process::AttachCompletionHandler::%s state %s: no more execs expected to start, continuing with attach", __FUNCTION__, StateAsCString(state));
3410
Greg Claytonc9ed4782011-11-12 02:10:56 +00003411 m_process->CompleteAttach ();
3412 return eEventActionSuccess;
3413 }
3414 }
Greg Clayton513c26c2011-01-29 07:10:55 +00003415 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00003416
Greg Clayton513c26c2011-01-29 07:10:55 +00003417 default:
3418 case eStateExited:
3419 case eStateInvalid:
Greg Clayton513c26c2011-01-29 07:10:55 +00003420 break;
Jim Inghambb3a2832011-01-29 01:49:25 +00003421 }
Greg Claytonc9ed4782011-11-12 02:10:56 +00003422
3423 m_exit_string.assign ("No valid Process");
3424 return eEventActionExit;
Jim Inghambb3a2832011-01-29 01:49:25 +00003425}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003426
Jim Inghambb3a2832011-01-29 01:49:25 +00003427Process::NextEventAction::EventActionResult
3428Process::AttachCompletionHandler::HandleBeingInterrupted()
3429{
3430 return eEventActionSuccess;
3431}
3432
3433const char *
3434Process::AttachCompletionHandler::GetExitString ()
3435{
3436 return m_exit_string.c_str();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003437}
3438
Greg Clayton8012cad2014-11-17 19:39:20 +00003439Listener &
3440ProcessAttachInfo::GetListenerForProcess (Debugger &debugger)
3441{
3442 if (m_listener_sp)
3443 return *m_listener_sp;
3444 else
3445 return debugger.GetListener();
3446}
3447
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003448Error
Greg Clayton144f3a92011-11-15 03:53:30 +00003449Process::Attach (ProcessAttachInfo &attach_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003450{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003451 m_abi_sp.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003452 m_process_input_reader.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003453 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003454 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00003455 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003456 m_os_ap.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +00003457 m_stop_info_override_callback = NULL;
Jim Ingham5aee1622010-08-09 23:31:02 +00003458
Greg Clayton144f3a92011-11-15 03:53:30 +00003459 lldb::pid_t attach_pid = attach_info.GetProcessID();
Greg Claytone996fd32011-03-08 22:40:15 +00003460 Error error;
Greg Clayton144f3a92011-11-15 03:53:30 +00003461 if (attach_pid == LLDB_INVALID_PROCESS_ID)
Jim Ingham5aee1622010-08-09 23:31:02 +00003462 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003463 char process_name[PATH_MAX];
Jim Ingham4299fdb2011-09-15 01:10:17 +00003464
Greg Clayton144f3a92011-11-15 03:53:30 +00003465 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
Jim Ingham2ecb7422010-08-17 21:54:19 +00003466 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003467 const bool wait_for_launch = attach_info.GetWaitForLaunch();
3468
3469 if (wait_for_launch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003470 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003471 error = WillAttachToProcessWithName(process_name, wait_for_launch);
3472 if (error.Success())
3473 {
Ed Maste64fad602013-07-29 20:58:06 +00003474 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00003475 {
3476 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00003477 const bool restarted = false;
3478 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00003479 // Now attach using these arguments.
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00003480 error = DoAttachToProcessWithName (process_name, attach_info);
Greg Clayton926cce72012-10-12 16:10:12 +00003481 }
3482 else
3483 {
3484 // This shouldn't happen
3485 error.SetErrorString("failed to acquire process run lock");
3486 }
Greg Claytone24c4ac2011-11-17 04:46:02 +00003487
Greg Clayton144f3a92011-11-15 03:53:30 +00003488 if (error.Fail())
3489 {
3490 if (GetID() != LLDB_INVALID_PROCESS_ID)
3491 {
3492 SetID (LLDB_INVALID_PROCESS_ID);
3493 if (error.AsCString() == NULL)
3494 error.SetErrorString("attach failed");
3495
3496 SetExitStatus(-1, error.AsCString());
3497 }
3498 }
3499 else
3500 {
3501 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3502 StartPrivateStateThread();
3503 }
3504 return error;
3505 }
Greg Claytone996fd32011-03-08 22:40:15 +00003506 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003507 else
Greg Claytone996fd32011-03-08 22:40:15 +00003508 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003509 ProcessInstanceInfoList process_infos;
Zachary Turner7529df92015-09-01 20:02:29 +00003510 PlatformSP platform_sp (GetTarget().GetPlatform ());
Greg Clayton144f3a92011-11-15 03:53:30 +00003511
3512 if (platform_sp)
3513 {
3514 ProcessInstanceInfoMatch match_info;
3515 match_info.GetProcessInfo() = attach_info;
3516 match_info.SetNameMatchType (eNameMatchEquals);
3517 platform_sp->FindProcesses (match_info, process_infos);
3518 const uint32_t num_matches = process_infos.GetSize();
3519 if (num_matches == 1)
3520 {
3521 attach_pid = process_infos.GetProcessIDAtIndex(0);
3522 // Fall through and attach using the above process ID
3523 }
3524 else
3525 {
3526 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
3527 if (num_matches > 1)
Jim Ingham368ac222014-08-15 17:05:27 +00003528 {
3529 StreamString s;
3530 ProcessInstanceInfo::DumpTableHeader (s, platform_sp.get(), true, false);
3531 for (size_t i = 0; i < num_matches; i++)
3532 {
3533 process_infos.GetProcessInfoAtIndex(i).DumpAsTableRow(s, platform_sp.get(), true, false);
3534 }
3535 error.SetErrorStringWithFormat ("more than one process named %s:\n%s",
3536 process_name,
3537 s.GetData());
3538 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003539 else
3540 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
3541 }
3542 }
3543 else
3544 {
3545 error.SetErrorString ("invalid platform, can't find processes by name");
3546 return error;
3547 }
Greg Claytone996fd32011-03-08 22:40:15 +00003548 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003549 }
3550 else
Greg Clayton144f3a92011-11-15 03:53:30 +00003551 {
3552 error.SetErrorString ("invalid process name");
Greg Claytone996fd32011-03-08 22:40:15 +00003553 }
3554 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003555
3556 if (attach_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00003557 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003558 error = WillAttachToProcessWithID(attach_pid);
Greg Claytone996fd32011-03-08 22:40:15 +00003559 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003560 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003561
Ed Maste64fad602013-07-29 20:58:06 +00003562 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00003563 {
3564 // Now attach using these arguments.
3565 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00003566 const bool restarted = false;
3567 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00003568 error = DoAttachToProcessWithID (attach_pid, attach_info);
3569 }
3570 else
3571 {
3572 // This shouldn't happen
3573 error.SetErrorString("failed to acquire process run lock");
3574 }
3575
Greg Clayton144f3a92011-11-15 03:53:30 +00003576 if (error.Success())
3577 {
3578
3579 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3580 StartPrivateStateThread();
3581 }
3582 else
Greg Claytone996fd32011-03-08 22:40:15 +00003583 {
3584 if (GetID() != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00003585 SetID (LLDB_INVALID_PROCESS_ID);
Greg Claytone996fd32011-03-08 22:40:15 +00003586
Oleksiy Vyalov5d064742014-11-19 18:27:45 +00003587 const char *error_string = error.AsCString();
3588 if (error_string == NULL)
3589 error_string = "attach failed";
3590
3591 SetExitStatus(-1, error_string);
Greg Claytone996fd32011-03-08 22:40:15 +00003592 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003593 }
3594 }
3595 return error;
3596}
3597
Greg Clayton93d3c8332011-02-16 04:46:07 +00003598void
3599Process::CompleteAttach ()
3600{
Todd Fiala76e0fc92014-08-27 22:58:26 +00003601 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3602 if (log)
3603 log->Printf ("Process::%s()", __FUNCTION__);
3604
Greg Clayton93d3c8332011-02-16 04:46:07 +00003605 // Let the process subclass figure out at much as it can about the process
3606 // before we go looking for a dynamic loader plug-in.
Jim Inghambb006ce2014-08-02 00:33:35 +00003607 ArchSpec process_arch;
3608 DidAttach(process_arch);
3609
3610 if (process_arch.IsValid())
Todd Fiala76e0fc92014-08-27 22:58:26 +00003611 {
Zachary Turner7529df92015-09-01 20:02:29 +00003612 GetTarget().SetArchitecture(process_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003613 if (log)
3614 {
3615 const char *triple_str = process_arch.GetTriple().getTriple().c_str ();
3616 log->Printf ("Process::%s replacing process architecture with DidAttach() architecture: %s",
3617 __FUNCTION__,
3618 triple_str ? triple_str : "<null>");
3619 }
3620 }
Greg Clayton93d3c8332011-02-16 04:46:07 +00003621
Jim Ingham4299fdb2011-09-15 01:10:17 +00003622 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
3623 // the same as the one we've already set, switch architectures.
Zachary Turner7529df92015-09-01 20:02:29 +00003624 PlatformSP platform_sp (GetTarget().GetPlatform ());
Jim Ingham4299fdb2011-09-15 01:10:17 +00003625 assert (platform_sp.get());
3626 if (platform_sp)
3627 {
Zachary Turner7529df92015-09-01 20:02:29 +00003628 const ArchSpec &target_arch = GetTarget().GetArchitecture();
Greg Clayton1e0c8842013-01-11 20:49:54 +00003629 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
Greg Clayton70512312012-05-08 01:45:38 +00003630 {
3631 ArchSpec platform_arch;
3632 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3633 if (platform_sp)
3634 {
Zachary Turner7529df92015-09-01 20:02:29 +00003635 GetTarget().SetPlatform (platform_sp);
3636 GetTarget().SetArchitecture(platform_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003637 if (log)
3638 log->Printf ("Process::%s switching platform to %s and architecture to %s based on info from attach", __FUNCTION__, platform_sp->GetName().AsCString (""), platform_arch.GetTriple().getTriple().c_str ());
Greg Clayton70512312012-05-08 01:45:38 +00003639 }
3640 }
Jim Inghambb006ce2014-08-02 00:33:35 +00003641 else if (!process_arch.IsValid())
Greg Clayton70512312012-05-08 01:45:38 +00003642 {
3643 ProcessInstanceInfo process_info;
3644 platform_sp->GetProcessInfo (GetID(), process_info);
3645 const ArchSpec &process_arch = process_info.GetArchitecture();
Zachary Turner7529df92015-09-01 20:02:29 +00003646 if (process_arch.IsValid() && !GetTarget().GetArchitecture().IsExactMatch(process_arch))
Todd Fiala76e0fc92014-08-27 22:58:26 +00003647 {
Zachary Turner7529df92015-09-01 20:02:29 +00003648 GetTarget().SetArchitecture (process_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003649 if (log)
3650 log->Printf ("Process::%s switching architecture to %s based on info the platform retrieved for pid %" PRIu64, __FUNCTION__, process_arch.GetTriple().getTriple().c_str (), GetID ());
3651 }
Greg Clayton70512312012-05-08 01:45:38 +00003652 }
Jim Ingham4299fdb2011-09-15 01:10:17 +00003653 }
3654
3655 // We have completed the attach, now it is time to find the dynamic loader
Greg Clayton93d3c8332011-02-16 04:46:07 +00003656 // plug-in
Greg Claytonc859e2d2012-02-13 23:10:39 +00003657 DynamicLoader *dyld = GetDynamicLoader ();
3658 if (dyld)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003659 {
Greg Claytonc859e2d2012-02-13 23:10:39 +00003660 dyld->DidAttach();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003661 if (log)
3662 {
Zachary Turner7529df92015-09-01 20:02:29 +00003663 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003664 log->Printf ("Process::%s after DynamicLoader::DidAttach(), target executable is %s (using %s plugin)",
3665 __FUNCTION__,
3666 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3667 dyld->GetPluginName().AsCString ("<unnamed>"));
3668 }
3669 }
Greg Clayton93d3c8332011-02-16 04:46:07 +00003670
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003671 GetJITLoaders().DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003672
Jason Molendaeef51062013-11-05 03:57:19 +00003673 SystemRuntime *system_runtime = GetSystemRuntime ();
3674 if (system_runtime)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003675 {
Jason Molendaeef51062013-11-05 03:57:19 +00003676 system_runtime->DidAttach();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003677 if (log)
3678 {
Zachary Turner7529df92015-09-01 20:02:29 +00003679 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003680 log->Printf ("Process::%s after SystemRuntime::DidAttach(), target executable is %s (using %s plugin)",
3681 __FUNCTION__,
3682 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3683 system_runtime->GetPluginName().AsCString("<unnamed>"));
3684 }
3685 }
Jason Molendaeef51062013-11-05 03:57:19 +00003686
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003687 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton93d3c8332011-02-16 04:46:07 +00003688 // Figure out which one is the executable, and set that in our target:
Zachary Turner7529df92015-09-01 20:02:29 +00003689 const ModuleList &target_modules = GetTarget().GetImages();
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003690 Mutex::Locker modules_locker(target_modules.GetMutex());
3691 size_t num_modules = target_modules.GetSize();
3692 ModuleSP new_executable_module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003693
Andy Gibbsa297a972013-06-19 19:04:53 +00003694 for (size_t i = 0; i < num_modules; i++)
Greg Clayton93d3c8332011-02-16 04:46:07 +00003695 {
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003696 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
Greg Clayton8b82f082011-04-12 05:54:46 +00003697 if (module_sp && module_sp->IsExecutable())
Greg Clayton93d3c8332011-02-16 04:46:07 +00003698 {
Zachary Turner7529df92015-09-01 20:02:29 +00003699 if (GetTarget().GetExecutableModulePointer() != module_sp.get())
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003700 new_executable_module_sp = module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003701 break;
3702 }
3703 }
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003704 if (new_executable_module_sp)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003705 {
Zachary Turner7529df92015-09-01 20:02:29 +00003706 GetTarget().SetExecutableModule (new_executable_module_sp, false);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003707 if (log)
3708 {
Zachary Turner7529df92015-09-01 20:02:29 +00003709 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003710 log->Printf ("Process::%s after looping through modules, target executable is %s",
3711 __FUNCTION__,
3712 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>");
3713 }
3714 }
Greg Claytona97c4d22014-12-09 23:31:02 +00003715
3716 m_stop_info_override_callback = process_arch.GetStopInfoOverrideCallback();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003717}
3718
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003719Error
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003720Process::ConnectRemote (Stream *strm, const char *remote_url)
Greg Claytonb766a732011-02-04 01:58:07 +00003721{
Greg Claytonb766a732011-02-04 01:58:07 +00003722 m_abi_sp.reset();
3723 m_process_input_reader.reset();
3724
3725 // Find the process and its architecture. Make sure it matches the architecture
3726 // of the current Target, and if not adjust it.
3727
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003728 Error error (DoConnectRemote (strm, remote_url));
Greg Claytonb766a732011-02-04 01:58:07 +00003729 if (error.Success())
3730 {
Greg Clayton71337622011-02-24 22:24:29 +00003731 if (GetID() != LLDB_INVALID_PROCESS_ID)
3732 {
Greg Clayton32e0a752011-03-30 18:16:51 +00003733 EventSP event_sp;
3734 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3735
3736 if (state == eStateStopped || state == eStateCrashed)
3737 {
3738 // If we attached and actually have a process on the other end, then
3739 // this ended up being the equivalent of an attach.
3740 CompleteAttach ();
3741
3742 // This delays passing the stopped event to listeners till
3743 // CompleteAttach gets a chance to complete...
3744 HandlePrivateEvent (event_sp);
3745
3746 }
Greg Clayton71337622011-02-24 22:24:29 +00003747 }
Greg Clayton32e0a752011-03-30 18:16:51 +00003748
3749 if (PrivateStateThreadIsValid ())
3750 ResumePrivateStateThread ();
3751 else
3752 StartPrivateStateThread ();
Greg Claytonb766a732011-02-04 01:58:07 +00003753 }
3754 return error;
3755}
3756
3757
3758Error
Jim Ingham3b8285d2012-04-19 01:40:33 +00003759Process::PrivateResume ()
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003760{
Greg Clayton5160ce52013-03-27 23:08:40 +00003761 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003762 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003763 log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s",
Jim Ingham4b536182011-08-09 02:12:22 +00003764 m_mod_id.GetStopID(),
Jim Ingham444586b2011-01-24 06:34:17 +00003765 StateAsCString(m_public_state.GetValue()),
3766 StateAsCString(m_private_state.GetValue()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003767
3768 Error error (WillResume());
3769 // Tell the process it is about to resume before the thread list
3770 if (error.Success())
3771 {
Johnny Chenc4221e42010-12-02 20:53:05 +00003772 // Now let the thread list know we are about to resume so it
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003773 // can let all of our threads know that they are about to be
3774 // resumed. Threads will each be called with
3775 // Thread::WillResume(StateType) where StateType contains the state
3776 // that they are supposed to have when the process is resumed
3777 // (suspended/running/stepping). Threads should also check
3778 // their resume signal in lldb::Thread::GetResumeSignal()
Jim Ingham221d51c2013-05-08 00:35:16 +00003779 // to see if they are supposed to start back up with a signal.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003780 if (m_thread_list.WillResume())
3781 {
Jim Ingham372787f2012-04-07 00:00:41 +00003782 // Last thing, do the PreResumeActions.
3783 if (!RunPreResumeActions())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003784 {
Jim Ingham0161b492013-02-09 01:29:05 +00003785 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming.");
Jim Ingham372787f2012-04-07 00:00:41 +00003786 }
3787 else
3788 {
3789 m_mod_id.BumpResumeID();
3790 error = DoResume();
3791 if (error.Success())
3792 {
3793 DidResume();
3794 m_thread_list.DidResume();
3795 if (log)
3796 log->Printf ("Process thinks the process has resumed.");
3797 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003798 }
3799 }
3800 else
3801 {
Jim Inghamd5ac1ab2015-01-19 23:51:51 +00003802 // Somebody wanted to run without running (e.g. we were faking a step from one frame of a set of inlined
3803 // frames that share the same PC to another.) So generate a continue & a stopped event,
Jim Ingham513c6bb2012-09-01 01:02:41 +00003804 // and let the world handle them.
3805 if (log)
3806 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3807
3808 SetPrivateState(eStateRunning);
3809 SetPrivateState(eStateStopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003810 }
3811 }
Jim Ingham444586b2011-01-24 06:34:17 +00003812 else if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003813 log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003814 return error;
3815}
3816
3817Error
Greg Claytonf9b57b92013-05-10 23:48:10 +00003818Process::Halt (bool clear_thread_plans)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003819{
Greg Claytonf9b57b92013-05-10 23:48:10 +00003820 // Don't clear the m_clear_thread_plans_on_stop, only set it to true if
3821 // in case it was already set and some thread plan logic calls halt on its
3822 // own.
3823 m_clear_thread_plans_on_stop |= clear_thread_plans;
3824
Jim Inghamaacc3182012-06-06 00:29:30 +00003825 // First make sure we aren't in the middle of handling an event, or we might restart. This is pretty weak, since
3826 // we could just straightaway get another event. It just narrows the window...
3827 m_currently_handling_event.WaitForValueEqualTo(false);
3828
3829
Jim Inghambb3a2832011-01-29 01:49:25 +00003830 // Pause our private state thread so we can ensure no one else eats
3831 // the stop event out from under us.
Jim Ingham0f16e732011-02-08 05:20:59 +00003832 Listener halt_listener ("lldb.process.halt_listener");
3833 HijackPrivateProcessEvents(&halt_listener);
Greg Clayton3af9ea52010-11-18 05:57:03 +00003834
Jim Inghambb3a2832011-01-29 01:49:25 +00003835 EventSP event_sp;
Greg Clayton513c26c2011-01-29 07:10:55 +00003836 Error error (WillHalt());
Jim Inghambb3a2832011-01-29 01:49:25 +00003837
Greg Clayton06357c92014-07-30 17:38:47 +00003838 bool restored_process_events = false;
Greg Clayton513c26c2011-01-29 07:10:55 +00003839 if (error.Success())
Jim Inghambb3a2832011-01-29 01:49:25 +00003840 {
Jim Inghambb3a2832011-01-29 01:49:25 +00003841
Greg Clayton513c26c2011-01-29 07:10:55 +00003842 bool caused_stop = false;
3843
3844 // Ask the process subclass to actually halt our process
3845 error = DoHalt(caused_stop);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003846 if (error.Success())
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003847 {
Greg Clayton513c26c2011-01-29 07:10:55 +00003848 if (m_public_state.GetValue() == eStateAttaching)
3849 {
Greg Clayton06357c92014-07-30 17:38:47 +00003850 // Don't hijack and eat the eStateExited as the code that was doing
3851 // the attach will be waiting for this event...
3852 RestorePrivateProcessEvents();
3853 restored_process_events = true;
Greg Clayton513c26c2011-01-29 07:10:55 +00003854 SetExitStatus(SIGKILL, "Cancelled async attach.");
Jason Molendaede31932015-04-17 05:01:58 +00003855 Destroy (false);
Greg Clayton513c26c2011-01-29 07:10:55 +00003856 }
3857 else
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003858 {
Jim Inghambb3a2832011-01-29 01:49:25 +00003859 // If "caused_stop" is true, then DoHalt stopped the process. If
3860 // "caused_stop" is false, the process was already stopped.
3861 // If the DoHalt caused the process to stop, then we want to catch
3862 // this event and set the interrupted bool to true before we pass
3863 // this along so clients know that the process was interrupted by
3864 // a halt command.
3865 if (caused_stop)
Greg Clayton3af9ea52010-11-18 05:57:03 +00003866 {
Jim Ingham0f16e732011-02-08 05:20:59 +00003867 // Wait for 1 second for the process to stop.
Jim Inghambb3a2832011-01-29 01:49:25 +00003868 TimeValue timeout_time;
3869 timeout_time = TimeValue::Now();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003870 timeout_time.OffsetWithSeconds(10);
Jim Ingham0f16e732011-02-08 05:20:59 +00003871 bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3872 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghambb3a2832011-01-29 01:49:25 +00003873
Jim Ingham0f16e732011-02-08 05:20:59 +00003874 if (!got_event || state == eStateInvalid)
Greg Clayton3af9ea52010-11-18 05:57:03 +00003875 {
Jim Inghambb3a2832011-01-29 01:49:25 +00003876 // We timeout out and didn't get a stop event...
Jim Ingham0f16e732011-02-08 05:20:59 +00003877 error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
Greg Clayton3af9ea52010-11-18 05:57:03 +00003878 }
3879 else
3880 {
Greg Clayton2637f822011-11-17 01:23:07 +00003881 if (StateIsStoppedState (state, false))
Jim Inghambb3a2832011-01-29 01:49:25 +00003882 {
3883 // We caused the process to interrupt itself, so mark this
3884 // as such in the stop event so clients can tell an interrupted
3885 // process from a natural stop
3886 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3887 }
3888 else
3889 {
Greg Clayton5160ce52013-03-27 23:08:40 +00003890 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Inghambb3a2832011-01-29 01:49:25 +00003891 if (log)
3892 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3893 error.SetErrorString ("Did not get stopped event after halt.");
3894 }
Greg Clayton3af9ea52010-11-18 05:57:03 +00003895 }
3896 }
Jim Inghambb3a2832011-01-29 01:49:25 +00003897 DidHalt();
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003898 }
3899 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003900 }
Jim Inghambb3a2832011-01-29 01:49:25 +00003901 // Resume our private state thread before we post the event (if any)
Greg Clayton06357c92014-07-30 17:38:47 +00003902 if (!restored_process_events)
3903 RestorePrivateProcessEvents();
Jim Inghambb3a2832011-01-29 01:49:25 +00003904
3905 // Post any event we might have consumed. If all goes well, we will have
3906 // stopped the process, intercepted the event and set the interrupted
3907 // bool in the event. Post it to the private event queue and that will end up
3908 // correctly setting the state.
3909 if (event_sp)
3910 m_private_state_broadcaster.BroadcastEvent(event_sp);
3911
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003912 return error;
3913}
3914
3915Error
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003916Process::HaltForDestroyOrDetach(lldb::EventSP &exit_event_sp)
3917{
3918 Error error;
3919 if (m_public_state.GetValue() == eStateRunning)
3920 {
3921 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3922 if (log)
Pavel Labathea3fb8e2015-09-03 15:44:14 +00003923 log->Printf("Process::%s() About to halt.", __FUNCTION__);
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003924 error = Halt();
3925 if (error.Success())
3926 {
3927 // Consume the halt event.
3928 TimeValue timeout (TimeValue::Now());
3929 timeout.OffsetWithSeconds(1);
3930 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp);
3931
3932 // If the process exited while we were waiting for it to stop, put the exited event into
3933 // the shared pointer passed in and return. Our caller doesn't need to do anything else, since
3934 // they don't have a process anymore...
3935
3936 if (state == eStateExited || m_private_state.GetValue() == eStateExited)
3937 {
3938 if (log)
3939 log->Printf("Process::HaltForDestroyOrDetach() Process exited while waiting to Halt.");
3940 return error;
3941 }
3942 else
3943 exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3944
3945 if (state != eStateStopped)
3946 {
3947 if (log)
3948 log->Printf("Process::HaltForDestroyOrDetach() Halt failed to stop, state is: %s", StateAsCString(state));
3949 // If we really couldn't stop the process then we should just error out here, but if the
3950 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3951 StateType private_state = m_private_state.GetValue();
3952 if (private_state != eStateStopped)
3953 {
3954 return error;
3955 }
3956 }
3957 }
3958 else
3959 {
3960 if (log)
3961 log->Printf("Process::HaltForDestroyOrDetach() Halt got error: %s", error.AsCString());
3962 }
3963 }
3964 return error;
3965}
3966
3967Error
Jim Inghamacff8952013-05-02 00:27:30 +00003968Process::Detach (bool keep_stopped)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003969{
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003970 EventSP exit_event_sp;
3971 Error error;
3972 m_destroy_in_process = true;
3973
3974 error = WillDetach();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003975
3976 if (error.Success())
3977 {
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003978 if (DetachRequiresHalt())
3979 {
3980 error = HaltForDestroyOrDetach (exit_event_sp);
3981 if (!error.Success())
3982 {
3983 m_destroy_in_process = false;
3984 return error;
3985 }
3986 else if (exit_event_sp)
3987 {
3988 // We shouldn't need to do anything else here. There's no process left to detach from...
3989 StopPrivateStateThread();
3990 m_destroy_in_process = false;
3991 return error;
3992 }
3993 }
3994
Andrew MacPhersonc3826b52014-03-25 19:59:36 +00003995 m_thread_list.DiscardThreadPlans();
3996 DisableAllBreakpointSites();
3997
Jim Inghamacff8952013-05-02 00:27:30 +00003998 error = DoDetach(keep_stopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003999 if (error.Success())
4000 {
4001 DidDetach();
4002 StopPrivateStateThread();
4003 }
Jim Inghamacff8952013-05-02 00:27:30 +00004004 else
4005 {
4006 return error;
4007 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004008 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00004009 m_destroy_in_process = false;
4010
4011 // If we exited when we were waiting for a process to stop, then
4012 // forward the event here so we don't lose the event
4013 if (exit_event_sp)
4014 {
4015 // Directly broadcast our exited event because we shut down our
4016 // private state thread above
4017 BroadcastEvent(exit_event_sp);
4018 }
4019
4020 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
4021 // the last events through the event system, in which case we might strand the write lock. Unlock
4022 // it here so when we do to tear down the process we don't get an error destroying the lock.
4023
Ed Maste64fad602013-07-29 20:58:06 +00004024 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004025 return error;
4026}
4027
4028Error
Jason Molendaede31932015-04-17 05:01:58 +00004029Process::Destroy (bool force_kill)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004030{
Jim Ingham09437922013-03-01 20:04:25 +00004031
4032 // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work
4033 // that might hinder the destruction. Remember to set this back to false when we are done. That way if the attempt
4034 // failed and the process stays around for some reason it won't be in a confused state.
Jason Molendaede31932015-04-17 05:01:58 +00004035
4036 if (force_kill)
4037 m_should_detach = false;
Jim Ingham09437922013-03-01 20:04:25 +00004038
Ilia Kfcc89a02015-03-26 07:08:47 +00004039 if (GetShouldDetach())
4040 {
4041 // FIXME: This will have to be a process setting:
4042 bool keep_stopped = false;
4043 Detach(keep_stopped);
4044 }
4045
Jim Ingham09437922013-03-01 20:04:25 +00004046 m_destroy_in_process = true;
4047
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004048 Error error (WillDestroy());
4049 if (error.Success())
4050 {
Greg Clayton85fb1b92012-09-11 02:33:37 +00004051 EventSP exit_event_sp;
Jim Ingham8af3b9c2013-03-29 01:18:12 +00004052 if (DestroyRequiresHalt())
Jim Ingham04e0a222012-05-23 15:46:31 +00004053 {
Jim Ingham8af3b9c2013-03-29 01:18:12 +00004054 error = HaltForDestroyOrDetach(exit_event_sp);
Jim Ingham04e0a222012-05-23 15:46:31 +00004055 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00004056
Jim Inghamaacc3182012-06-06 00:29:30 +00004057 if (m_public_state.GetValue() != eStateRunning)
4058 {
4059 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
4060 // kill it, we don't want it hitting a breakpoint...
4061 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
4062 // we're not going to have much luck doing this now.
4063 m_thread_list.DiscardThreadPlans();
4064 DisableAllBreakpointSites();
4065 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00004066
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004067 error = DoDestroy();
4068 if (error.Success())
4069 {
4070 DidDestroy();
4071 StopPrivateStateThread();
4072 }
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004073 m_stdio_communication.Disconnect();
Greg Clayton23d54f42015-06-03 00:34:01 +00004074 m_stdio_communication.StopReadThread();
Vince Harrondf3f00f2015-02-10 21:09:04 +00004075 m_stdin_forward = false;
Greg Claytonb4874f12014-02-28 18:22:24 +00004076
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004077 if (m_process_input_reader)
Greg Claytonb4874f12014-02-28 18:22:24 +00004078 {
4079 m_process_input_reader->SetIsDone(true);
4080 m_process_input_reader->Cancel();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004081 m_process_input_reader.reset();
Greg Claytonb4874f12014-02-28 18:22:24 +00004082 }
4083
Greg Clayton85fb1b92012-09-11 02:33:37 +00004084 // If we exited when we were waiting for a process to stop, then
4085 // forward the event here so we don't lose the event
4086 if (exit_event_sp)
4087 {
4088 // Directly broadcast our exited event because we shut down our
4089 // private state thread above
4090 BroadcastEvent(exit_event_sp);
4091 }
4092
Jim Inghamb1e2e842012-04-12 18:49:31 +00004093 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
4094 // the last events through the event system, in which case we might strand the write lock. Unlock
4095 // 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 +00004096 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004097 }
Jim Ingham09437922013-03-01 20:04:25 +00004098
4099 m_destroy_in_process = false;
4100
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004101 return error;
4102}
4103
4104Error
4105Process::Signal (int signal)
4106{
4107 Error error (WillSignal());
4108 if (error.Success())
4109 {
4110 error = DoSignal(signal);
4111 if (error.Success())
4112 DidSignal();
4113 }
4114 return error;
4115}
4116
Zachary Turner93749ab2015-03-03 21:51:25 +00004117void
Chaoren Linc963a222015-09-01 16:58:45 +00004118Process::SetUnixSignals(UnixSignalsSP &&signals_sp)
Zachary Turner93749ab2015-03-03 21:51:25 +00004119{
4120 assert (signals_sp && "null signals_sp");
4121 m_unix_signals_sp = signals_sp;
4122}
4123
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00004124const lldb::UnixSignalsSP &
Zachary Turner93749ab2015-03-03 21:51:25 +00004125Process::GetUnixSignals ()
4126{
4127 assert (m_unix_signals_sp && "null m_unix_signals_sp");
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00004128 return m_unix_signals_sp;
Zachary Turner93749ab2015-03-03 21:51:25 +00004129}
4130
Greg Clayton514487e2011-02-15 21:59:32 +00004131lldb::ByteOrder
4132Process::GetByteOrder () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004133{
Zachary Turner7529df92015-09-01 20:02:29 +00004134 return GetTarget().GetArchitecture().GetByteOrder();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004135}
4136
4137uint32_t
Greg Clayton514487e2011-02-15 21:59:32 +00004138Process::GetAddressByteSize () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004139{
Zachary Turner7529df92015-09-01 20:02:29 +00004140 return GetTarget().GetArchitecture().GetAddressByteSize();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004141}
4142
Greg Clayton514487e2011-02-15 21:59:32 +00004143
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004144bool
4145Process::ShouldBroadcastEvent (Event *event_ptr)
4146{
4147 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
4148 bool return_value = true;
Greg Clayton5160ce52013-03-27 23:08:40 +00004149 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS));
Jim Ingham0161b492013-02-09 01:29:05 +00004150
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004151 switch (state)
4152 {
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004153 case eStateDetached:
4154 case eStateExited:
4155 case eStateUnloaded:
Pavel Labath3f5df532015-03-12 10:12:41 +00004156 m_stdio_communication.SynchronizeWithReadThread();
Pavel Labatha9a43372015-09-03 09:30:17 +00004157 m_stdio_communication.Disconnect();
4158 m_stdio_communication.StopReadThread();
4159 m_stdin_forward = false;
4160
Pavel Labath3f5df532015-03-12 10:12:41 +00004161 // fall-through
4162 case eStateConnected:
4163 case eStateAttaching:
4164 case eStateLaunching:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004165 // These events indicate changes in the state of the debugging session, always report them.
4166 return_value = true;
4167 break;
4168 case eStateInvalid:
4169 // We stopped for no apparent reason, don't report it.
4170 return_value = false;
4171 break;
4172 case eStateRunning:
4173 case eStateStepping:
4174 // If we've started the target running, we handle the cases where we
4175 // are already running and where there is a transition from stopped to
4176 // running differently.
4177 // running -> running: Automatically suppress extra running events
4178 // stopped -> running: Report except when there is one or more no votes
4179 // and no yes votes.
4180 SynchronouslyNotifyStateChanged (state);
Jim Ingham1460e4b2014-01-10 23:46:59 +00004181 if (m_force_next_event_delivery)
4182 return_value = true;
4183 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004184 {
Jim Ingham1460e4b2014-01-10 23:46:59 +00004185 switch (m_last_broadcast_state)
4186 {
4187 case eStateRunning:
4188 case eStateStepping:
4189 // We always suppress multiple runnings with no PUBLIC stop in between.
4190 return_value = false;
4191 break;
4192 default:
4193 // TODO: make this work correctly. For now always report
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004194 // run if we aren't running so we don't miss any running
Jim Ingham1460e4b2014-01-10 23:46:59 +00004195 // events. If I run the lldb/test/thread/a.out file and
4196 // break at main.cpp:58, run and hit the breakpoints on
4197 // multiple threads, then somehow during the stepping over
4198 // of all breakpoints no run gets reported.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004199
Jim Ingham1460e4b2014-01-10 23:46:59 +00004200 // This is a transition from stop to run.
4201 switch (m_thread_list.ShouldReportRun (event_ptr))
4202 {
4203 case eVoteYes:
4204 case eVoteNoOpinion:
4205 return_value = true;
4206 break;
4207 case eVoteNo:
4208 return_value = false;
4209 break;
4210 }
4211 break;
4212 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004213 }
4214 break;
4215 case eStateStopped:
4216 case eStateCrashed:
4217 case eStateSuspended:
4218 {
4219 // We've stopped. First see if we're going to restart the target.
4220 // If we are going to stop, then we always broadcast the event.
4221 // 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 +00004222 // If no thread has an opinion, we don't report it.
Jim Ingham221d51c2013-05-08 00:35:16 +00004223
Pavel Labath3f5df532015-03-12 10:12:41 +00004224 m_stdio_communication.SynchronizeWithReadThread();
Jim Inghamcb4ca112012-05-16 01:32:14 +00004225 RefreshStateAfterStop ();
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004226 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004227 {
Greg Clayton3af9ea52010-11-18 05:57:03 +00004228 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004229 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004230 static_cast<void*>(event_ptr),
Jim Ingham0161b492013-02-09 01:29:05 +00004231 StateAsCString(state));
Jim Ingham35878c42014-04-08 21:33:21 +00004232 // Even though we know we are going to stop, we should let the threads have a look at the stop,
4233 // so they can properly set their state.
4234 m_thread_list.ShouldStop (event_ptr);
Jim Ingham0161b492013-02-09 01:29:05 +00004235 return_value = true;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004236 }
4237 else
4238 {
Jim Ingham221d51c2013-05-08 00:35:16 +00004239 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
4240 bool should_resume = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004241
Jim Ingham0161b492013-02-09 01:29:05 +00004242 // It makes no sense to ask "ShouldStop" if we've already been restarted...
4243 // Asking the thread list is also not likely to go well, since we are running again.
4244 // So in that case just report the event.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004245
Jim Ingham0161b492013-02-09 01:29:05 +00004246 if (!was_restarted)
4247 should_resume = m_thread_list.ShouldStop (event_ptr) == false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004248
Jim Ingham221d51c2013-05-08 00:35:16 +00004249 if (was_restarted || should_resume || m_resume_requested)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004250 {
Jim Ingham0161b492013-02-09 01:29:05 +00004251 Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr);
4252 if (log)
4253 log->Printf ("Process::ShouldBroadcastEvent: should_stop: %i state: %s was_restarted: %i stop_vote: %d.",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004254 should_resume, StateAsCString(state),
4255 was_restarted, stop_vote);
4256
Jim Ingham0161b492013-02-09 01:29:05 +00004257 switch (stop_vote)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004258 {
4259 case eVoteYes:
Jim Ingham0161b492013-02-09 01:29:05 +00004260 return_value = true;
4261 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004262 case eVoteNoOpinion:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004263 case eVoteNo:
4264 return_value = false;
4265 break;
4266 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004267
Jim Inghamcb95f342012-09-05 21:13:56 +00004268 if (!was_restarted)
Jim Ingham0161b492013-02-09 01:29:05 +00004269 {
4270 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004271 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s",
4272 static_cast<void*>(event_ptr),
4273 StateAsCString(state));
Jim Ingham0161b492013-02-09 01:29:05 +00004274 ProcessEventData::SetRestartedInEvent(event_ptr, true);
Jim Inghamcb95f342012-09-05 21:13:56 +00004275 PrivateResume ();
Jim Ingham0161b492013-02-09 01:29:05 +00004276 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004277
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004278 }
4279 else
4280 {
4281 return_value = true;
4282 SynchronouslyNotifyStateChanged (state);
4283 }
4284 }
4285 }
Jim Ingham0161b492013-02-09 01:29:05 +00004286 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004287 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004288
Jim Ingham1460e4b2014-01-10 23:46:59 +00004289 // Forcing the next event delivery is a one shot deal. So reset it here.
4290 m_force_next_event_delivery = false;
4291
Jim Ingham0161b492013-02-09 01:29:05 +00004292 // We do some coalescing of events (for instance two consecutive running events get coalesced.)
4293 // But we only coalesce against events we actually broadcast. So we use m_last_broadcast_state
4294 // to track that. NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done,
4295 // because the PublicState reflects the last event pulled off the queue, and there may be several
4296 // events stacked up on the queue unserviced. So the PublicState may not reflect the last broadcasted event
4297 // yet. m_last_broadcast_state gets updated here.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004298
Jim Ingham0161b492013-02-09 01:29:05 +00004299 if (return_value)
4300 m_last_broadcast_state = state;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004301
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004302 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004303 log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004304 static_cast<void*>(event_ptr), StateAsCString(state),
Jim Ingham0161b492013-02-09 01:29:05 +00004305 StateAsCString(m_last_broadcast_state),
4306 return_value ? "YES" : "NO");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004307 return return_value;
4308}
4309
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004310
4311bool
Jim Ingham60c915e2015-06-23 21:02:45 +00004312Process::StartPrivateStateThread (bool is_secondary_thread)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004313{
Greg Clayton5160ce52013-03-27 23:08:40 +00004314 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004315
Greg Clayton8b82f082011-04-12 05:54:46 +00004316 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004317 if (log)
Greg Clayton8b82f082011-04-12 05:54:46 +00004318 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
4319
Jim Ingham60c915e2015-06-23 21:02:45 +00004320 if (!is_secondary_thread && already_running)
Greg Clayton8b82f082011-04-12 05:54:46 +00004321 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004322
4323 // Create a thread that watches our internal state and controls which
4324 // events make it to clients (into the DCProcess event queue).
Greg Clayton3e06bd92011-01-09 21:07:35 +00004325 char thread_name[1024];
Todd Fiala17096d72014-07-16 19:03:16 +00004326
Zachary Turner39de3112014-09-09 20:54:56 +00004327 if (HostInfo::GetMaxThreadNameLength() <= 30)
Todd Fiala17096d72014-07-16 19:03:16 +00004328 {
Zachary Turner39de3112014-09-09 20:54:56 +00004329 // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit.
4330 if (already_running)
4331 snprintf(thread_name, sizeof(thread_name), "intern-state-OV");
4332 else
4333 snprintf(thread_name, sizeof(thread_name), "intern-state");
Todd Fiala17096d72014-07-16 19:03:16 +00004334 }
Jim Ingham372787f2012-04-07 00:00:41 +00004335 else
Todd Fiala17096d72014-07-16 19:03:16 +00004336 {
4337 if (already_running)
Zachary Turner39de3112014-09-09 20:54:56 +00004338 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
Todd Fiala17096d72014-07-16 19:03:16 +00004339 else
Zachary Turner39de3112014-09-09 20:54:56 +00004340 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
Todd Fiala17096d72014-07-16 19:03:16 +00004341 }
4342
Jim Ingham076b3042012-04-10 01:21:57 +00004343 // Create the private state thread, and start it running.
Jim Ingham60c915e2015-06-23 21:02:45 +00004344 PrivateStateThreadArgs args = {this, is_secondary_thread};
4345 m_private_state_thread = ThreadLauncher::LaunchThread(thread_name, Process::PrivateStateThread, (void *) &args, NULL);
Zachary Turneracee96a2014-09-23 18:32:09 +00004346 if (m_private_state_thread.IsJoinable())
Jim Ingham076b3042012-04-10 01:21:57 +00004347 {
4348 ResumePrivateStateThread();
4349 return true;
4350 }
4351 else
4352 return false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004353}
4354
4355void
4356Process::PausePrivateStateThread ()
4357{
4358 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
4359}
4360
4361void
4362Process::ResumePrivateStateThread ()
4363{
4364 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
4365}
4366
4367void
4368Process::StopPrivateStateThread ()
4369{
Greg Clayton8b82f082011-04-12 05:54:46 +00004370 if (PrivateStateThreadIsValid ())
4371 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Jim Inghamb1e2e842012-04-12 18:49:31 +00004372 else
4373 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004374 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Jim Inghamb1e2e842012-04-12 18:49:31 +00004375 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004376 log->Printf ("Went to stop the private state thread, but it was already invalid.");
Jim Inghamb1e2e842012-04-12 18:49:31 +00004377 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004378}
4379
4380void
4381Process::ControlPrivateStateThread (uint32_t signal)
4382{
Greg Clayton5160ce52013-03-27 23:08:40 +00004383 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004384
4385 assert (signal == eBroadcastInternalStateControlStop ||
4386 signal == eBroadcastInternalStateControlPause ||
4387 signal == eBroadcastInternalStateControlResume);
4388
4389 if (log)
Greg Clayton7ecb3a02011-01-22 17:43:17 +00004390 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004391
Greg Clayton7ecb3a02011-01-22 17:43:17 +00004392 // Signal the private state thread. First we should copy this is case the
4393 // thread starts exiting since the private state thread will NULL this out
4394 // when it exits
Zachary Turner39de3112014-09-09 20:54:56 +00004395 HostThread private_state_thread(m_private_state_thread);
Zachary Turneracee96a2014-09-23 18:32:09 +00004396 if (private_state_thread.IsJoinable())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004397 {
4398 TimeValue timeout_time;
4399 bool timed_out;
4400
4401 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
4402
4403 timeout_time = TimeValue::Now();
4404 timeout_time.OffsetWithSeconds(2);
Jim Inghamb1e2e842012-04-12 18:49:31 +00004405 if (log)
4406 log->Printf ("Sending control event of type: %d.", signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004407 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
4408 m_private_state_control_wait.SetValue (false, eBroadcastNever);
4409
4410 if (signal == eBroadcastInternalStateControlStop)
4411 {
4412 if (timed_out)
Jim Inghamb1e2e842012-04-12 18:49:31 +00004413 {
Zachary Turner39de3112014-09-09 20:54:56 +00004414 Error error = private_state_thread.Cancel();
Jim Inghamb1e2e842012-04-12 18:49:31 +00004415 if (log)
4416 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
4417 }
4418 else
4419 {
4420 if (log)
4421 log->Printf ("The control event killed the private state thread without having to cancel.");
4422 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004423
4424 thread_result_t result = NULL;
Zachary Turner39de3112014-09-09 20:54:56 +00004425 private_state_thread.Join(&result);
4426 m_private_state_thread.Reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004427 }
4428 }
Jim Inghamb1e2e842012-04-12 18:49:31 +00004429 else
4430 {
4431 if (log)
4432 log->Printf ("Private state thread already dead, no need to signal it to stop.");
4433 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004434}
4435
4436void
Jim Inghamcfc09352012-07-27 23:57:19 +00004437Process::SendAsyncInterrupt ()
4438{
4439 if (PrivateStateThreadIsValid())
4440 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4441 else
4442 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4443}
4444
4445void
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004446Process::HandlePrivateEvent (EventSP &event_sp)
4447{
Greg Clayton5160ce52013-03-27 23:08:40 +00004448 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham221d51c2013-05-08 00:35:16 +00004449 m_resume_requested = false;
4450
Jim Inghamaacc3182012-06-06 00:29:30 +00004451 m_currently_handling_event.SetValue(true, eBroadcastNever);
Jim Inghambb3a2832011-01-29 01:49:25 +00004452
Greg Clayton414f5d32011-01-25 02:58:48 +00004453 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghambb3a2832011-01-29 01:49:25 +00004454
4455 // First check to see if anybody wants a shot at this event:
Jim Ingham754ab982011-01-29 04:05:41 +00004456 if (m_next_event_action_ap.get() != NULL)
Jim Inghambb3a2832011-01-29 01:49:25 +00004457 {
Jim Ingham754ab982011-01-29 04:05:41 +00004458 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Ingham0161b492013-02-09 01:29:05 +00004459 if (log)
4460 log->Printf ("Ran next event action, result was %d.", action_result);
4461
Jim Inghambb3a2832011-01-29 01:49:25 +00004462 switch (action_result)
4463 {
4464 case NextEventAction::eEventActionSuccess:
4465 SetNextEventAction(NULL);
4466 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00004467
Jim Inghambb3a2832011-01-29 01:49:25 +00004468 case NextEventAction::eEventActionRetry:
4469 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00004470
Jim Inghambb3a2832011-01-29 01:49:25 +00004471 case NextEventAction::eEventActionExit:
Jim Ingham2a5fdd42011-01-29 01:57:31 +00004472 // Handle Exiting Here. If we already got an exited event,
4473 // we should just propagate it. Otherwise, swallow this event,
4474 // and set our state to exit so the next event will kill us.
4475 if (new_state != eStateExited)
4476 {
4477 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham754ab982011-01-29 04:05:41 +00004478 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Jim Ingham221d51c2013-05-08 00:35:16 +00004479 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Jim Ingham2a5fdd42011-01-29 01:57:31 +00004480 SetNextEventAction(NULL);
4481 return;
4482 }
4483 SetNextEventAction(NULL);
Jim Inghambb3a2832011-01-29 01:49:25 +00004484 break;
4485 }
4486 }
4487
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004488 // See if we should broadcast this state to external clients?
4489 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004490
4491 if (should_broadcast)
4492 {
Greg Claytonb4874f12014-02-28 18:22:24 +00004493 const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004494 if (log)
4495 {
Daniel Malead01b2952012-11-29 21:49:15 +00004496 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
Greg Clayton414f5d32011-01-25 02:58:48 +00004497 __FUNCTION__,
4498 GetID(),
4499 StateAsCString(new_state),
4500 StateAsCString (GetState ()),
Greg Claytonb4874f12014-02-28 18:22:24 +00004501 is_hijacked ? "hijacked" : "public");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004502 }
Jim Ingham9575d842011-03-11 03:53:59 +00004503 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton414f5d32011-01-25 02:58:48 +00004504 if (StateIsRunningState (new_state))
Greg Clayton44d93782014-01-27 23:43:24 +00004505 {
4506 // Only push the input handler if we aren't fowarding events,
4507 // as this means the curses GUI is in use...
Todd Fialaf72fa672014-10-07 16:05:21 +00004508 // Or don't push it if we are launching since it will come up stopped.
Zachary Turnerc62733b2015-05-20 18:31:17 +00004509 if (!GetTarget().GetDebugger().IsForwardingEvents() && new_state != eStateLaunching &&
4510 new_state != eStateAttaching)
Pavel Labath44464872015-05-27 12:40:32 +00004511 {
Greg Clayton44d93782014-01-27 23:43:24 +00004512 PushProcessIOHandler ();
Pavel Labath44464872015-05-27 12:40:32 +00004513 m_iohandler_sync.SetValue(m_iohandler_sync.GetValue()+1, eBroadcastAlways);
4514 if (log)
4515 log->Printf("Process::%s updated m_iohandler_sync to %d", __FUNCTION__, m_iohandler_sync.GetValue());
4516 }
Greg Clayton44d93782014-01-27 23:43:24 +00004517 }
Greg Claytonb4874f12014-02-28 18:22:24 +00004518 else if (StateIsStoppedState(new_state, false))
4519 {
4520 if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
4521 {
4522 // If the lldb_private::Debugger is handling the events, we don't
4523 // want to pop the process IOHandler here, we want to do it when
4524 // we receive the stopped event so we can carefully control when
4525 // the process IOHandler is popped because when we stop we want to
4526 // display some text stating how and why we stopped, then maybe some
4527 // process/thread/frame info, and then we want the "(lldb) " prompt
4528 // to show up. If we pop the process IOHandler here, then we will
4529 // cause the command interpreter to become the top IOHandler after
4530 // the process pops off and it will update its prompt right away...
4531 // See the Debugger.cpp file where it calls the function as
4532 // "process_sp->PopProcessIOHandler()" to see where I am talking about.
4533 // Otherwise we end up getting overlapping "(lldb) " prompts and
4534 // garbled output.
4535 //
4536 // If we aren't handling the events in the debugger (which is indicated
4537 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we
4538 // are hijacked, then we always pop the process IO handler manually.
4539 // Hijacking happens when the internal process state thread is running
4540 // thread plans, or when commands want to run in synchronous mode
4541 // and they call "process->WaitForProcessToStop()". An example of something
4542 // that will hijack the events is a simple expression:
4543 //
4544 // (lldb) expr (int)puts("hello")
4545 //
4546 // This will cause the internal process state thread to resume and halt
4547 // the process (and _it_ will hijack the eBroadcastBitStateChanged
4548 // events) and we do need the IO handler to be pushed and popped
4549 // correctly.
4550
Zachary Turner7529df92015-09-01 20:02:29 +00004551 if (is_hijacked || GetTarget().GetDebugger().IsHandlingEvents() == false)
Greg Claytonb4874f12014-02-28 18:22:24 +00004552 PopProcessIOHandler ();
4553 }
4554 }
Jim Ingham9575d842011-03-11 03:53:59 +00004555
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004556 BroadcastEvent (event_sp);
4557 }
4558 else
4559 {
4560 if (log)
4561 {
Daniel Malead01b2952012-11-29 21:49:15 +00004562 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
Greg Clayton414f5d32011-01-25 02:58:48 +00004563 __FUNCTION__,
4564 GetID(),
4565 StateAsCString(new_state),
Jason Molendafd54b362011-09-20 21:44:10 +00004566 StateAsCString (GetState ()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004567 }
4568 }
Jim Inghamaacc3182012-06-06 00:29:30 +00004569 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004570}
4571
Virgile Bellob2f1fb22013-08-23 12:44:05 +00004572thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004573Process::PrivateStateThread (void *arg)
4574{
Jim Ingham60c915e2015-06-23 21:02:45 +00004575 PrivateStateThreadArgs *real_args = static_cast<PrivateStateThreadArgs *> (arg);
4576 thread_result_t result = real_args->process->RunPrivateStateThread(real_args->is_secondary_thread);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004577 return result;
4578}
4579
Virgile Bellob2f1fb22013-08-23 12:44:05 +00004580thread_result_t
Jim Ingham60c915e2015-06-23 21:02:45 +00004581Process::RunPrivateStateThread (bool is_secondary_thread)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004582{
Jim Ingham076b3042012-04-10 01:21:57 +00004583 bool control_only = true;
Jim Inghamb1e2e842012-04-12 18:49:31 +00004584 m_private_state_control_wait.SetValue (false, eBroadcastNever);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004585
Greg Clayton5160ce52013-03-27 23:08:40 +00004586 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004587 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004588 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...",
4589 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004590
4591 bool exit_now = false;
4592 while (!exit_now)
4593 {
4594 EventSP event_sp;
4595 WaitForEventsPrivate (NULL, event_sp, control_only);
4596 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
4597 {
Jim Inghamb1e2e842012-04-12 18:49:31 +00004598 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004599 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d",
4600 __FUNCTION__, static_cast<void*>(this), GetID(),
4601 event_sp->GetType());
Jim Inghamb1e2e842012-04-12 18:49:31 +00004602
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004603 switch (event_sp->GetType())
4604 {
4605 case eBroadcastInternalStateControlStop:
4606 exit_now = true;
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004607 break; // doing any internal state management below
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004608
4609 case eBroadcastInternalStateControlPause:
4610 control_only = true;
4611 break;
4612
4613 case eBroadcastInternalStateControlResume:
4614 control_only = false;
4615 break;
4616 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004617
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004618 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004619 continue;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004620 }
Jim Inghamcfc09352012-07-27 23:57:19 +00004621 else if (event_sp->GetType() == eBroadcastBitInterrupt)
4622 {
4623 if (m_public_state.GetValue() == eStateAttaching)
4624 {
4625 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004626 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.",
4627 __FUNCTION__, static_cast<void*>(this),
4628 GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00004629 BroadcastEvent (eBroadcastBitInterrupt, NULL);
4630 }
4631 else
4632 {
4633 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004634 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.",
4635 __FUNCTION__, static_cast<void*>(this),
4636 GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00004637 Halt();
4638 }
4639 continue;
4640 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004641
4642 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4643
4644 if (internal_state != eStateInvalid)
4645 {
Greg Claytonf9b57b92013-05-10 23:48:10 +00004646 if (m_clear_thread_plans_on_stop &&
4647 StateIsStoppedState(internal_state, true))
4648 {
4649 m_clear_thread_plans_on_stop = false;
4650 m_thread_list.DiscardThreadPlans();
4651 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004652 HandlePrivateEvent (event_sp);
4653 }
4654
Greg Clayton58d1c9a2010-10-18 04:14:23 +00004655 if (internal_state == eStateInvalid ||
4656 internal_state == eStateExited ||
4657 internal_state == eStateDetached )
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004658 {
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004659 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004660 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...",
4661 __FUNCTION__, static_cast<void*>(this), GetID(),
4662 StateAsCString(internal_state));
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004663
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004664 break;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004665 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004666 }
4667
Caroline Tice20ad3c42010-10-29 21:48:37 +00004668 // Verify log is still enabled before attempting to write to it...
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004669 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004670 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...",
4671 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004672
Jim Ingham60c915e2015-06-23 21:02:45 +00004673 // If we are a secondary thread, then the primary thread we are working for will have already
4674 // acquired the public_run_lock, and isn't done with what it was doing yet, so don't
4675 // try to change it on the way out.
4676 if (!is_secondary_thread)
4677 m_public_run_lock.SetStopped();
Greg Clayton6ed95942011-01-22 07:12:45 +00004678 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Zachary Turner39de3112014-09-09 20:54:56 +00004679 m_private_state_thread.Reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004680 return NULL;
4681}
4682
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004683//------------------------------------------------------------------
4684// Process Event Data
4685//------------------------------------------------------------------
4686
4687Process::ProcessEventData::ProcessEventData () :
4688 EventData (),
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004689 m_process_wp (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004690 m_state (eStateInvalid),
Greg Claytonc982c762010-07-09 20:39:50 +00004691 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004692 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004693 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004694{
4695}
4696
4697Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
4698 EventData (),
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004699 m_process_wp (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004700 m_state (state),
Greg Claytonc982c762010-07-09 20:39:50 +00004701 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004702 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004703 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004704{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004705 if (process_sp)
4706 m_process_wp = process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004707}
4708
4709Process::ProcessEventData::~ProcessEventData()
4710{
4711}
4712
4713const ConstString &
4714Process::ProcessEventData::GetFlavorString ()
4715{
4716 static ConstString g_flavor ("Process::ProcessEventData");
4717 return g_flavor;
4718}
4719
4720const ConstString &
4721Process::ProcessEventData::GetFlavor () const
4722{
4723 return ProcessEventData::GetFlavorString ();
4724}
4725
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004726void
4727Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
4728{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004729 ProcessSP process_sp(m_process_wp.lock());
4730
4731 if (!process_sp)
4732 return;
4733
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004734 // This function gets called twice for each event, once when the event gets pulled
Jim Inghama8604692011-05-22 21:45:01 +00004735 // off of the private process event queue, and then any number of times, first when it gets pulled off of
4736 // the public event queue, then other times when we're pretending that this is where we stopped at the
4737 // end of expression evaluation. m_update_state is used to distinguish these
4738 // three cases; it is 0 when we're just pulling it off for private handling,
Jim Ingham221d51c2013-05-08 00:35:16 +00004739 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Jim Inghama8604692011-05-22 21:45:01 +00004740 if (m_update_state != 1)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004741 return;
Jim Ingham0161b492013-02-09 01:29:05 +00004742
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004743 process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr));
Jim Ingham35878c42014-04-08 21:33:21 +00004744
4745 // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had
4746 // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may
4747 // end up restarting the process.
4748 if (m_interrupted)
4749 return;
4750
4751 // If we're stopped and haven't restarted, then do the StopInfo actions here:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004752 if (m_state == eStateStopped && ! m_restarted)
Greg Clayton2e309072015-07-17 23:42:28 +00004753 {
4754 // Let process subclasses know we are about to do a public stop and
4755 // do anything they might need to in order to speed up register and
4756 // memory accesses.
4757 process_sp->WillPublicStop();
4758
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004759 ThreadList &curr_thread_list = process_sp->GetThreadList();
Greg Clayton61e7a582011-12-01 23:28:38 +00004760 uint32_t num_threads = curr_thread_list.GetSize();
4761 uint32_t idx;
Greg Claytonf4b47e12010-08-04 01:40:35 +00004762
Jim Ingham4b536182011-08-09 02:12:22 +00004763 // The actions might change one of the thread's stop_info's opinions about whether we should
4764 // stop the process, so we need to query that as we go.
Jim Ingham0faa43f2011-11-08 03:00:11 +00004765
4766 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
4767 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
4768 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
4769 // 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
4770 // against this list & bag out if anything differs.
Greg Clayton61e7a582011-12-01 23:28:38 +00004771 std::vector<uint32_t> thread_index_array(num_threads);
Jim Ingham0faa43f2011-11-08 03:00:11 +00004772 for (idx = 0; idx < num_threads; ++idx)
4773 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
4774
Jim Inghamc7078c22012-12-13 22:24:15 +00004775 // Use this to track whether we should continue from here. We will only continue the target running if
4776 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running,
4777 // then it doesn't matter what the other threads say...
4778
4779 bool still_should_stop = false;
Jim Ingham4b536182011-08-09 02:12:22 +00004780
Jim Ingham0ad7e052013-04-25 02:04:59 +00004781 // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a
4782 // valid stop reason. In that case we should just stop, because we have no way of telling what the right
4783 // thing to do is, and it's better to let the user decide than continue behind their backs.
4784
4785 bool does_anybody_have_an_opinion = false;
4786
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004787 for (idx = 0; idx < num_threads; ++idx)
4788 {
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004789 curr_thread_list = process_sp->GetThreadList();
Jim Ingham0faa43f2011-11-08 03:00:11 +00004790 if (curr_thread_list.GetSize() != num_threads)
4791 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004792 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004793 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004794 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 +00004795 break;
4796 }
4797
4798 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
4799
4800 if (thread_sp->GetIndexID() != thread_index_array[idx])
4801 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004802 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004803 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004804 log->Printf("The thread at position %u changed from %u to %u while processing event.",
Jim Ingham87c665f2011-12-01 20:26:15 +00004805 idx,
4806 thread_index_array[idx],
4807 thread_sp->GetIndexID());
Jim Ingham0faa43f2011-11-08 03:00:11 +00004808 break;
4809 }
4810
Jim Inghamb15bfc72010-10-20 00:39:53 +00004811 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
Jim Ingham5d88a062012-10-16 00:09:33 +00004812 if (stop_info_sp && stop_info_sp->IsValid())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004813 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004814 does_anybody_have_an_opinion = true;
Jim Ingham0161b492013-02-09 01:29:05 +00004815 bool this_thread_wants_to_stop;
4816 if (stop_info_sp->GetOverrideShouldStop())
Jim Ingham4b536182011-08-09 02:12:22 +00004817 {
Jim Ingham0161b492013-02-09 01:29:05 +00004818 this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue();
4819 }
4820 else
4821 {
4822 stop_info_sp->PerformAction(event_ptr);
4823 // The stop action might restart the target. If it does, then we want to mark that in the
4824 // event so that whoever is receiving it will know to wait for the running event and reflect
4825 // that state appropriately.
4826 // We also need to stop processing actions, since they aren't expecting the target to be running.
4827
4828 // FIXME: we might have run.
4829 if (stop_info_sp->HasTargetRunSinceMe())
4830 {
4831 SetRestarted (true);
4832 break;
4833 }
4834
4835 this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
Jim Ingham4b536182011-08-09 02:12:22 +00004836 }
Jim Inghamc7078c22012-12-13 22:24:15 +00004837
Jim Inghamc7078c22012-12-13 22:24:15 +00004838 if (still_should_stop == false)
4839 still_should_stop = this_thread_wants_to_stop;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004840 }
4841 }
Jim Ingham3ebcf7f2010-08-10 00:59:59 +00004842
Ashok Thirumurthicf7c55e2013-04-18 14:38:20 +00004843
Jim Inghama8ca6e22013-05-03 23:04:37 +00004844 if (!GetRestarted())
Jim Ingham9575d842011-03-11 03:53:59 +00004845 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004846 if (!still_should_stop && does_anybody_have_an_opinion)
Jim Ingham4b536182011-08-09 02:12:22 +00004847 {
4848 // We've been asked to continue, so do that here.
Jim Ingham9575d842011-03-11 03:53:59 +00004849 SetRestarted(true);
Jim Ingham3b8285d2012-04-19 01:40:33 +00004850 // Use the public resume method here, since this is just
4851 // extending a public resume.
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004852 process_sp->PrivateResume();
Jim Ingham4b536182011-08-09 02:12:22 +00004853 }
4854 else
4855 {
4856 // If we didn't restart, run the Stop Hooks here:
4857 // They might also restart the target, so watch for that.
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004858 process_sp->GetTarget().RunStopHooks();
4859 if (process_sp->GetPrivateState() == eStateRunning)
Jim Ingham4b536182011-08-09 02:12:22 +00004860 SetRestarted(true);
4861 }
Jim Ingham9575d842011-03-11 03:53:59 +00004862 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004863 }
4864}
4865
4866void
4867Process::ProcessEventData::Dump (Stream *s) const
4868{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004869 ProcessSP process_sp(m_process_wp.lock());
4870
4871 if (process_sp)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004872 s->Printf(" process = %p (pid = %" PRIu64 "), ",
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004873 static_cast<void*>(process_sp.get()), process_sp->GetID());
4874 else
4875 s->PutCString(" process = NULL, ");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004876
Greg Clayton8b82f082011-04-12 05:54:46 +00004877 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004878}
4879
4880const Process::ProcessEventData *
4881Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
4882{
4883 if (event_ptr)
4884 {
4885 const EventData *event_data = event_ptr->GetData();
4886 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4887 return static_cast <const ProcessEventData *> (event_ptr->GetData());
4888 }
4889 return NULL;
4890}
4891
4892ProcessSP
4893Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4894{
4895 ProcessSP process_sp;
4896 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4897 if (data)
4898 process_sp = data->GetProcessSP();
4899 return process_sp;
4900}
4901
4902StateType
4903Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4904{
4905 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4906 if (data == NULL)
4907 return eStateInvalid;
4908 else
4909 return data->GetState();
4910}
4911
4912bool
4913Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4914{
4915 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4916 if (data == NULL)
4917 return false;
4918 else
4919 return data->GetRestarted();
4920}
4921
4922void
4923Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4924{
4925 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4926 if (data != NULL)
4927 data->SetRestarted(new_value);
4928}
4929
Jim Ingham0161b492013-02-09 01:29:05 +00004930size_t
4931Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr)
4932{
4933 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4934 if (data != NULL)
4935 return data->GetNumRestartedReasons();
4936 else
4937 return 0;
4938}
4939
4940const char *
4941Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx)
4942{
4943 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4944 if (data != NULL)
4945 return data->GetRestartedReasonAtIndex(idx);
4946 else
4947 return NULL;
4948}
4949
4950void
4951Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason)
4952{
4953 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4954 if (data != NULL)
4955 data->AddRestartedReason(reason);
4956}
4957
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004958bool
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004959Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4960{
4961 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4962 if (data == NULL)
4963 return false;
4964 else
4965 return data->GetInterrupted ();
4966}
4967
4968void
4969Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4970{
4971 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4972 if (data != NULL)
4973 data->SetInterrupted(new_value);
4974}
4975
4976bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004977Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4978{
4979 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4980 if (data)
4981 {
4982 data->SetUpdateStateOnRemoval();
4983 return true;
4984 }
4985 return false;
4986}
4987
Greg Claytond9e416c2012-02-18 05:35:26 +00004988lldb::TargetSP
4989Process::CalculateTarget ()
4990{
Zachary Turner7529df92015-09-01 20:02:29 +00004991 return m_target_sp.lock();
Greg Claytond9e416c2012-02-18 05:35:26 +00004992}
4993
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004994void
Greg Clayton0603aa92010-10-04 01:05:56 +00004995Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004996{
Zachary Turner7529df92015-09-01 20:02:29 +00004997 exe_ctx.SetTargetPtr (&GetTarget());
Greg Claytonc14ee322011-09-22 04:58:26 +00004998 exe_ctx.SetProcessPtr (this);
4999 exe_ctx.SetThreadPtr(NULL);
5000 exe_ctx.SetFramePtr (NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00005001}
5002
Greg Claytone996fd32011-03-08 22:40:15 +00005003//uint32_t
5004//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
5005//{
5006// return 0;
5007//}
5008//
5009//ArchSpec
5010//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
5011//{
5012// return Host::GetArchSpecForExistingProcess (pid);
5013//}
5014//
5015//ArchSpec
5016//Process::GetArchSpecForExistingProcess (const char *process_name)
5017//{
5018// return Host::GetArchSpecForExistingProcess (process_name);
5019//}
5020//
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005021void
5022Process::AppendSTDOUT (const char * s, size_t len)
5023{
Greg Clayton3af9ea52010-11-18 05:57:03 +00005024 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005025 m_stdout_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00005026 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005027}
5028
5029void
Greg Clayton93e86192011-11-13 04:45:22 +00005030Process::AppendSTDERR (const char * s, size_t len)
5031{
5032 Mutex::Locker locker (m_stdio_communication_mutex);
5033 m_stderr_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00005034 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
Greg Clayton93e86192011-11-13 04:45:22 +00005035}
5036
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005037void
Han Ming Ong91ed6b82013-06-24 18:15:05 +00005038Process::BroadcastAsyncProfileData(const std::string &one_profile_data)
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005039{
5040 Mutex::Locker locker (m_profile_data_comm_mutex);
Han Ming Ong91ed6b82013-06-24 18:15:05 +00005041 m_profile_data.push_back(one_profile_data);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005042 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
5043}
5044
5045size_t
5046Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
5047{
5048 Mutex::Locker locker(m_profile_data_comm_mutex);
Han Ming Ong929a94f2012-11-29 22:14:45 +00005049 if (m_profile_data.empty())
5050 return 0;
Han Ming Ong91ed6b82013-06-24 18:15:05 +00005051
5052 std::string &one_profile_data = m_profile_data.front();
5053 size_t bytes_available = one_profile_data.size();
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005054 if (bytes_available > 0)
5055 {
Greg Clayton5160ce52013-03-27 23:08:40 +00005056 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005057 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005058 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")",
5059 static_cast<void*>(buf),
5060 static_cast<uint64_t>(buf_size));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005061 if (bytes_available > buf_size)
5062 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00005063 memcpy(buf, one_profile_data.c_str(), buf_size);
5064 one_profile_data.erase(0, buf_size);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005065 bytes_available = buf_size;
5066 }
5067 else
5068 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00005069 memcpy(buf, one_profile_data.c_str(), bytes_available);
Han Ming Ong929a94f2012-11-29 22:14:45 +00005070 m_profile_data.erase(m_profile_data.begin());
Han Ming Ongab3b8b22012-11-17 00:21:04 +00005071 }
5072 }
5073 return bytes_available;
5074}
5075
5076
Greg Clayton93e86192011-11-13 04:45:22 +00005077//------------------------------------------------------------------
5078// Process STDIO
5079//------------------------------------------------------------------
5080
5081size_t
5082Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
5083{
5084 Mutex::Locker locker(m_stdio_communication_mutex);
5085 size_t bytes_available = m_stdout_data.size();
5086 if (bytes_available > 0)
5087 {
Greg Clayton5160ce52013-03-27 23:08:40 +00005088 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00005089 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005090 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")",
5091 static_cast<void*>(buf),
5092 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00005093 if (bytes_available > buf_size)
5094 {
5095 memcpy(buf, m_stdout_data.c_str(), buf_size);
5096 m_stdout_data.erase(0, buf_size);
5097 bytes_available = buf_size;
5098 }
5099 else
5100 {
5101 memcpy(buf, m_stdout_data.c_str(), bytes_available);
5102 m_stdout_data.clear();
5103 }
5104 }
5105 return bytes_available;
5106}
5107
5108
5109size_t
5110Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
5111{
5112 Mutex::Locker locker(m_stdio_communication_mutex);
5113 size_t bytes_available = m_stderr_data.size();
5114 if (bytes_available > 0)
5115 {
Greg Clayton5160ce52013-03-27 23:08:40 +00005116 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00005117 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005118 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")",
5119 static_cast<void*>(buf),
5120 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00005121 if (bytes_available > buf_size)
5122 {
5123 memcpy(buf, m_stderr_data.c_str(), buf_size);
5124 m_stderr_data.erase(0, buf_size);
5125 bytes_available = buf_size;
5126 }
5127 else
5128 {
5129 memcpy(buf, m_stderr_data.c_str(), bytes_available);
5130 m_stderr_data.clear();
5131 }
5132 }
5133 return bytes_available;
5134}
5135
5136void
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005137Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
5138{
5139 Process *process = (Process *) baton;
5140 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
5141}
5142
Greg Clayton44d93782014-01-27 23:43:24 +00005143class IOHandlerProcessSTDIO :
5144 public IOHandler
5145{
5146public:
5147 IOHandlerProcessSTDIO (Process *process,
5148 int write_fd) :
Kate Stonee30f11d2014-11-17 19:06:59 +00005149 IOHandler(process->GetTarget().GetDebugger(), IOHandler::Type::ProcessIO),
Greg Clayton44d93782014-01-27 23:43:24 +00005150 m_process (process),
5151 m_read_file (),
5152 m_write_file (write_fd, false),
Greg Clayton100eb932014-07-02 21:10:39 +00005153 m_pipe ()
Greg Clayton44d93782014-01-27 23:43:24 +00005154 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005155 m_pipe.CreateNew(false);
Greg Clayton44d93782014-01-27 23:43:24 +00005156 m_read_file.SetDescriptor(GetInputFD(), false);
5157 }
5158
5159 virtual
5160 ~IOHandlerProcessSTDIO ()
5161 {
5162
5163 }
5164
Greg Clayton44d93782014-01-27 23:43:24 +00005165 // Each IOHandler gets to run until it is done. It should read data
5166 // from the "in" and place output into "out" and "err and return
5167 // when done.
Pavel Labath44464872015-05-27 12:40:32 +00005168 void
5169 Run () override
Greg Clayton44d93782014-01-27 23:43:24 +00005170 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005171 if (!m_read_file.IsValid() || !m_write_file.IsValid() || !m_pipe.CanRead() || !m_pipe.CanWrite())
Greg Clayton44d93782014-01-27 23:43:24 +00005172 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005173 SetIsDone(true);
5174 return;
5175 }
5176
5177 SetIsDone(false);
5178 const int read_fd = m_read_file.GetDescriptor();
5179 TerminalState terminal_state;
5180 terminal_state.Save (read_fd, false);
5181 Terminal terminal(read_fd);
5182 terminal.SetCanonical(false);
5183 terminal.SetEcho(false);
Deepak Panickal914b8d92014-01-31 18:48:46 +00005184// FD_ZERO, FD_SET are not supported on windows
Hafiz Abid Qadeer6eff1012014-03-12 10:45:23 +00005185#ifndef _WIN32
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005186 const int pipe_read_fd = m_pipe.GetReadFileDescriptor();
5187 while (!GetIsDone())
5188 {
5189 fd_set read_fdset;
5190 FD_ZERO (&read_fdset);
5191 FD_SET (read_fd, &read_fdset);
5192 FD_SET (pipe_read_fd, &read_fdset);
5193 const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1;
5194 int num_set_fds = select (nfds, &read_fdset, NULL, NULL, NULL);
5195 if (num_set_fds < 0)
5196 {
5197 const int select_errno = errno;
5198
5199 if (select_errno != EINTR)
5200 SetIsDone(true);
5201 }
5202 else if (num_set_fds > 0)
5203 {
5204 char ch = 0;
5205 size_t n;
5206 if (FD_ISSET (read_fd, &read_fdset))
Greg Clayton44d93782014-01-27 23:43:24 +00005207 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005208 n = 1;
5209 if (m_read_file.Read(&ch, n).Success() && n == 1)
Greg Clayton44d93782014-01-27 23:43:24 +00005210 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005211 if (m_write_file.Write(&ch, n).Fail() || n != 1)
Greg Clayton44d93782014-01-27 23:43:24 +00005212 SetIsDone(true);
5213 }
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005214 else
5215 SetIsDone(true);
5216 }
5217 if (FD_ISSET (pipe_read_fd, &read_fdset))
5218 {
5219 size_t bytes_read;
5220 // Consume the interrupt byte
5221 Error error = m_pipe.Read(&ch, 1, bytes_read);
5222 if (error.Success())
Greg Clayton44d93782014-01-27 23:43:24 +00005223 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005224 switch (ch)
Greg Clayton44d93782014-01-27 23:43:24 +00005225 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005226 case 'q':
Greg Clayton44d93782014-01-27 23:43:24 +00005227 SetIsDone(true);
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005228 break;
5229 case 'i':
5230 if (StateIsRunningState(m_process->GetState()))
5231 m_process->Halt();
5232 break;
Greg Clayton44d93782014-01-27 23:43:24 +00005233 }
5234 }
5235 }
Greg Clayton44d93782014-01-27 23:43:24 +00005236 }
Greg Clayton44d93782014-01-27 23:43:24 +00005237 }
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005238#endif
5239 terminal_state.Restore();
Greg Clayton44d93782014-01-27 23:43:24 +00005240 }
5241
Pavel Labath44464872015-05-27 12:40:32 +00005242 void
5243 Cancel () override
Greg Clayton44d93782014-01-27 23:43:24 +00005244 {
Greg Clayton19e11352014-02-26 22:47:33 +00005245 char ch = 'q'; // Send 'q' for quit
Zachary Turner0b9d3ee2014-12-17 18:02:19 +00005246 size_t bytes_written = 0;
5247 m_pipe.Write(&ch, 1, bytes_written);
Greg Clayton44d93782014-01-27 23:43:24 +00005248 }
Greg Claytone68f5d62014-02-24 22:50:57 +00005249
Pavel Labath44464872015-05-27 12:40:32 +00005250 bool
5251 Interrupt () override
Greg Claytone68f5d62014-02-24 22:50:57 +00005252 {
Greg Clayton19e11352014-02-26 22:47:33 +00005253 // Do only things that are safe to do in an interrupt context (like in
5254 // a SIGINT handler), like write 1 byte to a file descriptor. This will
5255 // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte
5256 // that was written to the pipe and then call m_process->Halt() from a
5257 // much safer location in code.
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00005258 if (m_active)
5259 {
5260 char ch = 'i'; // Send 'i' for interrupt
Zachary Turner0b9d3ee2014-12-17 18:02:19 +00005261 size_t bytes_written = 0;
5262 Error result = m_pipe.Write(&ch, 1, bytes_written);
5263 return result.Success();
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00005264 }
5265 else
5266 {
5267 // This IOHandler might be pushed on the stack, but not being run currently
5268 // so do the right thing if we aren't actively watching for STDIN by sending
5269 // the interrupt to the process. Otherwise the write to the pipe above would
5270 // do nothing. This can happen when the command interpreter is running and
5271 // gets a "expression ...". It will be on the IOHandler thread and sending
5272 // the input is complete to the delegate which will cause the expression to
5273 // run, which will push the process IO handler, but not run it.
5274
5275 if (StateIsRunningState(m_process->GetState()))
5276 {
5277 m_process->SendAsyncInterrupt();
5278 return true;
5279 }
5280 }
5281 return false;
Greg Claytone68f5d62014-02-24 22:50:57 +00005282 }
Greg Clayton44d93782014-01-27 23:43:24 +00005283
Pavel Labath44464872015-05-27 12:40:32 +00005284 void
5285 GotEOF() override
Greg Clayton44d93782014-01-27 23:43:24 +00005286 {
5287
5288 }
5289
5290protected:
5291 Process *m_process;
5292 File m_read_file; // Read from this file (usually actual STDIN for LLDB
5293 File m_write_file; // Write to this file (usually the master pty for getting io to debuggee)
Greg Clayton100eb932014-07-02 21:10:39 +00005294 Pipe m_pipe;
Greg Clayton44d93782014-01-27 23:43:24 +00005295};
5296
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005297void
Greg Clayton44d93782014-01-27 23:43:24 +00005298Process::SetSTDIOFileDescriptor (int fd)
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005299{
5300 // First set up the Read Thread for reading/handling process I/O
5301
Greg Clayton44d93782014-01-27 23:43:24 +00005302 std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005303
5304 if (conn_ap.get())
5305 {
5306 m_stdio_communication.SetConnection (conn_ap.release());
5307 if (m_stdio_communication.IsConnected())
5308 {
5309 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
5310 m_stdio_communication.StartReadThread();
5311
5312 // Now read thread is set up, set up input reader.
5313
5314 if (!m_process_input_reader.get())
Greg Clayton44d93782014-01-27 23:43:24 +00005315 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005316 }
5317 }
5318}
5319
Greg Claytonb4874f12014-02-28 18:22:24 +00005320bool
Greg Clayton6fea17e2014-03-03 19:15:20 +00005321Process::ProcessIOHandlerIsActive ()
5322{
5323 IOHandlerSP io_handler_sp (m_process_input_reader);
5324 if (io_handler_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00005325 return GetTarget().GetDebugger().IsTopIOHandler (io_handler_sp);
Greg Clayton6fea17e2014-03-03 19:15:20 +00005326 return false;
5327}
5328bool
Greg Clayton44d93782014-01-27 23:43:24 +00005329Process::PushProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005330{
Greg Clayton44d93782014-01-27 23:43:24 +00005331 IOHandlerSP io_handler_sp (m_process_input_reader);
5332 if (io_handler_sp)
5333 {
Pavel Labath44464872015-05-27 12:40:32 +00005334 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
5335 if (log)
5336 log->Printf("Process::%s pushing IO handler", __FUNCTION__);
5337
Greg Clayton44d93782014-01-27 23:43:24 +00005338 io_handler_sp->SetIsDone(false);
Zachary Turner7529df92015-09-01 20:02:29 +00005339 GetTarget().GetDebugger().PushIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00005340 return true;
Greg Clayton44d93782014-01-27 23:43:24 +00005341 }
Greg Claytonb4874f12014-02-28 18:22:24 +00005342 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005343}
5344
Greg Claytonb4874f12014-02-28 18:22:24 +00005345bool
Greg Clayton44d93782014-01-27 23:43:24 +00005346Process::PopProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005347{
Greg Clayton44d93782014-01-27 23:43:24 +00005348 IOHandlerSP io_handler_sp (m_process_input_reader);
5349 if (io_handler_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00005350 return GetTarget().GetDebugger().PopIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00005351 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005352}
5353
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00005354// The process needs to know about installed plug-ins
Greg Clayton99d0faf2010-11-18 23:32:35 +00005355void
Caroline Tice20bd37f2011-03-10 22:14:10 +00005356Process::SettingsInitialize ()
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005357{
Greg Clayton6920b522012-08-22 18:39:03 +00005358 Thread::SettingsInitialize ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00005359}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005360
Greg Clayton99d0faf2010-11-18 23:32:35 +00005361void
Caroline Tice20bd37f2011-03-10 22:14:10 +00005362Process::SettingsTerminate ()
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00005363{
Greg Clayton6920b522012-08-22 18:39:03 +00005364 Thread::SettingsTerminate ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00005365}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005366
Jim Ingham1624a2d2014-05-05 02:26:40 +00005367ExpressionResults
Jim Inghamf48169b2010-11-30 02:22:11 +00005368Process::RunThreadPlan (ExecutionContext &exe_ctx,
Jim Ingham372787f2012-04-07 00:00:41 +00005369 lldb::ThreadPlanSP &thread_plan_sp,
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005370 const EvaluateExpressionOptions &options,
Jim Inghamf48169b2010-11-30 02:22:11 +00005371 Stream &errors)
5372{
Jim Ingham8646d3c2014-05-05 02:47:44 +00005373 ExpressionResults return_value = eExpressionSetupError;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005374
Jim Ingham77787032011-01-20 02:03:18 +00005375 if (thread_plan_sp.get() == NULL)
5376 {
5377 errors.Printf("RunThreadPlan called with empty thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005378 return eExpressionSetupError;
Jim Ingham77787032011-01-20 02:03:18 +00005379 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005380
Jim Ingham7d7931d2013-03-28 00:05:34 +00005381 if (!thread_plan_sp->ValidatePlan(NULL))
5382 {
5383 errors.Printf ("RunThreadPlan called with an invalid thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005384 return eExpressionSetupError;
Jim Ingham7d7931d2013-03-28 00:05:34 +00005385 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005386
Greg Claytonc14ee322011-09-22 04:58:26 +00005387 if (exe_ctx.GetProcessPtr() != this)
5388 {
5389 errors.Printf("RunThreadPlan called on wrong process.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005390 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00005391 }
5392
5393 Thread *thread = exe_ctx.GetThreadPtr();
5394 if (thread == NULL)
5395 {
5396 errors.Printf("RunThreadPlan called with invalid thread.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005397 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00005398 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005399
Jim Ingham17e5c4e2011-05-17 22:24:54 +00005400 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
5401 // For that to be true the plan can't be private - since private plans suppress themselves in the
5402 // GetCompletedPlan call.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005403
Jim Ingham17e5c4e2011-05-17 22:24:54 +00005404 bool orig_plan_private = thread_plan_sp->GetPrivate();
5405 thread_plan_sp->SetPrivate(false);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005406
Jim Ingham444586b2011-01-24 06:34:17 +00005407 if (m_private_state.GetValue() != eStateStopped)
5408 {
5409 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005410 return eExpressionSetupError;
Jim Ingham444586b2011-01-24 06:34:17 +00005411 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005412
Jim Ingham66243842011-08-13 00:56:10 +00005413 // Save the thread & frame from the exe_ctx for restoration after we run
Greg Claytonc14ee322011-09-22 04:58:26 +00005414 const uint32_t thread_idx_id = thread->GetIndexID();
Jason Molendab57e4a12013-11-04 09:33:30 +00005415 StackFrameSP selected_frame_sp = thread->GetSelectedFrame();
Jim Ingham11b0e052013-02-19 23:22:45 +00005416 if (!selected_frame_sp)
5417 {
5418 thread->SetSelectedFrame(0);
5419 selected_frame_sp = thread->GetSelectedFrame();
5420 if (!selected_frame_sp)
5421 {
5422 errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005423 return eExpressionSetupError;
Jim Ingham11b0e052013-02-19 23:22:45 +00005424 }
5425 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005426
Jim Ingham11b0e052013-02-19 23:22:45 +00005427 StackID ctx_frame_id = selected_frame_sp->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00005428
5429 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
5430 // so we should arrange to reset them as well.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005431
Greg Claytonc14ee322011-09-22 04:58:26 +00005432 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005433
Jim Ingham66243842011-08-13 00:56:10 +00005434 uint32_t selected_tid;
5435 StackID selected_stack_id;
Greg Clayton762f7132011-09-18 18:59:15 +00005436 if (selected_thread_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00005437 {
5438 selected_tid = selected_thread_sp->GetIndexID();
Jim Ingham66243842011-08-13 00:56:10 +00005439 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00005440 }
5441 else
5442 {
5443 selected_tid = LLDB_INVALID_THREAD_ID;
5444 }
5445
Zachary Turner39de3112014-09-09 20:54:56 +00005446 HostThread backup_private_state_thread;
Jason Molenda76513fd2014-10-15 23:39:31 +00005447 lldb::StateType old_state = eStateInvalid;
Jim Ingham076b3042012-04-10 01:21:57 +00005448 lldb::ThreadPlanSP stopper_base_plan_sp;
Jim Ingham372787f2012-04-07 00:00:41 +00005449
Greg Clayton5160ce52013-03-27 23:08:40 +00005450 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Zachary Turner39de3112014-09-09 20:54:56 +00005451 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
Jim Ingham372787f2012-04-07 00:00:41 +00005452 {
Jim Ingham076b3042012-04-10 01:21:57 +00005453 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
5454 // we are the thread that is generating public events.
Jim Ingham372787f2012-04-07 00:00:41 +00005455 // 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 +00005456 // we are fielding public events here.
5457 if (log)
Jason Molendad251c9d2012-11-17 01:41:04 +00005458 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 +00005459
Jim Ingham372787f2012-04-07 00:00:41 +00005460 backup_private_state_thread = m_private_state_thread;
Jim Ingham076b3042012-04-10 01:21:57 +00005461
5462 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
5463 // returning control here.
5464 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
5465 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
5466 // before the plan we want to run. Since base plans always stop and return control to the user, that will
5467 // do just what we want.
5468 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
5469 thread->QueueThreadPlan (stopper_base_plan_sp, false);
5470 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
5471 old_state = m_public_state.GetValue();
5472 m_public_state.SetValueNoLock(eStateStopped);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005473
Jim Ingham076b3042012-04-10 01:21:57 +00005474 // Now spin up the private state thread:
Jim Ingham372787f2012-04-07 00:00:41 +00005475 StartPrivateStateThread(true);
5476 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005477
Jim Ingham372787f2012-04-07 00:00:41 +00005478 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005479
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005480 if (options.GetDebug())
5481 {
5482 // In this case, we aren't actually going to run, we just want to stop right away.
5483 // Flush this thread so we will refetch the stacks and show the correct backtrace.
5484 // FIXME: To make this prettier we should invent some stop reason for this, but that
5485 // is only cosmetic, and this functionality is only of use to lldb developers who can
5486 // live with not pretty...
5487 thread->Flush();
Jim Ingham8646d3c2014-05-05 02:47:44 +00005488 return eExpressionStoppedForDebug;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005489 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005490
Jim Ingham1e7a9ee2011-01-23 21:14:08 +00005491 Listener listener("lldb.process.listener.run-thread-plan");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005492
Sean Callanana46ec452012-07-11 21:31:24 +00005493 lldb::EventSP event_to_broadcast_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005494
Jim Ingham77787032011-01-20 02:03:18 +00005495 {
Sean Callanana46ec452012-07-11 21:31:24 +00005496 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
5497 // restored on exit to the function.
5498 //
5499 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
5500 // is put into event_to_broadcast_sp for rebroadcasting.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005501
Sean Callanana46ec452012-07-11 21:31:24 +00005502 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005503
Jim Inghamf48169b2010-11-30 02:22:11 +00005504 if (log)
Jim Ingham0f16e732011-02-08 05:20:59 +00005505 {
5506 StreamString s;
Sean Callanana46ec452012-07-11 21:31:24 +00005507 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
Daniel Malead01b2952012-11-29 21:49:15 +00005508 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
Sean Callanana46ec452012-07-11 21:31:24 +00005509 thread->GetIndexID(),
5510 thread->GetID(),
5511 s.GetData());
5512 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005513
Sean Callanana46ec452012-07-11 21:31:24 +00005514 bool got_event;
5515 lldb::EventSP event_sp;
5516 lldb::StateType stop_state = lldb::eStateInvalid;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005517
Sean Callanana46ec452012-07-11 21:31:24 +00005518 TimeValue* timeout_ptr = NULL;
5519 TimeValue real_timeout;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005520
Jim Ingham0161b492013-02-09 01:29:05 +00005521 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 +00005522 bool do_resume = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005523 bool handle_running_event = true;
Jim Ingham35e1bda2012-10-16 21:41:58 +00005524 const uint64_t default_one_thread_timeout_usec = 250000;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005525
Jim Ingham0161b492013-02-09 01:29:05 +00005526 // This is just for accounting:
5527 uint32_t num_resumes = 0;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005528
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005529 uint32_t timeout_usec = options.GetTimeoutUsec();
Jim Inghamfd95f892014-04-22 01:41:52 +00005530 uint32_t one_thread_timeout_usec;
5531 uint32_t all_threads_timeout_usec = 0;
Jim Inghamfe1c3422014-04-16 02:24:48 +00005532
5533 // If we are going to run all threads the whole time, or if we are only going to run one thread,
5534 // then we don't need the first timeout. So we set the final timeout, and pretend we are after the
5535 // first timeout already.
5536
5537 if (!options.GetStopOthers() || !options.GetTryAllThreads())
Jim Ingham286fb1e2014-02-28 02:52:06 +00005538 {
5539 before_first_timeout = false;
Jim Inghamfd95f892014-04-22 01:41:52 +00005540 one_thread_timeout_usec = 0;
5541 all_threads_timeout_usec = timeout_usec;
Jim Ingham286fb1e2014-02-28 02:52:06 +00005542 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00005543 else
Jim Ingham0161b492013-02-09 01:29:05 +00005544 {
Jim Inghamfd95f892014-04-22 01:41:52 +00005545 uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005546
Jim Ingham914f4e72014-03-28 21:58:28 +00005547 // If the overall wait is forever, then we only need to set the one thread timeout:
5548 if (timeout_usec == 0)
5549 {
Ed Maste801335c2014-03-31 19:28:14 +00005550 if (option_one_thread_timeout != 0)
Jim Inghamfd95f892014-04-22 01:41:52 +00005551 one_thread_timeout_usec = option_one_thread_timeout;
Jim Ingham914f4e72014-03-28 21:58:28 +00005552 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005553 one_thread_timeout_usec = default_one_thread_timeout_usec;
Jim Ingham914f4e72014-03-28 21:58:28 +00005554 }
Jim Ingham0161b492013-02-09 01:29:05 +00005555 else
5556 {
Jim Ingham914f4e72014-03-28 21:58:28 +00005557 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout,
5558 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec.
5559 uint64_t computed_one_thread_timeout;
5560 if (option_one_thread_timeout != 0)
5561 {
5562 if (timeout_usec < option_one_thread_timeout)
5563 {
5564 errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005565 return eExpressionSetupError;
Jim Ingham914f4e72014-03-28 21:58:28 +00005566 }
5567 computed_one_thread_timeout = option_one_thread_timeout;
5568 }
5569 else
5570 {
5571 computed_one_thread_timeout = timeout_usec / 2;
5572 if (computed_one_thread_timeout > default_one_thread_timeout_usec)
5573 computed_one_thread_timeout = default_one_thread_timeout_usec;
5574 }
Jim Inghamfd95f892014-04-22 01:41:52 +00005575 one_thread_timeout_usec = computed_one_thread_timeout;
5576 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec;
5577
Jim Ingham0161b492013-02-09 01:29:05 +00005578 }
Jim Ingham0161b492013-02-09 01:29:05 +00005579 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00005580
5581 if (log)
Jim Inghamfd95f892014-04-22 01:41:52 +00005582 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 +00005583 options.GetStopOthers(),
5584 options.GetTryAllThreads(),
Jim Inghamfd95f892014-04-22 01:41:52 +00005585 before_first_timeout,
5586 one_thread_timeout_usec,
5587 all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005588
Jim Ingham1460e4b2014-01-10 23:46:59 +00005589 // This isn't going to work if there are unfetched events on the queue.
5590 // Are there cases where we might want to run the remaining events here, and then try to
5591 // call the function? That's probably being too tricky for our own good.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005592
Jim Ingham1460e4b2014-01-10 23:46:59 +00005593 Event *other_events = listener.PeekAtNextEvent();
5594 if (other_events != NULL)
5595 {
5596 errors.Printf("Calling RunThreadPlan with pending events on the queue.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005597 return eExpressionSetupError;
Jim Ingham1460e4b2014-01-10 23:46:59 +00005598 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005599
Jim Ingham1460e4b2014-01-10 23:46:59 +00005600 // We also need to make sure that the next event is delivered. We might be calling a function as part of
5601 // a thread plan, in which case the last delivered event could be the running event, and we don't want
5602 // event coalescing to cause us to lose OUR running event...
5603 ForceNextEventDelivery();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005604
Jim Ingham8559a352012-11-26 23:52:18 +00005605 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
5606 // So don't call return anywhere within it.
Jim Ingham35878c42014-04-08 21:33:21 +00005607
5608#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5609 // It's pretty much impossible to write test cases for things like:
5610 // One thread timeout expires, I go to halt, but the process already stopped
5611 // on the function call stop breakpoint. Turning on this define will make us not
5612 // fetch the first event till after the halt. So if you run a quick function, it will have
5613 // completed, and the completion event will be waiting, when you interrupt for halt.
5614 // The expression evaluation should still succeed.
5615 bool miss_first_event = true;
5616#endif
Jim Inghamfd95f892014-04-22 01:41:52 +00005617 TimeValue one_thread_timeout;
5618 TimeValue final_timeout;
5619
Jim Ingham35878c42014-04-08 21:33:21 +00005620
Sean Callanana46ec452012-07-11 21:31:24 +00005621 while (1)
5622 {
5623 // We usually want to resume the process if we get to the top of the loop.
5624 // The only exception is if we get two running events with no intervening
5625 // stop, which can happen, we will just wait for then next stop event.
Jim Ingham0161b492013-02-09 01:29:05 +00005626 if (log)
5627 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.",
5628 do_resume,
5629 handle_running_event,
5630 before_first_timeout);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005631
Jim Ingham184e9812013-01-15 02:47:48 +00005632 if (do_resume || handle_running_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005633 {
5634 // Do the initial resume and wait for the running event before going further.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005635
Jim Ingham184e9812013-01-15 02:47:48 +00005636 if (do_resume)
Sean Callanana46ec452012-07-11 21:31:24 +00005637 {
Jim Ingham0161b492013-02-09 01:29:05 +00005638 num_resumes++;
Jim Ingham184e9812013-01-15 02:47:48 +00005639 Error resume_error = PrivateResume ();
5640 if (!resume_error.Success())
5641 {
Jim Ingham0161b492013-02-09 01:29:05 +00005642 errors.Printf("Error resuming inferior the %d time: \"%s\".\n",
5643 num_resumes,
5644 resume_error.AsCString());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005645 return_value = eExpressionSetupError;
Jim Ingham184e9812013-01-15 02:47:48 +00005646 break;
5647 }
Sean Callanana46ec452012-07-11 21:31:24 +00005648 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005649
Jim Ingham0161b492013-02-09 01:29:05 +00005650 TimeValue resume_timeout = TimeValue::Now();
5651 resume_timeout.OffsetWithMicroSeconds(500000);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005652
Jim Ingham0161b492013-02-09 01:29:05 +00005653 got_event = listener.WaitForEvent(&resume_timeout, event_sp);
Sean Callanana46ec452012-07-11 21:31:24 +00005654 if (!got_event)
5655 {
5656 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005657 log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.",
5658 num_resumes);
Sean Callanana46ec452012-07-11 21:31:24 +00005659
Jim Ingham0161b492013-02-09 01:29:05 +00005660 errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005661 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005662 break;
5663 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005664
Sean Callanana46ec452012-07-11 21:31:24 +00005665 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Ingham0161b492013-02-09 01:29:05 +00005666
Sean Callanana46ec452012-07-11 21:31:24 +00005667 if (stop_state != eStateRunning)
5668 {
Jim Ingham0161b492013-02-09 01:29:05 +00005669 bool restarted = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005670
Jim Ingham0161b492013-02-09 01:29:05 +00005671 if (stop_state == eStateStopped)
5672 {
5673 restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get());
5674 if (log)
5675 log->Printf("Process::RunThreadPlan(): didn't get running event after "
5676 "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).",
5677 num_resumes,
5678 StateAsCString(stop_state),
5679 restarted,
5680 do_resume,
5681 handle_running_event);
5682 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005683
Jim Ingham0161b492013-02-09 01:29:05 +00005684 if (restarted)
5685 {
5686 // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted
5687 // event here. But if I do, the best thing is to Halt and then get out of here.
5688 Halt();
5689 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005690
Jim Ingham35e1bda2012-10-16 21:41:58 +00005691 errors.Printf("Didn't get running event after initial resume, got %s instead.",
5692 StateAsCString(stop_state));
Jim Ingham8646d3c2014-05-05 02:47:44 +00005693 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005694 break;
5695 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005696
Sean Callanana46ec452012-07-11 21:31:24 +00005697 if (log)
5698 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
5699 // We need to call the function synchronously, so spin waiting for it to return.
5700 // If we get interrupted while executing, we're going to lose our context, and
5701 // won't be able to gather the result at this point.
5702 // We set the timeout AFTER the resume, since the resume takes some time and we
5703 // don't want to charge that to the timeout.
Sean Callanana46ec452012-07-11 21:31:24 +00005704 }
Jim Ingham0f16e732011-02-08 05:20:59 +00005705 else
5706 {
Sean Callanana46ec452012-07-11 21:31:24 +00005707 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005708 log->PutCString ("Process::RunThreadPlan(): waiting for next event.");
Jim Ingham0f16e732011-02-08 05:20:59 +00005709 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005710
Jim Ingham0161b492013-02-09 01:29:05 +00005711 if (before_first_timeout)
5712 {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005713 if (options.GetTryAllThreads())
Jim Inghamfd95f892014-04-22 01:41:52 +00005714 {
5715 one_thread_timeout = TimeValue::Now();
5716 one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005717 timeout_ptr = &one_thread_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005718 }
Jim Ingham0161b492013-02-09 01:29:05 +00005719 else
5720 {
5721 if (timeout_usec == 0)
5722 timeout_ptr = NULL;
5723 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005724 {
5725 final_timeout = TimeValue::Now();
5726 final_timeout.OffsetWithMicroSeconds (timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005727 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005728 }
Jim Ingham0161b492013-02-09 01:29:05 +00005729 }
5730 }
5731 else
5732 {
5733 if (timeout_usec == 0)
5734 timeout_ptr = NULL;
5735 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005736 {
5737 final_timeout = TimeValue::Now();
5738 final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005739 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005740 }
Jim Ingham0161b492013-02-09 01:29:05 +00005741 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005742
Jim Ingham0161b492013-02-09 01:29:05 +00005743 do_resume = true;
5744 handle_running_event = true;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005745
Sean Callanana46ec452012-07-11 21:31:24 +00005746 // Now wait for the process to stop again:
Sean Callanana46ec452012-07-11 21:31:24 +00005747 event_sp.reset();
Jim Ingham0f16e732011-02-08 05:20:59 +00005748
Jim Ingham0f16e732011-02-08 05:20:59 +00005749 if (log)
Jim Ingham20829ac2011-08-09 22:24:33 +00005750 {
Sean Callanana46ec452012-07-11 21:31:24 +00005751 if (timeout_ptr)
5752 {
Matt Kopec676a4872013-02-21 23:55:31 +00005753 log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64,
Jim Ingham0161b492013-02-09 01:29:05 +00005754 TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(),
5755 timeout_ptr->GetAsMicroSecondsSinceJan1_1970());
Sean Callanana46ec452012-07-11 21:31:24 +00005756 }
Jim Ingham20829ac2011-08-09 22:24:33 +00005757 else
Sean Callanana46ec452012-07-11 21:31:24 +00005758 {
5759 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
5760 }
5761 }
Jim Ingham35878c42014-04-08 21:33:21 +00005762
5763#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5764 // See comment above...
5765 if (miss_first_event)
5766 {
5767 usleep(1000);
5768 miss_first_event = false;
5769 got_event = false;
5770 }
5771 else
5772#endif
Sean Callanana46ec452012-07-11 21:31:24 +00005773 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005774
Sean Callanana46ec452012-07-11 21:31:24 +00005775 if (got_event)
5776 {
5777 if (event_sp.get())
5778 {
5779 bool keep_going = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005780 if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005781 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005782 Halt();
Jim Ingham8646d3c2014-05-05 02:47:44 +00005783 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005784 errors.Printf ("Execution halted by user interrupt.");
5785 if (log)
5786 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
Jim Ingham0161b492013-02-09 01:29:05 +00005787 break;
Jim Inghamcfc09352012-07-27 23:57:19 +00005788 }
5789 else
5790 {
5791 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5792 if (log)
5793 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005794
Jim Inghamcfc09352012-07-27 23:57:19 +00005795 switch (stop_state)
Sean Callanana46ec452012-07-11 21:31:24 +00005796 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005797 case lldb::eStateStopped:
Sean Callanana46ec452012-07-11 21:31:24 +00005798 {
Jim Ingham0161b492013-02-09 01:29:05 +00005799 // We stopped, figure out what we are going to do now.
Jim Inghamcfc09352012-07-27 23:57:19 +00005800 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
5801 if (!thread_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005802 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005803 // Ooh, our thread has vanished. Unlikely that this was successful execution...
Sean Callanana46ec452012-07-11 21:31:24 +00005804 if (log)
Jim Inghamcfc09352012-07-27 23:57:19 +00005805 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005806 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005807 }
5808 else
5809 {
Jim Ingham0161b492013-02-09 01:29:05 +00005810 // If we were restarted, we just need to go back up to fetch another event.
5811 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
Jim Inghamcfc09352012-07-27 23:57:19 +00005812 {
5813 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005814 {
5815 log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting.");
5816 }
5817 keep_going = true;
5818 do_resume = false;
5819 handle_running_event = true;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005820
Jim Inghamcfc09352012-07-27 23:57:19 +00005821 }
5822 else
5823 {
Jim Ingham0161b492013-02-09 01:29:05 +00005824 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
5825 StopReason stop_reason = eStopReasonInvalid;
5826 if (stop_info_sp)
5827 stop_reason = stop_info_sp->GetStopReason();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005828
Jim Ingham0161b492013-02-09 01:29:05 +00005829 // FIXME: We only check if the stop reason is plan complete, should we make sure that
5830 // it is OUR plan that is complete?
5831 if (stop_reason == eStopReasonPlanComplete)
Jim Ingham184e9812013-01-15 02:47:48 +00005832 {
5833 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005834 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
5835 // Now mark this plan as private so it doesn't get reported as the stop reason
5836 // after this point.
5837 if (thread_plan_sp)
5838 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005839 return_value = eExpressionCompleted;
Jim Ingham184e9812013-01-15 02:47:48 +00005840 }
5841 else
5842 {
Jim Ingham0161b492013-02-09 01:29:05 +00005843 // Something restarted the target, so just wait for it to stop for real.
Jim Ingham184e9812013-01-15 02:47:48 +00005844 if (stop_reason == eStopReasonBreakpoint)
Jim Ingham0161b492013-02-09 01:29:05 +00005845 {
5846 if (log)
5847 log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005848 return_value = eExpressionHitBreakpoint;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005849 if (!options.DoesIgnoreBreakpoints())
Sean Callanan4b388c92013-07-30 19:54:09 +00005850 {
5851 event_to_broadcast_sp = event_sp;
5852 }
Jim Ingham0161b492013-02-09 01:29:05 +00005853 }
Jim Ingham184e9812013-01-15 02:47:48 +00005854 else
Jim Ingham0161b492013-02-09 01:29:05 +00005855 {
5856 if (log)
5857 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005858 if (!options.DoesUnwindOnError())
Sean Callanan4b388c92013-07-30 19:54:09 +00005859 event_to_broadcast_sp = event_sp;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005860 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005861 }
Jim Ingham184e9812013-01-15 02:47:48 +00005862 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005863 }
Sean Callanana46ec452012-07-11 21:31:24 +00005864 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005865 }
5866 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005867
Jim Inghamcfc09352012-07-27 23:57:19 +00005868 case lldb::eStateRunning:
Jim Ingham0161b492013-02-09 01:29:05 +00005869 // This shouldn't really happen, but sometimes we do get two running events without an
5870 // intervening stop, and in that case we should just go back to waiting for the stop.
Jim Inghamcfc09352012-07-27 23:57:19 +00005871 do_resume = false;
5872 keep_going = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005873 handle_running_event = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005874 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005875
Jim Inghamcfc09352012-07-27 23:57:19 +00005876 default:
5877 if (log)
5878 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005879
Jim Inghamcfc09352012-07-27 23:57:19 +00005880 if (stop_state == eStateExited)
5881 event_to_broadcast_sp = event_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005882
Sean Callananbf154da2012-08-08 17:35:10 +00005883 errors.Printf ("Execution stopped with unexpected state.\n");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005884 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005885 break;
5886 }
Sean Callanana46ec452012-07-11 21:31:24 +00005887 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005888
Sean Callanana46ec452012-07-11 21:31:24 +00005889 if (keep_going)
5890 continue;
5891 else
5892 break;
5893 }
5894 else
5895 {
5896 if (log)
5897 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005898 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005899 break;
5900 }
5901 }
5902 else
5903 {
5904 // If we didn't get an event that means we've timed out...
5905 // We will interrupt the process here. Depending on what we were asked to do we will
5906 // either exit, or try with all threads running for the same timeout.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005907
Sean Callanana46ec452012-07-11 21:31:24 +00005908 if (log) {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005909 if (options.GetTryAllThreads())
Sean Callanana46ec452012-07-11 21:31:24 +00005910 {
Jim Ingham0161b492013-02-09 01:29:05 +00005911 if (before_first_timeout)
Jim Inghamfe1c3422014-04-16 02:24:48 +00005912 {
5913 if (timeout_usec != 0)
5914 {
Jim Inghamfe1c3422014-04-16 02:24:48 +00005915 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Jim Inghamfd95f892014-04-22 01:41:52 +00005916 "running for %" PRIu32 " usec with all threads enabled.",
5917 all_threads_timeout_usec);
Jim Inghamfe1c3422014-04-16 02:24:48 +00005918 }
5919 else
5920 {
5921 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Ed Mastee61c7b02014-04-29 17:48:06 +00005922 "running forever with all threads enabled.");
Jim Inghamfe1c3422014-04-16 02:24:48 +00005923 }
5924 }
Sean Callanana46ec452012-07-11 21:31:24 +00005925 else
5926 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
Jason Molenda6a8658a2013-10-27 02:32:23 +00005927 "and timeout: %u timed out, abandoning execution.",
Jim Ingham35e1bda2012-10-16 21:41:58 +00005928 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005929 }
5930 else
Jason Molenda6a8658a2013-10-27 02:32:23 +00005931 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, "
Jim Ingham35e1bda2012-10-16 21:41:58 +00005932 "abandoning execution.",
5933 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005934 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005935
Jim Ingham0161b492013-02-09 01:29:05 +00005936 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target
5937 // could have stopped. That's fine, Halt will figure that out and send the appropriate Stopped event.
5938 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.) In
5939 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's
5940 // stopped event. That's what this while loop does.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005941
Jim Ingham0161b492013-02-09 01:29:05 +00005942 bool back_to_top = true;
5943 uint32_t try_halt_again = 0;
5944 bool do_halt = true;
5945 const uint32_t num_retries = 5;
5946 while (try_halt_again < num_retries)
Sean Callanana46ec452012-07-11 21:31:24 +00005947 {
Jim Ingham0161b492013-02-09 01:29:05 +00005948 Error halt_error;
5949 if (do_halt)
5950 {
5951 if (log)
5952 log->Printf ("Process::RunThreadPlan(): Running Halt.");
5953 halt_error = Halt();
5954 }
5955 if (halt_error.Success())
5956 {
5957 if (log)
5958 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005959
Jim Ingham0161b492013-02-09 01:29:05 +00005960 real_timeout = TimeValue::Now();
5961 real_timeout.OffsetWithMicroSeconds(500000);
5962
5963 got_event = listener.WaitForEvent(&real_timeout, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005964
Jim Ingham0161b492013-02-09 01:29:05 +00005965 if (got_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005966 {
Jim Ingham0161b492013-02-09 01:29:05 +00005967 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5968 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00005969 {
Jim Ingham0161b492013-02-09 01:29:05 +00005970 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
5971 if (stop_state == lldb::eStateStopped
5972 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
5973 log->PutCString (" Event was the Halt interruption event.");
Sean Callanana46ec452012-07-11 21:31:24 +00005974 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005975
Jim Ingham0161b492013-02-09 01:29:05 +00005976 if (stop_state == lldb::eStateStopped)
Sean Callanana46ec452012-07-11 21:31:24 +00005977 {
Jim Ingham0161b492013-02-09 01:29:05 +00005978 // Between the time we initiated the Halt and the time we delivered it, the process could have
5979 // already finished its job. Check that here:
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005980
Jim Ingham0161b492013-02-09 01:29:05 +00005981 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
5982 {
5983 if (log)
5984 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
5985 "Exiting wait loop.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005986 return_value = eExpressionCompleted;
Jim Ingham0161b492013-02-09 01:29:05 +00005987 back_to_top = false;
5988 break;
5989 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005990
Jim Ingham0161b492013-02-09 01:29:05 +00005991 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5992 {
5993 if (log)
5994 log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again... "
5995 "Exiting wait loop.");
5996 try_halt_again++;
5997 do_halt = false;
5998 continue;
5999 }
Sean Callanana46ec452012-07-11 21:31:24 +00006000
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006001 if (!options.GetTryAllThreads())
Jim Ingham0161b492013-02-09 01:29:05 +00006002 {
6003 if (log)
6004 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006005 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00006006 back_to_top = false;
6007 break;
6008 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006009
Jim Ingham0161b492013-02-09 01:29:05 +00006010 if (before_first_timeout)
6011 {
6012 // Set all the other threads to run, and return to the top of the loop, which will continue;
6013 before_first_timeout = false;
6014 thread_plan_sp->SetStopOthers (false);
6015 if (log)
6016 log->PutCString ("Process::RunThreadPlan(): about to resume.");
Sean Callanana46ec452012-07-11 21:31:24 +00006017
Jim Ingham0161b492013-02-09 01:29:05 +00006018 back_to_top = true;
6019 break;
6020 }
6021 else
6022 {
6023 // Running all threads failed, so return Interrupted.
6024 if (log)
6025 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006026 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00006027 back_to_top = false;
6028 break;
6029 }
Sean Callanana46ec452012-07-11 21:31:24 +00006030 }
6031 }
6032 else
Jim Ingham0161b492013-02-09 01:29:05 +00006033 { if (log)
6034 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
6035 "I'm getting out of here passing Interrupted.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006036 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00006037 back_to_top = false;
6038 break;
Sean Callanana46ec452012-07-11 21:31:24 +00006039 }
6040 }
Jim Ingham0161b492013-02-09 01:29:05 +00006041 else
6042 {
6043 try_halt_again++;
6044 continue;
6045 }
Sean Callanana46ec452012-07-11 21:31:24 +00006046 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006047
Jim Ingham0161b492013-02-09 01:29:05 +00006048 if (!back_to_top || try_halt_again > num_retries)
6049 break;
6050 else
6051 continue;
Sean Callanana46ec452012-07-11 21:31:24 +00006052 }
Sean Callanana46ec452012-07-11 21:31:24 +00006053 } // END WAIT LOOP
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006054
Sean Callanana46ec452012-07-11 21:31:24 +00006055 // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
Zachary Turneracee96a2014-09-23 18:32:09 +00006056 if (backup_private_state_thread.IsJoinable())
Sean Callanana46ec452012-07-11 21:31:24 +00006057 {
6058 StopPrivateStateThread();
6059 Error error;
6060 m_private_state_thread = backup_private_state_thread;
Sean Callanan9a028512012-08-09 00:50:26 +00006061 if (stopper_base_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00006062 {
6063 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
6064 }
Jason Molenda76513fd2014-10-15 23:39:31 +00006065 if (old_state != eStateInvalid)
6066 m_public_state.SetValueNoLock(old_state);
Sean Callanana46ec452012-07-11 21:31:24 +00006067 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006068
Jim Ingham184e9812013-01-15 02:47:48 +00006069 // Restore the thread state if we are going to discard the plan execution. There are three cases where this
6070 // could happen:
6071 // 1) The execution successfully completed
6072 // 2) We hit a breakpoint, and ignore_breakpoints was true
6073 // 3) We got some other error, and discard_on_error was true
Jim Ingham8646d3c2014-05-05 02:47:44 +00006074 bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError())
6075 || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints());
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006076
Jim Ingham8646d3c2014-05-05 02:47:44 +00006077 if (return_value == eExpressionCompleted
Jim Ingham184e9812013-01-15 02:47:48 +00006078 || should_unwind)
Jim Ingham8559a352012-11-26 23:52:18 +00006079 {
6080 thread_plan_sp->RestoreThreadState();
6081 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006082
Sean Callanana46ec452012-07-11 21:31:24 +00006083 // Now do some processing on the results of the run:
Jim Ingham8646d3c2014-05-05 02:47:44 +00006084 if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint)
Sean Callanana46ec452012-07-11 21:31:24 +00006085 {
6086 if (log)
6087 {
6088 StreamString s;
6089 if (event_sp)
6090 event_sp->Dump (&s);
6091 else
6092 {
6093 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
6094 }
6095
6096 StreamString ts;
6097
6098 const char *event_explanation = NULL;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006099
Sean Callanana46ec452012-07-11 21:31:24 +00006100 do
6101 {
Jim Inghamcfc09352012-07-27 23:57:19 +00006102 if (!event_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00006103 {
Jim Inghamcfc09352012-07-27 23:57:19 +00006104 event_explanation = "<no event>";
Sean Callanana46ec452012-07-11 21:31:24 +00006105 break;
6106 }
Jim Inghamcfc09352012-07-27 23:57:19 +00006107 else if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00006108 {
Jim Inghamcfc09352012-07-27 23:57:19 +00006109 event_explanation = "<user interrupt>";
Sean Callanana46ec452012-07-11 21:31:24 +00006110 break;
6111 }
Jim Inghamcfc09352012-07-27 23:57:19 +00006112 else
Sean Callanana46ec452012-07-11 21:31:24 +00006113 {
Jim Inghamcfc09352012-07-27 23:57:19 +00006114 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
6115
6116 if (!event_data)
Sean Callanana46ec452012-07-11 21:31:24 +00006117 {
Jim Inghamcfc09352012-07-27 23:57:19 +00006118 event_explanation = "<no event data>";
6119 break;
Sean Callanana46ec452012-07-11 21:31:24 +00006120 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006121
Jim Inghamcfc09352012-07-27 23:57:19 +00006122 Process *process = event_data->GetProcessSP().get();
6123
6124 if (!process)
Sean Callanana46ec452012-07-11 21:31:24 +00006125 {
Jim Inghamcfc09352012-07-27 23:57:19 +00006126 event_explanation = "<no process>";
6127 break;
Sean Callanana46ec452012-07-11 21:31:24 +00006128 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006129
Jim Inghamcfc09352012-07-27 23:57:19 +00006130 ThreadList &thread_list = process->GetThreadList();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006131
Jim Inghamcfc09352012-07-27 23:57:19 +00006132 uint32_t num_threads = thread_list.GetSize();
6133 uint32_t thread_index;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006134
Jim Inghamcfc09352012-07-27 23:57:19 +00006135 ts.Printf("<%u threads> ", num_threads);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006136
Jim Inghamcfc09352012-07-27 23:57:19 +00006137 for (thread_index = 0;
6138 thread_index < num_threads;
6139 ++thread_index)
6140 {
6141 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006142
Jim Inghamcfc09352012-07-27 23:57:19 +00006143 if (!thread)
6144 {
6145 ts.Printf("<?> ");
6146 continue;
6147 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006148
Daniel Malead01b2952012-11-29 21:49:15 +00006149 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00006150 RegisterContext *register_context = thread->GetRegisterContext().get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006151
Jim Inghamcfc09352012-07-27 23:57:19 +00006152 if (register_context)
Daniel Malead01b2952012-11-29 21:49:15 +00006153 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
Jim Inghamcfc09352012-07-27 23:57:19 +00006154 else
6155 ts.Printf("[ip unknown] ");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006156
Jim Inghamcfc09352012-07-27 23:57:19 +00006157 lldb::StopInfoSP stop_info_sp = thread->GetStopInfo();
6158 if (stop_info_sp)
6159 {
6160 const char *stop_desc = stop_info_sp->GetDescription();
6161 if (stop_desc)
6162 ts.PutCString (stop_desc);
6163 }
6164 ts.Printf(">");
6165 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006166
Jim Inghamcfc09352012-07-27 23:57:19 +00006167 event_explanation = ts.GetData();
Sean Callanana46ec452012-07-11 21:31:24 +00006168 }
Sean Callanana46ec452012-07-11 21:31:24 +00006169 } while (0);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006170
Jim Inghamcfc09352012-07-27 23:57:19 +00006171 if (event_explanation)
6172 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
Sean Callanana46ec452012-07-11 21:31:24 +00006173 else
Jim Inghamcfc09352012-07-27 23:57:19 +00006174 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
6175 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006176
Jim Inghame4483cf2013-09-27 01:13:01 +00006177 if (should_unwind)
Jim Inghamcfc09352012-07-27 23:57:19 +00006178 {
6179 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006180 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.",
6181 static_cast<void*>(thread_plan_sp.get()));
Jim Inghamcfc09352012-07-27 23:57:19 +00006182 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6183 thread_plan_sp->SetPrivate (orig_plan_private);
6184 }
6185 else
6186 {
6187 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006188 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.",
6189 static_cast<void*>(thread_plan_sp.get()));
Sean Callanana46ec452012-07-11 21:31:24 +00006190 }
6191 }
Jim Ingham8646d3c2014-05-05 02:47:44 +00006192 else if (return_value == eExpressionSetupError)
Sean Callanana46ec452012-07-11 21:31:24 +00006193 {
6194 if (log)
6195 log->PutCString("Process::RunThreadPlan(): execution set up error.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006196
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006197 if (options.DoesUnwindOnError())
Jim Ingham0f16e732011-02-08 05:20:59 +00006198 {
Greg Claytonc14ee322011-09-22 04:58:26 +00006199 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Ingham4b536182011-08-09 02:12:22 +00006200 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Ingham0f16e732011-02-08 05:20:59 +00006201 }
Jim Inghamf48169b2010-11-30 02:22:11 +00006202 }
6203 else
6204 {
Sean Callanana46ec452012-07-11 21:31:24 +00006205 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
Jim Inghamf48169b2010-11-30 02:22:11 +00006206 {
Jim Ingham0f16e732011-02-08 05:20:59 +00006207 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00006208 log->PutCString("Process::RunThreadPlan(): thread plan is done");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006209 return_value = eExpressionCompleted;
Sean Callanana46ec452012-07-11 21:31:24 +00006210 }
6211 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
6212 {
6213 if (log)
6214 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006215 return_value = eExpressionDiscarded;
Sean Callanana46ec452012-07-11 21:31:24 +00006216 }
6217 else
6218 {
6219 if (log)
6220 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006221 if (options.DoesUnwindOnError() && thread_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00006222 {
6223 if (log)
Jim Ingham184e9812013-01-15 02:47:48 +00006224 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
Sean Callanana46ec452012-07-11 21:31:24 +00006225 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6226 thread_plan_sp->SetPrivate (orig_plan_private);
6227 }
6228 }
6229 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006230
Sean Callanana46ec452012-07-11 21:31:24 +00006231 // Thread we ran the function in may have gone away because we ran the target
6232 // Check that it's still there, and if it is put it back in the context. Also restore the
6233 // frame in the context if it is still present.
6234 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
6235 if (thread)
6236 {
6237 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
6238 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006239
Sean Callanana46ec452012-07-11 21:31:24 +00006240 // Also restore the current process'es selected frame & thread, since this function calling may
6241 // be done behind the user's back.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006242
Sean Callanana46ec452012-07-11 21:31:24 +00006243 if (selected_tid != LLDB_INVALID_THREAD_ID)
6244 {
6245 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
6246 {
6247 // We were able to restore the selected thread, now restore the frame:
Daniel Maleaa012d3a2013-07-31 20:21:20 +00006248 Mutex::Locker lock(GetThreadList().GetMutex());
Jason Molendab57e4a12013-11-04 09:33:30 +00006249 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
Sean Callanana46ec452012-07-11 21:31:24 +00006250 if (old_frame_sp)
6251 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
Jim Inghamf48169b2010-11-30 02:22:11 +00006252 }
Jim Inghamf48169b2010-11-30 02:22:11 +00006253 }
6254 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006255
Sean Callanana46ec452012-07-11 21:31:24 +00006256 // If the process exited during the run of the thread plan, notify everyone.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006257
Sean Callanana46ec452012-07-11 21:31:24 +00006258 if (event_to_broadcast_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00006259 {
Sean Callanana46ec452012-07-11 21:31:24 +00006260 if (log)
6261 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
6262 BroadcastEvent(event_to_broadcast_sp);
Jim Inghamf48169b2010-11-30 02:22:11 +00006263 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006264
Jim Inghamf48169b2010-11-30 02:22:11 +00006265 return return_value;
6266}
6267
6268const char *
Jim Ingham1624a2d2014-05-05 02:26:40 +00006269Process::ExecutionResultAsCString (ExpressionResults result)
Jim Inghamf48169b2010-11-30 02:22:11 +00006270{
6271 const char *result_name;
6272
6273 switch (result)
6274 {
Jim Ingham8646d3c2014-05-05 02:47:44 +00006275 case eExpressionCompleted:
6276 result_name = "eExpressionCompleted";
Jim Inghamf48169b2010-11-30 02:22:11 +00006277 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006278 case eExpressionDiscarded:
6279 result_name = "eExpressionDiscarded";
Jim Inghamf48169b2010-11-30 02:22:11 +00006280 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006281 case eExpressionInterrupted:
6282 result_name = "eExpressionInterrupted";
Jim Inghamf48169b2010-11-30 02:22:11 +00006283 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006284 case eExpressionHitBreakpoint:
6285 result_name = "eExpressionHitBreakpoint";
Jim Ingham184e9812013-01-15 02:47:48 +00006286 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006287 case eExpressionSetupError:
6288 result_name = "eExpressionSetupError";
Jim Inghamf48169b2010-11-30 02:22:11 +00006289 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006290 case eExpressionParseError:
6291 result_name = "eExpressionParseError";
Jim Ingham1624a2d2014-05-05 02:26:40 +00006292 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006293 case eExpressionResultUnavailable:
6294 result_name = "eExpressionResultUnavailable";
Jim Ingham1624a2d2014-05-05 02:26:40 +00006295 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006296 case eExpressionTimedOut:
6297 result_name = "eExpressionTimedOut";
Jim Inghamf48169b2010-11-30 02:22:11 +00006298 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006299 case eExpressionStoppedForDebug:
6300 result_name = "eExpressionStoppedForDebug";
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006301 break;
Jim Inghamf48169b2010-11-30 02:22:11 +00006302 }
6303 return result_name;
6304}
6305
Greg Clayton7260f622011-04-18 08:33:37 +00006306void
6307Process::GetStatus (Stream &strm)
6308{
6309 const StateType state = GetState();
Greg Clayton2637f822011-11-17 01:23:07 +00006310 if (StateIsStoppedState(state, false))
Greg Clayton7260f622011-04-18 08:33:37 +00006311 {
6312 if (state == eStateExited)
6313 {
6314 int exit_status = GetExitStatus();
6315 const char *exit_description = GetExitDescription();
Daniel Malead01b2952012-11-29 21:49:15 +00006316 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
Greg Clayton7260f622011-04-18 08:33:37 +00006317 GetID(),
6318 exit_status,
6319 exit_status,
6320 exit_description ? exit_description : "");
6321 }
6322 else
6323 {
6324 if (state == eStateConnected)
6325 strm.Printf ("Connected to remote target.\n");
6326 else
Daniel Malead01b2952012-11-29 21:49:15 +00006327 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
Greg Clayton7260f622011-04-18 08:33:37 +00006328 }
6329 }
6330 else
6331 {
Daniel Malead01b2952012-11-29 21:49:15 +00006332 strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
Greg Clayton7260f622011-04-18 08:33:37 +00006333 }
6334}
6335
6336size_t
6337Process::GetThreadStatus (Stream &strm,
6338 bool only_threads_with_stop_reason,
6339 uint32_t start_frame,
6340 uint32_t num_frames,
6341 uint32_t num_frames_with_source)
6342{
6343 size_t num_thread_infos_dumped = 0;
6344
Jim Ingham4a65fb12014-03-07 11:20:03 +00006345 // You can't hold the thread list lock while calling Thread::GetStatus. That very well might run code (e.g. if we need it
6346 // to get return values or arguments.) For that to work the process has to be able to acquire it. So instead copy the thread
6347 // ID's, and look them up one by one:
6348
6349 uint32_t num_threads;
Greg Clayton332e8b12015-01-13 21:13:08 +00006350 std::vector<lldb::tid_t> thread_id_array;
Jim Ingham4a65fb12014-03-07 11:20:03 +00006351 //Scope for thread list locker;
6352 {
6353 Mutex::Locker locker (GetThreadList().GetMutex());
6354 ThreadList &curr_thread_list = GetThreadList();
6355 num_threads = curr_thread_list.GetSize();
6356 uint32_t idx;
Greg Clayton332e8b12015-01-13 21:13:08 +00006357 thread_id_array.resize(num_threads);
Jim Ingham4a65fb12014-03-07 11:20:03 +00006358 for (idx = 0; idx < num_threads; ++idx)
Greg Clayton332e8b12015-01-13 21:13:08 +00006359 thread_id_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID();
Jim Ingham4a65fb12014-03-07 11:20:03 +00006360 }
6361
Greg Clayton7260f622011-04-18 08:33:37 +00006362 for (uint32_t i = 0; i < num_threads; i++)
6363 {
Greg Clayton332e8b12015-01-13 21:13:08 +00006364 ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_id_array[i]));
Jim Ingham4a65fb12014-03-07 11:20:03 +00006365 if (thread_sp)
Greg Clayton7260f622011-04-18 08:33:37 +00006366 {
6367 if (only_threads_with_stop_reason)
6368 {
Jim Ingham4a65fb12014-03-07 11:20:03 +00006369 StopInfoSP stop_info_sp = thread_sp->GetStopInfo();
Jim Ingham5d88a062012-10-16 00:09:33 +00006370 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
Greg Clayton7260f622011-04-18 08:33:37 +00006371 continue;
6372 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00006373 thread_sp->GetStatus (strm,
Greg Clayton7260f622011-04-18 08:33:37 +00006374 start_frame,
6375 num_frames,
6376 num_frames_with_source);
6377 ++num_thread_infos_dumped;
6378 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00006379 else
6380 {
6381 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
6382 if (log)
6383 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus.");
6384
6385 }
Greg Clayton7260f622011-04-18 08:33:37 +00006386 }
6387 return num_thread_infos_dumped;
6388}
6389
Greg Claytona9f40ad2012-02-22 04:37:26 +00006390void
6391Process::AddInvalidMemoryRegion (const LoadRange &region)
6392{
6393 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
6394}
6395
6396bool
6397Process::RemoveInvalidMemoryRange (const LoadRange &region)
6398{
6399 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
6400}
6401
Jim Ingham372787f2012-04-07 00:00:41 +00006402void
6403Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
6404{
6405 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
6406}
6407
6408bool
6409Process::RunPreResumeActions ()
6410{
6411 bool result = true;
6412 while (!m_pre_resume_actions.empty())
6413 {
6414 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
6415 m_pre_resume_actions.pop_back();
6416 bool this_result = action.callback (action.baton);
Jason Molenda55710932014-11-17 20:10:15 +00006417 if (result == true)
6418 result = this_result;
Jim Ingham372787f2012-04-07 00:00:41 +00006419 }
6420 return result;
6421}
6422
6423void
6424Process::ClearPreResumeActions ()
6425{
6426 m_pre_resume_actions.clear();
6427}
Greg Claytona9f40ad2012-02-22 04:37:26 +00006428
Zachary Turner93749ab2015-03-03 21:51:25 +00006429ProcessRunLock &
6430Process::GetRunLock()
6431{
6432 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
6433 return m_private_run_lock;
6434 else
6435 return m_public_run_lock;
6436}
6437
Greg Claytonfa559e52012-05-18 02:38:05 +00006438void
6439Process::Flush ()
6440{
6441 m_thread_list.Flush();
Jason Molenda5e8dce42013-12-13 00:29:16 +00006442 m_extended_thread_list.Flush();
6443 m_extended_thread_stop_id = 0;
6444 m_queue_list.Clear();
6445 m_queue_list_stop_id = 0;
Greg Claytonfa559e52012-05-18 02:38:05 +00006446}
Greg Clayton90ba8112012-12-05 00:16:59 +00006447
6448void
6449Process::DidExec ()
6450{
Todd Fiala76e0fc92014-08-27 22:58:26 +00006451 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
6452 if (log)
6453 log->Printf ("Process::%s()", __FUNCTION__);
6454
Greg Clayton90ba8112012-12-05 00:16:59 +00006455 Target &target = GetTarget();
6456 target.CleanupProcess ();
Greg Claytonb35db632013-11-09 00:03:31 +00006457 target.ClearModules(false);
Greg Clayton90ba8112012-12-05 00:16:59 +00006458 m_dynamic_checkers_ap.reset();
6459 m_abi_sp.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00006460 m_system_runtime_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00006461 m_os_ap.reset();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006462 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00006463 m_jit_loaders_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00006464 m_image_tokens.clear();
6465 m_allocated_memory_cache.Clear();
6466 m_language_runtimes.clear();
Kuba Breckaafdf8422014-10-10 23:43:03 +00006467 m_instrumentation_runtimes.clear();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006468 m_thread_list.DiscardThreadPlans();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006469 m_memory_cache.Clear(true);
Greg Claytona97c4d22014-12-09 23:31:02 +00006470 m_stop_info_override_callback = NULL;
Greg Clayton90ba8112012-12-05 00:16:59 +00006471 DoDidExec();
6472 CompleteAttach ();
Greg Clayton095eeaa2013-11-05 23:28:00 +00006473 // Flush the process (threads and all stack frames) after running CompleteAttach()
6474 // in case the dynamic loader loaded things in new locations.
6475 Flush();
Greg Claytonb35db632013-11-09 00:03:31 +00006476
6477 // After we figure out what was loaded/unloaded in CompleteAttach,
6478 // we need to let the target know so it can do any cleanup it needs to.
6479 target.DidExec();
Greg Clayton90ba8112012-12-05 00:16:59 +00006480}
Greg Clayton095eeaa2013-11-05 23:28:00 +00006481
Jim Ingham1460e4b2014-01-10 23:46:59 +00006482addr_t
6483Process::ResolveIndirectFunction(const Address *address, Error &error)
6484{
6485 if (address == nullptr)
6486 {
Jean-Daniel Dupasef37711f2014-02-08 20:22:05 +00006487 error.SetErrorString("Invalid address argument");
Jim Ingham1460e4b2014-01-10 23:46:59 +00006488 return LLDB_INVALID_ADDRESS;
6489 }
6490
6491 addr_t function_addr = LLDB_INVALID_ADDRESS;
6492
6493 addr_t addr = address->GetLoadAddress(&GetTarget());
6494 std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr);
6495 if (iter != m_resolved_indirect_addresses.end())
6496 {
6497 function_addr = (*iter).second;
6498 }
6499 else
6500 {
6501 if (!InferiorCall(this, address, function_addr))
6502 {
6503 Symbol *symbol = address->CalculateSymbolContextSymbol();
6504 error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s",
6505 symbol ? symbol->GetName().AsCString() : "<UNKNOWN>");
6506 function_addr = LLDB_INVALID_ADDRESS;
6507 }
6508 else
6509 {
6510 m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr));
6511 }
6512 }
6513 return function_addr;
6514}
6515
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006516void
6517Process::ModulesDidLoad (ModuleList &module_list)
6518{
Kuba Breckaafdf8422014-10-10 23:43:03 +00006519 SystemRuntime *sys_runtime = GetSystemRuntime();
6520 if (sys_runtime)
6521 {
6522 sys_runtime->ModulesDidLoad (module_list);
6523 }
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006524
Kuba Breckaafdf8422014-10-10 23:43:03 +00006525 GetJITLoaders().ModulesDidLoad (module_list);
6526
6527 // Give runtimes a chance to be created.
6528 InstrumentationRuntime::ModulesDidLoad(module_list, this, m_instrumentation_runtimes);
6529
6530 // Tell runtimes about new modules.
6531 for (auto pos = m_instrumentation_runtimes.begin(); pos != m_instrumentation_runtimes.end(); ++pos)
6532 {
6533 InstrumentationRuntimeSP runtime = pos->second;
6534 runtime->ModulesDidLoad(module_list);
6535 }
6536
Greg Clayton35ca64b2015-04-16 17:13:34 +00006537 // Let any language runtimes we have already created know
6538 // about the modules that loaded.
6539
6540 // Iterate over a copy of this language runtime list in case
6541 // the language runtime ModulesDidLoad somehow causes the language
6542 // riuntime to be unloaded.
6543 LanguageRuntimeCollection language_runtimes(m_language_runtimes);
6544 for (const auto &pair: language_runtimes)
6545 {
6546 // We must check language_runtime_sp to make sure it is not
6547 // NULL as we might cache the fact that we didn't have a
6548 // language runtime for a language.
6549 LanguageRuntimeSP language_runtime_sp = pair.second;
6550 if (language_runtime_sp)
6551 language_runtime_sp->ModulesDidLoad(module_list);
6552 }
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006553}
Kuba Breckaa51ea382014-09-06 01:33:13 +00006554
Jason Molendaef7d6412015-08-06 03:27:10 +00006555void
6556Process::PrintWarning (uint64_t warning_type, void *repeat_key, const char *fmt, ...)
6557{
6558 bool print_warning = true;
6559
6560 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
6561 if (stream_sp.get() == nullptr)
6562 return;
6563 if (warning_type == eWarningsOptimization
6564 && GetWarningsOptimization() == false)
6565 {
6566 return;
6567 }
6568
6569 if (repeat_key != nullptr)
6570 {
6571 WarningsCollection::iterator it = m_warnings_issued.find (warning_type);
6572 if (it == m_warnings_issued.end())
6573 {
6574 m_warnings_issued[warning_type] = WarningsPointerSet();
6575 m_warnings_issued[warning_type].insert (repeat_key);
6576 }
6577 else
6578 {
6579 if (it->second.find (repeat_key) != it->second.end())
6580 {
6581 print_warning = false;
6582 }
6583 else
6584 {
6585 it->second.insert (repeat_key);
6586 }
6587 }
6588 }
6589
6590 if (print_warning)
6591 {
6592 va_list args;
6593 va_start (args, fmt);
6594 stream_sp->PrintfVarArg (fmt, args);
6595 va_end (args);
6596 }
6597}
6598
Jason Molenda484900b2015-08-10 07:55:25 +00006599void
6600Process::PrintWarningOptimization (const SymbolContext &sc)
6601{
6602 if (GetWarningsOptimization() == true
6603 && sc.module_sp.get()
6604 && sc.module_sp->GetFileSpec().GetFilename().IsEmpty() == false
6605 && sc.function
6606 && sc.function->GetIsOptimized() == true)
6607 {
6608 PrintWarning (Process::Warnings::eWarningsOptimization, sc.module_sp.get(), "%s was compiled with optimization - stepping may behave oddly; variables may not be available.\n", sc.module_sp->GetFileSpec().GetFilename().GetCString());
6609 }
6610}
6611
Kuba Breckaa51ea382014-09-06 01:33:13 +00006612ThreadCollectionSP
6613Process::GetHistoryThreads(lldb::addr_t addr)
6614{
6615 ThreadCollectionSP threads;
Greg Clayton35ca64b2015-04-16 17:13:34 +00006616
Kuba Breckaa51ea382014-09-06 01:33:13 +00006617 const MemoryHistorySP &memory_history = MemoryHistory::FindPlugin(shared_from_this());
6618
6619 if (! memory_history.get()) {
6620 return threads;
6621 }
6622
6623 threads.reset(new ThreadCollection(memory_history->GetHistoryThreads(addr)));
6624
6625 return threads;
6626}
Kuba Brecka63927542014-10-11 01:59:32 +00006627
6628InstrumentationRuntimeSP
6629Process::GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type)
6630{
6631 InstrumentationRuntimeCollection::iterator pos;
6632 pos = m_instrumentation_runtimes.find (type);
6633 if (pos == m_instrumentation_runtimes.end())
6634 {
6635 return InstrumentationRuntimeSP();
6636 }
6637 else
6638 return (*pos).second;
6639}
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +00006640
6641bool
6642Process::GetModuleSpec(const FileSpec& module_file_spec,
6643 const ArchSpec& arch,
6644 ModuleSpec& module_spec)
6645{
6646 module_spec.Clear();
6647 return false;
6648}