blob: 27970d7804a500e901de71dc1c8cf68812ec82c6 [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
Eugene Zelenko8f30a652015-10-23 18:39:37 +000010// C Includes
11// C++ Includes
12// Other libraries and framework includes
13// Project includes
Chris Lattner30fdc8d2010-06-08 16:52:24 +000014#include "lldb/Target/Process.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000015#include "lldb/Breakpoint/StoppointCallbackContext.h"
16#include "lldb/Breakpoint/BreakpointLocation.h"
17#include "lldb/Core/Event.h"
18#include "lldb/Core/Debugger.h"
19#include "lldb/Core/Log.h"
Greg Clayton1f746072012-08-29 21:13:06 +000020#include "lldb/Core/Module.h"
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +000021#include "lldb/Core/ModuleSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000022#include "lldb/Core/PluginManager.h"
23#include "lldb/Core/State.h"
Greg Clayton44d93782014-01-27 23:43:24 +000024#include "lldb/Core/StreamFile.h"
Jim Ingham151c0322015-09-15 21:13:50 +000025#include "lldb/Expression/UserExpression.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000026#include "lldb/Expression/IRDynamicChecks.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000027#include "lldb/Host/ConnectionFileDescriptor.h"
Zachary Turner4eff2d32015-10-14 21:37:36 +000028#include "lldb/Host/FileSystem.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000029#include "lldb/Host/Host.h"
Zachary Turner39de3112014-09-09 20:54:56 +000030#include "lldb/Host/HostInfo.h"
Greg Clayton100eb932014-07-02 21:10:39 +000031#include "lldb/Host/Pipe.h"
Greg Clayton44d93782014-01-27 23:43:24 +000032#include "lldb/Host/Terminal.h"
Zachary Turner39de3112014-09-09 20:54:56 +000033#include "lldb/Host/ThreadLauncher.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000034#include "lldb/Interpreter/CommandInterpreter.h"
Zachary Turner633a29c2015-03-04 01:58:01 +000035#include "lldb/Interpreter/OptionValueProperties.h"
Jason Molenda484900b2015-08-10 07:55:25 +000036#include "lldb/Symbol/Function.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000037#include "lldb/Symbol/Symbol.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000038#include "lldb/Target/ABI.h"
Greg Clayton8f343b02010-11-04 01:54:29 +000039#include "lldb/Target/DynamicLoader.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000040#include "lldb/Target/InstrumentationRuntime.h"
Andrew MacPherson17220c12014-03-05 10:12:43 +000041#include "lldb/Target/JITLoader.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000042#include "lldb/Target/JITLoaderList.h"
Kuba Breckaa51ea382014-09-06 01:33:13 +000043#include "lldb/Target/MemoryHistory.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000044#include "lldb/Target/MemoryRegionInfo.h"
Greg Clayton56d9a1b2011-08-22 02:49:39 +000045#include "lldb/Target/OperatingSystem.h"
Jim Ingham22777012010-09-23 02:01:19 +000046#include "lldb/Target/LanguageRuntime.h"
47#include "lldb/Target/CPPLanguageRuntime.h"
48#include "lldb/Target/ObjCLanguageRuntime.h"
Greg Claytone996fd32011-03-08 22:40:15 +000049#include "lldb/Target/Platform.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000050#include "lldb/Target/RegisterContext.h"
Greg Claytonf4b47e12010-08-04 01:40:35 +000051#include "lldb/Target/StopInfo.h"
Jason Molendaeef51062013-11-05 03:57:19 +000052#include "lldb/Target/SystemRuntime.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000053#include "lldb/Target/Target.h"
54#include "lldb/Target/TargetList.h"
55#include "lldb/Target/Thread.h"
56#include "lldb/Target/ThreadPlan.h"
Jim Ingham076b3042012-04-10 01:21:57 +000057#include "lldb/Target/ThreadPlanBase.h"
Zachary Turner93749ab2015-03-03 21:51:25 +000058#include "lldb/Target/UnixSignals.h"
Zachary Turner50232572015-03-18 21:31:45 +000059#include "lldb/Utility/NameMatches.h"
Jim Ingham1460e4b2014-01-10 23:46:59 +000060#include "Plugins/Process/Utility/InferiorCallPOSIX.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000061
62using namespace lldb;
63using namespace lldb_private;
64
Greg Clayton67cc0632012-08-22 17:17:09 +000065// Comment out line below to disable memory caching, overriding the process setting
66// target.process.disable-memory-cache
67#define ENABLE_MEMORY_CACHING
68
69#ifdef ENABLE_MEMORY_CACHING
70#define DISABLE_MEM_CACHE_DEFAULT false
71#else
72#define DISABLE_MEM_CACHE_DEFAULT true
73#endif
74
75class ProcessOptionValueProperties : public OptionValueProperties
76{
77public:
78 ProcessOptionValueProperties (const ConstString &name) :
79 OptionValueProperties (name)
80 {
81 }
82
83 // This constructor is used when creating ProcessOptionValueProperties when it
84 // is part of a new lldb_private::Process instance. It will copy all current
85 // global property values as needed
86 ProcessOptionValueProperties (ProcessProperties *global_properties) :
87 OptionValueProperties(*global_properties->GetValueProperties())
88 {
89 }
90
Eugene Zelenko8f30a652015-10-23 18:39:37 +000091 const Property *
92 GetPropertyAtIndex(const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const override
Greg Clayton67cc0632012-08-22 17:17:09 +000093 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +000094 // When getting the value for a key from the process options, we will always
Greg Clayton67cc0632012-08-22 17:17:09 +000095 // try and grab the setting from the current process if there is one. Else we just
96 // use the one from this instance.
97 if (exe_ctx)
98 {
99 Process *process = exe_ctx->GetProcessPtr();
100 if (process)
101 {
102 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
103 if (this != instance_properties)
104 return instance_properties->ProtectedGetPropertyAtIndex (idx);
105 }
106 }
107 return ProtectedGetPropertyAtIndex (idx);
108 }
109};
110
111static PropertyDefinition
112g_properties[] =
113{
114 { "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 +0000115 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used. "
116 "For instance, to turn on debugserver logging set this to \"QSetLogging:bitmask=LOG_DEFAULT;\"" },
Jim Inghamafc1b122013-01-31 19:48:57 +0000117 { "ignore-breakpoints-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, breakpoints will be ignored during expression evaluation." },
118 { "unwind-on-error-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, errors in expression evaluation will unwind the stack back to the state before the call." },
Greg Claytone1e835c2012-11-29 18:48:47 +0000119 { "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 +0000120 { "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 +0000121 { "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 +0000122 { "memory-cache-line-size" , OptionValue::eTypeUInt64, false, 512, NULL, NULL, "The memory cache line size" },
Jason Molendaef7d6412015-08-06 03:27:10 +0000123 { "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 +0000124 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
125};
126
127enum {
128 ePropertyDisableMemCache,
Greg Claytonc9d645d2012-10-18 22:40:37 +0000129 ePropertyExtraStartCommand,
Jim Ingham184e9812013-01-15 02:47:48 +0000130 ePropertyIgnoreBreakpointsInExpressions,
131 ePropertyUnwindOnErrorInExpressions,
Jim Ingham29950772013-01-26 02:19:28 +0000132 ePropertyPythonOSPluginPath,
Jim Inghamacff8952013-05-02 00:27:30 +0000133 ePropertyStopOnSharedLibraryEvents,
Jason Molendaf0340c92014-09-03 22:30:54 +0000134 ePropertyDetachKeepsStopped,
Jason Molendaef7d6412015-08-06 03:27:10 +0000135 ePropertyMemCacheLineSize,
136 ePropertyWarningOptimization
Greg Clayton67cc0632012-08-22 17:17:09 +0000137};
138
Greg Clayton332e8b12015-01-13 21:13:08 +0000139ProcessProperties::ProcessProperties (lldb_private::Process *process) :
140 Properties (),
141 m_process (process) // Can be NULL for global ProcessProperties
Greg Clayton67cc0632012-08-22 17:17:09 +0000142{
Greg Clayton332e8b12015-01-13 21:13:08 +0000143 if (process == NULL)
Greg Clayton67cc0632012-08-22 17:17:09 +0000144 {
Greg Clayton332e8b12015-01-13 21:13:08 +0000145 // Global process properties, set them up one time
Greg Clayton67cc0632012-08-22 17:17:09 +0000146 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
147 m_collection_sp->Initialize(g_properties);
148 m_collection_sp->AppendProperty(ConstString("thread"),
Jim Ingham29950772013-01-26 02:19:28 +0000149 ConstString("Settings specific to threads."),
Greg Clayton67cc0632012-08-22 17:17:09 +0000150 true,
151 Thread::GetGlobalProperties()->GetValueProperties());
152 }
153 else
Greg Clayton332e8b12015-01-13 21:13:08 +0000154 {
Greg Clayton67cc0632012-08-22 17:17:09 +0000155 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
Greg Clayton332e8b12015-01-13 21:13:08 +0000156 m_collection_sp->SetValueChangedCallback(ePropertyPythonOSPluginPath, ProcessProperties::OptionValueChangedCallback, this);
157 }
Greg Clayton67cc0632012-08-22 17:17:09 +0000158}
159
Eugene Zelenko8f30a652015-10-23 18:39:37 +0000160ProcessProperties::~ProcessProperties() = default;
Greg Clayton67cc0632012-08-22 17:17:09 +0000161
Greg Clayton332e8b12015-01-13 21:13:08 +0000162void
163ProcessProperties::OptionValueChangedCallback (void *baton, OptionValue *option_value)
164{
165 ProcessProperties *properties = (ProcessProperties *)baton;
166 if (properties->m_process)
167 properties->m_process->LoadOperatingSystemPlugin(true);
168}
169
Greg Clayton67cc0632012-08-22 17:17:09 +0000170bool
171ProcessProperties::GetDisableMemoryCache() const
172{
173 const uint32_t idx = ePropertyDisableMemCache;
174 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
175}
176
Jason Molendaf0340c92014-09-03 22:30:54 +0000177uint64_t
178ProcessProperties::GetMemoryCacheLineSize() const
179{
180 const uint32_t idx = ePropertyMemCacheLineSize;
181 return m_collection_sp->GetPropertyAtIndexAsUInt64 (NULL, idx, g_properties[idx].default_uint_value);
182}
183
Greg Clayton67cc0632012-08-22 17:17:09 +0000184Args
185ProcessProperties::GetExtraStartupCommands () const
186{
187 Args args;
188 const uint32_t idx = ePropertyExtraStartCommand;
189 m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
190 return args;
191}
192
193void
194ProcessProperties::SetExtraStartupCommands (const Args &args)
195{
196 const uint32_t idx = ePropertyExtraStartCommand;
197 m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
198}
199
Greg Claytonc9d645d2012-10-18 22:40:37 +0000200FileSpec
201ProcessProperties::GetPythonOSPluginPath () const
202{
203 const uint32_t idx = ePropertyPythonOSPluginPath;
204 return m_collection_sp->GetPropertyAtIndexAsFileSpec(NULL, idx);
205}
206
207void
208ProcessProperties::SetPythonOSPluginPath (const FileSpec &file)
209{
210 const uint32_t idx = ePropertyPythonOSPluginPath;
211 m_collection_sp->SetPropertyAtIndexAsFileSpec(NULL, idx, file);
212}
213
Jim Ingham184e9812013-01-15 02:47:48 +0000214bool
215ProcessProperties::GetIgnoreBreakpointsInExpressions () const
216{
217 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
218 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
219}
220
221void
222ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore)
223{
224 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
225 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
226}
227
228bool
229ProcessProperties::GetUnwindOnErrorInExpressions () const
230{
231 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
232 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
233}
234
235void
236ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore)
237{
238 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
239 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
240}
241
Jim Ingham29950772013-01-26 02:19:28 +0000242bool
243ProcessProperties::GetStopOnSharedLibraryEvents () const
244{
245 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
246 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
247}
248
249void
250ProcessProperties::SetStopOnSharedLibraryEvents (bool stop)
251{
252 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
253 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
254}
255
Jim Inghamacff8952013-05-02 00:27:30 +0000256bool
257ProcessProperties::GetDetachKeepsStopped () const
258{
259 const uint32_t idx = ePropertyDetachKeepsStopped;
260 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
261}
262
263void
264ProcessProperties::SetDetachKeepsStopped (bool stop)
265{
266 const uint32_t idx = ePropertyDetachKeepsStopped;
267 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
268}
269
Jason Molendaef7d6412015-08-06 03:27:10 +0000270bool
271ProcessProperties::GetWarningsOptimization () const
272{
273 const uint32_t idx = ePropertyWarningOptimization;
274 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
275}
276
Greg Clayton32e0a752011-03-30 18:16:51 +0000277void
Greg Clayton8b82f082011-04-12 05:54:46 +0000278ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000279{
280 const char *cstr;
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000281 if (m_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malead01b2952012-11-29 21:49:15 +0000282 s.Printf (" pid = %" PRIu64 "\n", m_pid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000283
284 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malead01b2952012-11-29 21:49:15 +0000285 s.Printf (" parent = %" PRIu64 "\n", m_parent_pid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000286
287 if (m_executable)
288 {
289 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
290 s.PutCString (" file = ");
291 m_executable.Dump(&s);
292 s.EOL();
293 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000294 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000295 if (argc > 0)
296 {
297 for (uint32_t i=0; i<argc; i++)
298 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000299 const char *arg = m_arguments.GetArgumentAtIndex(i);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000300 if (i < 10)
Greg Clayton8b82f082011-04-12 05:54:46 +0000301 s.Printf (" arg[%u] = %s\n", i, arg);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000302 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000303 s.Printf ("arg[%u] = %s\n", i, arg);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000304 }
305 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000306
307 const uint32_t envc = m_environment.GetArgumentCount();
308 if (envc > 0)
309 {
310 for (uint32_t i=0; i<envc; i++)
311 {
312 const char *env = m_environment.GetArgumentAtIndex(i);
313 if (i < 10)
314 s.Printf (" env[%u] = %s\n", i, env);
315 else
316 s.Printf ("env[%u] = %s\n", i, env);
317 }
318 }
319
Todd Fiala7df337f2015-10-13 23:41:19 +0000320 if (m_arch.IsValid())
321 {
322 s.Printf (" arch = ");
323 m_arch.DumpTriple(s);
324 s.EOL();
325 }
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000326
Greg Clayton8b82f082011-04-12 05:54:46 +0000327 if (m_uid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000328 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000329 cstr = platform->GetUserName (m_uid);
330 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000331 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000332 if (m_gid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000333 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000334 cstr = platform->GetGroupName (m_gid);
335 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000336 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000337 if (m_euid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000338 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000339 cstr = platform->GetUserName (m_euid);
340 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000341 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000342 if (m_egid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000343 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000344 cstr = platform->GetGroupName (m_egid);
345 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000346 }
347}
348
349void
Greg Clayton8b82f082011-04-12 05:54:46 +0000350ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
Greg Clayton32e0a752011-03-30 18:16:51 +0000351{
Greg Clayton8b82f082011-04-12 05:54:46 +0000352 const char *label;
353 if (show_args || verbose)
354 label = "ARGUMENTS";
355 else
356 label = "NAME";
357
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000358 if (verbose)
359 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000360 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000361 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
362 }
363 else
364 {
Jim Ingham368ac222014-08-15 17:05:27 +0000365 s.Printf ("PID PARENT USER TRIPLE %s\n", label);
366 s.PutCString ("====== ====== ========== ======================== ============================\n");
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000367 }
Greg Clayton32e0a752011-03-30 18:16:51 +0000368}
369
370void
Greg Clayton8b82f082011-04-12 05:54:46 +0000371ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000372{
373 if (m_pid != LLDB_INVALID_PROCESS_ID)
374 {
375 const char *cstr;
Daniel Malead01b2952012-11-29 21:49:15 +0000376 s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000377
Todd Fiala7df337f2015-10-13 23:41:19 +0000378 StreamString arch_strm;
379 if (m_arch.IsValid())
380 m_arch.DumpTriple(arch_strm);
381
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000382 if (verbose)
383 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000384 cstr = platform->GetUserName (m_uid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000385 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
386 s.Printf ("%-10s ", cstr);
387 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000388 s.Printf ("%-10u ", m_uid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000389
Greg Clayton8b82f082011-04-12 05:54:46 +0000390 cstr = platform->GetGroupName (m_gid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000391 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
392 s.Printf ("%-10s ", cstr);
393 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000394 s.Printf ("%-10u ", m_gid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000395
Greg Clayton8b82f082011-04-12 05:54:46 +0000396 cstr = platform->GetUserName (m_euid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000397 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
398 s.Printf ("%-10s ", cstr);
399 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000400 s.Printf ("%-10u ", m_euid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000401
Greg Clayton8b82f082011-04-12 05:54:46 +0000402 cstr = platform->GetGroupName (m_egid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000403 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
404 s.Printf ("%-10s ", cstr);
405 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000406 s.Printf ("%-10u ", m_egid);
Todd Fiala7df337f2015-10-13 23:41:19 +0000407
408 s.Printf ("%-24s ", arch_strm.GetString().c_str());
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000409 }
410 else
411 {
Jim Ingham368ac222014-08-15 17:05:27 +0000412 s.Printf ("%-10s %-24s ",
Greg Clayton8b82f082011-04-12 05:54:46 +0000413 platform->GetUserName (m_euid),
Todd Fiala7df337f2015-10-13 23:41:19 +0000414 arch_strm.GetString().c_str());
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000415 }
416
Greg Clayton8b82f082011-04-12 05:54:46 +0000417 if (verbose || show_args)
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000418 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000419 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000420 if (argc > 0)
421 {
422 for (uint32_t i=0; i<argc; i++)
423 {
424 if (i > 0)
425 s.PutChar (' ');
Greg Clayton8b82f082011-04-12 05:54:46 +0000426 s.PutCString (m_arguments.GetArgumentAtIndex(i));
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000427 }
428 }
429 }
430 else
431 {
432 s.PutCString (GetName());
433 }
434
435 s.EOL();
Greg Clayton32e0a752011-03-30 18:16:51 +0000436 }
437}
438
Greg Clayton8b82f082011-04-12 05:54:46 +0000439Error
Greg Claytonf6b8b582011-04-13 00:18:08 +0000440ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
Greg Clayton8b82f082011-04-12 05:54:46 +0000441{
442 Error error;
Greg Clayton3bcdfc02012-12-04 00:32:51 +0000443 const int short_option = m_getopt_table[option_idx].val;
Greg Clayton8b82f082011-04-12 05:54:46 +0000444
445 switch (short_option)
446 {
447 case 's': // Stop at program entry point
448 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
449 break;
450
Greg Clayton8b82f082011-04-12 05:54:46 +0000451 case 'i': // STDIN for read only
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000452 {
453 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000454 if (action.Open(STDIN_FILENO, FileSpec{option_arg, false}, true, false))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000455 launch_info.AppendFileAction (action);
Greg Clayton8b82f082011-04-12 05:54:46 +0000456 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000457 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000458
459 case 'o': // Open STDOUT for write only
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000460 {
461 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000462 if (action.Open(STDOUT_FILENO, FileSpec{option_arg, false}, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000463 launch_info.AppendFileAction (action);
Greg Clayton9845a8d2012-03-06 04:01:04 +0000464 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000465 }
Greg Clayton9845a8d2012-03-06 04:01:04 +0000466
467 case 'e': // STDERR for write only
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000468 {
469 FileAction action;
Chaoren Lind3173f32015-05-29 19:52:29 +0000470 if (action.Open(STDERR_FILENO, FileSpec{option_arg, false}, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000471 launch_info.AppendFileAction (action);
Greg Clayton8b82f082011-04-12 05:54:46 +0000472 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000473 }
Greg Clayton9845a8d2012-03-06 04:01:04 +0000474
Greg Clayton8b82f082011-04-12 05:54:46 +0000475 case 'p': // Process plug-in name
476 launch_info.SetProcessPluginName (option_arg);
477 break;
478
479 case 'n': // Disable STDIO
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000480 {
481 FileAction action;
Zachary Turner4eff2d32015-10-14 21:37:36 +0000482 const FileSpec dev_null{FileSystem::DEV_NULL, false};
Chaoren Lind3173f32015-05-29 19:52:29 +0000483 if (action.Open(STDIN_FILENO, dev_null, true, false))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000484 launch_info.AppendFileAction (action);
Chaoren Lind3173f32015-05-29 19:52:29 +0000485 if (action.Open(STDOUT_FILENO, dev_null, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000486 launch_info.AppendFileAction (action);
Chaoren Lind3173f32015-05-29 19:52:29 +0000487 if (action.Open(STDERR_FILENO, dev_null, false, true))
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000488 launch_info.AppendFileAction (action);
Greg Clayton8b82f082011-04-12 05:54:46 +0000489 break;
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000490 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000491
492 case 'w':
Chaoren Lind3173f32015-05-29 19:52:29 +0000493 launch_info.SetWorkingDirectory(FileSpec{option_arg, false});
Greg Clayton8b82f082011-04-12 05:54:46 +0000494 break;
495
496 case 't': // Open process in new terminal window
497 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
498 break;
499
500 case 'a':
Greg Clayton70512312012-05-08 01:45:38 +0000501 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
502 launch_info.GetArchitecture().SetTriple (option_arg);
Greg Clayton8b82f082011-04-12 05:54:46 +0000503 break;
504
Todd Fiala51637922014-08-19 17:40:43 +0000505 case 'A': // Disable ASLR.
506 {
507 bool success;
508 const bool disable_aslr_arg = Args::StringToBoolean (option_arg, true, &success);
509 if (success)
510 disable_aslr = disable_aslr_arg ? eLazyBoolYes : eLazyBoolNo;
511 else
512 error.SetErrorStringWithFormat ("Invalid boolean value for disable-aslr option: '%s'", option_arg ? option_arg : "<null>");
Greg Clayton8b82f082011-04-12 05:54:46 +0000513 break;
Todd Fiala51637922014-08-19 17:40:43 +0000514 }
515
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000516 case 'X': // shell expand args.
Enrico Granatad7a83a92015-02-10 03:06:24 +0000517 {
518 bool success;
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000519 const bool expand_args = Args::StringToBoolean (option_arg, true, &success);
Enrico Granatad7a83a92015-02-10 03:06:24 +0000520 if (success)
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000521 launch_info.SetShellExpandArguments(expand_args);
Enrico Granatad7a83a92015-02-10 03:06:24 +0000522 else
Enrico Granatab38ef8c2015-02-20 22:20:30 +0000523 error.SetErrorStringWithFormat ("Invalid boolean value for shell-expand-args option: '%s'", option_arg ? option_arg : "<null>");
Enrico Granatad7a83a92015-02-10 03:06:24 +0000524 break;
525 }
526
Todd Fiala51637922014-08-19 17:40:43 +0000527 case 'c':
Greg Clayton144f3a92011-11-15 03:53:30 +0000528 if (option_arg && option_arg[0])
Zachary Turner10687b02014-10-20 17:46:43 +0000529 launch_info.SetShell (FileSpec(option_arg, false));
Greg Clayton144f3a92011-11-15 03:53:30 +0000530 else
Zachary Turner10687b02014-10-20 17:46:43 +0000531 launch_info.SetShell (HostInfo::GetDefaultShell());
Greg Clayton982c9762011-11-03 21:22:33 +0000532 break;
533
Greg Clayton8b82f082011-04-12 05:54:46 +0000534 case 'v':
535 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
536 break;
537
538 default:
Greg Clayton86edbf42011-10-26 00:56:27 +0000539 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
Greg Clayton8b82f082011-04-12 05:54:46 +0000540 break;
Greg Clayton8b82f082011-04-12 05:54:46 +0000541 }
542 return error;
543}
544
545OptionDefinition
546ProcessLaunchCommandOptions::g_option_table[] =
547{
Zachary Turnerd37221d2014-07-09 16:31:49 +0000548{ 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 +0000549{ 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 +0000550{ LLDB_OPT_SET_ALL, false, "plugin", 'p', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
551{ LLDB_OPT_SET_ALL, false, "working-dir", 'w', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeDirectoryName, "Set the current working directory to <path> when running the inferior."},
552{ LLDB_OPT_SET_ALL, false, "arch", 'a', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
553{ LLDB_OPT_SET_ALL, false, "environment", 'v', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeNone, "Specify an environment variable name/value string (--environment NAME=VALUE). Can be specified multiple times for subsequent environment entries."},
Enrico Granatad7a83a92015-02-10 03:06:24 +0000554{ 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 +0000555
Zachary Turnerd37221d2014-07-09 16:31:49 +0000556{ LLDB_OPT_SET_1 , false, "stdin", 'i', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdin for the process to <filename>."},
557{ LLDB_OPT_SET_1 , false, "stdout", 'o', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdout for the process to <filename>."},
558{ LLDB_OPT_SET_1 , false, "stderr", 'e', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stderr for the process to <filename>."},
Greg Clayton8b82f082011-04-12 05:54:46 +0000559
Zachary Turnerd37221d2014-07-09 16:31:49 +0000560{ 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 +0000561
Zachary Turnerd37221d2014-07-09 16:31:49 +0000562{ 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 +0000563{ 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 +0000564{ 0 , false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
Greg Clayton8b82f082011-04-12 05:54:46 +0000565};
566
Greg Clayton8b82f082011-04-12 05:54:46 +0000567bool
568ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000569{
570 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
571 return true;
572 const char *match_name = m_match_info.GetName();
573 if (!match_name)
574 return true;
575
576 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
577}
578
579bool
Greg Clayton8b82f082011-04-12 05:54:46 +0000580ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000581{
582 if (!NameMatches (proc_info.GetName()))
583 return false;
584
585 if (m_match_info.ProcessIDIsValid() &&
586 m_match_info.GetProcessID() != proc_info.GetProcessID())
587 return false;
588
589 if (m_match_info.ParentProcessIDIsValid() &&
590 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
591 return false;
592
Greg Clayton8b82f082011-04-12 05:54:46 +0000593 if (m_match_info.UserIDIsValid () &&
594 m_match_info.GetUserID() != proc_info.GetUserID())
Greg Clayton32e0a752011-03-30 18:16:51 +0000595 return false;
596
Greg Clayton8b82f082011-04-12 05:54:46 +0000597 if (m_match_info.GroupIDIsValid () &&
598 m_match_info.GetGroupID() != proc_info.GetGroupID())
Greg Clayton32e0a752011-03-30 18:16:51 +0000599 return false;
600
601 if (m_match_info.EffectiveUserIDIsValid () &&
602 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
603 return false;
604
605 if (m_match_info.EffectiveGroupIDIsValid () &&
606 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
607 return false;
608
609 if (m_match_info.GetArchitecture().IsValid() &&
Sean Callananbf4b7be2012-12-13 22:07:14 +0000610 !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture()))
Greg Clayton32e0a752011-03-30 18:16:51 +0000611 return false;
612 return true;
613}
614
615bool
Greg Clayton8b82f082011-04-12 05:54:46 +0000616ProcessInstanceInfoMatch::MatchAllProcesses () const
Greg Clayton32e0a752011-03-30 18:16:51 +0000617{
618 if (m_name_match_type != eNameMatchIgnore)
619 return false;
620
621 if (m_match_info.ProcessIDIsValid())
622 return false;
623
624 if (m_match_info.ParentProcessIDIsValid())
625 return false;
626
Greg Clayton8b82f082011-04-12 05:54:46 +0000627 if (m_match_info.UserIDIsValid ())
Greg Clayton32e0a752011-03-30 18:16:51 +0000628 return false;
629
Greg Clayton8b82f082011-04-12 05:54:46 +0000630 if (m_match_info.GroupIDIsValid ())
Greg Clayton32e0a752011-03-30 18:16:51 +0000631 return false;
632
633 if (m_match_info.EffectiveUserIDIsValid ())
634 return false;
635
636 if (m_match_info.EffectiveGroupIDIsValid ())
637 return false;
638
639 if (m_match_info.GetArchitecture().IsValid())
640 return false;
641
642 if (m_match_all_users)
643 return false;
644
645 return true;
Greg Clayton32e0a752011-03-30 18:16:51 +0000646}
647
648void
Greg Clayton8b82f082011-04-12 05:54:46 +0000649ProcessInstanceInfoMatch::Clear()
Greg Clayton32e0a752011-03-30 18:16:51 +0000650{
651 m_match_info.Clear();
652 m_name_match_type = eNameMatchIgnore;
653 m_match_all_users = false;
654}
Greg Clayton58be07b2011-01-07 06:08:19 +0000655
Greg Claytonc3776bf2012-02-09 06:16:32 +0000656ProcessSP
Zachary Turner7529df92015-09-01 20:02:29 +0000657Process::FindPlugin (lldb::TargetSP target_sp, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000658{
Greg Clayton949e8222013-01-16 17:29:04 +0000659 static uint32_t g_process_unique_id = 0;
660
Greg Claytonc3776bf2012-02-09 06:16:32 +0000661 ProcessSP process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000662 ProcessCreateInstance create_callback = NULL;
663 if (plugin_name)
664 {
Greg Clayton57abc5d2013-05-10 21:47:16 +0000665 ConstString const_plugin_name(plugin_name);
666 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (const_plugin_name);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000667 if (create_callback)
668 {
Zachary Turner7529df92015-09-01 20:02:29 +0000669 process_sp = create_callback(target_sp, listener, crash_file_path);
Greg Claytonc3776bf2012-02-09 06:16:32 +0000670 if (process_sp)
671 {
Zachary Turner7529df92015-09-01 20:02:29 +0000672 if (process_sp->CanDebug(target_sp, true))
Greg Clayton949e8222013-01-16 17:29:04 +0000673 {
674 process_sp->m_process_unique_id = ++g_process_unique_id;
675 }
676 else
Greg Claytonc3776bf2012-02-09 06:16:32 +0000677 process_sp.reset();
678 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000679 }
680 }
681 else
682 {
Greg Claytonc982c762010-07-09 20:39:50 +0000683 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000684 {
Zachary Turner7529df92015-09-01 20:02:29 +0000685 process_sp = create_callback(target_sp, listener, crash_file_path);
Greg Claytonc3776bf2012-02-09 06:16:32 +0000686 if (process_sp)
687 {
Zachary Turner7529df92015-09-01 20:02:29 +0000688 if (process_sp->CanDebug(target_sp, false))
Greg Clayton949e8222013-01-16 17:29:04 +0000689 {
690 process_sp->m_process_unique_id = ++g_process_unique_id;
Greg Claytonc3776bf2012-02-09 06:16:32 +0000691 break;
Greg Clayton949e8222013-01-16 17:29:04 +0000692 }
693 else
694 process_sp.reset();
Greg Claytonc3776bf2012-02-09 06:16:32 +0000695 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000696 }
697 }
Greg Claytonc3776bf2012-02-09 06:16:32 +0000698 return process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000699}
700
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000701ConstString &
702Process::GetStaticBroadcasterClass ()
703{
704 static ConstString class_name ("lldb.process");
705 return class_name;
706}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000707
Zachary Turner7529df92015-09-01 20:02:29 +0000708Process::Process(lldb::TargetSP target_sp, Listener &listener) :
709 Process(target_sp, listener, UnixSignals::Create(HostInfo::GetArchitecture()))
Todd Fiala4ceced32014-08-29 17:35:57 +0000710{
711 // This constructor just delegates to the full Process constructor,
712 // defaulting to using the Host's UnixSignals.
713}
714
Zachary Turner7529df92015-09-01 20:02:29 +0000715Process::Process(lldb::TargetSP target_sp, Listener &listener, const UnixSignalsSP &unix_signals_sp) :
Greg Clayton332e8b12015-01-13 21:13:08 +0000716 ProcessProperties (this),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000717 UserID (LLDB_INVALID_PROCESS_ID),
Zachary Turner7529df92015-09-01 20:02:29 +0000718 Broadcaster (&(target_sp->GetDebugger()), Process::GetStaticBroadcasterClass().AsCString()),
719 m_target_sp (target_sp),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000720 m_public_state (eStateUnloaded),
721 m_private_state (eStateUnloaded),
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000722 m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
723 m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000724 m_private_state_listener ("lldb.process.internal_state_listener"),
725 m_private_state_control_wait(),
Jim Ingham4b536182011-08-09 02:12:22 +0000726 m_mod_id (),
Greg Clayton949e8222013-01-16 17:29:04 +0000727 m_process_unique_id(0),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000728 m_thread_index_id (0),
Han Ming Ongc2c423e2013-01-08 22:10:01 +0000729 m_thread_id_to_index_id_map (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000730 m_exit_status (-1),
731 m_exit_string (),
Todd Fiala7b0917a2014-09-15 20:07:33 +0000732 m_exit_status_mutex(),
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000733 m_thread_mutex (Mutex::eMutexTypeRecursive),
734 m_thread_list_real (this),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000735 m_thread_list (this),
Jason Molenda864f1cc2013-11-11 05:20:44 +0000736 m_extended_thread_list (this),
Jason Molenda4ff13262013-11-20 00:31:38 +0000737 m_extended_thread_stop_id (0),
Jason Molenda5e8dce42013-12-13 00:29:16 +0000738 m_queue_list (this),
739 m_queue_list_stop_id (0),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000740 m_notifications (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000741 m_image_tokens (),
742 m_listener (listener),
743 m_breakpoint_site_list (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000744 m_dynamic_checkers_ap (),
Todd Fiala4ceced32014-08-29 17:35:57 +0000745 m_unix_signals_sp (unix_signals_sp),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000746 m_abi_sp (),
Caroline Ticeef5c6d02010-11-16 05:07:41 +0000747 m_process_input_reader (),
Greg Clayton3e06bd92011-01-09 21:07:35 +0000748 m_stdio_communication ("process.stdio"),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000749 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
Vince Harrondf3f00f2015-02-10 21:09:04 +0000750 m_stdin_forward (false),
Greg Clayton58be07b2011-01-07 06:08:19 +0000751 m_stdout_data (),
Greg Clayton93e86192011-11-13 04:45:22 +0000752 m_stderr_data (),
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000753 m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive),
754 m_profile_data (),
Pavel Labath44464872015-05-27 12:40:32 +0000755 m_iohandler_sync (0),
Greg Claytond495c532011-05-17 03:37:42 +0000756 m_memory_cache (*this),
757 m_allocated_memory_cache (*this),
Greg Claytone24c4ac2011-11-17 04:46:02 +0000758 m_should_detach (false),
Sean Callanan90539452011-09-20 23:01:51 +0000759 m_next_event_action_ap(),
Greg Clayton96249852013-04-18 16:57:27 +0000760 m_public_run_lock (),
Greg Clayton96249852013-04-18 16:57:27 +0000761 m_private_run_lock (),
Pavel Labath00fea632015-12-01 17:59:56 +0000762 m_currently_handling_event(false),
Greg Claytona97c4d22014-12-09 23:31:02 +0000763 m_stop_info_override_callback (NULL),
Greg Claytonc00ca312015-04-02 18:44:58 +0000764 m_finalizing (false),
765 m_finalize_called (false),
Greg Claytonf9b57b92013-05-10 23:48:10 +0000766 m_clear_thread_plans_on_stop (false),
Greg Claytonc00ca312015-04-02 18:44:58 +0000767 m_force_next_event_delivery (false),
Jim Ingham0161b492013-02-09 01:29:05 +0000768 m_last_broadcast_state (eStateInvalid),
Jason Molenda69b6b632013-03-05 03:33:59 +0000769 m_destroy_in_process (false),
Ewan Crawford90ff7912015-07-14 10:56:58 +0000770 m_can_interpret_function_calls(false),
Jason Molendaef7d6412015-08-06 03:27:10 +0000771 m_warnings_issued (),
Jason Molenda69b6b632013-03-05 03:33:59 +0000772 m_can_jit(eCanJITDontKnow)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000773{
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000774 CheckInWithManager ();
Caroline Tice1559a462010-09-27 00:30:10 +0000775
Greg Clayton5160ce52013-03-27 23:08:40 +0000776 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000777 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000778 log->Printf ("%p Process::Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000779
Todd Fiala4ceced32014-08-29 17:35:57 +0000780 if (!m_unix_signals_sp)
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000781 m_unix_signals_sp = std::make_shared<UnixSignals>();
Todd Fiala4ceced32014-08-29 17:35:57 +0000782
Greg Claytoncfd1ace2010-10-31 03:01:06 +0000783 SetEventName (eBroadcastBitStateChanged, "state-changed");
784 SetEventName (eBroadcastBitInterrupt, "interrupt");
785 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
786 SetEventName (eBroadcastBitSTDERR, "stderr-available");
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000787 SetEventName (eBroadcastBitProfileData, "profile-data-available");
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000788
Greg Clayton35a4cc52012-10-29 20:52:08 +0000789 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" );
790 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
791 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
792
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000793 listener.StartListeningForEvents (this,
794 eBroadcastBitStateChanged |
795 eBroadcastBitInterrupt |
796 eBroadcastBitSTDOUT |
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000797 eBroadcastBitSTDERR |
798 eBroadcastBitProfileData);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000799
800 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +0000801 eBroadcastBitStateChanged |
802 eBroadcastBitInterrupt);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000803
804 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
805 eBroadcastInternalStateControlStop |
806 eBroadcastInternalStateControlPause |
807 eBroadcastInternalStateControlResume);
Todd Fiala4ceced32014-08-29 17:35:57 +0000808 // We need something valid here, even if just the default UnixSignalsSP.
809 assert (m_unix_signals_sp && "null m_unix_signals_sp after initialization");
Pavel Labathf2991482015-10-20 10:33:17 +0000810
811 // Allow the platform to override the default cache line size
812 OptionValueSP value_sp =
813 m_collection_sp->GetPropertyAtIndex(nullptr, true, ePropertyMemCacheLineSize)->GetValue();
814 uint32_t platform_cache_line_size = target_sp->GetPlatform()->GetDefaultMemoryCacheLineSize();
815 if (! value_sp->OptionWasSet() && platform_cache_line_size != 0)
816 value_sp->SetUInt64Value(platform_cache_line_size);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000817}
818
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000819Process::~Process()
820{
Greg Clayton5160ce52013-03-27 23:08:40 +0000821 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000822 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000823 log->Printf ("%p Process::~Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000824 StopPrivateStateThread();
Zachary Turner39de3112014-09-09 20:54:56 +0000825
826 // ThreadList::Clear() will try to acquire this process's mutex, so
827 // explicitly clear the thread list here to ensure that the mutex
828 // is not destroyed before the thread list.
829 m_thread_list.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000830}
831
Greg Clayton67cc0632012-08-22 17:17:09 +0000832const ProcessPropertiesSP &
833Process::GetGlobalProperties()
834{
835 static ProcessPropertiesSP g_settings_sp;
836 if (!g_settings_sp)
Greg Clayton332e8b12015-01-13 21:13:08 +0000837 g_settings_sp.reset (new ProcessProperties (NULL));
Greg Clayton67cc0632012-08-22 17:17:09 +0000838 return g_settings_sp;
839}
840
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000841void
842Process::Finalize()
843{
Greg Claytonc00ca312015-04-02 18:44:58 +0000844 m_finalizing = true;
845
Ilia Kc7efd562015-03-26 07:40:40 +0000846 // Destroy this process if needed
847 switch (GetPrivateState())
848 {
849 case eStateConnected:
850 case eStateAttaching:
851 case eStateLaunching:
852 case eStateStopped:
853 case eStateRunning:
854 case eStateStepping:
855 case eStateCrashed:
856 case eStateSuspended:
Jason Molendaede31932015-04-17 05:01:58 +0000857 Destroy(false);
Ilia Kc7efd562015-03-26 07:40:40 +0000858 break;
859
860 case eStateInvalid:
861 case eStateUnloaded:
862 case eStateDetached:
863 case eStateExited:
864 break;
865 }
Greg Claytone24c4ac2011-11-17 04:46:02 +0000866
Greg Clayton1ed54f52011-10-01 00:45:15 +0000867 // Clear our broadcaster before we proceed with destroying
868 Broadcaster::Clear();
869
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000870 // Do any cleanup needed prior to being destructed... Subclasses
871 // that override this method should call this superclass method as well.
Jim Inghamd0a3e122011-02-16 17:54:55 +0000872
873 // We need to destroy the loader before the derived Process class gets destroyed
874 // since it is very likely that undoing the loader will require access to the real process.
Greg Clayton894f82f2012-01-20 23:08:34 +0000875 m_dynamic_checkers_ap.reset();
876 m_abi_sp.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +0000877 m_os_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +0000878 m_system_runtime_ap.reset();
Greg Clayton894f82f2012-01-20 23:08:34 +0000879 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +0000880 m_jit_loaders_ap.reset();
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000881 m_thread_list_real.Destroy();
Greg Claytone1cd1be2012-01-29 20:56:30 +0000882 m_thread_list.Destroy();
Jason Molenda864f1cc2013-11-11 05:20:44 +0000883 m_extended_thread_list.Destroy();
Jason Molenda5e8dce42013-12-13 00:29:16 +0000884 m_queue_list.Clear();
885 m_queue_list_stop_id = 0;
Greg Clayton894f82f2012-01-20 23:08:34 +0000886 std::vector<Notifications> empty_notifications;
887 m_notifications.swap(empty_notifications);
888 m_image_tokens.clear();
889 m_memory_cache.Clear();
890 m_allocated_memory_cache.Clear();
891 m_language_runtimes.clear();
Kuba Breckaafdf8422014-10-10 23:43:03 +0000892 m_instrumentation_runtimes.clear();
Greg Clayton894f82f2012-01-20 23:08:34 +0000893 m_next_event_action_ap.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +0000894 m_stop_info_override_callback = NULL;
Greg Clayton08765fa2015-05-28 03:24:30 +0000895 // Clear the last natural stop ID since it has a strong
896 // reference to this process
897 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
Greg Clayton35a4cc52012-10-29 20:52:08 +0000898//#ifdef LLDB_CONFIGURATION_DEBUG
899// StreamFile s(stdout, false);
900// EventSP event_sp;
901// while (m_private_state_listener.GetNextEvent(event_sp))
902// {
903// event_sp->Dump (&s);
904// s.EOL();
905// }
906//#endif
907 // We have to be very careful here as the m_private_state_listener might
908 // contain events that have ProcessSP values in them which can keep this
909 // process around forever. These events need to be cleared out.
910 m_private_state_listener.Clear();
Ed Maste64fad602013-07-29 20:58:06 +0000911 m_public_run_lock.TrySetRunning(); // This will do nothing if already locked
912 m_public_run_lock.SetStopped();
913 m_private_run_lock.TrySetRunning(); // This will do nothing if already locked
914 m_private_run_lock.SetStopped();
Jim Ingham4fc6cb92012-08-22 21:34:33 +0000915 m_finalize_called = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000916}
917
918void
919Process::RegisterNotificationCallbacks (const Notifications& callbacks)
920{
921 m_notifications.push_back(callbacks);
922 if (callbacks.initialize != NULL)
923 callbacks.initialize (callbacks.baton, this);
924}
925
926bool
927Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
928{
929 std::vector<Notifications>::iterator pos, end = m_notifications.end();
930 for (pos = m_notifications.begin(); pos != end; ++pos)
931 {
932 if (pos->baton == callbacks.baton &&
933 pos->initialize == callbacks.initialize &&
934 pos->process_state_changed == callbacks.process_state_changed)
935 {
936 m_notifications.erase(pos);
937 return true;
938 }
939 }
940 return false;
941}
942
943void
944Process::SynchronouslyNotifyStateChanged (StateType state)
945{
946 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
947 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
948 {
949 if (notification_pos->process_state_changed)
950 notification_pos->process_state_changed (notification_pos->baton, this, state);
951 }
952}
953
954// FIXME: We need to do some work on events before the general Listener sees them.
955// For instance if we are continuing from a breakpoint, we need to ensure that we do
956// the little "insert real insn, step & stop" trick. But we can't do that when the
957// event is delivered by the broadcaster - since that is done on the thread that is
958// waiting for new events, so if we needed more than one event for our handling, we would
959// stall. So instead we do it when we fetch the event off of the queue.
960//
961
962StateType
963Process::GetNextEvent (EventSP &event_sp)
964{
965 StateType state = eStateInvalid;
966
967 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
968 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
969
970 return state;
971}
972
Pavel Labath44464872015-05-27 12:40:32 +0000973void
974Process::SyncIOHandler (uint32_t iohandler_id, uint64_t timeout_msec)
Todd Fialaa3b89e22014-08-12 14:33:19 +0000975{
Todd Fialaa3b89e22014-08-12 14:33:19 +0000976 // don't sync (potentially context switch) in case where there is no process IO
Pavel Labath44464872015-05-27 12:40:32 +0000977 if (! m_process_input_reader)
978 return;
Todd Fialaa3b89e22014-08-12 14:33:19 +0000979
Pavel Labath44464872015-05-27 12:40:32 +0000980 TimeValue timeout = TimeValue::Now();
981 timeout.OffsetWithMicroSeconds(timeout_msec*1000);
982 uint32_t new_iohandler_id = 0;
983 m_iohandler_sync.WaitForValueNotEqualTo(iohandler_id, new_iohandler_id, &timeout);
Todd Fialaa3b89e22014-08-12 14:33:19 +0000984
Pavel Labath44464872015-05-27 12:40:32 +0000985 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
986 if (log)
987 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 +0000988}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000989
990StateType
Greg Claytondc6224e2014-10-21 01:00:42 +0000991Process::WaitForProcessToStop (const TimeValue *timeout,
992 EventSP *event_sp_ptr,
993 bool wait_always,
994 Listener *hijack_listener,
Pavel Labath00fea632015-12-01 17:59:56 +0000995 Stream *stream)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000996{
Jim Ingham4b536182011-08-09 02:12:22 +0000997 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
998 // We have to actually check each event, and in the case of a stopped event check the restarted flag
999 // on the event.
Greg Clayton85fb1b92012-09-11 02:33:37 +00001000 if (event_sp_ptr)
1001 event_sp_ptr->reset();
Jim Ingham4b536182011-08-09 02:12:22 +00001002 StateType state = GetState();
1003 // If we are exited or detached, we won't ever get back to any
1004 // other valid state...
1005 if (state == eStateDetached || state == eStateExited)
1006 return state;
1007
Daniel Malea9e9919f2013-10-09 16:56:28 +00001008 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1009 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001010 log->Printf ("Process::%s (timeout = %p)", __FUNCTION__,
1011 static_cast<const void*>(timeout));
Daniel Malea9e9919f2013-10-09 16:56:28 +00001012
1013 if (!wait_always &&
1014 StateIsStoppedState(state, true) &&
Jim Ingham5b4c5eb2015-04-22 17:48:24 +00001015 StateIsStoppedState(GetPrivateState(), true))
1016 {
Daniel Malea9e9919f2013-10-09 16:56:28 +00001017 if (log)
1018 log->Printf("Process::%s returning without waiting for events; process private and public states are already 'stopped'.",
1019 __FUNCTION__);
Pavel Labath78521ef2015-03-06 10:52:47 +00001020 // We need to toggle the run lock as this won't get done in
1021 // SetPublicState() if the process is hijacked.
Pavel Labath00fea632015-12-01 17:59:56 +00001022 if (hijack_listener)
Pavel Labath78521ef2015-03-06 10:52:47 +00001023 m_public_run_lock.SetStopped();
Daniel Malea9e9919f2013-10-09 16:56:28 +00001024 return state;
1025 }
1026
Jim Ingham4b536182011-08-09 02:12:22 +00001027 while (state != eStateInvalid)
1028 {
Greg Clayton85fb1b92012-09-11 02:33:37 +00001029 EventSP event_sp;
Greg Clayton44d93782014-01-27 23:43:24 +00001030 state = WaitForStateChangedEvents (timeout, event_sp, hijack_listener);
Greg Clayton85fb1b92012-09-11 02:33:37 +00001031 if (event_sp_ptr && event_sp)
1032 *event_sp_ptr = event_sp;
1033
Greg Claytondc6224e2014-10-21 01:00:42 +00001034 bool pop_process_io_handler = hijack_listener != NULL;
1035 Process::HandleProcessStateChangedEvent (event_sp, stream, pop_process_io_handler);
1036
Jim Ingham4b536182011-08-09 02:12:22 +00001037 switch (state)
1038 {
1039 case eStateCrashed:
1040 case eStateDetached:
1041 case eStateExited:
1042 case eStateUnloaded:
Greg Clayton44d93782014-01-27 23:43:24 +00001043 // We need to toggle the run lock as this won't get done in
1044 // SetPublicState() if the process is hijacked.
Pavel Labath00fea632015-12-01 17:59:56 +00001045 if (hijack_listener)
Greg Clayton44d93782014-01-27 23:43:24 +00001046 m_public_run_lock.SetStopped();
Jim Ingham4b536182011-08-09 02:12:22 +00001047 return state;
1048 case eStateStopped:
1049 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1050 continue;
1051 else
Greg Clayton44d93782014-01-27 23:43:24 +00001052 {
1053 // We need to toggle the run lock as this won't get done in
1054 // SetPublicState() if the process is hijacked.
Pavel Labath00fea632015-12-01 17:59:56 +00001055 if (hijack_listener)
Greg Clayton44d93782014-01-27 23:43:24 +00001056 m_public_run_lock.SetStopped();
Jim Ingham4b536182011-08-09 02:12:22 +00001057 return state;
Greg Clayton44d93782014-01-27 23:43:24 +00001058 }
Jim Ingham4b536182011-08-09 02:12:22 +00001059 default:
1060 continue;
1061 }
1062 }
1063 return state;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001064}
1065
Greg Claytondc6224e2014-10-21 01:00:42 +00001066bool
1067Process::HandleProcessStateChangedEvent (const EventSP &event_sp,
1068 Stream *stream,
1069 bool &pop_process_io_handler)
1070{
1071 const bool handle_pop = pop_process_io_handler == true;
1072
1073 pop_process_io_handler = false;
1074 ProcessSP process_sp = Process::ProcessEventData::GetProcessFromEvent(event_sp.get());
1075
1076 if (!process_sp)
1077 return false;
1078
1079 StateType event_state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
1080 if (event_state == eStateInvalid)
1081 return false;
1082
1083 switch (event_state)
1084 {
1085 case eStateInvalid:
1086 case eStateUnloaded:
Greg Claytondc6224e2014-10-21 01:00:42 +00001087 case eStateAttaching:
1088 case eStateLaunching:
1089 case eStateStepping:
1090 case eStateDetached:
1091 {
1092 if (stream)
1093 stream->Printf ("Process %" PRIu64 " %s\n",
1094 process_sp->GetID(),
1095 StateAsCString (event_state));
1096
1097 if (event_state == eStateDetached)
1098 pop_process_io_handler = true;
1099 }
1100 break;
1101
Stephane Sezerf2ef94e2014-12-13 05:23:51 +00001102 case eStateConnected:
Greg Claytondc6224e2014-10-21 01:00:42 +00001103 case eStateRunning:
1104 // Don't be chatty when we run...
1105 break;
1106
1107 case eStateExited:
1108 if (stream)
1109 process_sp->GetStatus(*stream);
1110 pop_process_io_handler = true;
1111 break;
1112
1113 case eStateStopped:
1114 case eStateCrashed:
1115 case eStateSuspended:
1116 // Make sure the program hasn't been auto-restarted:
1117 if (Process::ProcessEventData::GetRestartedFromEvent (event_sp.get()))
1118 {
1119 if (stream)
1120 {
1121 size_t num_reasons = Process::ProcessEventData::GetNumRestartedReasons(event_sp.get());
1122 if (num_reasons > 0)
1123 {
1124 // FIXME: Do we want to report this, or would that just be annoyingly chatty?
1125 if (num_reasons == 1)
1126 {
1127 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), 0);
1128 stream->Printf ("Process %" PRIu64 " stopped and restarted: %s\n",
1129 process_sp->GetID(),
1130 reason ? reason : "<UNKNOWN REASON>");
1131 }
1132 else
1133 {
1134 stream->Printf ("Process %" PRIu64 " stopped and restarted, reasons:\n",
1135 process_sp->GetID());
1136
1137
1138 for (size_t i = 0; i < num_reasons; i++)
1139 {
1140 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), i);
1141 stream->Printf("\t%s\n", reason ? reason : "<UNKNOWN REASON>");
1142 }
1143 }
1144 }
1145 }
1146 }
1147 else
1148 {
1149 // Lock the thread list so it doesn't change on us, this is the scope for the locker:
1150 {
1151 ThreadList &thread_list = process_sp->GetThreadList();
1152 Mutex::Locker locker (thread_list.GetMutex());
1153
1154 ThreadSP curr_thread (thread_list.GetSelectedThread());
1155 ThreadSP thread;
1156 StopReason curr_thread_stop_reason = eStopReasonInvalid;
1157 if (curr_thread)
1158 curr_thread_stop_reason = curr_thread->GetStopReason();
1159 if (!curr_thread ||
1160 !curr_thread->IsValid() ||
1161 curr_thread_stop_reason == eStopReasonInvalid ||
1162 curr_thread_stop_reason == eStopReasonNone)
1163 {
1164 // Prefer a thread that has just completed its plan over another thread as current thread.
1165 ThreadSP plan_thread;
1166 ThreadSP other_thread;
Jim Inghamce400d92015-07-08 00:06:30 +00001167
Greg Claytondc6224e2014-10-21 01:00:42 +00001168 const size_t num_threads = thread_list.GetSize();
1169 size_t i;
1170 for (i = 0; i < num_threads; ++i)
1171 {
1172 thread = thread_list.GetThreadAtIndex(i);
1173 StopReason thread_stop_reason = thread->GetStopReason();
1174 switch (thread_stop_reason)
1175 {
1176 case eStopReasonInvalid:
1177 case eStopReasonNone:
1178 break;
1179
Jim Inghamce400d92015-07-08 00:06:30 +00001180 case eStopReasonSignal:
1181 {
1182 // Don't select a signal thread if we weren't going to stop at that
1183 // signal. We have to have had another reason for stopping here, and
1184 // the user doesn't want to see this thread.
1185 uint64_t signo = thread->GetStopInfo()->GetValue();
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00001186 if (process_sp->GetUnixSignals()->GetShouldStop(signo))
Jim Inghamce400d92015-07-08 00:06:30 +00001187 {
1188 if (!other_thread)
1189 other_thread = thread;
1190 }
1191 break;
1192 }
Greg Claytondc6224e2014-10-21 01:00:42 +00001193 case eStopReasonTrace:
1194 case eStopReasonBreakpoint:
1195 case eStopReasonWatchpoint:
Greg Claytondc6224e2014-10-21 01:00:42 +00001196 case eStopReasonException:
1197 case eStopReasonExec:
1198 case eStopReasonThreadExiting:
1199 case eStopReasonInstrumentation:
1200 if (!other_thread)
1201 other_thread = thread;
1202 break;
1203 case eStopReasonPlanComplete:
1204 if (!plan_thread)
1205 plan_thread = thread;
1206 break;
1207 }
1208 }
1209 if (plan_thread)
1210 thread_list.SetSelectedThreadByID (plan_thread->GetID());
1211 else if (other_thread)
1212 thread_list.SetSelectedThreadByID (other_thread->GetID());
1213 else
1214 {
1215 if (curr_thread && curr_thread->IsValid())
1216 thread = curr_thread;
1217 else
1218 thread = thread_list.GetThreadAtIndex(0);
1219
1220 if (thread)
1221 thread_list.SetSelectedThreadByID (thread->GetID());
1222 }
1223 }
1224 }
1225 // Drop the ThreadList mutex by here, since GetThreadStatus below might have to run code,
1226 // e.g. for Data formatters, and if we hold the ThreadList mutex, then the process is going to
1227 // have a hard time restarting the process.
1228 if (stream)
1229 {
1230 Debugger &debugger = process_sp->GetTarget().GetDebugger();
1231 if (debugger.GetTargetList().GetSelectedTarget().get() == &process_sp->GetTarget())
1232 {
1233 const bool only_threads_with_stop_reason = true;
1234 const uint32_t start_frame = 0;
1235 const uint32_t num_frames = 1;
1236 const uint32_t num_frames_with_source = 1;
1237 process_sp->GetStatus(*stream);
1238 process_sp->GetThreadStatus (*stream,
1239 only_threads_with_stop_reason,
1240 start_frame,
1241 num_frames,
1242 num_frames_with_source);
1243 }
1244 else
1245 {
1246 uint32_t target_idx = debugger.GetTargetList().GetIndexOfTarget(process_sp->GetTarget().shared_from_this());
1247 if (target_idx != UINT32_MAX)
1248 stream->Printf ("Target %d: (", target_idx);
1249 else
1250 stream->Printf ("Target <unknown index>: (");
1251 process_sp->GetTarget().Dump (stream, eDescriptionLevelBrief);
1252 stream->Printf (") stopped.\n");
1253 }
1254 }
1255
1256 // Pop the process IO handler
1257 pop_process_io_handler = true;
1258 }
1259 break;
1260 }
1261
1262 if (handle_pop && pop_process_io_handler)
1263 process_sp->PopProcessIOHandler();
1264
1265 return true;
1266}
1267
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001268StateType
Eugene Zelenko8f30a652015-10-23 18:39:37 +00001269Process::WaitForState(const TimeValue *timeout,
1270 const StateType *match_states,
1271 const uint32_t num_match_states)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001272{
1273 EventSP event_sp;
1274 uint32_t i;
Greg Clayton05faeb72010-10-07 04:19:01 +00001275 StateType state = GetState();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001276 while (state != eStateInvalid)
1277 {
Greg Clayton05faeb72010-10-07 04:19:01 +00001278 // If we are exited or detached, we won't ever get back to any
1279 // other valid state...
1280 if (state == eStateDetached || state == eStateExited)
1281 return state;
1282
Greg Clayton44d93782014-01-27 23:43:24 +00001283 state = WaitForStateChangedEvents (timeout, event_sp, NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001284
1285 for (i=0; i<num_match_states; ++i)
1286 {
1287 if (match_states[i] == state)
1288 return state;
1289 }
1290 }
1291 return state;
1292}
1293
Jim Ingham30f9b212010-10-11 23:53:14 +00001294bool
1295Process::HijackProcessEvents (Listener *listener)
1296{
1297 if (listener != NULL)
1298 {
Jim Inghamcfc09352012-07-27 23:57:19 +00001299 return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham30f9b212010-10-11 23:53:14 +00001300 }
1301 else
1302 return false;
1303}
1304
1305void
1306Process::RestoreProcessEvents ()
1307{
1308 RestoreBroadcaster();
1309}
1310
Pavel Labath00fea632015-12-01 17:59:56 +00001311bool
1312Process::HijackPrivateProcessEvents (Listener *listener)
1313{
1314 if (listener != NULL)
1315 {
1316 return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
1317 }
1318 else
1319 return false;
1320}
1321
1322void
1323Process::RestorePrivateProcessEvents ()
1324{
1325 m_private_state_broadcaster.RestoreBroadcaster();
1326}
1327
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001328StateType
Greg Clayton44d93782014-01-27 23:43:24 +00001329Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, Listener *hijack_listener)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001330{
Greg Clayton5160ce52013-03-27 23:08:40 +00001331 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001332
1333 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001334 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1335 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001336
Greg Clayton44d93782014-01-27 23:43:24 +00001337 Listener *listener = hijack_listener;
1338 if (listener == NULL)
1339 listener = &m_listener;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001340
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001341 StateType state = eStateInvalid;
Greg Clayton44d93782014-01-27 23:43:24 +00001342 if (listener->WaitForEventForBroadcasterWithType (timeout,
1343 this,
1344 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1345 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001346 {
1347 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1348 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1349 else if (log)
1350 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1351 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001352
1353 if (log)
1354 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001355 __FUNCTION__, static_cast<const void*>(timeout),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001356 StateAsCString(state));
1357 return state;
1358}
1359
1360Event *
1361Process::PeekAtStateChangedEvents ()
1362{
Greg Clayton5160ce52013-03-27 23:08:40 +00001363 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001364
1365 if (log)
1366 log->Printf ("Process::%s...", __FUNCTION__);
1367
1368 Event *event_ptr;
Greg Clayton3fcbed62010-10-19 03:25:40 +00001369 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1370 eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001371 if (log)
1372 {
1373 if (event_ptr)
1374 {
1375 log->Printf ("Process::%s (event_ptr) => %s",
1376 __FUNCTION__,
1377 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1378 }
1379 else
1380 {
1381 log->Printf ("Process::%s no events found",
1382 __FUNCTION__);
1383 }
1384 }
1385 return event_ptr;
1386}
1387
1388StateType
1389Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1390{
Greg Clayton5160ce52013-03-27 23:08:40 +00001391 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001392
1393 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001394 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1395 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001396
1397 StateType state = eStateInvalid;
Greg Clayton6779606a2011-01-22 23:43:18 +00001398 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1399 &m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +00001400 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton6779606a2011-01-22 23:43:18 +00001401 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001402 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1403 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001404
1405 // This is a bit of a hack, but when we wait here we could very well return
1406 // to the command-line, and that could disable the log, which would render the
1407 // log we got above invalid.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001408 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001409 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1410 __FUNCTION__, static_cast<const void *>(timeout),
1411 state == eStateInvalid ? "TIMEOUT" : StateAsCString(state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001412 return state;
1413}
1414
1415bool
1416Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1417{
Greg Clayton5160ce52013-03-27 23:08:40 +00001418 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001419
1420 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001421 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1422 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001423
1424 if (control_only)
1425 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1426 else
1427 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1428}
1429
1430bool
1431Process::IsRunning () const
1432{
1433 return StateIsRunningState (m_public_state.GetValue());
1434}
1435
1436int
1437Process::GetExitStatus ()
1438{
Todd Fiala7b0917a2014-09-15 20:07:33 +00001439 Mutex::Locker locker (m_exit_status_mutex);
1440
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001441 if (m_public_state.GetValue() == eStateExited)
1442 return m_exit_status;
1443 return -1;
1444}
1445
1446const char *
1447Process::GetExitDescription ()
1448{
Todd Fiala7b0917a2014-09-15 20:07:33 +00001449 Mutex::Locker locker (m_exit_status_mutex);
1450
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001451 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1452 return m_exit_string.c_str();
1453 return NULL;
1454}
1455
Greg Clayton6779606a2011-01-22 23:43:18 +00001456bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001457Process::SetExitStatus (int status, const char *cstr)
1458{
Greg Clayton81e2b6b2015-06-01 23:14:09 +00001459 // Use a mutex to protect setting the exit status.
1460 Mutex::Locker locker (m_exit_status_mutex);
1461
Greg Clayton5160ce52013-03-27 23:08:40 +00001462 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Greg Clayton414f5d32011-01-25 02:58:48 +00001463 if (log)
1464 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1465 status, status,
1466 cstr ? "\"" : "",
1467 cstr ? cstr : "NULL",
1468 cstr ? "\"" : "");
1469
Greg Clayton6779606a2011-01-22 23:43:18 +00001470 // We were already in the exited state
1471 if (m_private_state.GetValue() == eStateExited)
Greg Clayton414f5d32011-01-25 02:58:48 +00001472 {
Greg Clayton385d6032011-01-26 23:47:29 +00001473 if (log)
1474 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton6779606a2011-01-22 23:43:18 +00001475 return false;
Greg Clayton414f5d32011-01-25 02:58:48 +00001476 }
Todd Fiala7b0917a2014-09-15 20:07:33 +00001477
Greg Clayton81e2b6b2015-06-01 23:14:09 +00001478 m_exit_status = status;
1479 if (cstr)
1480 m_exit_string = cstr;
1481 else
1482 m_exit_string.clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001483
Pavel Labatha9a43372015-09-03 09:30:17 +00001484 // When we exit, we don't need the input reader anymore
Greg Clayton5df78fa2015-05-23 03:54:53 +00001485 if (m_process_input_reader)
1486 {
1487 m_process_input_reader->SetIsDone(true);
1488 m_process_input_reader->Cancel();
1489 m_process_input_reader.reset();
1490 }
Greg Clayton10177aa2010-12-08 05:08:21 +00001491
Greg Clayton08765fa2015-05-28 03:24:30 +00001492 // Clear the last natural stop ID since it has a strong
1493 // reference to this process
1494 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
1495
Greg Clayton6779606a2011-01-22 23:43:18 +00001496 SetPrivateState (eStateExited);
Greg Clayton5df78fa2015-05-23 03:54:53 +00001497
1498 // Allow subclasses to do some cleanup
1499 DidExit ();
1500
Greg Clayton6779606a2011-01-22 23:43:18 +00001501 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001502}
1503
Jason Molendaa814f702015-11-05 23:03:44 +00001504bool
1505Process::IsAlive ()
1506{
1507 switch (m_private_state.GetValue())
1508 {
1509 case eStateInvalid:
1510 case eStateUnloaded:
1511 case eStateDetached:
1512 case eStateExited:
1513 return false;
1514
1515 case eStateConnected:
1516 case eStateAttaching:
1517 case eStateLaunching:
1518 case eStateStopped:
1519 case eStateRunning:
1520 case eStateStepping:
1521 case eStateCrashed:
1522 case eStateSuspended:
1523 return true;
1524 }
1525}
1526
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001527// This static callback can be used to watch for local child processes on
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00001528// the current host. The child process exits, the process will be
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001529// found in the global target list (we want to be completely sure that the
1530// lldb_private::Process doesn't go away before we can deliver the signal.
1531bool
Greg Claytone4e45922011-11-16 05:37:56 +00001532Process::SetProcessExitStatus (void *callback_baton,
1533 lldb::pid_t pid,
1534 bool exited,
1535 int signo, // Zero for no signal
1536 int exit_status // Exit value of process if signal is zero
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001537)
1538{
Greg Clayton5160ce52013-03-27 23:08:40 +00001539 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytone4e45922011-11-16 05:37:56 +00001540 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001541 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
Greg Claytone4e45922011-11-16 05:37:56 +00001542 callback_baton,
1543 pid,
1544 exited,
1545 signo,
1546 exit_status);
1547
1548 if (exited)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001549 {
Greg Clayton66111032010-06-23 01:19:29 +00001550 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001551 if (target_sp)
1552 {
1553 ProcessSP process_sp (target_sp->GetProcessSP());
1554 if (process_sp)
1555 {
1556 const char *signal_cstr = NULL;
1557 if (signo)
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00001558 signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001559
1560 process_sp->SetExitStatus (exit_status, signal_cstr);
1561 }
1562 }
1563 return true;
1564 }
1565 return false;
1566}
1567
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001568void
1569Process::UpdateThreadListIfNeeded ()
1570{
1571 const uint32_t stop_id = GetStopID();
1572 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1573 {
Greg Clayton2637f822011-11-17 01:23:07 +00001574 const StateType state = GetPrivateState();
1575 if (StateIsStoppedState (state, true))
1576 {
1577 Mutex::Locker locker (m_thread_list.GetMutex ());
Greg Claytone24c4ac2011-11-17 04:46:02 +00001578 // m_thread_list does have its own mutex, but we need to
1579 // hold onto the mutex between the call to UpdateThreadList(...)
1580 // and the os->UpdateThreadList(...) so it doesn't change on us
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001581 ThreadList &old_thread_list = m_thread_list;
1582 ThreadList real_thread_list(this);
Greg Clayton2637f822011-11-17 01:23:07 +00001583 ThreadList new_thread_list(this);
1584 // Always update the thread list with the protocol specific
Greg Clayton9fc13552012-04-10 00:18:59 +00001585 // thread list, but only update if "true" is returned
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001586 if (UpdateThreadList (m_thread_list_real, real_thread_list))
Greg Clayton9fc13552012-04-10 00:18:59 +00001587 {
Jim Ingham09437922013-03-01 20:04:25 +00001588 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since
1589 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is
1590 // shutting us down, causing a deadlock.
Pavel Labath862432c2015-11-03 16:05:18 +00001591 OperatingSystem *os = GetOperatingSystem ();
1592 if (os && !m_destroy_in_process)
Jim Ingham09437922013-03-01 20:04:25 +00001593 {
Pavel Labath862432c2015-11-03 16:05:18 +00001594 // Clear any old backing threads where memory threads might have been
1595 // backed by actual threads from the lldb_private::Process subclass
1596 size_t num_old_threads = old_thread_list.GetSize(false);
1597 for (size_t i=0; i<num_old_threads; ++i)
1598 old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread();
Greg Claytonb3ae8762013-04-12 20:07:46 +00001599
Pavel Labath862432c2015-11-03 16:05:18 +00001600 // Turn off dynamic types to ensure we don't run any expressions. Objective C
1601 // can run an expression to determine if a SBValue is a dynamic type or not
1602 // and we need to avoid this. OperatingSystem plug-ins can't run expressions
1603 // that require running code...
Greg Clayton15484402015-05-15 18:40:24 +00001604
Pavel Labath862432c2015-11-03 16:05:18 +00001605 Target &target = GetTarget();
1606 const lldb::DynamicValueType saved_prefer_dynamic = target.GetPreferDynamicValue ();
1607 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1608 target.SetPreferDynamicValue(lldb::eNoDynamicValues);
Greg Clayton15484402015-05-15 18:40:24 +00001609
Pavel Labath862432c2015-11-03 16:05:18 +00001610 // Now let the OperatingSystem plug-in update the thread list
Greg Clayton15484402015-05-15 18:40:24 +00001611
Pavel Labath862432c2015-11-03 16:05:18 +00001612 os->UpdateThreadList (old_thread_list, // Old list full of threads created by OS plug-in
1613 real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass
1614 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 +00001615
Pavel Labath862432c2015-11-03 16:05:18 +00001616 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1617 target.SetPreferDynamicValue(saved_prefer_dynamic);
1618 }
1619 else
1620 {
1621 // No OS plug-in, the new thread list is the same as the real thread list
1622 new_thread_list = real_thread_list;
Jim Ingham09437922013-03-01 20:04:25 +00001623 }
Jim Ingham02ff8e02013-06-22 00:55:02 +00001624
1625 m_thread_list_real.Update(real_thread_list);
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001626 m_thread_list.Update (new_thread_list);
1627 m_thread_list.SetStopID (stop_id);
Jason Molendaa6e91302013-11-19 05:44:41 +00001628
Jason Molenda4ff13262013-11-20 00:31:38 +00001629 if (GetLastNaturalStopID () != m_extended_thread_stop_id)
1630 {
1631 // Clear any extended threads that we may have accumulated previously
1632 m_extended_thread_list.Clear();
1633 m_extended_thread_stop_id = GetLastNaturalStopID ();
Jason Molenda5e8dce42013-12-13 00:29:16 +00001634
1635 m_queue_list.Clear();
1636 m_queue_list_stop_id = GetLastNaturalStopID ();
Jason Molenda4ff13262013-11-20 00:31:38 +00001637 }
Greg Clayton9fc13552012-04-10 00:18:59 +00001638 }
Greg Clayton2637f822011-11-17 01:23:07 +00001639 }
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001640 }
1641}
1642
Jason Molenda5e8dce42013-12-13 00:29:16 +00001643void
1644Process::UpdateQueueListIfNeeded ()
1645{
1646 if (m_system_runtime_ap.get())
1647 {
1648 if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID())
1649 {
1650 const StateType state = GetPrivateState();
1651 if (StateIsStoppedState (state, true))
1652 {
1653 m_system_runtime_ap->PopulateQueueList (m_queue_list);
1654 m_queue_list_stop_id = GetLastNaturalStopID();
1655 }
1656 }
1657 }
1658}
1659
Greg Claytona4d87472013-01-18 23:41:08 +00001660ThreadSP
1661Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1662{
1663 OperatingSystem *os = GetOperatingSystem ();
1664 if (os)
1665 return os->CreateThread(tid, context);
1666 return ThreadSP();
1667}
1668
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001669uint32_t
1670Process::GetNextThreadIndexID (uint64_t thread_id)
1671{
1672 return AssignIndexIDToThread(thread_id);
1673}
1674
1675bool
1676Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1677{
Eugene Zelenko8f30a652015-10-23 18:39:37 +00001678 return (m_thread_id_to_index_id_map.find(thread_id) != m_thread_id_to_index_id_map.end());
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001679}
1680
1681uint32_t
1682Process::AssignIndexIDToThread(uint64_t thread_id)
1683{
1684 uint32_t result = 0;
1685 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1686 if (iterator == m_thread_id_to_index_id_map.end())
1687 {
1688 result = ++m_thread_index_id;
1689 m_thread_id_to_index_id_map[thread_id] = result;
1690 }
1691 else
1692 {
1693 result = iterator->second;
1694 }
1695
1696 return result;
1697}
1698
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001699StateType
1700Process::GetState()
1701{
1702 // If any other threads access this we will need a mutex for it
1703 return m_public_state.GetValue ();
1704}
1705
Greg Claytondc6224e2014-10-21 01:00:42 +00001706bool
1707Process::StateChangedIsExternallyHijacked()
1708{
1709 if (IsHijackedForEvent(eBroadcastBitStateChanged))
1710 {
1711 if (strcmp(m_hijacking_listeners.back()->GetName(), "lldb.Process.ResumeSynchronous.hijack"))
1712 return true;
1713 }
1714 return false;
1715}
1716
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001717void
Jim Ingham221d51c2013-05-08 00:35:16 +00001718Process::SetPublicState (StateType new_state, bool restarted)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001719{
Greg Clayton5160ce52013-03-27 23:08:40 +00001720 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001721 if (log)
Jim Ingham221d51c2013-05-08 00:35:16 +00001722 log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted);
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001723 const StateType old_state = m_public_state.GetValue();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001724 m_public_state.SetValue (new_state);
Jim Ingham3b8285d2012-04-19 01:40:33 +00001725
1726 // On the transition from Run to Stopped, we unlock the writer end of the
1727 // run lock. The lock gets locked in Resume, which is the public API
1728 // to tell the program to run.
Greg Claytondc6224e2014-10-21 01:00:42 +00001729 if (!StateChangedIsExternallyHijacked())
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001730 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001731 if (new_state == eStateDetached)
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001732 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001733 if (log)
1734 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001735 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001736 }
1737 else
1738 {
1739 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1740 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
Jim Ingham221d51c2013-05-08 00:35:16 +00001741 if ((old_state_is_stopped != new_state_is_stopped))
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001742 {
Jim Ingham221d51c2013-05-08 00:35:16 +00001743 if (new_state_is_stopped && !restarted)
Sean Callanan8b0737f2012-06-02 01:16:20 +00001744 {
1745 if (log)
1746 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001747 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001748 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001749 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001750 }
1751 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001752}
1753
Jim Ingham3b8285d2012-04-19 01:40:33 +00001754Error
1755Process::Resume ()
1756{
Greg Clayton5160ce52013-03-27 23:08:40 +00001757 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Jim Ingham3b8285d2012-04-19 01:40:33 +00001758 if (log)
1759 log->Printf("Process::Resume -- locking run lock");
Ed Maste64fad602013-07-29 20:58:06 +00001760 if (!m_public_run_lock.TrySetRunning())
Jim Ingham3b8285d2012-04-19 01:40:33 +00001761 {
1762 Error error("Resume request failed - process still running.");
1763 if (log)
Ed Maste64fad602013-07-29 20:58:06 +00001764 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
Jim Ingham3b8285d2012-04-19 01:40:33 +00001765 return error;
1766 }
1767 return PrivateResume();
1768}
1769
Greg Claytondc6224e2014-10-21 01:00:42 +00001770Error
1771Process::ResumeSynchronous (Stream *stream)
1772{
1773 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1774 if (log)
1775 log->Printf("Process::ResumeSynchronous -- locking run lock");
1776 if (!m_public_run_lock.TrySetRunning())
1777 {
1778 Error error("Resume request failed - process still running.");
1779 if (log)
1780 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1781 return error;
1782 }
1783
1784 ListenerSP listener_sp (new Listener("lldb.Process.ResumeSynchronous.hijack"));
1785 HijackProcessEvents(listener_sp.get());
1786
1787 Error error = PrivateResume();
Ilia Kd8c14752015-04-30 13:10:32 +00001788 if (error.Success())
1789 {
1790 StateType state = WaitForProcessToStop (NULL, NULL, true, listener_sp.get(), stream);
1791 const bool must_be_alive = false; // eStateExited is ok, so this must be false
1792 if (!StateIsStoppedState(state, must_be_alive))
1793 error.SetErrorStringWithFormat("process not in stopped state after synchronous resume: %s", StateAsCString(state));
1794 }
Greg Claytondc6224e2014-10-21 01:00:42 +00001795
1796 // Undo the hijacking of process events...
1797 RestoreProcessEvents();
1798
Greg Claytondc6224e2014-10-21 01:00:42 +00001799 return error;
1800}
1801
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001802StateType
1803Process::GetPrivateState ()
1804{
1805 return m_private_state.GetValue();
1806}
1807
1808void
1809Process::SetPrivateState (StateType new_state)
1810{
Greg Claytonfb8b37a2014-07-14 23:09:29 +00001811 if (m_finalize_called)
1812 return;
1813
Greg Clayton5160ce52013-03-27 23:08:40 +00001814 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001815 bool state_changed = false;
1816
1817 if (log)
1818 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1819
Andrew Kaylor29d65742013-05-10 17:19:04 +00001820 Mutex::Locker thread_locker(m_thread_list.GetMutex());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001821 Mutex::Locker locker(m_private_state.GetMutex());
1822
1823 const StateType old_state = m_private_state.GetValueNoLock ();
1824 state_changed = old_state != new_state;
Ed Mastec29693f2013-07-02 16:35:47 +00001825
Greg Claytonaa49c832013-05-03 22:25:56 +00001826 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1827 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1828 if (old_state_is_stopped != new_state_is_stopped)
1829 {
1830 if (new_state_is_stopped)
Ed Maste64fad602013-07-29 20:58:06 +00001831 m_private_run_lock.SetStopped();
Greg Claytonaa49c832013-05-03 22:25:56 +00001832 else
Ed Maste64fad602013-07-29 20:58:06 +00001833 m_private_run_lock.SetRunning();
Greg Claytonaa49c832013-05-03 22:25:56 +00001834 }
Andrew Kaylor93132f52013-05-28 23:04:25 +00001835
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001836 if (state_changed)
1837 {
1838 m_private_state.SetValueNoLock (new_state);
Ilia K38810f42015-05-20 10:15:47 +00001839 EventSP event_sp (new Event (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state)));
Greg Clayton2637f822011-11-17 01:23:07 +00001840 if (StateIsStoppedState(new_state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001841 {
Andrew Kaylor29d65742013-05-10 17:19:04 +00001842 // Note, this currently assumes that all threads in the list
1843 // stop when the process stops. In the future we will want to
1844 // support a debugging model where some threads continue to run
1845 // while others are stopped. When that happens we will either need
1846 // a way for the thread list to identify which threads are stopping
1847 // or create a special thread list containing only threads which
1848 // actually stopped.
1849 //
1850 // The process plugin is responsible for managing the actual
1851 // behavior of the threads and should have stopped any threads
1852 // that are going to stop before we get here.
1853 m_thread_list.DidStop();
1854
Jim Ingham4b536182011-08-09 02:12:22 +00001855 m_mod_id.BumpStopID();
Ilia K38810f42015-05-20 10:15:47 +00001856 if (!m_mod_id.IsLastResumeForUserExpression())
1857 m_mod_id.SetStopEventForLastNaturalStopID(event_sp);
Greg Clayton58be07b2011-01-07 06:08:19 +00001858 m_memory_cache.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001859 if (log)
Jim Ingham4b536182011-08-09 02:12:22 +00001860 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001861 }
Ilia K38810f42015-05-20 10:15:47 +00001862
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001863 // Use our target to get a shared pointer to ourselves...
Greg Clayton35a4cc52012-10-29 20:52:08 +00001864 if (m_finalize_called && PrivateStateThreadIsValid() == false)
Ilia K38810f42015-05-20 10:15:47 +00001865 BroadcastEvent (event_sp);
Greg Clayton35a4cc52012-10-29 20:52:08 +00001866 else
Ilia K38810f42015-05-20 10:15:47 +00001867 m_private_state_broadcaster.BroadcastEvent (event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001868 }
1869 else
1870 {
1871 if (log)
Jason Molendafd54b362011-09-20 21:44:10 +00001872 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001873 }
1874}
1875
Jim Ingham0faa43f2011-11-08 03:00:11 +00001876void
1877Process::SetRunningUserExpression (bool on)
1878{
1879 m_mod_id.SetRunningUserExpression (on);
1880}
1881
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001882addr_t
1883Process::GetImageInfoAddress()
1884{
1885 return LLDB_INVALID_ADDRESS;
1886}
1887
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001888const lldb::ABISP &
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001889Process::GetABI()
1890{
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001891 if (!m_abi_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00001892 m_abi_sp = ABI::FindPlugin(GetTarget().GetArchitecture());
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001893 return m_abi_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001894}
1895
Jim Ingham22777012010-09-23 02:01:19 +00001896LanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001897Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001898{
Greg Claytonc00ca312015-04-02 18:44:58 +00001899 if (m_finalizing)
1900 return nullptr;
1901
Jim Ingham22777012010-09-23 02:01:19 +00001902 LanguageRuntimeCollection::iterator pos;
1903 pos = m_language_runtimes.find (language);
Jim Inghamab175242012-03-10 00:22:19 +00001904 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
Jim Ingham22777012010-09-23 02:01:19 +00001905 {
Jim Inghamab175242012-03-10 00:22:19 +00001906 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
Jim Ingham22777012010-09-23 02:01:19 +00001907
Jim Inghamab175242012-03-10 00:22:19 +00001908 m_language_runtimes[language] = runtime_sp;
1909 return runtime_sp.get();
Jim Ingham22777012010-09-23 02:01:19 +00001910 }
1911 else
1912 return (*pos).second.get();
1913}
1914
1915CPPLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001916Process::GetCPPLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001917{
Jim Inghamab175242012-03-10 00:22:19 +00001918 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00001919 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1920 return static_cast<CPPLanguageRuntime *> (runtime);
1921 return NULL;
1922}
1923
1924ObjCLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001925Process::GetObjCLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001926{
Jim Inghamab175242012-03-10 00:22:19 +00001927 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00001928 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1929 return static_cast<ObjCLanguageRuntime *> (runtime);
1930 return NULL;
1931}
1932
Enrico Granatafd4c84e2012-05-21 16:51:35 +00001933bool
1934Process::IsPossibleDynamicValue (ValueObject& in_value)
1935{
Greg Claytonc00ca312015-04-02 18:44:58 +00001936 if (m_finalizing)
1937 return false;
1938
Enrico Granatafd4c84e2012-05-21 16:51:35 +00001939 if (in_value.IsDynamic())
1940 return false;
1941 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1942
1943 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1944 {
1945 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1946 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1947 }
1948
1949 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1950 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1951 return true;
1952
1953 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1954 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1955}
1956
Zachary Turner93749ab2015-03-03 21:51:25 +00001957void
1958Process::SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers)
1959{
1960 m_dynamic_checkers_ap.reset(dynamic_checkers);
1961}
1962
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001963BreakpointSiteList &
1964Process::GetBreakpointSiteList()
1965{
1966 return m_breakpoint_site_list;
1967}
1968
1969const BreakpointSiteList &
1970Process::GetBreakpointSiteList() const
1971{
1972 return m_breakpoint_site_list;
1973}
1974
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001975void
1976Process::DisableAllBreakpointSites ()
1977{
Greg Claytond8cf1a12013-06-12 00:46:38 +00001978 m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void {
1979// bp_site->SetEnabled(true);
1980 DisableBreakpointSite(bp_site);
1981 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001982}
1983
1984Error
1985Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1986{
1987 Error error (DisableBreakpointSiteByID (break_id));
1988
1989 if (error.Success())
1990 m_breakpoint_site_list.Remove(break_id);
1991
1992 return error;
1993}
1994
1995Error
1996Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1997{
1998 Error error;
1999 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2000 if (bp_site_sp)
2001 {
2002 if (bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00002003 error = DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002004 }
2005 else
2006 {
Daniel Malead01b2952012-11-29 21:49:15 +00002007 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002008 }
2009
2010 return error;
2011}
2012
2013Error
2014Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
2015{
2016 Error error;
2017 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2018 if (bp_site_sp)
2019 {
2020 if (!bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00002021 error = EnableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002022 }
2023 else
2024 {
Daniel Malead01b2952012-11-29 21:49:15 +00002025 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002026 }
2027 return error;
2028}
2029
Stephen Wilson50bd94f2010-07-17 00:56:13 +00002030lldb::break_id_t
Greg Claytone1cd1be2012-01-29 20:56:30 +00002031Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002032{
Jim Ingham1460e4b2014-01-10 23:46:59 +00002033 addr_t load_addr = LLDB_INVALID_ADDRESS;
2034
2035 bool show_error = true;
2036 switch (GetState())
2037 {
2038 case eStateInvalid:
2039 case eStateUnloaded:
2040 case eStateConnected:
2041 case eStateAttaching:
2042 case eStateLaunching:
2043 case eStateDetached:
2044 case eStateExited:
2045 show_error = false;
2046 break;
2047
2048 case eStateStopped:
2049 case eStateRunning:
2050 case eStateStepping:
2051 case eStateCrashed:
2052 case eStateSuspended:
2053 show_error = IsAlive();
2054 break;
2055 }
2056
2057 // Reset the IsIndirect flag here, in case the location changes from
2058 // pointing to a indirect symbol to a regular symbol.
2059 owner->SetIsIndirect (false);
2060
2061 if (owner->ShouldResolveIndirectFunctions())
2062 {
2063 Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol();
2064 if (symbol && symbol->IsIndirect())
2065 {
2066 Error error;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002067 Address symbol_address = symbol->GetAddress();
2068 load_addr = ResolveIndirectFunction (&symbol_address, error);
Jim Ingham1460e4b2014-01-10 23:46:59 +00002069 if (!error.Success() && show_error)
2070 {
Zachary Turner7529df92015-09-01 20:02:29 +00002071 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2072 symbol->GetLoadAddress(&GetTarget()),
2073 owner->GetBreakpoint().GetID(),
2074 owner->GetID(),
2075 error.AsCString() ? error.AsCString() : "unknown error");
Jim Ingham1460e4b2014-01-10 23:46:59 +00002076 return LLDB_INVALID_BREAK_ID;
2077 }
2078 Address resolved_address(load_addr);
Zachary Turner7529df92015-09-01 20:02:29 +00002079 load_addr = resolved_address.GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002080 owner->SetIsIndirect(true);
2081 }
2082 else
Zachary Turner7529df92015-09-01 20:02:29 +00002083 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002084 }
2085 else
Zachary Turner7529df92015-09-01 20:02:29 +00002086 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002087
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002088 if (load_addr != LLDB_INVALID_ADDRESS)
2089 {
2090 BreakpointSiteSP bp_site_sp;
2091
2092 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
2093 // create a new breakpoint site and add it.
2094
2095 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
2096
2097 if (bp_site_sp)
2098 {
2099 bp_site_sp->AddOwner (owner);
2100 owner->SetBreakpointSite (bp_site_sp);
2101 return bp_site_sp->GetID();
2102 }
2103 else
2104 {
Greg Claytonc7bece562013-01-25 18:06:21 +00002105 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002106 if (bp_site_sp)
2107 {
Greg Claytoneb023e72013-10-11 19:48:25 +00002108 Error error = EnableBreakpointSite (bp_site_sp.get());
2109 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002110 {
2111 owner->SetBreakpointSite (bp_site_sp);
2112 return m_breakpoint_site_list.Add (bp_site_sp);
2113 }
Greg Claytoneb023e72013-10-11 19:48:25 +00002114 else
2115 {
Greg Claytonfbb76342013-11-20 21:07:01 +00002116 if (show_error)
2117 {
2118 // Report error for setting breakpoint...
Zachary Turner7529df92015-09-01 20:02:29 +00002119 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2120 load_addr,
2121 owner->GetBreakpoint().GetID(),
2122 owner->GetID(),
2123 error.AsCString() ? error.AsCString() : "unknown error");
Greg Claytonfbb76342013-11-20 21:07:01 +00002124 }
Greg Claytoneb023e72013-10-11 19:48:25 +00002125 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002126 }
2127 }
2128 }
2129 // We failed to enable the breakpoint
2130 return LLDB_INVALID_BREAK_ID;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002131}
2132
2133void
2134Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
2135{
2136 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
2137 if (num_owners == 0)
2138 {
Jim Inghamf1ff3bb2013-04-06 00:16:39 +00002139 // Don't try to disable the site if we don't have a live process anymore.
2140 if (IsAlive())
2141 DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002142 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
2143 }
2144}
2145
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002146size_t
2147Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
2148{
2149 size_t bytes_removed = 0;
Jim Ingham20c77192011-06-29 19:42:28 +00002150 BreakpointSiteList bp_sites_in_range;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002151
Jim Ingham20c77192011-06-29 19:42:28 +00002152 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002153 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002154 bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void {
2155 if (bp_site->GetType() == BreakpointSite::eSoftware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002156 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002157 addr_t intersect_addr;
2158 size_t intersect_size;
2159 size_t opcode_offset;
2160 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
Jim Ingham20c77192011-06-29 19:42:28 +00002161 {
2162 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
2163 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002164 assert(opcode_offset + intersect_size <= bp_site->GetByteSize());
Jim Ingham20c77192011-06-29 19:42:28 +00002165 size_t buf_offset = intersect_addr - bp_addr;
Greg Claytond8cf1a12013-06-12 00:46:38 +00002166 ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
Jim Ingham20c77192011-06-29 19:42:28 +00002167 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002168 }
Greg Claytond8cf1a12013-06-12 00:46:38 +00002169 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002170 }
2171 return bytes_removed;
2172}
2173
Greg Claytonded470d2011-03-19 01:12:21 +00002174size_t
2175Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
2176{
Zachary Turner7529df92015-09-01 20:02:29 +00002177 PlatformSP platform_sp (GetTarget().GetPlatform());
Greg Claytonded470d2011-03-19 01:12:21 +00002178 if (platform_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00002179 return platform_sp->GetSoftwareBreakpointTrapOpcode (GetTarget(), bp_site);
Greg Claytonded470d2011-03-19 01:12:21 +00002180 return 0;
2181}
2182
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002183Error
2184Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
2185{
2186 Error error;
2187 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002188 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002189 const addr_t bp_addr = bp_site->GetLoadAddress();
2190 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002191 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002192 if (bp_site->IsEnabled())
2193 {
2194 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002195 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 +00002196 return error;
2197 }
2198
2199 if (bp_addr == LLDB_INVALID_ADDRESS)
2200 {
2201 error.SetErrorString("BreakpointSite contains an invalid load address.");
2202 return error;
2203 }
2204 // Ask the lldb::Process subclass to fill in the correct software breakpoint
2205 // trap for the breakpoint site
2206 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
2207
2208 if (bp_opcode_size == 0)
2209 {
Daniel Malead01b2952012-11-29 21:49:15 +00002210 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002211 }
2212 else
2213 {
2214 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
2215
2216 if (bp_opcode_bytes == NULL)
2217 {
2218 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
2219 return error;
2220 }
2221
2222 // Save the original opcode by reading it
2223 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
2224 {
2225 // Write a software breakpoint in place of the original opcode
2226 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2227 {
2228 uint8_t verify_bp_opcode_bytes[64];
2229 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2230 {
2231 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
2232 {
2233 bp_site->SetEnabled(true);
2234 bp_site->SetType (BreakpointSite::eSoftware);
2235 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002236 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002237 bp_site->GetID(),
2238 (uint64_t)bp_addr);
2239 }
2240 else
Greg Clayton86edbf42011-10-26 00:56:27 +00002241 error.SetErrorString("failed to verify the breakpoint trap in memory.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002242 }
2243 else
2244 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
2245 }
2246 else
2247 error.SetErrorString("Unable to write breakpoint trap to memory.");
2248 }
2249 else
2250 error.SetErrorString("Unable to read memory at breakpoint address.");
2251 }
Stephen Wilson78a4feb2011-01-12 04:20:03 +00002252 if (log && error.Fail())
Daniel Malead01b2952012-11-29 21:49:15 +00002253 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002254 bp_site->GetID(),
2255 (uint64_t)bp_addr,
2256 error.AsCString());
2257 return error;
2258}
2259
2260Error
2261Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2262{
2263 Error error;
2264 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002265 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002266 addr_t bp_addr = bp_site->GetLoadAddress();
2267 lldb::user_id_t breakID = bp_site->GetID();
2268 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00002269 log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002270
2271 if (bp_site->IsHardware())
2272 {
2273 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2274 }
2275 else if (bp_site->IsEnabled())
2276 {
2277 const size_t break_op_size = bp_site->GetByteSize();
2278 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2279 if (break_op_size > 0)
2280 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00002281 // Clear a software breakpoint instruction
Greg Claytonc982c762010-07-09 20:39:50 +00002282 uint8_t curr_break_op[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002283 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002284 bool break_op_found = false;
2285
2286 // Read the breakpoint opcode
2287 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2288 {
2289 bool verify = false;
Bruce Mitchener58ef3912015-06-18 05:27:05 +00002290 // Make sure the breakpoint opcode exists at this address
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002291 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2292 {
2293 break_op_found = true;
2294 // We found a valid breakpoint opcode at this address, now restore
2295 // the saved opcode.
2296 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2297 {
2298 verify = true;
2299 }
2300 else
2301 error.SetErrorString("Memory write failed when restoring original opcode.");
2302 }
2303 else
2304 {
2305 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2306 // Set verify to true and so we can check if the original opcode has already been restored
2307 verify = true;
2308 }
2309
2310 if (verify)
2311 {
Greg Claytonc982c762010-07-09 20:39:50 +00002312 uint8_t verify_opcode[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002313 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002314 // Verify that our original opcode made it back to the inferior
2315 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2316 {
2317 // compare the memory we just read with the original opcode
2318 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2319 {
2320 // SUCCESS
2321 bp_site->SetEnabled(false);
2322 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002323 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 +00002324 return error;
2325 }
2326 else
2327 {
2328 if (break_op_found)
2329 error.SetErrorString("Failed to restore original opcode.");
2330 }
2331 }
2332 else
2333 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2334 }
2335 }
2336 else
2337 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2338 }
2339 }
2340 else
2341 {
2342 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002343 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 +00002344 return error;
2345 }
2346
2347 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002348 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002349 bp_site->GetID(),
2350 (uint64_t)bp_addr,
2351 error.AsCString());
2352 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002353}
2354
Greg Clayton58be07b2011-01-07 06:08:19 +00002355// Uncomment to verify memory caching works after making changes to caching code
2356//#define VERIFY_MEMORY_READS
2357
Sean Callanan64c0cf22012-06-07 22:26:42 +00002358size_t
2359Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2360{
Jason Molendaa7b5afa2013-11-15 00:17:32 +00002361 error.Clear();
Sean Callanan64c0cf22012-06-07 22:26:42 +00002362 if (!GetDisableMemoryCache())
2363 {
Greg Clayton58be07b2011-01-07 06:08:19 +00002364#if defined (VERIFY_MEMORY_READS)
Sean Callanan64c0cf22012-06-07 22:26:42 +00002365 // Memory caching is enabled, with debug verification
2366
2367 if (buf && size)
2368 {
2369 // Uncomment the line below to make sure memory caching is working.
2370 // I ran this through the test suite and got no assertions, so I am
2371 // pretty confident this is working well. If any changes are made to
2372 // memory caching, uncomment the line below and test your changes!
2373
2374 // Verify all memory reads by using the cache first, then redundantly
2375 // reading the same memory from the inferior and comparing to make sure
2376 // everything is exactly the same.
2377 std::string verify_buf (size, '\0');
2378 assert (verify_buf.size() == size);
2379 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2380 Error verify_error;
2381 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2382 assert (cache_bytes_read == verify_bytes_read);
2383 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2384 assert (verify_error.Success() == error.Success());
2385 return cache_bytes_read;
2386 }
2387 return 0;
2388#else // !defined(VERIFY_MEMORY_READS)
2389 // Memory caching is enabled, without debug verification
2390
2391 return m_memory_cache.Read (addr, buf, size, error);
2392#endif // defined (VERIFY_MEMORY_READS)
Greg Clayton58be07b2011-01-07 06:08:19 +00002393 }
Sean Callanan64c0cf22012-06-07 22:26:42 +00002394 else
2395 {
2396 // Memory caching is disabled
2397
2398 return ReadMemoryFromInferior (addr, buf, size, error);
2399 }
Greg Clayton58be07b2011-01-07 06:08:19 +00002400}
Greg Clayton58be07b2011-01-07 06:08:19 +00002401
Greg Clayton4c82d422012-05-18 23:20:01 +00002402size_t
2403Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2404{
Greg Claytonde87c0f2012-05-19 00:18:00 +00002405 char buf[256];
Greg Clayton4c82d422012-05-18 23:20:01 +00002406 out_str.clear();
2407 addr_t curr_addr = addr;
2408 while (1)
2409 {
2410 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2411 if (length == 0)
2412 break;
2413 out_str.append(buf, length);
2414 // If we got "length - 1" bytes, we didn't get the whole C string, we
2415 // need to read some more characters
2416 if (length == sizeof(buf) - 1)
2417 curr_addr += length;
2418 else
2419 break;
2420 }
2421 return out_str.size();
2422}
2423
Greg Clayton58be07b2011-01-07 06:08:19 +00002424size_t
Ashok Thirumurthi6ac9d132013-04-19 15:58:38 +00002425Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error,
2426 size_t type_width)
2427{
2428 size_t total_bytes_read = 0;
2429 if (dst && max_bytes && type_width && max_bytes >= type_width)
2430 {
2431 // Ensure a null terminator independent of the number of bytes that is read.
2432 memset (dst, 0, max_bytes);
2433 size_t bytes_left = max_bytes - type_width;
2434
2435 const char terminator[4] = {'\0', '\0', '\0', '\0'};
2436 assert(sizeof(terminator) >= type_width &&
2437 "Attempting to validate a string with more than 4 bytes per character!");
2438
2439 addr_t curr_addr = addr;
2440 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2441 char *curr_dst = dst;
2442
2443 error.Clear();
2444 while (bytes_left > 0 && error.Success())
2445 {
2446 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2447 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2448 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2449
2450 if (bytes_read == 0)
2451 break;
2452
2453 // Search for a null terminator of correct size and alignment in bytes_read
2454 size_t aligned_start = total_bytes_read - total_bytes_read % type_width;
2455 for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width)
2456 if (::strncmp(&dst[i], terminator, type_width) == 0)
2457 {
2458 error.Clear();
2459 return i;
2460 }
2461
2462 total_bytes_read += bytes_read;
2463 curr_dst += bytes_read;
2464 curr_addr += bytes_read;
2465 bytes_left -= bytes_read;
2466 }
2467 }
2468 else
2469 {
2470 if (max_bytes)
2471 error.SetErrorString("invalid arguments");
2472 }
2473 return total_bytes_read;
2474}
2475
2476// Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find
2477// null terminators.
2478size_t
Greg Claytone91b7952011-12-15 03:14:23 +00002479Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
Greg Clayton8b82f082011-04-12 05:54:46 +00002480{
2481 size_t total_cstr_len = 0;
2482 if (dst && dst_max_len)
2483 {
Greg Claytone91b7952011-12-15 03:14:23 +00002484 result_error.Clear();
Greg Clayton8b82f082011-04-12 05:54:46 +00002485 // NULL out everything just to be safe
2486 memset (dst, 0, dst_max_len);
2487 Error error;
2488 addr_t curr_addr = addr;
2489 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2490 size_t bytes_left = dst_max_len - 1;
2491 char *curr_dst = dst;
2492
2493 while (bytes_left > 0)
2494 {
2495 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2496 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2497 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2498
2499 if (bytes_read == 0)
2500 {
Greg Claytone91b7952011-12-15 03:14:23 +00002501 result_error = error;
Greg Clayton8b82f082011-04-12 05:54:46 +00002502 dst[total_cstr_len] = '\0';
2503 break;
2504 }
2505 const size_t len = strlen(curr_dst);
2506
2507 total_cstr_len += len;
2508
2509 if (len < bytes_to_read)
2510 break;
2511
2512 curr_dst += bytes_read;
2513 curr_addr += bytes_read;
2514 bytes_left -= bytes_read;
2515 }
2516 }
Greg Claytone91b7952011-12-15 03:14:23 +00002517 else
2518 {
2519 if (dst == NULL)
2520 result_error.SetErrorString("invalid arguments");
2521 else
2522 result_error.Clear();
2523 }
Greg Clayton8b82f082011-04-12 05:54:46 +00002524 return total_cstr_len;
2525}
2526
2527size_t
Greg Clayton58be07b2011-01-07 06:08:19 +00002528Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2529{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002530 if (buf == NULL || size == 0)
2531 return 0;
2532
2533 size_t bytes_read = 0;
2534 uint8_t *bytes = (uint8_t *)buf;
2535
2536 while (bytes_read < size)
2537 {
2538 const size_t curr_size = size - bytes_read;
2539 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2540 bytes + bytes_read,
2541 curr_size,
2542 error);
2543 bytes_read += curr_bytes_read;
2544 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2545 break;
2546 }
2547
2548 // Replace any software breakpoint opcodes that fall into this range back
2549 // into "buf" before we return
2550 if (bytes_read > 0)
2551 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2552 return bytes_read;
2553}
2554
Greg Clayton58a4c462010-12-16 20:01:20 +00002555uint64_t
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002556Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
Greg Clayton58a4c462010-12-16 20:01:20 +00002557{
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002558 Scalar scalar;
2559 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2560 return scalar.ULongLong(fail_value);
2561 return fail_value;
2562}
2563
2564addr_t
2565Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2566{
2567 Scalar scalar;
2568 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2569 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2570 return LLDB_INVALID_ADDRESS;
2571}
2572
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002573bool
2574Process::WritePointerToMemory (lldb::addr_t vm_addr,
2575 lldb::addr_t ptr_value,
2576 Error &error)
2577{
2578 Scalar scalar;
2579 const uint32_t addr_byte_size = GetAddressByteSize();
2580 if (addr_byte_size <= 4)
2581 scalar = (uint32_t)ptr_value;
Greg Clayton58a4c462010-12-16 20:01:20 +00002582 else
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002583 scalar = ptr_value;
2584 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
Greg Clayton58a4c462010-12-16 20:01:20 +00002585}
2586
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002587size_t
2588Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2589{
2590 size_t bytes_written = 0;
2591 const uint8_t *bytes = (const uint8_t *)buf;
2592
2593 while (bytes_written < size)
2594 {
2595 const size_t curr_size = size - bytes_written;
2596 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2597 bytes + bytes_written,
2598 curr_size,
2599 error);
2600 bytes_written += curr_bytes_written;
2601 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2602 break;
2603 }
2604 return bytes_written;
2605}
2606
2607size_t
2608Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2609{
Greg Clayton58be07b2011-01-07 06:08:19 +00002610#if defined (ENABLE_MEMORY_CACHING)
2611 m_memory_cache.Flush (addr, size);
2612#endif
2613
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002614 if (buf == NULL || size == 0)
2615 return 0;
Jim Ingham78a685a2011-04-16 00:01:13 +00002616
Jim Ingham4b536182011-08-09 02:12:22 +00002617 m_mod_id.BumpMemoryID();
Jim Ingham78a685a2011-04-16 00:01:13 +00002618
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002619 // We need to write any data that would go where any current software traps
2620 // (enabled software breakpoints) any software traps (breakpoints) that we
2621 // may have placed in our tasks memory.
2622
Greg Claytond8cf1a12013-06-12 00:46:38 +00002623 BreakpointSiteList bp_sites_in_range;
2624
2625 if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002626 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002627 // No breakpoint sites overlap
2628 if (bp_sites_in_range.IsEmpty())
2629 return WriteMemoryPrivate (addr, buf, size, error);
2630 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002631 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002632 const uint8_t *ubuf = (const uint8_t *)buf;
2633 uint64_t bytes_written = 0;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002634
Greg Claytond8cf1a12013-06-12 00:46:38 +00002635 bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void {
2636
2637 if (error.Success())
2638 {
2639 addr_t intersect_addr;
2640 size_t intersect_size;
2641 size_t opcode_offset;
2642 const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset);
Bruce Mitchener8a67bf72015-07-24 00:23:29 +00002643 UNUSED_IF_ASSERT_DISABLED(intersects);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002644 assert(intersects);
2645 assert(addr <= intersect_addr && intersect_addr < addr + size);
2646 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2647 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2648
2649 // Check for bytes before this breakpoint
2650 const addr_t curr_addr = addr + bytes_written;
2651 if (intersect_addr > curr_addr)
2652 {
2653 // There are some bytes before this breakpoint that we need to
2654 // just write to memory
2655 size_t curr_size = intersect_addr - curr_addr;
2656 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2657 ubuf + bytes_written,
2658 curr_size,
2659 error);
2660 bytes_written += curr_bytes_written;
2661 if (curr_bytes_written != curr_size)
2662 {
2663 // We weren't able to write all of the requested bytes, we
2664 // are done looping and will return the number of bytes that
2665 // we have written so far.
2666 if (error.Success())
2667 error.SetErrorToGenericError();
2668 }
2669 }
2670 // Now write any bytes that would cover up any software breakpoints
2671 // directly into the breakpoint opcode buffer
2672 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2673 bytes_written += intersect_size;
2674 }
2675 });
2676
2677 if (bytes_written < size)
Jason Molenda8b5f2cf2014-10-16 07:49:27 +00002678 WriteMemoryPrivate (addr + bytes_written,
2679 ubuf + bytes_written,
2680 size - bytes_written,
2681 error);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002682 }
2683 }
2684 else
2685 {
2686 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002687 }
2688
2689 // Write any remaining bytes after the last breakpoint if we have any left
Greg Claytond8cf1a12013-06-12 00:46:38 +00002690 return 0; //bytes_written;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002691}
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002692
2693size_t
Greg Claytonc7bece562013-01-25 18:06:21 +00002694Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002695{
2696 if (byte_size == UINT32_MAX)
2697 byte_size = scalar.GetByteSize();
2698 if (byte_size > 0)
2699 {
2700 uint8_t buf[32];
2701 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2702 if (mem_size > 0)
2703 return WriteMemory(addr, buf, mem_size, error);
2704 else
2705 error.SetErrorString ("failed to get scalar as memory data");
2706 }
2707 else
2708 {
2709 error.SetErrorString ("invalid scalar value");
2710 }
2711 return 0;
2712}
2713
2714size_t
2715Process::ReadScalarIntegerFromMemory (addr_t addr,
2716 uint32_t byte_size,
2717 bool is_signed,
2718 Scalar &scalar,
2719 Error &error)
2720{
Greg Clayton7060f892013-05-01 23:41:30 +00002721 uint64_t uval = 0;
2722 if (byte_size == 0)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002723 {
Greg Clayton7060f892013-05-01 23:41:30 +00002724 error.SetErrorString ("byte size is zero");
2725 }
2726 else if (byte_size & (byte_size - 1))
2727 {
2728 error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size);
2729 }
2730 else if (byte_size <= sizeof(uval))
2731 {
2732 const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002733 if (bytes_read == byte_size)
2734 {
2735 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
Greg Claytonc7bece562013-01-25 18:06:21 +00002736 lldb::offset_t offset = 0;
Greg Clayton7060f892013-05-01 23:41:30 +00002737 if (byte_size <= 4)
2738 scalar = data.GetMaxU32 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002739 else
Greg Clayton7060f892013-05-01 23:41:30 +00002740 scalar = data.GetMaxU64 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002741 if (is_signed)
2742 scalar.SignExtend(byte_size * 8);
2743 return bytes_read;
2744 }
2745 }
2746 else
2747 {
2748 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2749 }
2750 return 0;
2751}
2752
Greg Claytond495c532011-05-17 03:37:42 +00002753#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002754addr_t
2755Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2756{
Jim Inghamf72ce3a2011-06-20 17:32:44 +00002757 if (GetPrivateState() != eStateStopped)
2758 return LLDB_INVALID_ADDRESS;
2759
Greg Claytond495c532011-05-17 03:37:42 +00002760#if defined (USE_ALLOCATE_MEMORY_CACHE)
2761 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2762#else
Greg Claytonb2daec92011-01-23 19:58:49 +00002763 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
Greg Clayton5160ce52013-03-27 23:08:40 +00002764 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002765 if (log)
Greg Clayton45989072013-10-23 18:24:30 +00002766 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 +00002767 (uint64_t)size,
Greg Claytond495c532011-05-17 03:37:42 +00002768 GetPermissionsAsCString (permissions),
Greg Claytonb2daec92011-01-23 19:58:49 +00002769 (uint64_t)allocated_addr,
Jim Ingham4b536182011-08-09 02:12:22 +00002770 m_mod_id.GetStopID(),
2771 m_mod_id.GetMemoryID());
Greg Claytonb2daec92011-01-23 19:58:49 +00002772 return allocated_addr;
Greg Claytond495c532011-05-17 03:37:42 +00002773#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002774}
2775
Jim Ingham2c381412015-11-04 20:32:27 +00002776addr_t
2777Process::CallocateMemory(size_t size, uint32_t permissions, Error &error)
2778{
2779 addr_t return_addr = AllocateMemory(size, permissions, error);
2780 if (error.Success())
2781 {
2782 std::string buffer(size, 0);
2783 WriteMemory(return_addr, buffer.c_str(), size, error);
2784 }
2785 return return_addr;
2786}
2787
Sean Callanan90539452011-09-20 23:01:51 +00002788bool
2789Process::CanJIT ()
2790{
Sean Callanana7b443a2012-02-14 22:50:38 +00002791 if (m_can_jit == eCanJITDontKnow)
2792 {
Todd Fialaaf245d12014-06-30 21:05:18 +00002793 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Sean Callanana7b443a2012-02-14 22:50:38 +00002794 Error err;
2795
2796 uint64_t allocated_memory = AllocateMemory(8,
2797 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2798 err);
2799
2800 if (err.Success())
Todd Fialaaf245d12014-06-30 21:05:18 +00002801 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002802 m_can_jit = eCanJITYes;
Todd Fialaaf245d12014-06-30 21:05:18 +00002803 if (log)
2804 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ());
2805 }
Sean Callanana7b443a2012-02-14 22:50:38 +00002806 else
Todd Fialaaf245d12014-06-30 21:05:18 +00002807 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002808 m_can_jit = eCanJITNo;
Todd Fialaaf245d12014-06-30 21:05:18 +00002809 if (log)
2810 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ());
2811 }
Sean Callanana7b443a2012-02-14 22:50:38 +00002812
2813 DeallocateMemory (allocated_memory);
2814 }
2815
Sean Callanan90539452011-09-20 23:01:51 +00002816 return m_can_jit == eCanJITYes;
2817}
2818
2819void
2820Process::SetCanJIT (bool can_jit)
2821{
2822 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2823}
2824
Ewan Crawford90ff7912015-07-14 10:56:58 +00002825void
2826Process::SetCanRunCode (bool can_run_code)
2827{
2828 SetCanJIT(can_run_code);
2829 m_can_interpret_function_calls = can_run_code;
2830}
2831
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002832Error
2833Process::DeallocateMemory (addr_t ptr)
2834{
Greg Claytond495c532011-05-17 03:37:42 +00002835 Error error;
2836#if defined (USE_ALLOCATE_MEMORY_CACHE)
2837 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2838 {
Daniel Malead01b2952012-11-29 21:49:15 +00002839 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
Greg Claytond495c532011-05-17 03:37:42 +00002840 }
2841#else
2842 error = DoDeallocateMemory (ptr);
Greg Claytonb2daec92011-01-23 19:58:49 +00002843
Greg Clayton5160ce52013-03-27 23:08:40 +00002844 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002845 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002846 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 +00002847 ptr,
2848 error.AsCString("SUCCESS"),
Jim Ingham4b536182011-08-09 02:12:22 +00002849 m_mod_id.GetStopID(),
2850 m_mod_id.GetMemoryID());
Greg Claytond495c532011-05-17 03:37:42 +00002851#endif
Greg Claytonb2daec92011-01-23 19:58:49 +00002852 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002853}
2854
Greg Claytonc9660542012-02-05 02:38:54 +00002855ModuleSP
Greg Claytonc859e2d2012-02-13 23:10:39 +00002856Process::ReadModuleFromMemory (const FileSpec& file_spec,
Andrew MacPherson17220c12014-03-05 10:12:43 +00002857 lldb::addr_t header_addr,
2858 size_t size_to_read)
Greg Claytonc9660542012-02-05 02:38:54 +00002859{
Jason Molenda08a32582015-07-25 02:39:42 +00002860 Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
2861 if (log)
2862 {
2863 log->Printf ("Process::ReadModuleFromMemory reading %s binary from memory", file_spec.GetPath().c_str());
2864 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002865 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
Greg Claytonc9660542012-02-05 02:38:54 +00002866 if (module_sp)
2867 {
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002868 Error error;
Andrew MacPherson17220c12014-03-05 10:12:43 +00002869 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read);
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002870 if (objfile)
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002871 return module_sp;
Greg Claytonc9660542012-02-05 02:38:54 +00002872 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002873 return ModuleSP();
Greg Claytonc9660542012-02-05 02:38:54 +00002874}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002875
Zachary Turner93749ab2015-03-03 21:51:25 +00002876bool
2877Process::GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions)
2878{
2879 MemoryRegionInfo range_info;
2880 permissions = 0;
2881 Error error (GetMemoryRegionInfo (load_addr, range_info));
2882 if (!error.Success())
2883 return false;
2884 if (range_info.GetReadable() == MemoryRegionInfo::eDontKnow
2885 || range_info.GetWritable() == MemoryRegionInfo::eDontKnow
2886 || range_info.GetExecutable() == MemoryRegionInfo::eDontKnow)
2887 {
2888 return false;
2889 }
2890
2891 if (range_info.GetReadable() == MemoryRegionInfo::eYes)
2892 permissions |= lldb::ePermissionsReadable;
2893
2894 if (range_info.GetWritable() == MemoryRegionInfo::eYes)
2895 permissions |= lldb::ePermissionsWritable;
2896
2897 if (range_info.GetExecutable() == MemoryRegionInfo::eYes)
2898 permissions |= lldb::ePermissionsExecutable;
2899
2900 return true;
2901}
2902
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002903Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00002904Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002905{
2906 Error error;
2907 error.SetErrorString("watchpoints are not supported");
2908 return error;
2909}
2910
2911Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00002912Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002913{
2914 Error error;
2915 error.SetErrorString("watchpoints are not supported");
2916 return error;
2917}
2918
2919StateType
2920Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2921{
2922 StateType state;
2923 // Now wait for the process to launch and return control to us, and then
2924 // call DidLaunch:
2925 while (1)
2926 {
Greg Clayton6779606a2011-01-22 23:43:18 +00002927 event_sp.reset();
2928 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2929
Greg Clayton2637f822011-11-17 01:23:07 +00002930 if (StateIsStoppedState(state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002931 break;
Greg Clayton6779606a2011-01-22 23:43:18 +00002932
2933 // If state is invalid, then we timed out
2934 if (state == eStateInvalid)
2935 break;
2936
2937 if (event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002938 HandlePrivateEvent (event_sp);
2939 }
2940 return state;
2941}
2942
Greg Clayton332e8b12015-01-13 21:13:08 +00002943void
2944Process::LoadOperatingSystemPlugin(bool flush)
2945{
2946 if (flush)
2947 m_thread_list.Clear();
2948 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2949 if (flush)
2950 Flush();
2951}
2952
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002953Error
Greg Claytonfbb76342013-11-20 21:07:01 +00002954Process::Launch (ProcessLaunchInfo &launch_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002955{
2956 Error error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002957 m_abi_sp.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00002958 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00002959 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00002960 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00002961 m_os_ap.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00002962 m_process_input_reader.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +00002963 m_stop_info_override_callback = NULL;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002964
Zachary Turner7529df92015-09-01 20:02:29 +00002965 Module *exe_module = GetTarget().GetExecutableModulePointer();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002966 if (exe_module)
2967 {
Greg Clayton2289fa42011-04-30 01:09:13 +00002968 char local_exec_file_path[PATH_MAX];
2969 char platform_exec_file_path[PATH_MAX];
2970 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2971 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002972 if (exe_module->GetFileSpec().Exists())
2973 {
Greg Claytonfbb76342013-11-20 21:07:01 +00002974 // Install anything that might need to be installed prior to launching.
2975 // For host systems, this will do nothing, but if we are connected to a
2976 // remote platform it will install any needed binaries
2977 error = GetTarget().Install(&launch_info);
2978 if (error.Fail())
2979 return error;
2980
Greg Clayton71337622011-02-24 22:24:29 +00002981 if (PrivateStateThreadIsValid ())
2982 PausePrivateStateThread ();
2983
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002984 error = WillLaunch (exe_module);
2985 if (error.Success())
2986 {
Jim Ingham221d51c2013-05-08 00:35:16 +00002987 const bool restarted = false;
2988 SetPublicState (eStateLaunching, restarted);
Greg Claytone24c4ac2011-11-17 04:46:02 +00002989 m_should_detach = false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002990
Ed Maste64fad602013-07-29 20:58:06 +00002991 if (m_public_run_lock.TrySetRunning())
Greg Clayton69fd4be2012-09-04 20:29:05 +00002992 {
2993 // Now launch using these arguments.
2994 error = DoLaunch (exe_module, launch_info);
2995 }
2996 else
2997 {
2998 // This shouldn't happen
2999 error.SetErrorString("failed to acquire process run lock");
3000 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003001
3002 if (error.Fail())
3003 {
3004 if (GetID() != LLDB_INVALID_PROCESS_ID)
3005 {
3006 SetID (LLDB_INVALID_PROCESS_ID);
3007 const char *error_string = error.AsCString();
3008 if (error_string == NULL)
3009 error_string = "launch failed";
3010 SetExitStatus (-1, error_string);
3011 }
3012 }
3013 else
3014 {
3015 EventSP event_sp;
Greg Clayton1a38ea72011-06-22 01:42:17 +00003016 TimeValue timeout_time;
3017 timeout_time = TimeValue::Now();
3018 timeout_time.OffsetWithSeconds(10);
3019 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003020
Greg Clayton1a38ea72011-06-22 01:42:17 +00003021 if (state == eStateInvalid || event_sp.get() == NULL)
3022 {
3023 // We were able to launch the process, but we failed to
3024 // catch the initial stop.
Tamas Berghammer04e63142015-02-23 10:59:54 +00003025 error.SetErrorString ("failed to catch stop after launch");
Greg Clayton1a38ea72011-06-22 01:42:17 +00003026 SetExitStatus (0, "failed to catch stop after launch");
Jason Molendaede31932015-04-17 05:01:58 +00003027 Destroy(false);
Greg Clayton1a38ea72011-06-22 01:42:17 +00003028 }
3029 else if (state == eStateStopped || state == eStateCrashed)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003030 {
3031 DidLaunch ();
3032
Greg Claytonc859e2d2012-02-13 23:10:39 +00003033 DynamicLoader *dyld = GetDynamicLoader ();
3034 if (dyld)
3035 dyld->DidLaunch();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003036
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003037 GetJITLoaders().DidLaunch();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003038
Jason Molendaeef51062013-11-05 03:57:19 +00003039 SystemRuntime *system_runtime = GetSystemRuntime ();
3040 if (system_runtime)
3041 system_runtime->DidLaunch();
3042
Greg Clayton332e8b12015-01-13 21:13:08 +00003043 LoadOperatingSystemPlugin(false);
Todd Fialaf72fa672014-10-07 16:05:21 +00003044
3045 // Note, the stop event was consumed above, but not handled. This was done
3046 // to give DidLaunch a chance to run. The target is either stopped or crashed.
3047 // Directly set the state. This is done to prevent a stop message with a bunch
3048 // of spurious output on thread status, as well as not pop a ProcessIOHandler.
3049 SetPublicState(state, false);
Greg Clayton71337622011-02-24 22:24:29 +00003050
3051 if (PrivateStateThreadIsValid ())
3052 ResumePrivateStateThread ();
3053 else
3054 StartPrivateStateThread ();
Greg Claytona97c4d22014-12-09 23:31:02 +00003055
3056 m_stop_info_override_callback = GetTarget().GetArchitecture().GetStopInfoOverrideCallback();
Ilia K6af632f2015-02-06 18:15:05 +00003057
3058 // Target was stopped at entry as was intended. Need to notify the listeners
3059 // about it.
Ilia K333fc182015-02-11 11:24:20 +00003060 if (state == eStateStopped && launch_info.GetFlags().Test(eLaunchFlagStopAtEntry))
Ilia K6af632f2015-02-06 18:15:05 +00003061 HandlePrivateEvent(event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003062 }
3063 else if (state == eStateExited)
3064 {
3065 // We exited while trying to launch somehow. Don't call DidLaunch as that's
3066 // not likely to work, and return an invalid pid.
3067 HandlePrivateEvent (event_sp);
3068 }
3069 }
3070 }
3071 }
3072 else
3073 {
Greg Clayton86edbf42011-10-26 00:56:27 +00003074 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003075 }
3076 }
3077 return error;
3078}
3079
Greg Claytonc3776bf2012-02-09 06:16:32 +00003080Error
3081Process::LoadCore ()
3082{
3083 Error error = DoLoadCore();
3084 if (error.Success())
3085 {
Greg Clayton35824e32015-02-20 20:59:47 +00003086 Listener listener ("lldb.process.load_core_listener");
Greg Clayton338d0bd2015-02-20 21:51:06 +00003087 HijackProcessEvents(&listener);
Greg Clayton35824e32015-02-20 20:59:47 +00003088
Greg Claytonc3776bf2012-02-09 06:16:32 +00003089 if (PrivateStateThreadIsValid ())
3090 ResumePrivateStateThread ();
3091 else
3092 StartPrivateStateThread ();
3093
Greg Claytonc859e2d2012-02-13 23:10:39 +00003094 DynamicLoader *dyld = GetDynamicLoader ();
3095 if (dyld)
3096 dyld->DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003097
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003098 GetJITLoaders().DidAttach();
Greg Claytonc859e2d2012-02-13 23:10:39 +00003099
Jason Molendaeef51062013-11-05 03:57:19 +00003100 SystemRuntime *system_runtime = GetSystemRuntime ();
3101 if (system_runtime)
3102 system_runtime->DidAttach();
3103
Greg Claytonc859e2d2012-02-13 23:10:39 +00003104 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Claytonc3776bf2012-02-09 06:16:32 +00003105 // We successfully loaded a core file, now pretend we stopped so we can
3106 // show all of the threads in the core file and explore the crashed
3107 // state.
3108 SetPrivateState (eStateStopped);
Greg Clayton35824e32015-02-20 20:59:47 +00003109
3110 // Wait indefinitely for a stopped event since we just posted one above...
3111 lldb::EventSP event_sp;
3112 listener.WaitForEvent (NULL, event_sp);
3113 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3114
3115 if (!StateIsStoppedState (state, false))
3116 {
3117 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3118 if (log)
3119 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3120 error.SetErrorString ("Did not get stopped event after loading the core file.");
3121 }
Greg Clayton338d0bd2015-02-20 21:51:06 +00003122 RestoreProcessEvents ();
Greg Claytonc3776bf2012-02-09 06:16:32 +00003123 }
3124 return error;
3125}
3126
Greg Claytonc859e2d2012-02-13 23:10:39 +00003127DynamicLoader *
3128Process::GetDynamicLoader ()
3129{
3130 if (m_dyld_ap.get() == NULL)
3131 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
3132 return m_dyld_ap.get();
3133}
Greg Claytonc3776bf2012-02-09 06:16:32 +00003134
Todd Fialaaf245d12014-06-30 21:05:18 +00003135const lldb::DataBufferSP
3136Process::GetAuxvData()
3137{
3138 return DataBufferSP ();
3139}
3140
Andrew MacPherson17220c12014-03-05 10:12:43 +00003141JITLoaderList &
3142Process::GetJITLoaders ()
3143{
3144 if (!m_jit_loaders_ap)
3145 {
3146 m_jit_loaders_ap.reset(new JITLoaderList());
3147 JITLoader::LoadPlugins(this, *m_jit_loaders_ap);
3148 }
3149 return *m_jit_loaders_ap;
3150}
3151
Jason Molendaeef51062013-11-05 03:57:19 +00003152SystemRuntime *
3153Process::GetSystemRuntime ()
3154{
3155 if (m_system_runtime_ap.get() == NULL)
3156 m_system_runtime_ap.reset (SystemRuntime::FindPlugin(this));
3157 return m_system_runtime_ap.get();
3158}
3159
Todd Fiala76e0fc92014-08-27 22:58:26 +00003160Process::AttachCompletionHandler::AttachCompletionHandler (Process *process, uint32_t exec_count) :
3161 NextEventAction (process),
3162 m_exec_count (exec_count)
3163{
3164 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3165 if (log)
3166 log->Printf ("Process::AttachCompletionHandler::%s process=%p, exec_count=%" PRIu32, __FUNCTION__, static_cast<void*>(process), exec_count);
3167}
Greg Claytonc3776bf2012-02-09 06:16:32 +00003168
Jim Inghambb3a2832011-01-29 01:49:25 +00003169Process::NextEventAction::EventActionResult
3170Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003171{
Todd Fiala76e0fc92014-08-27 22:58:26 +00003172 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3173
Jim Inghambb3a2832011-01-29 01:49:25 +00003174 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
Todd Fiala76e0fc92014-08-27 22:58:26 +00003175 if (log)
3176 log->Printf ("Process::AttachCompletionHandler::%s called with state %s (%d)", __FUNCTION__, StateAsCString(state), static_cast<int> (state));
3177
3178 switch (state)
Greg Clayton19388cf2010-10-18 01:45:30 +00003179 {
Zachary Turnerc62733b2015-05-20 18:31:17 +00003180 case eStateAttaching:
3181 return eEventActionSuccess;
3182
Greg Clayton513c26c2011-01-29 07:10:55 +00003183 case eStateRunning:
Greg Clayton71337622011-02-24 22:24:29 +00003184 case eStateConnected:
Greg Clayton513c26c2011-01-29 07:10:55 +00003185 return eEventActionRetry;
3186
3187 case eStateStopped:
3188 case eStateCrashed:
Greg Claytonc9ed4782011-11-12 02:10:56 +00003189 {
3190 // During attach, prior to sending the eStateStopped event,
Jim Inghamb1e2e842012-04-12 18:49:31 +00003191 // lldb_private::Process subclasses must set the new process ID.
Greg Claytonc9ed4782011-11-12 02:10:56 +00003192 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
Jim Ingham221d51c2013-05-08 00:35:16 +00003193 // We don't want these events to be reported, so go set the ShouldReportStop here:
3194 m_process->GetThreadList().SetShouldReportStop (eVoteNo);
3195
Greg Claytonc9ed4782011-11-12 02:10:56 +00003196 if (m_exec_count > 0)
3197 {
3198 --m_exec_count;
Todd Fiala76e0fc92014-08-27 22:58:26 +00003199
3200 if (log)
3201 log->Printf ("Process::AttachCompletionHandler::%s state %s: reduced remaining exec count to %" PRIu32 ", requesting resume", __FUNCTION__, StateAsCString(state), m_exec_count);
3202
Jim Ingham221d51c2013-05-08 00:35:16 +00003203 RequestResume();
Greg Claytonc9ed4782011-11-12 02:10:56 +00003204 return eEventActionRetry;
3205 }
3206 else
3207 {
Todd Fiala76e0fc92014-08-27 22:58:26 +00003208 if (log)
3209 log->Printf ("Process::AttachCompletionHandler::%s state %s: no more execs expected to start, continuing with attach", __FUNCTION__, StateAsCString(state));
3210
Greg Claytonc9ed4782011-11-12 02:10:56 +00003211 m_process->CompleteAttach ();
3212 return eEventActionSuccess;
3213 }
3214 }
Greg Clayton513c26c2011-01-29 07:10:55 +00003215 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00003216
Greg Clayton513c26c2011-01-29 07:10:55 +00003217 default:
3218 case eStateExited:
3219 case eStateInvalid:
Greg Clayton513c26c2011-01-29 07:10:55 +00003220 break;
Jim Inghambb3a2832011-01-29 01:49:25 +00003221 }
Greg Claytonc9ed4782011-11-12 02:10:56 +00003222
3223 m_exit_string.assign ("No valid Process");
3224 return eEventActionExit;
Jim Inghambb3a2832011-01-29 01:49:25 +00003225}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003226
Jim Inghambb3a2832011-01-29 01:49:25 +00003227Process::NextEventAction::EventActionResult
3228Process::AttachCompletionHandler::HandleBeingInterrupted()
3229{
3230 return eEventActionSuccess;
3231}
3232
3233const char *
3234Process::AttachCompletionHandler::GetExitString ()
3235{
3236 return m_exit_string.c_str();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003237}
3238
Greg Clayton8012cad2014-11-17 19:39:20 +00003239Listener &
3240ProcessAttachInfo::GetListenerForProcess (Debugger &debugger)
3241{
3242 if (m_listener_sp)
3243 return *m_listener_sp;
3244 else
3245 return debugger.GetListener();
3246}
3247
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003248Error
Greg Clayton144f3a92011-11-15 03:53:30 +00003249Process::Attach (ProcessAttachInfo &attach_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003250{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003251 m_abi_sp.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003252 m_process_input_reader.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003253 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003254 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00003255 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003256 m_os_ap.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +00003257 m_stop_info_override_callback = NULL;
Jim Ingham5aee1622010-08-09 23:31:02 +00003258
Greg Clayton144f3a92011-11-15 03:53:30 +00003259 lldb::pid_t attach_pid = attach_info.GetProcessID();
Greg Claytone996fd32011-03-08 22:40:15 +00003260 Error error;
Greg Clayton144f3a92011-11-15 03:53:30 +00003261 if (attach_pid == LLDB_INVALID_PROCESS_ID)
Jim Ingham5aee1622010-08-09 23:31:02 +00003262 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003263 char process_name[PATH_MAX];
Jim Ingham4299fdb2011-09-15 01:10:17 +00003264
Greg Clayton144f3a92011-11-15 03:53:30 +00003265 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
Jim Ingham2ecb7422010-08-17 21:54:19 +00003266 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003267 const bool wait_for_launch = attach_info.GetWaitForLaunch();
3268
3269 if (wait_for_launch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003270 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003271 error = WillAttachToProcessWithName(process_name, wait_for_launch);
3272 if (error.Success())
3273 {
Ed Maste64fad602013-07-29 20:58:06 +00003274 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00003275 {
3276 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00003277 const bool restarted = false;
3278 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00003279 // Now attach using these arguments.
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00003280 error = DoAttachToProcessWithName (process_name, attach_info);
Greg Clayton926cce72012-10-12 16:10:12 +00003281 }
3282 else
3283 {
3284 // This shouldn't happen
3285 error.SetErrorString("failed to acquire process run lock");
3286 }
Greg Claytone24c4ac2011-11-17 04:46:02 +00003287
Greg Clayton144f3a92011-11-15 03:53:30 +00003288 if (error.Fail())
3289 {
3290 if (GetID() != LLDB_INVALID_PROCESS_ID)
3291 {
3292 SetID (LLDB_INVALID_PROCESS_ID);
3293 if (error.AsCString() == NULL)
3294 error.SetErrorString("attach failed");
3295
3296 SetExitStatus(-1, error.AsCString());
3297 }
3298 }
3299 else
3300 {
3301 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3302 StartPrivateStateThread();
3303 }
3304 return error;
3305 }
Greg Claytone996fd32011-03-08 22:40:15 +00003306 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003307 else
Greg Claytone996fd32011-03-08 22:40:15 +00003308 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003309 ProcessInstanceInfoList process_infos;
Zachary Turner7529df92015-09-01 20:02:29 +00003310 PlatformSP platform_sp (GetTarget().GetPlatform ());
Greg Clayton144f3a92011-11-15 03:53:30 +00003311
3312 if (platform_sp)
3313 {
3314 ProcessInstanceInfoMatch match_info;
3315 match_info.GetProcessInfo() = attach_info;
3316 match_info.SetNameMatchType (eNameMatchEquals);
3317 platform_sp->FindProcesses (match_info, process_infos);
3318 const uint32_t num_matches = process_infos.GetSize();
3319 if (num_matches == 1)
3320 {
3321 attach_pid = process_infos.GetProcessIDAtIndex(0);
3322 // Fall through and attach using the above process ID
3323 }
3324 else
3325 {
3326 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
3327 if (num_matches > 1)
Jim Ingham368ac222014-08-15 17:05:27 +00003328 {
3329 StreamString s;
3330 ProcessInstanceInfo::DumpTableHeader (s, platform_sp.get(), true, false);
3331 for (size_t i = 0; i < num_matches; i++)
3332 {
3333 process_infos.GetProcessInfoAtIndex(i).DumpAsTableRow(s, platform_sp.get(), true, false);
3334 }
3335 error.SetErrorStringWithFormat ("more than one process named %s:\n%s",
3336 process_name,
3337 s.GetData());
3338 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003339 else
3340 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
3341 }
3342 }
3343 else
3344 {
3345 error.SetErrorString ("invalid platform, can't find processes by name");
3346 return error;
3347 }
Greg Claytone996fd32011-03-08 22:40:15 +00003348 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003349 }
3350 else
Greg Clayton144f3a92011-11-15 03:53:30 +00003351 {
3352 error.SetErrorString ("invalid process name");
Greg Claytone996fd32011-03-08 22:40:15 +00003353 }
3354 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003355
3356 if (attach_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00003357 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003358 error = WillAttachToProcessWithID(attach_pid);
Greg Claytone996fd32011-03-08 22:40:15 +00003359 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003360 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003361
Ed Maste64fad602013-07-29 20:58:06 +00003362 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00003363 {
3364 // Now attach using these arguments.
3365 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00003366 const bool restarted = false;
3367 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00003368 error = DoAttachToProcessWithID (attach_pid, attach_info);
3369 }
3370 else
3371 {
3372 // This shouldn't happen
3373 error.SetErrorString("failed to acquire process run lock");
3374 }
3375
Greg Clayton144f3a92011-11-15 03:53:30 +00003376 if (error.Success())
3377 {
3378
3379 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3380 StartPrivateStateThread();
3381 }
3382 else
Greg Claytone996fd32011-03-08 22:40:15 +00003383 {
3384 if (GetID() != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00003385 SetID (LLDB_INVALID_PROCESS_ID);
Greg Claytone996fd32011-03-08 22:40:15 +00003386
Oleksiy Vyalov5d064742014-11-19 18:27:45 +00003387 const char *error_string = error.AsCString();
3388 if (error_string == NULL)
3389 error_string = "attach failed";
3390
3391 SetExitStatus(-1, error_string);
Greg Claytone996fd32011-03-08 22:40:15 +00003392 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003393 }
3394 }
3395 return error;
3396}
3397
Greg Clayton93d3c8332011-02-16 04:46:07 +00003398void
3399Process::CompleteAttach ()
3400{
Todd Fiala76e0fc92014-08-27 22:58:26 +00003401 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3402 if (log)
3403 log->Printf ("Process::%s()", __FUNCTION__);
3404
Greg Clayton93d3c8332011-02-16 04:46:07 +00003405 // Let the process subclass figure out at much as it can about the process
3406 // before we go looking for a dynamic loader plug-in.
Jim Inghambb006ce2014-08-02 00:33:35 +00003407 ArchSpec process_arch;
3408 DidAttach(process_arch);
3409
3410 if (process_arch.IsValid())
Todd Fiala76e0fc92014-08-27 22:58:26 +00003411 {
Zachary Turner7529df92015-09-01 20:02:29 +00003412 GetTarget().SetArchitecture(process_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003413 if (log)
3414 {
3415 const char *triple_str = process_arch.GetTriple().getTriple().c_str ();
3416 log->Printf ("Process::%s replacing process architecture with DidAttach() architecture: %s",
3417 __FUNCTION__,
3418 triple_str ? triple_str : "<null>");
3419 }
3420 }
Greg Clayton93d3c8332011-02-16 04:46:07 +00003421
Jim Ingham4299fdb2011-09-15 01:10:17 +00003422 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
3423 // the same as the one we've already set, switch architectures.
Zachary Turner7529df92015-09-01 20:02:29 +00003424 PlatformSP platform_sp (GetTarget().GetPlatform ());
Jim Ingham4299fdb2011-09-15 01:10:17 +00003425 assert (platform_sp.get());
3426 if (platform_sp)
3427 {
Zachary Turner7529df92015-09-01 20:02:29 +00003428 const ArchSpec &target_arch = GetTarget().GetArchitecture();
Greg Clayton1e0c8842013-01-11 20:49:54 +00003429 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
Greg Clayton70512312012-05-08 01:45:38 +00003430 {
3431 ArchSpec platform_arch;
3432 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3433 if (platform_sp)
3434 {
Zachary Turner7529df92015-09-01 20:02:29 +00003435 GetTarget().SetPlatform (platform_sp);
3436 GetTarget().SetArchitecture(platform_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003437 if (log)
3438 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 +00003439 }
3440 }
Jim Inghambb006ce2014-08-02 00:33:35 +00003441 else if (!process_arch.IsValid())
Greg Clayton70512312012-05-08 01:45:38 +00003442 {
3443 ProcessInstanceInfo process_info;
3444 platform_sp->GetProcessInfo (GetID(), process_info);
3445 const ArchSpec &process_arch = process_info.GetArchitecture();
Zachary Turner7529df92015-09-01 20:02:29 +00003446 if (process_arch.IsValid() && !GetTarget().GetArchitecture().IsExactMatch(process_arch))
Todd Fiala76e0fc92014-08-27 22:58:26 +00003447 {
Zachary Turner7529df92015-09-01 20:02:29 +00003448 GetTarget().SetArchitecture (process_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003449 if (log)
3450 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 ());
3451 }
Greg Clayton70512312012-05-08 01:45:38 +00003452 }
Jim Ingham4299fdb2011-09-15 01:10:17 +00003453 }
3454
3455 // We have completed the attach, now it is time to find the dynamic loader
Greg Clayton93d3c8332011-02-16 04:46:07 +00003456 // plug-in
Greg Claytonc859e2d2012-02-13 23:10:39 +00003457 DynamicLoader *dyld = GetDynamicLoader ();
3458 if (dyld)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003459 {
Greg Claytonc859e2d2012-02-13 23:10:39 +00003460 dyld->DidAttach();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003461 if (log)
3462 {
Zachary Turner7529df92015-09-01 20:02:29 +00003463 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003464 log->Printf ("Process::%s after DynamicLoader::DidAttach(), target executable is %s (using %s plugin)",
3465 __FUNCTION__,
3466 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3467 dyld->GetPluginName().AsCString ("<unnamed>"));
3468 }
3469 }
Greg Clayton93d3c8332011-02-16 04:46:07 +00003470
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003471 GetJITLoaders().DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003472
Jason Molendaeef51062013-11-05 03:57:19 +00003473 SystemRuntime *system_runtime = GetSystemRuntime ();
3474 if (system_runtime)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003475 {
Jason Molendaeef51062013-11-05 03:57:19 +00003476 system_runtime->DidAttach();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003477 if (log)
3478 {
Zachary Turner7529df92015-09-01 20:02:29 +00003479 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003480 log->Printf ("Process::%s after SystemRuntime::DidAttach(), target executable is %s (using %s plugin)",
3481 __FUNCTION__,
3482 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3483 system_runtime->GetPluginName().AsCString("<unnamed>"));
3484 }
3485 }
Jason Molendaeef51062013-11-05 03:57:19 +00003486
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003487 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton93d3c8332011-02-16 04:46:07 +00003488 // Figure out which one is the executable, and set that in our target:
Zachary Turner7529df92015-09-01 20:02:29 +00003489 const ModuleList &target_modules = GetTarget().GetImages();
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003490 Mutex::Locker modules_locker(target_modules.GetMutex());
3491 size_t num_modules = target_modules.GetSize();
3492 ModuleSP new_executable_module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003493
Andy Gibbsa297a972013-06-19 19:04:53 +00003494 for (size_t i = 0; i < num_modules; i++)
Greg Clayton93d3c8332011-02-16 04:46:07 +00003495 {
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003496 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
Greg Clayton8b82f082011-04-12 05:54:46 +00003497 if (module_sp && module_sp->IsExecutable())
Greg Clayton93d3c8332011-02-16 04:46:07 +00003498 {
Zachary Turner7529df92015-09-01 20:02:29 +00003499 if (GetTarget().GetExecutableModulePointer() != module_sp.get())
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003500 new_executable_module_sp = module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003501 break;
3502 }
3503 }
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003504 if (new_executable_module_sp)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003505 {
Zachary Turner7529df92015-09-01 20:02:29 +00003506 GetTarget().SetExecutableModule (new_executable_module_sp, false);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003507 if (log)
3508 {
Zachary Turner7529df92015-09-01 20:02:29 +00003509 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003510 log->Printf ("Process::%s after looping through modules, target executable is %s",
3511 __FUNCTION__,
3512 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>");
3513 }
3514 }
Greg Claytona97c4d22014-12-09 23:31:02 +00003515
3516 m_stop_info_override_callback = process_arch.GetStopInfoOverrideCallback();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003517}
3518
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003519Error
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003520Process::ConnectRemote (Stream *strm, const char *remote_url)
Greg Claytonb766a732011-02-04 01:58:07 +00003521{
Greg Claytonb766a732011-02-04 01:58:07 +00003522 m_abi_sp.reset();
3523 m_process_input_reader.reset();
3524
3525 // Find the process and its architecture. Make sure it matches the architecture
3526 // of the current Target, and if not adjust it.
3527
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003528 Error error (DoConnectRemote (strm, remote_url));
Greg Claytonb766a732011-02-04 01:58:07 +00003529 if (error.Success())
3530 {
Greg Clayton71337622011-02-24 22:24:29 +00003531 if (GetID() != LLDB_INVALID_PROCESS_ID)
3532 {
Greg Clayton32e0a752011-03-30 18:16:51 +00003533 EventSP event_sp;
3534 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3535
3536 if (state == eStateStopped || state == eStateCrashed)
3537 {
3538 // If we attached and actually have a process on the other end, then
3539 // this ended up being the equivalent of an attach.
3540 CompleteAttach ();
3541
3542 // This delays passing the stopped event to listeners till
3543 // CompleteAttach gets a chance to complete...
3544 HandlePrivateEvent (event_sp);
3545
3546 }
Greg Clayton71337622011-02-24 22:24:29 +00003547 }
Greg Clayton32e0a752011-03-30 18:16:51 +00003548
3549 if (PrivateStateThreadIsValid ())
3550 ResumePrivateStateThread ();
3551 else
3552 StartPrivateStateThread ();
Greg Claytonb766a732011-02-04 01:58:07 +00003553 }
3554 return error;
3555}
3556
Greg Claytonb766a732011-02-04 01:58:07 +00003557Error
Jim Ingham3b8285d2012-04-19 01:40:33 +00003558Process::PrivateResume ()
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003559{
Greg Clayton5160ce52013-03-27 23:08:40 +00003560 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003561 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003562 log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s",
Jim Ingham4b536182011-08-09 02:12:22 +00003563 m_mod_id.GetStopID(),
Jim Ingham444586b2011-01-24 06:34:17 +00003564 StateAsCString(m_public_state.GetValue()),
3565 StateAsCString(m_private_state.GetValue()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003566
3567 Error error (WillResume());
3568 // Tell the process it is about to resume before the thread list
3569 if (error.Success())
3570 {
Johnny Chenc4221e42010-12-02 20:53:05 +00003571 // Now let the thread list know we are about to resume so it
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003572 // can let all of our threads know that they are about to be
3573 // resumed. Threads will each be called with
3574 // Thread::WillResume(StateType) where StateType contains the state
3575 // that they are supposed to have when the process is resumed
3576 // (suspended/running/stepping). Threads should also check
3577 // their resume signal in lldb::Thread::GetResumeSignal()
Jim Ingham221d51c2013-05-08 00:35:16 +00003578 // to see if they are supposed to start back up with a signal.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003579 if (m_thread_list.WillResume())
3580 {
Jim Ingham372787f2012-04-07 00:00:41 +00003581 // Last thing, do the PreResumeActions.
3582 if (!RunPreResumeActions())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003583 {
Jim Ingham0161b492013-02-09 01:29:05 +00003584 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming.");
Jim Ingham372787f2012-04-07 00:00:41 +00003585 }
3586 else
3587 {
3588 m_mod_id.BumpResumeID();
3589 error = DoResume();
3590 if (error.Success())
3591 {
3592 DidResume();
3593 m_thread_list.DidResume();
3594 if (log)
3595 log->Printf ("Process thinks the process has resumed.");
3596 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003597 }
3598 }
3599 else
3600 {
Jim Inghamd5ac1ab2015-01-19 23:51:51 +00003601 // Somebody wanted to run without running (e.g. we were faking a step from one frame of a set of inlined
3602 // frames that share the same PC to another.) So generate a continue & a stopped event,
Jim Ingham513c6bb2012-09-01 01:02:41 +00003603 // and let the world handle them.
3604 if (log)
3605 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3606
3607 SetPrivateState(eStateRunning);
3608 SetPrivateState(eStateStopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003609 }
3610 }
Jim Ingham444586b2011-01-24 06:34:17 +00003611 else if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003612 log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003613 return error;
3614}
3615
3616Error
Pavel Labath00fea632015-12-01 17:59:56 +00003617Process::Halt (bool clear_thread_plans)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003618{
Greg Claytonf9b57b92013-05-10 23:48:10 +00003619 // Don't clear the m_clear_thread_plans_on_stop, only set it to true if
3620 // in case it was already set and some thread plan logic calls halt on its
3621 // own.
3622 m_clear_thread_plans_on_stop |= clear_thread_plans;
3623
Pavel Labath00fea632015-12-01 17:59:56 +00003624 // First make sure we aren't in the middle of handling an event, or we might restart. This is pretty weak, since
3625 // we could just straightaway get another event. It just narrows the window...
3626 m_currently_handling_event.WaitForValueEqualTo(false);
3627
3628
3629 // Pause our private state thread so we can ensure no one else eats
3630 // the stop event out from under us.
Jim Ingham0f16e732011-02-08 05:20:59 +00003631 Listener halt_listener ("lldb.process.halt_listener");
Pavel Labath00fea632015-12-01 17:59:56 +00003632 HijackPrivateProcessEvents(&halt_listener);
Greg Clayton3af9ea52010-11-18 05:57:03 +00003633
Jim Inghambb3a2832011-01-29 01:49:25 +00003634 EventSP event_sp;
Pavel Labath00fea632015-12-01 17:59:56 +00003635 Error error (WillHalt());
Jim Inghambb3a2832011-01-29 01:49:25 +00003636
Pavel Labath00fea632015-12-01 17:59:56 +00003637 bool restored_process_events = false;
3638 if (error.Success())
Jim Inghambb3a2832011-01-29 01:49:25 +00003639 {
Pavel Labath00fea632015-12-01 17:59:56 +00003640
3641 bool caused_stop = false;
3642
3643 // Ask the process subclass to actually halt our process
3644 error = DoHalt(caused_stop);
3645 if (error.Success())
3646 {
3647 if (m_public_state.GetValue() == eStateAttaching)
3648 {
3649 // Don't hijack and eat the eStateExited as the code that was doing
3650 // the attach will be waiting for this event...
3651 RestorePrivateProcessEvents();
3652 restored_process_events = true;
3653 SetExitStatus(SIGKILL, "Cancelled async attach.");
3654 Destroy (false);
3655 }
3656 else
3657 {
3658 // If "caused_stop" is true, then DoHalt stopped the process. If
3659 // "caused_stop" is false, the process was already stopped.
3660 // If the DoHalt caused the process to stop, then we want to catch
3661 // this event and set the interrupted bool to true before we pass
3662 // this along so clients know that the process was interrupted by
3663 // a halt command.
3664 if (caused_stop)
3665 {
3666 // Wait for 1 second for the process to stop.
3667 TimeValue timeout_time;
3668 timeout_time = TimeValue::Now();
3669 timeout_time.OffsetWithSeconds(10);
3670 bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3671 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3672
3673 if (!got_event || state == eStateInvalid)
3674 {
3675 // We timeout out and didn't get a stop event...
3676 error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
3677 }
3678 else
3679 {
3680 if (StateIsStoppedState (state, false))
3681 {
3682 // We caused the process to interrupt itself, so mark this
3683 // as such in the stop event so clients can tell an interrupted
3684 // process from a natural stop
3685 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3686 }
3687 else
3688 {
3689 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3690 if (log)
3691 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3692 error.SetErrorString ("Did not get stopped event after halt.");
3693 }
3694 }
3695 }
3696 DidHalt();
3697 }
3698 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003699 }
Pavel Labath00fea632015-12-01 17:59:56 +00003700 // Resume our private state thread before we post the event (if any)
3701 if (!restored_process_events)
3702 RestorePrivateProcessEvents();
Jim Inghambb3a2832011-01-29 01:49:25 +00003703
Pavel Labath00fea632015-12-01 17:59:56 +00003704 // Post any event we might have consumed. If all goes well, we will have
3705 // stopped the process, intercepted the event and set the interrupted
3706 // bool in the event. Post it to the private event queue and that will end up
3707 // correctly setting the state.
3708 if (event_sp)
3709 m_private_state_broadcaster.BroadcastEvent(event_sp);
Jim Inghambb3a2832011-01-29 01:49:25 +00003710
Pavel Labath00fea632015-12-01 17:59:56 +00003711 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003712}
3713
3714Error
Pavel Labathfcc7f662015-10-07 15:11:11 +00003715Process::StopForDestroyOrDetach(lldb::EventSP &exit_event_sp)
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003716{
3717 Error error;
3718 if (m_public_state.GetValue() == eStateRunning)
3719 {
3720 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3721 if (log)
Pavel Labathfcc7f662015-10-07 15:11:11 +00003722 log->Printf("Process::%s() About to stop.", __FUNCTION__);
3723
3724 ListenerSP listener_sp (new Listener("lldb.Process.StopForDestroyOrDetach.hijack"));
3725 HijackProcessEvents(listener_sp.get());
3726
3727 SendAsyncInterrupt();
3728
3729 // Consume the interrupt event.
3730 TimeValue timeout (TimeValue::Now());
3731 timeout.OffsetWithSeconds(10);
3732
3733 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp, true, listener_sp.get());
3734
3735 RestoreProcessEvents();
3736
3737 // If the process exited while we were waiting for it to stop, put the exited event into
3738 // the shared pointer passed in and return. Our caller doesn't need to do anything else, since
3739 // they don't have a process anymore...
3740
3741 if (state == eStateExited || m_private_state.GetValue() == eStateExited)
Pavel Labathc8c77d42015-09-28 09:37:51 +00003742 {
3743 if (log)
Pavel Labathfcc7f662015-10-07 15:11:11 +00003744 log->Printf("Process::%s() Process exited while waiting to stop.", __FUNCTION__);
3745 return error;
3746 }
3747 else
3748 exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3749
3750 if (state != eStateStopped)
3751 {
3752 if (log)
3753 log->Printf("Process::%s() failed to stop, state is: %s", __FUNCTION__, StateAsCString(state));
3754 // If we really couldn't stop the process then we should just error out here, but if the
3755 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3756 StateType private_state = m_private_state.GetValue();
3757 if (private_state != eStateStopped)
3758 {
3759 return error;
3760 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003761 }
3762 }
3763 return error;
3764}
3765
3766Error
Jim Inghamacff8952013-05-02 00:27:30 +00003767Process::Detach (bool keep_stopped)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003768{
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003769 EventSP exit_event_sp;
3770 Error error;
3771 m_destroy_in_process = true;
3772
3773 error = WillDetach();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003774
3775 if (error.Success())
3776 {
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003777 if (DetachRequiresHalt())
3778 {
Pavel Labathfcc7f662015-10-07 15:11:11 +00003779 error = StopForDestroyOrDetach (exit_event_sp);
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003780 if (!error.Success())
3781 {
3782 m_destroy_in_process = false;
3783 return error;
3784 }
3785 else if (exit_event_sp)
3786 {
3787 // We shouldn't need to do anything else here. There's no process left to detach from...
3788 StopPrivateStateThread();
3789 m_destroy_in_process = false;
3790 return error;
3791 }
3792 }
3793
Andrew MacPhersonc3826b52014-03-25 19:59:36 +00003794 m_thread_list.DiscardThreadPlans();
3795 DisableAllBreakpointSites();
3796
Jim Inghamacff8952013-05-02 00:27:30 +00003797 error = DoDetach(keep_stopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003798 if (error.Success())
3799 {
3800 DidDetach();
3801 StopPrivateStateThread();
3802 }
Jim Inghamacff8952013-05-02 00:27:30 +00003803 else
3804 {
3805 return error;
3806 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003807 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003808 m_destroy_in_process = false;
3809
3810 // If we exited when we were waiting for a process to stop, then
3811 // forward the event here so we don't lose the event
3812 if (exit_event_sp)
3813 {
3814 // Directly broadcast our exited event because we shut down our
3815 // private state thread above
3816 BroadcastEvent(exit_event_sp);
3817 }
3818
3819 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3820 // the last events through the event system, in which case we might strand the write lock. Unlock
3821 // it here so when we do to tear down the process we don't get an error destroying the lock.
3822
Ed Maste64fad602013-07-29 20:58:06 +00003823 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003824 return error;
3825}
3826
3827Error
Jason Molendaede31932015-04-17 05:01:58 +00003828Process::Destroy (bool force_kill)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003829{
Jim Ingham09437922013-03-01 20:04:25 +00003830
3831 // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work
3832 // that might hinder the destruction. Remember to set this back to false when we are done. That way if the attempt
3833 // failed and the process stays around for some reason it won't be in a confused state.
Jason Molendaede31932015-04-17 05:01:58 +00003834
3835 if (force_kill)
3836 m_should_detach = false;
Jim Ingham09437922013-03-01 20:04:25 +00003837
Ilia Kfcc89a02015-03-26 07:08:47 +00003838 if (GetShouldDetach())
3839 {
3840 // FIXME: This will have to be a process setting:
3841 bool keep_stopped = false;
3842 Detach(keep_stopped);
3843 }
3844
Jim Ingham09437922013-03-01 20:04:25 +00003845 m_destroy_in_process = true;
3846
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003847 Error error (WillDestroy());
3848 if (error.Success())
3849 {
Greg Clayton85fb1b92012-09-11 02:33:37 +00003850 EventSP exit_event_sp;
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003851 if (DestroyRequiresHalt())
Jim Ingham04e0a222012-05-23 15:46:31 +00003852 {
Pavel Labathfcc7f662015-10-07 15:11:11 +00003853 error = StopForDestroyOrDetach(exit_event_sp);
Jim Ingham04e0a222012-05-23 15:46:31 +00003854 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003855
Jim Inghamaacc3182012-06-06 00:29:30 +00003856 if (m_public_state.GetValue() != eStateRunning)
3857 {
3858 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3859 // kill it, we don't want it hitting a breakpoint...
3860 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3861 // we're not going to have much luck doing this now.
3862 m_thread_list.DiscardThreadPlans();
3863 DisableAllBreakpointSites();
3864 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003865
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003866 error = DoDestroy();
3867 if (error.Success())
3868 {
3869 DidDestroy();
3870 StopPrivateStateThread();
3871 }
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003872 m_stdio_communication.Disconnect();
Greg Clayton23d54f42015-06-03 00:34:01 +00003873 m_stdio_communication.StopReadThread();
Vince Harrondf3f00f2015-02-10 21:09:04 +00003874 m_stdin_forward = false;
Greg Claytonb4874f12014-02-28 18:22:24 +00003875
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003876 if (m_process_input_reader)
Greg Claytonb4874f12014-02-28 18:22:24 +00003877 {
3878 m_process_input_reader->SetIsDone(true);
3879 m_process_input_reader->Cancel();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003880 m_process_input_reader.reset();
Greg Claytonb4874f12014-02-28 18:22:24 +00003881 }
3882
Greg Clayton85fb1b92012-09-11 02:33:37 +00003883 // If we exited when we were waiting for a process to stop, then
3884 // forward the event here so we don't lose the event
3885 if (exit_event_sp)
3886 {
3887 // Directly broadcast our exited event because we shut down our
3888 // private state thread above
3889 BroadcastEvent(exit_event_sp);
3890 }
3891
Jim Inghamb1e2e842012-04-12 18:49:31 +00003892 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3893 // the last events through the event system, in which case we might strand the write lock. Unlock
3894 // 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 +00003895 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003896 }
Jim Ingham09437922013-03-01 20:04:25 +00003897
3898 m_destroy_in_process = false;
3899
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003900 return error;
3901}
3902
3903Error
3904Process::Signal (int signal)
3905{
3906 Error error (WillSignal());
3907 if (error.Success())
3908 {
3909 error = DoSignal(signal);
3910 if (error.Success())
3911 DidSignal();
3912 }
3913 return error;
3914}
3915
Zachary Turner93749ab2015-03-03 21:51:25 +00003916void
Chaoren Linc963a222015-09-01 16:58:45 +00003917Process::SetUnixSignals(UnixSignalsSP &&signals_sp)
Zachary Turner93749ab2015-03-03 21:51:25 +00003918{
3919 assert (signals_sp && "null signals_sp");
3920 m_unix_signals_sp = signals_sp;
3921}
3922
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00003923const lldb::UnixSignalsSP &
Zachary Turner93749ab2015-03-03 21:51:25 +00003924Process::GetUnixSignals ()
3925{
3926 assert (m_unix_signals_sp && "null m_unix_signals_sp");
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00003927 return m_unix_signals_sp;
Zachary Turner93749ab2015-03-03 21:51:25 +00003928}
3929
Greg Clayton514487e2011-02-15 21:59:32 +00003930lldb::ByteOrder
3931Process::GetByteOrder () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003932{
Zachary Turner7529df92015-09-01 20:02:29 +00003933 return GetTarget().GetArchitecture().GetByteOrder();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003934}
3935
3936uint32_t
Greg Clayton514487e2011-02-15 21:59:32 +00003937Process::GetAddressByteSize () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003938{
Zachary Turner7529df92015-09-01 20:02:29 +00003939 return GetTarget().GetArchitecture().GetAddressByteSize();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003940}
3941
3942bool
3943Process::ShouldBroadcastEvent (Event *event_ptr)
3944{
3945 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3946 bool return_value = true;
Greg Clayton5160ce52013-03-27 23:08:40 +00003947 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS));
Jim Ingham0161b492013-02-09 01:29:05 +00003948
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003949 switch (state)
3950 {
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003951 case eStateDetached:
3952 case eStateExited:
3953 case eStateUnloaded:
Pavel Labath3f5df532015-03-12 10:12:41 +00003954 m_stdio_communication.SynchronizeWithReadThread();
Pavel Labatha9a43372015-09-03 09:30:17 +00003955 m_stdio_communication.Disconnect();
3956 m_stdio_communication.StopReadThread();
3957 m_stdin_forward = false;
3958
Pavel Labath3f5df532015-03-12 10:12:41 +00003959 // fall-through
3960 case eStateConnected:
3961 case eStateAttaching:
3962 case eStateLaunching:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003963 // These events indicate changes in the state of the debugging session, always report them.
3964 return_value = true;
3965 break;
3966 case eStateInvalid:
3967 // We stopped for no apparent reason, don't report it.
3968 return_value = false;
3969 break;
3970 case eStateRunning:
3971 case eStateStepping:
3972 // If we've started the target running, we handle the cases where we
3973 // are already running and where there is a transition from stopped to
3974 // running differently.
3975 // running -> running: Automatically suppress extra running events
3976 // stopped -> running: Report except when there is one or more no votes
3977 // and no yes votes.
3978 SynchronouslyNotifyStateChanged (state);
Jim Ingham1460e4b2014-01-10 23:46:59 +00003979 if (m_force_next_event_delivery)
3980 return_value = true;
3981 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003982 {
Jim Ingham1460e4b2014-01-10 23:46:59 +00003983 switch (m_last_broadcast_state)
3984 {
3985 case eStateRunning:
3986 case eStateStepping:
3987 // We always suppress multiple runnings with no PUBLIC stop in between.
3988 return_value = false;
3989 break;
3990 default:
3991 // TODO: make this work correctly. For now always report
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00003992 // run if we aren't running so we don't miss any running
Jim Ingham1460e4b2014-01-10 23:46:59 +00003993 // events. If I run the lldb/test/thread/a.out file and
3994 // break at main.cpp:58, run and hit the breakpoints on
3995 // multiple threads, then somehow during the stepping over
3996 // of all breakpoints no run gets reported.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003997
Jim Ingham1460e4b2014-01-10 23:46:59 +00003998 // This is a transition from stop to run.
3999 switch (m_thread_list.ShouldReportRun (event_ptr))
4000 {
4001 case eVoteYes:
4002 case eVoteNoOpinion:
4003 return_value = true;
4004 break;
4005 case eVoteNo:
4006 return_value = false;
4007 break;
4008 }
4009 break;
4010 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004011 }
4012 break;
4013 case eStateStopped:
4014 case eStateCrashed:
4015 case eStateSuspended:
4016 {
4017 // We've stopped. First see if we're going to restart the target.
4018 // If we are going to stop, then we always broadcast the event.
4019 // 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 +00004020 // If no thread has an opinion, we don't report it.
Jim Ingham221d51c2013-05-08 00:35:16 +00004021
Pavel Labath3f5df532015-03-12 10:12:41 +00004022 m_stdio_communication.SynchronizeWithReadThread();
Jim Inghamcb4ca112012-05-16 01:32:14 +00004023 RefreshStateAfterStop ();
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004024 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004025 {
Greg Clayton3af9ea52010-11-18 05:57:03 +00004026 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004027 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004028 static_cast<void*>(event_ptr),
Jim Ingham0161b492013-02-09 01:29:05 +00004029 StateAsCString(state));
Jim Ingham35878c42014-04-08 21:33:21 +00004030 // Even though we know we are going to stop, we should let the threads have a look at the stop,
4031 // so they can properly set their state.
4032 m_thread_list.ShouldStop (event_ptr);
Jim Ingham0161b492013-02-09 01:29:05 +00004033 return_value = true;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004034 }
4035 else
4036 {
Jim Ingham221d51c2013-05-08 00:35:16 +00004037 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
4038 bool should_resume = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004039
Jim Ingham0161b492013-02-09 01:29:05 +00004040 // It makes no sense to ask "ShouldStop" if we've already been restarted...
4041 // Asking the thread list is also not likely to go well, since we are running again.
4042 // So in that case just report the event.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004043
Jim Ingham0161b492013-02-09 01:29:05 +00004044 if (!was_restarted)
4045 should_resume = m_thread_list.ShouldStop (event_ptr) == false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004046
Jim Ingham221d51c2013-05-08 00:35:16 +00004047 if (was_restarted || should_resume || m_resume_requested)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004048 {
Jim Ingham0161b492013-02-09 01:29:05 +00004049 Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr);
4050 if (log)
4051 log->Printf ("Process::ShouldBroadcastEvent: should_stop: %i state: %s was_restarted: %i stop_vote: %d.",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004052 should_resume, StateAsCString(state),
4053 was_restarted, stop_vote);
4054
Jim Ingham0161b492013-02-09 01:29:05 +00004055 switch (stop_vote)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004056 {
4057 case eVoteYes:
Jim Ingham0161b492013-02-09 01:29:05 +00004058 return_value = true;
4059 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004060 case eVoteNoOpinion:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004061 case eVoteNo:
4062 return_value = false;
4063 break;
4064 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004065
Jim Inghamcb95f342012-09-05 21:13:56 +00004066 if (!was_restarted)
Jim Ingham0161b492013-02-09 01:29:05 +00004067 {
4068 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004069 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s",
4070 static_cast<void*>(event_ptr),
4071 StateAsCString(state));
Jim Ingham0161b492013-02-09 01:29:05 +00004072 ProcessEventData::SetRestartedInEvent(event_ptr, true);
Jim Inghamcb95f342012-09-05 21:13:56 +00004073 PrivateResume ();
Jim Ingham0161b492013-02-09 01:29:05 +00004074 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004075 }
4076 else
4077 {
4078 return_value = true;
4079 SynchronouslyNotifyStateChanged (state);
4080 }
4081 }
4082 }
Jim Ingham0161b492013-02-09 01:29:05 +00004083 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004084 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004085
Jim Ingham1460e4b2014-01-10 23:46:59 +00004086 // Forcing the next event delivery is a one shot deal. So reset it here.
4087 m_force_next_event_delivery = false;
4088
Jim Ingham0161b492013-02-09 01:29:05 +00004089 // We do some coalescing of events (for instance two consecutive running events get coalesced.)
4090 // But we only coalesce against events we actually broadcast. So we use m_last_broadcast_state
4091 // to track that. NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done,
4092 // because the PublicState reflects the last event pulled off the queue, and there may be several
4093 // events stacked up on the queue unserviced. So the PublicState may not reflect the last broadcasted event
4094 // yet. m_last_broadcast_state gets updated here.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004095
Jim Ingham0161b492013-02-09 01:29:05 +00004096 if (return_value)
4097 m_last_broadcast_state = state;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004098
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004099 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004100 log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004101 static_cast<void*>(event_ptr), StateAsCString(state),
Jim Ingham0161b492013-02-09 01:29:05 +00004102 StateAsCString(m_last_broadcast_state),
4103 return_value ? "YES" : "NO");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004104 return return_value;
4105}
4106
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004107bool
Jim Ingham60c915e2015-06-23 21:02:45 +00004108Process::StartPrivateStateThread (bool is_secondary_thread)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004109{
Greg Clayton5160ce52013-03-27 23:08:40 +00004110 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004111
Greg Clayton8b82f082011-04-12 05:54:46 +00004112 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004113 if (log)
Greg Clayton8b82f082011-04-12 05:54:46 +00004114 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
4115
Jim Ingham60c915e2015-06-23 21:02:45 +00004116 if (!is_secondary_thread && already_running)
Greg Clayton8b82f082011-04-12 05:54:46 +00004117 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004118
4119 // Create a thread that watches our internal state and controls which
4120 // events make it to clients (into the DCProcess event queue).
Greg Clayton3e06bd92011-01-09 21:07:35 +00004121 char thread_name[1024];
Todd Fiala17096d72014-07-16 19:03:16 +00004122
Zachary Turner39de3112014-09-09 20:54:56 +00004123 if (HostInfo::GetMaxThreadNameLength() <= 30)
Todd Fiala17096d72014-07-16 19:03:16 +00004124 {
Zachary Turner39de3112014-09-09 20:54:56 +00004125 // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit.
4126 if (already_running)
4127 snprintf(thread_name, sizeof(thread_name), "intern-state-OV");
4128 else
4129 snprintf(thread_name, sizeof(thread_name), "intern-state");
Todd Fiala17096d72014-07-16 19:03:16 +00004130 }
Jim Ingham372787f2012-04-07 00:00:41 +00004131 else
Todd Fiala17096d72014-07-16 19:03:16 +00004132 {
4133 if (already_running)
Zachary Turner39de3112014-09-09 20:54:56 +00004134 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
Todd Fiala17096d72014-07-16 19:03:16 +00004135 else
Zachary Turner39de3112014-09-09 20:54:56 +00004136 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
Todd Fiala17096d72014-07-16 19:03:16 +00004137 }
4138
Jim Ingham076b3042012-04-10 01:21:57 +00004139 // Create the private state thread, and start it running.
Jim Ingham60c915e2015-06-23 21:02:45 +00004140 PrivateStateThreadArgs args = {this, is_secondary_thread};
4141 m_private_state_thread = ThreadLauncher::LaunchThread(thread_name, Process::PrivateStateThread, (void *) &args, NULL);
Zachary Turneracee96a2014-09-23 18:32:09 +00004142 if (m_private_state_thread.IsJoinable())
Jim Ingham076b3042012-04-10 01:21:57 +00004143 {
4144 ResumePrivateStateThread();
4145 return true;
4146 }
4147 else
4148 return false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004149}
4150
4151void
4152Process::PausePrivateStateThread ()
4153{
4154 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
4155}
4156
4157void
4158Process::ResumePrivateStateThread ()
4159{
4160 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
4161}
4162
4163void
4164Process::StopPrivateStateThread ()
4165{
Greg Clayton8b82f082011-04-12 05:54:46 +00004166 if (PrivateStateThreadIsValid ())
4167 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Jim Inghamb1e2e842012-04-12 18:49:31 +00004168 else
4169 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004170 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Jim Inghamb1e2e842012-04-12 18:49:31 +00004171 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004172 log->Printf ("Went to stop the private state thread, but it was already invalid.");
Jim Inghamb1e2e842012-04-12 18:49:31 +00004173 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004174}
4175
4176void
4177Process::ControlPrivateStateThread (uint32_t signal)
4178{
Greg Clayton5160ce52013-03-27 23:08:40 +00004179 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004180
4181 assert (signal == eBroadcastInternalStateControlStop ||
4182 signal == eBroadcastInternalStateControlPause ||
4183 signal == eBroadcastInternalStateControlResume);
4184
4185 if (log)
Greg Clayton7ecb3a02011-01-22 17:43:17 +00004186 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004187
Greg Clayton7ecb3a02011-01-22 17:43:17 +00004188 // Signal the private state thread. First we should copy this is case the
4189 // thread starts exiting since the private state thread will NULL this out
4190 // when it exits
Zachary Turner39de3112014-09-09 20:54:56 +00004191 HostThread private_state_thread(m_private_state_thread);
Zachary Turneracee96a2014-09-23 18:32:09 +00004192 if (private_state_thread.IsJoinable())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004193 {
4194 TimeValue timeout_time;
4195 bool timed_out;
4196
4197 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
4198
4199 timeout_time = TimeValue::Now();
4200 timeout_time.OffsetWithSeconds(2);
Jim Inghamb1e2e842012-04-12 18:49:31 +00004201 if (log)
4202 log->Printf ("Sending control event of type: %d.", signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004203 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
4204 m_private_state_control_wait.SetValue (false, eBroadcastNever);
4205
4206 if (signal == eBroadcastInternalStateControlStop)
4207 {
4208 if (timed_out)
Jim Inghamb1e2e842012-04-12 18:49:31 +00004209 {
Zachary Turner39de3112014-09-09 20:54:56 +00004210 Error error = private_state_thread.Cancel();
Jim Inghamb1e2e842012-04-12 18:49:31 +00004211 if (log)
4212 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
4213 }
4214 else
4215 {
4216 if (log)
4217 log->Printf ("The control event killed the private state thread without having to cancel.");
4218 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004219
4220 thread_result_t result = NULL;
Zachary Turner39de3112014-09-09 20:54:56 +00004221 private_state_thread.Join(&result);
4222 m_private_state_thread.Reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004223 }
4224 }
Jim Inghamb1e2e842012-04-12 18:49:31 +00004225 else
4226 {
4227 if (log)
4228 log->Printf ("Private state thread already dead, no need to signal it to stop.");
4229 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004230}
4231
4232void
Jim Inghamcfc09352012-07-27 23:57:19 +00004233Process::SendAsyncInterrupt ()
4234{
4235 if (PrivateStateThreadIsValid())
4236 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4237 else
4238 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4239}
4240
4241void
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004242Process::HandlePrivateEvent (EventSP &event_sp)
4243{
Greg Clayton5160ce52013-03-27 23:08:40 +00004244 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham221d51c2013-05-08 00:35:16 +00004245 m_resume_requested = false;
4246
Pavel Labath00fea632015-12-01 17:59:56 +00004247 m_currently_handling_event.SetValue(true, eBroadcastNever);
4248
Greg Clayton414f5d32011-01-25 02:58:48 +00004249 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghambb3a2832011-01-29 01:49:25 +00004250
4251 // First check to see if anybody wants a shot at this event:
Jim Ingham754ab982011-01-29 04:05:41 +00004252 if (m_next_event_action_ap.get() != NULL)
Jim Inghambb3a2832011-01-29 01:49:25 +00004253 {
Jim Ingham754ab982011-01-29 04:05:41 +00004254 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Ingham0161b492013-02-09 01:29:05 +00004255 if (log)
4256 log->Printf ("Ran next event action, result was %d.", action_result);
4257
Jim Inghambb3a2832011-01-29 01:49:25 +00004258 switch (action_result)
4259 {
4260 case NextEventAction::eEventActionSuccess:
4261 SetNextEventAction(NULL);
4262 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00004263
Jim Inghambb3a2832011-01-29 01:49:25 +00004264 case NextEventAction::eEventActionRetry:
4265 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00004266
Jim Inghambb3a2832011-01-29 01:49:25 +00004267 case NextEventAction::eEventActionExit:
Jim Ingham2a5fdd42011-01-29 01:57:31 +00004268 // Handle Exiting Here. If we already got an exited event,
4269 // we should just propagate it. Otherwise, swallow this event,
4270 // and set our state to exit so the next event will kill us.
4271 if (new_state != eStateExited)
4272 {
4273 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham754ab982011-01-29 04:05:41 +00004274 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Pavel Labath00fea632015-12-01 17:59:56 +00004275 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Jim Ingham2a5fdd42011-01-29 01:57:31 +00004276 SetNextEventAction(NULL);
4277 return;
4278 }
4279 SetNextEventAction(NULL);
Jim Inghambb3a2832011-01-29 01:49:25 +00004280 break;
4281 }
4282 }
4283
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004284 // See if we should broadcast this state to external clients?
4285 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004286
4287 if (should_broadcast)
4288 {
Greg Claytonb4874f12014-02-28 18:22:24 +00004289 const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004290 if (log)
4291 {
Daniel Malead01b2952012-11-29 21:49:15 +00004292 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
Greg Clayton414f5d32011-01-25 02:58:48 +00004293 __FUNCTION__,
4294 GetID(),
4295 StateAsCString(new_state),
4296 StateAsCString (GetState ()),
Greg Claytonb4874f12014-02-28 18:22:24 +00004297 is_hijacked ? "hijacked" : "public");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004298 }
Jim Ingham9575d842011-03-11 03:53:59 +00004299 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton414f5d32011-01-25 02:58:48 +00004300 if (StateIsRunningState (new_state))
Greg Clayton44d93782014-01-27 23:43:24 +00004301 {
4302 // Only push the input handler if we aren't fowarding events,
4303 // as this means the curses GUI is in use...
Todd Fialaf72fa672014-10-07 16:05:21 +00004304 // Or don't push it if we are launching since it will come up stopped.
Zachary Turnerc62733b2015-05-20 18:31:17 +00004305 if (!GetTarget().GetDebugger().IsForwardingEvents() && new_state != eStateLaunching &&
4306 new_state != eStateAttaching)
Pavel Labath44464872015-05-27 12:40:32 +00004307 {
Greg Clayton44d93782014-01-27 23:43:24 +00004308 PushProcessIOHandler ();
Pavel Labath44464872015-05-27 12:40:32 +00004309 m_iohandler_sync.SetValue(m_iohandler_sync.GetValue()+1, eBroadcastAlways);
4310 if (log)
4311 log->Printf("Process::%s updated m_iohandler_sync to %d", __FUNCTION__, m_iohandler_sync.GetValue());
4312 }
Greg Clayton44d93782014-01-27 23:43:24 +00004313 }
Greg Claytonb4874f12014-02-28 18:22:24 +00004314 else if (StateIsStoppedState(new_state, false))
4315 {
4316 if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
4317 {
4318 // If the lldb_private::Debugger is handling the events, we don't
4319 // want to pop the process IOHandler here, we want to do it when
4320 // we receive the stopped event so we can carefully control when
4321 // the process IOHandler is popped because when we stop we want to
4322 // display some text stating how and why we stopped, then maybe some
4323 // process/thread/frame info, and then we want the "(lldb) " prompt
4324 // to show up. If we pop the process IOHandler here, then we will
4325 // cause the command interpreter to become the top IOHandler after
4326 // the process pops off and it will update its prompt right away...
4327 // See the Debugger.cpp file where it calls the function as
4328 // "process_sp->PopProcessIOHandler()" to see where I am talking about.
4329 // Otherwise we end up getting overlapping "(lldb) " prompts and
4330 // garbled output.
4331 //
4332 // If we aren't handling the events in the debugger (which is indicated
4333 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we
4334 // are hijacked, then we always pop the process IO handler manually.
4335 // Hijacking happens when the internal process state thread is running
4336 // thread plans, or when commands want to run in synchronous mode
4337 // and they call "process->WaitForProcessToStop()". An example of something
4338 // that will hijack the events is a simple expression:
4339 //
4340 // (lldb) expr (int)puts("hello")
4341 //
4342 // This will cause the internal process state thread to resume and halt
4343 // the process (and _it_ will hijack the eBroadcastBitStateChanged
4344 // events) and we do need the IO handler to be pushed and popped
4345 // correctly.
4346
Zachary Turner7529df92015-09-01 20:02:29 +00004347 if (is_hijacked || GetTarget().GetDebugger().IsHandlingEvents() == false)
Greg Claytonb4874f12014-02-28 18:22:24 +00004348 PopProcessIOHandler ();
4349 }
4350 }
Jim Ingham9575d842011-03-11 03:53:59 +00004351
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004352 BroadcastEvent (event_sp);
4353 }
4354 else
4355 {
4356 if (log)
4357 {
Daniel Malead01b2952012-11-29 21:49:15 +00004358 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
Greg Clayton414f5d32011-01-25 02:58:48 +00004359 __FUNCTION__,
4360 GetID(),
4361 StateAsCString(new_state),
Jason Molendafd54b362011-09-20 21:44:10 +00004362 StateAsCString (GetState ()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004363 }
4364 }
Pavel Labath00fea632015-12-01 17:59:56 +00004365 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004366}
4367
Virgile Bellob2f1fb22013-08-23 12:44:05 +00004368thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004369Process::PrivateStateThread (void *arg)
4370{
Jim Ingham60c915e2015-06-23 21:02:45 +00004371 PrivateStateThreadArgs *real_args = static_cast<PrivateStateThreadArgs *> (arg);
4372 thread_result_t result = real_args->process->RunPrivateStateThread(real_args->is_secondary_thread);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004373 return result;
4374}
4375
Virgile Bellob2f1fb22013-08-23 12:44:05 +00004376thread_result_t
Jim Ingham60c915e2015-06-23 21:02:45 +00004377Process::RunPrivateStateThread (bool is_secondary_thread)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004378{
Jim Ingham076b3042012-04-10 01:21:57 +00004379 bool control_only = true;
Jim Inghamb1e2e842012-04-12 18:49:31 +00004380 m_private_state_control_wait.SetValue (false, eBroadcastNever);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004381
Greg Clayton5160ce52013-03-27 23:08:40 +00004382 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004383 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004384 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...",
4385 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004386
4387 bool exit_now = false;
4388 while (!exit_now)
4389 {
4390 EventSP event_sp;
4391 WaitForEventsPrivate (NULL, event_sp, control_only);
4392 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
4393 {
Jim Inghamb1e2e842012-04-12 18:49:31 +00004394 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004395 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d",
4396 __FUNCTION__, static_cast<void*>(this), GetID(),
4397 event_sp->GetType());
Jim Inghamb1e2e842012-04-12 18:49:31 +00004398
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004399 switch (event_sp->GetType())
4400 {
4401 case eBroadcastInternalStateControlStop:
4402 exit_now = true;
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004403 break; // doing any internal state management below
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004404
4405 case eBroadcastInternalStateControlPause:
4406 control_only = true;
4407 break;
4408
4409 case eBroadcastInternalStateControlResume:
4410 control_only = false;
4411 break;
4412 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004413
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004414 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004415 continue;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004416 }
Jim Inghamcfc09352012-07-27 23:57:19 +00004417 else if (event_sp->GetType() == eBroadcastBitInterrupt)
4418 {
4419 if (m_public_state.GetValue() == eStateAttaching)
4420 {
4421 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004422 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.",
4423 __FUNCTION__, static_cast<void*>(this),
4424 GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00004425 BroadcastEvent (eBroadcastBitInterrupt, NULL);
4426 }
4427 else
4428 {
4429 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004430 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.",
4431 __FUNCTION__, static_cast<void*>(this),
4432 GetID());
Pavel Labath00fea632015-12-01 17:59:56 +00004433 Halt();
Jim Inghamcfc09352012-07-27 23:57:19 +00004434 }
4435 continue;
4436 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004437
4438 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4439
4440 if (internal_state != eStateInvalid)
4441 {
Greg Claytonf9b57b92013-05-10 23:48:10 +00004442 if (m_clear_thread_plans_on_stop &&
4443 StateIsStoppedState(internal_state, true))
4444 {
4445 m_clear_thread_plans_on_stop = false;
4446 m_thread_list.DiscardThreadPlans();
4447 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004448 HandlePrivateEvent (event_sp);
4449 }
4450
Greg Clayton58d1c9a2010-10-18 04:14:23 +00004451 if (internal_state == eStateInvalid ||
4452 internal_state == eStateExited ||
4453 internal_state == eStateDetached )
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004454 {
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004455 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004456 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...",
4457 __FUNCTION__, static_cast<void*>(this), GetID(),
4458 StateAsCString(internal_state));
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004459
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004460 break;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004461 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004462 }
4463
Caroline Tice20ad3c42010-10-29 21:48:37 +00004464 // Verify log is still enabled before attempting to write to it...
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004465 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004466 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...",
4467 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004468
Jim Ingham60c915e2015-06-23 21:02:45 +00004469 // If we are a secondary thread, then the primary thread we are working for will have already
4470 // acquired the public_run_lock, and isn't done with what it was doing yet, so don't
4471 // try to change it on the way out.
4472 if (!is_secondary_thread)
4473 m_public_run_lock.SetStopped();
Greg Clayton6ed95942011-01-22 07:12:45 +00004474 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Zachary Turner39de3112014-09-09 20:54:56 +00004475 m_private_state_thread.Reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004476 return NULL;
4477}
4478
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004479//------------------------------------------------------------------
4480// Process Event Data
4481//------------------------------------------------------------------
4482
4483Process::ProcessEventData::ProcessEventData () :
4484 EventData (),
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004485 m_process_wp (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004486 m_state (eStateInvalid),
Greg Claytonc982c762010-07-09 20:39:50 +00004487 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004488 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004489 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004490{
4491}
4492
4493Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
4494 EventData (),
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004495 m_process_wp (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004496 m_state (state),
Greg Claytonc982c762010-07-09 20:39:50 +00004497 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004498 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004499 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004500{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004501 if (process_sp)
4502 m_process_wp = process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004503}
4504
Eugene Zelenko8f30a652015-10-23 18:39:37 +00004505Process::ProcessEventData::~ProcessEventData() = default;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004506
4507const ConstString &
4508Process::ProcessEventData::GetFlavorString ()
4509{
4510 static ConstString g_flavor ("Process::ProcessEventData");
4511 return g_flavor;
4512}
4513
4514const ConstString &
4515Process::ProcessEventData::GetFlavor () const
4516{
4517 return ProcessEventData::GetFlavorString ();
4518}
4519
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004520void
4521Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
4522{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004523 ProcessSP process_sp(m_process_wp.lock());
4524
4525 if (!process_sp)
4526 return;
4527
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004528 // This function gets called twice for each event, once when the event gets pulled
Jim Inghama8604692011-05-22 21:45:01 +00004529 // off of the private process event queue, and then any number of times, first when it gets pulled off of
4530 // the public event queue, then other times when we're pretending that this is where we stopped at the
4531 // end of expression evaluation. m_update_state is used to distinguish these
4532 // three cases; it is 0 when we're just pulling it off for private handling,
Jim Ingham221d51c2013-05-08 00:35:16 +00004533 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Jim Inghama8604692011-05-22 21:45:01 +00004534 if (m_update_state != 1)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004535 return;
Jim Ingham0161b492013-02-09 01:29:05 +00004536
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004537 process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr));
Jim Ingham35878c42014-04-08 21:33:21 +00004538
4539 // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had
4540 // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may
4541 // end up restarting the process.
4542 if (m_interrupted)
4543 return;
4544
4545 // If we're stopped and haven't restarted, then do the StopInfo actions here:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004546 if (m_state == eStateStopped && ! m_restarted)
Greg Clayton2e309072015-07-17 23:42:28 +00004547 {
4548 // Let process subclasses know we are about to do a public stop and
4549 // do anything they might need to in order to speed up register and
4550 // memory accesses.
4551 process_sp->WillPublicStop();
4552
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004553 ThreadList &curr_thread_list = process_sp->GetThreadList();
Greg Clayton61e7a582011-12-01 23:28:38 +00004554 uint32_t num_threads = curr_thread_list.GetSize();
4555 uint32_t idx;
Greg Claytonf4b47e12010-08-04 01:40:35 +00004556
Jim Ingham4b536182011-08-09 02:12:22 +00004557 // The actions might change one of the thread's stop_info's opinions about whether we should
4558 // stop the process, so we need to query that as we go.
Jim Ingham0faa43f2011-11-08 03:00:11 +00004559
4560 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
4561 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
4562 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
4563 // 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
4564 // against this list & bag out if anything differs.
Greg Clayton61e7a582011-12-01 23:28:38 +00004565 std::vector<uint32_t> thread_index_array(num_threads);
Jim Ingham0faa43f2011-11-08 03:00:11 +00004566 for (idx = 0; idx < num_threads; ++idx)
4567 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
4568
Jim Inghamc7078c22012-12-13 22:24:15 +00004569 // Use this to track whether we should continue from here. We will only continue the target running if
4570 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running,
4571 // then it doesn't matter what the other threads say...
4572
4573 bool still_should_stop = false;
Jim Ingham4b536182011-08-09 02:12:22 +00004574
Jim Ingham0ad7e052013-04-25 02:04:59 +00004575 // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a
4576 // valid stop reason. In that case we should just stop, because we have no way of telling what the right
4577 // thing to do is, and it's better to let the user decide than continue behind their backs.
4578
4579 bool does_anybody_have_an_opinion = false;
4580
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004581 for (idx = 0; idx < num_threads; ++idx)
4582 {
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004583 curr_thread_list = process_sp->GetThreadList();
Jim Ingham0faa43f2011-11-08 03:00:11 +00004584 if (curr_thread_list.GetSize() != num_threads)
4585 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004586 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004587 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004588 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 +00004589 break;
4590 }
4591
4592 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
4593
4594 if (thread_sp->GetIndexID() != thread_index_array[idx])
4595 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004596 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004597 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004598 log->Printf("The thread at position %u changed from %u to %u while processing event.",
Jim Ingham87c665f2011-12-01 20:26:15 +00004599 idx,
4600 thread_index_array[idx],
4601 thread_sp->GetIndexID());
Jim Ingham0faa43f2011-11-08 03:00:11 +00004602 break;
4603 }
4604
Jim Inghamb15bfc72010-10-20 00:39:53 +00004605 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
Jim Ingham5d88a062012-10-16 00:09:33 +00004606 if (stop_info_sp && stop_info_sp->IsValid())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004607 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004608 does_anybody_have_an_opinion = true;
Jim Ingham0161b492013-02-09 01:29:05 +00004609 bool this_thread_wants_to_stop;
4610 if (stop_info_sp->GetOverrideShouldStop())
Jim Ingham4b536182011-08-09 02:12:22 +00004611 {
Jim Ingham0161b492013-02-09 01:29:05 +00004612 this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue();
4613 }
4614 else
4615 {
4616 stop_info_sp->PerformAction(event_ptr);
4617 // The stop action might restart the target. If it does, then we want to mark that in the
4618 // event so that whoever is receiving it will know to wait for the running event and reflect
4619 // that state appropriately.
4620 // We also need to stop processing actions, since they aren't expecting the target to be running.
4621
4622 // FIXME: we might have run.
4623 if (stop_info_sp->HasTargetRunSinceMe())
4624 {
4625 SetRestarted (true);
4626 break;
4627 }
4628
4629 this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
Jim Ingham4b536182011-08-09 02:12:22 +00004630 }
Jim Inghamc7078c22012-12-13 22:24:15 +00004631
Jim Inghamc7078c22012-12-13 22:24:15 +00004632 if (still_should_stop == false)
4633 still_should_stop = this_thread_wants_to_stop;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004634 }
4635 }
Ashok Thirumurthicf7c55e2013-04-18 14:38:20 +00004636
Jim Inghama8ca6e22013-05-03 23:04:37 +00004637 if (!GetRestarted())
Jim Ingham9575d842011-03-11 03:53:59 +00004638 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004639 if (!still_should_stop && does_anybody_have_an_opinion)
Jim Ingham4b536182011-08-09 02:12:22 +00004640 {
4641 // We've been asked to continue, so do that here.
Jim Ingham9575d842011-03-11 03:53:59 +00004642 SetRestarted(true);
Jim Ingham3b8285d2012-04-19 01:40:33 +00004643 // Use the public resume method here, since this is just
4644 // extending a public resume.
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004645 process_sp->PrivateResume();
Jim Ingham4b536182011-08-09 02:12:22 +00004646 }
4647 else
4648 {
4649 // If we didn't restart, run the Stop Hooks here:
4650 // They might also restart the target, so watch for that.
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004651 process_sp->GetTarget().RunStopHooks();
4652 if (process_sp->GetPrivateState() == eStateRunning)
Jim Ingham4b536182011-08-09 02:12:22 +00004653 SetRestarted(true);
4654 }
Jim Ingham9575d842011-03-11 03:53:59 +00004655 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004656 }
4657}
4658
4659void
4660Process::ProcessEventData::Dump (Stream *s) const
4661{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004662 ProcessSP process_sp(m_process_wp.lock());
4663
4664 if (process_sp)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004665 s->Printf(" process = %p (pid = %" PRIu64 "), ",
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004666 static_cast<void*>(process_sp.get()), process_sp->GetID());
4667 else
4668 s->PutCString(" process = NULL, ");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004669
Greg Clayton8b82f082011-04-12 05:54:46 +00004670 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004671}
4672
4673const Process::ProcessEventData *
4674Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
4675{
4676 if (event_ptr)
4677 {
4678 const EventData *event_data = event_ptr->GetData();
4679 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4680 return static_cast <const ProcessEventData *> (event_ptr->GetData());
4681 }
4682 return NULL;
4683}
4684
4685ProcessSP
4686Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4687{
4688 ProcessSP process_sp;
4689 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4690 if (data)
4691 process_sp = data->GetProcessSP();
4692 return process_sp;
4693}
4694
4695StateType
4696Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4697{
4698 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4699 if (data == NULL)
4700 return eStateInvalid;
4701 else
4702 return data->GetState();
4703}
4704
4705bool
4706Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4707{
4708 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4709 if (data == NULL)
4710 return false;
4711 else
4712 return data->GetRestarted();
4713}
4714
4715void
4716Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4717{
4718 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4719 if (data != NULL)
4720 data->SetRestarted(new_value);
4721}
4722
Jim Ingham0161b492013-02-09 01:29:05 +00004723size_t
4724Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr)
4725{
4726 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4727 if (data != NULL)
4728 return data->GetNumRestartedReasons();
4729 else
4730 return 0;
4731}
4732
4733const char *
4734Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx)
4735{
4736 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4737 if (data != NULL)
4738 return data->GetRestartedReasonAtIndex(idx);
4739 else
4740 return NULL;
4741}
4742
4743void
4744Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason)
4745{
4746 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4747 if (data != NULL)
4748 data->AddRestartedReason(reason);
4749}
4750
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004751bool
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004752Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4753{
4754 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4755 if (data == NULL)
4756 return false;
4757 else
4758 return data->GetInterrupted ();
4759}
4760
4761void
4762Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4763{
4764 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4765 if (data != NULL)
4766 data->SetInterrupted(new_value);
4767}
4768
4769bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004770Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4771{
4772 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4773 if (data)
4774 {
4775 data->SetUpdateStateOnRemoval();
4776 return true;
4777 }
4778 return false;
4779}
4780
Greg Claytond9e416c2012-02-18 05:35:26 +00004781lldb::TargetSP
4782Process::CalculateTarget ()
4783{
Zachary Turner7529df92015-09-01 20:02:29 +00004784 return m_target_sp.lock();
Greg Claytond9e416c2012-02-18 05:35:26 +00004785}
4786
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004787void
Greg Clayton0603aa92010-10-04 01:05:56 +00004788Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004789{
Zachary Turner7529df92015-09-01 20:02:29 +00004790 exe_ctx.SetTargetPtr (&GetTarget());
Greg Claytonc14ee322011-09-22 04:58:26 +00004791 exe_ctx.SetProcessPtr (this);
4792 exe_ctx.SetThreadPtr(NULL);
4793 exe_ctx.SetFramePtr (NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004794}
4795
Greg Claytone996fd32011-03-08 22:40:15 +00004796//uint32_t
4797//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4798//{
4799// return 0;
4800//}
4801//
4802//ArchSpec
4803//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
4804//{
4805// return Host::GetArchSpecForExistingProcess (pid);
4806//}
4807//
4808//ArchSpec
4809//Process::GetArchSpecForExistingProcess (const char *process_name)
4810//{
4811// return Host::GetArchSpecForExistingProcess (process_name);
4812//}
4813//
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004814void
4815Process::AppendSTDOUT (const char * s, size_t len)
4816{
Greg Clayton3af9ea52010-11-18 05:57:03 +00004817 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004818 m_stdout_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00004819 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004820}
4821
4822void
Greg Clayton93e86192011-11-13 04:45:22 +00004823Process::AppendSTDERR (const char * s, size_t len)
4824{
4825 Mutex::Locker locker (m_stdio_communication_mutex);
4826 m_stderr_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00004827 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
Greg Clayton93e86192011-11-13 04:45:22 +00004828}
4829
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004830void
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004831Process::BroadcastAsyncProfileData(const std::string &one_profile_data)
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004832{
4833 Mutex::Locker locker (m_profile_data_comm_mutex);
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004834 m_profile_data.push_back(one_profile_data);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004835 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
4836}
4837
4838size_t
4839Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
4840{
4841 Mutex::Locker locker(m_profile_data_comm_mutex);
Han Ming Ong929a94f2012-11-29 22:14:45 +00004842 if (m_profile_data.empty())
4843 return 0;
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004844
4845 std::string &one_profile_data = m_profile_data.front();
4846 size_t bytes_available = one_profile_data.size();
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004847 if (bytes_available > 0)
4848 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004849 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004850 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004851 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")",
4852 static_cast<void*>(buf),
4853 static_cast<uint64_t>(buf_size));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004854 if (bytes_available > buf_size)
4855 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004856 memcpy(buf, one_profile_data.c_str(), buf_size);
4857 one_profile_data.erase(0, buf_size);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004858 bytes_available = buf_size;
4859 }
4860 else
4861 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004862 memcpy(buf, one_profile_data.c_str(), bytes_available);
Han Ming Ong929a94f2012-11-29 22:14:45 +00004863 m_profile_data.erase(m_profile_data.begin());
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004864 }
4865 }
4866 return bytes_available;
4867}
4868
Greg Clayton93e86192011-11-13 04:45:22 +00004869//------------------------------------------------------------------
4870// Process STDIO
4871//------------------------------------------------------------------
4872
4873size_t
4874Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
4875{
4876 Mutex::Locker locker(m_stdio_communication_mutex);
4877 size_t bytes_available = m_stdout_data.size();
4878 if (bytes_available > 0)
4879 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004880 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00004881 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004882 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")",
4883 static_cast<void*>(buf),
4884 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00004885 if (bytes_available > buf_size)
4886 {
4887 memcpy(buf, m_stdout_data.c_str(), buf_size);
4888 m_stdout_data.erase(0, buf_size);
4889 bytes_available = buf_size;
4890 }
4891 else
4892 {
4893 memcpy(buf, m_stdout_data.c_str(), bytes_available);
4894 m_stdout_data.clear();
4895 }
4896 }
4897 return bytes_available;
4898}
4899
Greg Clayton93e86192011-11-13 04:45:22 +00004900size_t
4901Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
4902{
4903 Mutex::Locker locker(m_stdio_communication_mutex);
4904 size_t bytes_available = m_stderr_data.size();
4905 if (bytes_available > 0)
4906 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004907 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00004908 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004909 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")",
4910 static_cast<void*>(buf),
4911 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00004912 if (bytes_available > buf_size)
4913 {
4914 memcpy(buf, m_stderr_data.c_str(), buf_size);
4915 m_stderr_data.erase(0, buf_size);
4916 bytes_available = buf_size;
4917 }
4918 else
4919 {
4920 memcpy(buf, m_stderr_data.c_str(), bytes_available);
4921 m_stderr_data.clear();
4922 }
4923 }
4924 return bytes_available;
4925}
4926
4927void
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004928Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
4929{
4930 Process *process = (Process *) baton;
4931 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
4932}
4933
Greg Clayton44d93782014-01-27 23:43:24 +00004934class IOHandlerProcessSTDIO :
4935 public IOHandler
4936{
4937public:
4938 IOHandlerProcessSTDIO (Process *process,
4939 int write_fd) :
Kate Stonee30f11d2014-11-17 19:06:59 +00004940 IOHandler(process->GetTarget().GetDebugger(), IOHandler::Type::ProcessIO),
Greg Clayton44d93782014-01-27 23:43:24 +00004941 m_process (process),
4942 m_read_file (),
4943 m_write_file (write_fd, false),
Greg Clayton100eb932014-07-02 21:10:39 +00004944 m_pipe ()
Greg Clayton44d93782014-01-27 23:43:24 +00004945 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004946 m_pipe.CreateNew(false);
Greg Clayton44d93782014-01-27 23:43:24 +00004947 m_read_file.SetDescriptor(GetInputFD(), false);
4948 }
4949
Eugene Zelenko8f30a652015-10-23 18:39:37 +00004950 ~IOHandlerProcessSTDIO() override = default;
4951
Greg Clayton44d93782014-01-27 23:43:24 +00004952 // Each IOHandler gets to run until it is done. It should read data
4953 // from the "in" and place output into "out" and "err and return
4954 // when done.
Pavel Labath44464872015-05-27 12:40:32 +00004955 void
4956 Run () override
Greg Clayton44d93782014-01-27 23:43:24 +00004957 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004958 if (!m_read_file.IsValid() || !m_write_file.IsValid() || !m_pipe.CanRead() || !m_pipe.CanWrite())
Greg Clayton44d93782014-01-27 23:43:24 +00004959 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004960 SetIsDone(true);
4961 return;
4962 }
4963
4964 SetIsDone(false);
4965 const int read_fd = m_read_file.GetDescriptor();
4966 TerminalState terminal_state;
4967 terminal_state.Save (read_fd, false);
4968 Terminal terminal(read_fd);
4969 terminal.SetCanonical(false);
4970 terminal.SetEcho(false);
Deepak Panickal914b8d92014-01-31 18:48:46 +00004971// FD_ZERO, FD_SET are not supported on windows
Hafiz Abid Qadeer6eff1012014-03-12 10:45:23 +00004972#ifndef _WIN32
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004973 const int pipe_read_fd = m_pipe.GetReadFileDescriptor();
4974 while (!GetIsDone())
4975 {
4976 fd_set read_fdset;
4977 FD_ZERO (&read_fdset);
4978 FD_SET (read_fd, &read_fdset);
4979 FD_SET (pipe_read_fd, &read_fdset);
4980 const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1;
4981 int num_set_fds = select (nfds, &read_fdset, NULL, NULL, NULL);
4982 if (num_set_fds < 0)
4983 {
4984 const int select_errno = errno;
4985
4986 if (select_errno != EINTR)
4987 SetIsDone(true);
4988 }
4989 else if (num_set_fds > 0)
4990 {
4991 char ch = 0;
4992 size_t n;
4993 if (FD_ISSET (read_fd, &read_fdset))
Greg Clayton44d93782014-01-27 23:43:24 +00004994 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004995 n = 1;
4996 if (m_read_file.Read(&ch, n).Success() && n == 1)
Greg Clayton44d93782014-01-27 23:43:24 +00004997 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004998 if (m_write_file.Write(&ch, n).Fail() || n != 1)
Greg Clayton44d93782014-01-27 23:43:24 +00004999 SetIsDone(true);
5000 }
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005001 else
5002 SetIsDone(true);
5003 }
5004 if (FD_ISSET (pipe_read_fd, &read_fdset))
5005 {
5006 size_t bytes_read;
5007 // Consume the interrupt byte
5008 Error error = m_pipe.Read(&ch, 1, bytes_read);
5009 if (error.Success())
Greg Clayton44d93782014-01-27 23:43:24 +00005010 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005011 switch (ch)
Greg Clayton44d93782014-01-27 23:43:24 +00005012 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005013 case 'q':
Greg Clayton44d93782014-01-27 23:43:24 +00005014 SetIsDone(true);
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005015 break;
5016 case 'i':
5017 if (StateIsRunningState(m_process->GetState()))
Pavel Labathfcc7f662015-10-07 15:11:11 +00005018 m_process->SendAsyncInterrupt();
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005019 break;
Greg Clayton44d93782014-01-27 23:43:24 +00005020 }
5021 }
5022 }
Greg Clayton44d93782014-01-27 23:43:24 +00005023 }
Greg Clayton44d93782014-01-27 23:43:24 +00005024 }
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005025#endif
5026 terminal_state.Restore();
Greg Clayton44d93782014-01-27 23:43:24 +00005027 }
5028
Pavel Labath44464872015-05-27 12:40:32 +00005029 void
5030 Cancel () override
Greg Clayton44d93782014-01-27 23:43:24 +00005031 {
Greg Clayton19e11352014-02-26 22:47:33 +00005032 char ch = 'q'; // Send 'q' for quit
Zachary Turner0b9d3ee2014-12-17 18:02:19 +00005033 size_t bytes_written = 0;
5034 m_pipe.Write(&ch, 1, bytes_written);
Greg Clayton44d93782014-01-27 23:43:24 +00005035 }
Greg Claytone68f5d62014-02-24 22:50:57 +00005036
Pavel Labath44464872015-05-27 12:40:32 +00005037 bool
5038 Interrupt () override
Greg Claytone68f5d62014-02-24 22:50:57 +00005039 {
Greg Clayton19e11352014-02-26 22:47:33 +00005040 // Do only things that are safe to do in an interrupt context (like in
5041 // a SIGINT handler), like write 1 byte to a file descriptor. This will
5042 // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte
Pavel Labathfcc7f662015-10-07 15:11:11 +00005043 // that was written to the pipe and then call m_process->SendAsyncInterrupt()
5044 // from a much safer location in code.
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00005045 if (m_active)
5046 {
5047 char ch = 'i'; // Send 'i' for interrupt
Zachary Turner0b9d3ee2014-12-17 18:02:19 +00005048 size_t bytes_written = 0;
5049 Error result = m_pipe.Write(&ch, 1, bytes_written);
5050 return result.Success();
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00005051 }
5052 else
5053 {
5054 // This IOHandler might be pushed on the stack, but not being run currently
5055 // so do the right thing if we aren't actively watching for STDIN by sending
5056 // the interrupt to the process. Otherwise the write to the pipe above would
5057 // do nothing. This can happen when the command interpreter is running and
5058 // gets a "expression ...". It will be on the IOHandler thread and sending
5059 // the input is complete to the delegate which will cause the expression to
5060 // run, which will push the process IO handler, but not run it.
5061
5062 if (StateIsRunningState(m_process->GetState()))
5063 {
5064 m_process->SendAsyncInterrupt();
5065 return true;
5066 }
5067 }
5068 return false;
Greg Claytone68f5d62014-02-24 22:50:57 +00005069 }
Greg Clayton44d93782014-01-27 23:43:24 +00005070
Pavel Labath44464872015-05-27 12:40:32 +00005071 void
5072 GotEOF() override
Greg Clayton44d93782014-01-27 23:43:24 +00005073 {
Greg Clayton44d93782014-01-27 23:43:24 +00005074 }
5075
5076protected:
5077 Process *m_process;
5078 File m_read_file; // Read from this file (usually actual STDIN for LLDB
5079 File m_write_file; // Write to this file (usually the master pty for getting io to debuggee)
Greg Clayton100eb932014-07-02 21:10:39 +00005080 Pipe m_pipe;
Greg Clayton44d93782014-01-27 23:43:24 +00005081};
5082
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005083void
Greg Clayton44d93782014-01-27 23:43:24 +00005084Process::SetSTDIOFileDescriptor (int fd)
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005085{
5086 // First set up the Read Thread for reading/handling process I/O
5087
Greg Clayton44d93782014-01-27 23:43:24 +00005088 std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005089
5090 if (conn_ap.get())
5091 {
5092 m_stdio_communication.SetConnection (conn_ap.release());
5093 if (m_stdio_communication.IsConnected())
5094 {
5095 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
5096 m_stdio_communication.StartReadThread();
5097
5098 // Now read thread is set up, set up input reader.
5099
5100 if (!m_process_input_reader.get())
Greg Clayton44d93782014-01-27 23:43:24 +00005101 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005102 }
5103 }
5104}
5105
Greg Claytonb4874f12014-02-28 18:22:24 +00005106bool
Greg Clayton6fea17e2014-03-03 19:15:20 +00005107Process::ProcessIOHandlerIsActive ()
5108{
5109 IOHandlerSP io_handler_sp (m_process_input_reader);
5110 if (io_handler_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00005111 return GetTarget().GetDebugger().IsTopIOHandler (io_handler_sp);
Greg Clayton6fea17e2014-03-03 19:15:20 +00005112 return false;
5113}
5114bool
Greg Clayton44d93782014-01-27 23:43:24 +00005115Process::PushProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005116{
Greg Clayton44d93782014-01-27 23:43:24 +00005117 IOHandlerSP io_handler_sp (m_process_input_reader);
5118 if (io_handler_sp)
5119 {
Pavel Labath44464872015-05-27 12:40:32 +00005120 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
5121 if (log)
5122 log->Printf("Process::%s pushing IO handler", __FUNCTION__);
5123
Greg Clayton44d93782014-01-27 23:43:24 +00005124 io_handler_sp->SetIsDone(false);
Zachary Turner7529df92015-09-01 20:02:29 +00005125 GetTarget().GetDebugger().PushIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00005126 return true;
Greg Clayton44d93782014-01-27 23:43:24 +00005127 }
Greg Claytonb4874f12014-02-28 18:22:24 +00005128 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005129}
5130
Greg Claytonb4874f12014-02-28 18:22:24 +00005131bool
Greg Clayton44d93782014-01-27 23:43:24 +00005132Process::PopProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005133{
Greg Clayton44d93782014-01-27 23:43:24 +00005134 IOHandlerSP io_handler_sp (m_process_input_reader);
5135 if (io_handler_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00005136 return GetTarget().GetDebugger().PopIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00005137 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005138}
5139
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00005140// The process needs to know about installed plug-ins
Greg Clayton99d0faf2010-11-18 23:32:35 +00005141void
Caroline Tice20bd37f2011-03-10 22:14:10 +00005142Process::SettingsInitialize ()
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005143{
Greg Clayton6920b522012-08-22 18:39:03 +00005144 Thread::SettingsInitialize ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00005145}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005146
Greg Clayton99d0faf2010-11-18 23:32:35 +00005147void
Caroline Tice20bd37f2011-03-10 22:14:10 +00005148Process::SettingsTerminate ()
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00005149{
Greg Clayton6920b522012-08-22 18:39:03 +00005150 Thread::SettingsTerminate ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00005151}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005152
Jim Inghamc60963c2015-10-12 19:11:03 +00005153namespace
5154{
5155 // RestorePlanState is used to record the "is private", "is master" and "okay to discard" fields of
5156 // the plan we are running, and reset it on Clean or on destruction.
5157 // It will only reset the state once, so you can call Clean and then monkey with the state and it
5158 // won't get reset on you again.
5159
5160 class RestorePlanState
5161 {
5162 public:
5163 RestorePlanState (lldb::ThreadPlanSP thread_plan_sp) :
5164 m_thread_plan_sp(thread_plan_sp),
5165 m_already_reset(false)
5166 {
5167 if (m_thread_plan_sp)
5168 {
5169 m_private = m_thread_plan_sp->GetPrivate();
5170 m_is_master = m_thread_plan_sp->IsMasterPlan();
5171 m_okay_to_discard = m_thread_plan_sp->OkayToDiscard();
5172 }
5173 }
5174
5175 ~RestorePlanState()
5176 {
5177 Clean();
5178 }
5179
5180 void
5181 Clean ()
5182 {
5183 if (!m_already_reset && m_thread_plan_sp)
5184 {
5185 m_already_reset = true;
5186 m_thread_plan_sp->SetPrivate(m_private);
5187 m_thread_plan_sp->SetIsMasterPlan (m_is_master);
5188 m_thread_plan_sp->SetOkayToDiscard(m_okay_to_discard);
5189 }
5190 }
Eugene Zelenko8f30a652015-10-23 18:39:37 +00005191
Jim Inghamc60963c2015-10-12 19:11:03 +00005192 private:
5193 lldb::ThreadPlanSP m_thread_plan_sp;
5194 bool m_already_reset;
5195 bool m_private;
5196 bool m_is_master;
5197 bool m_okay_to_discard;
5198 };
Eugene Zelenko8f30a652015-10-23 18:39:37 +00005199} // anonymous namespace
Jim Inghamc60963c2015-10-12 19:11:03 +00005200
Jim Ingham1624a2d2014-05-05 02:26:40 +00005201ExpressionResults
Jim Inghamf48169b2010-11-30 02:22:11 +00005202Process::RunThreadPlan (ExecutionContext &exe_ctx,
Jim Ingham372787f2012-04-07 00:00:41 +00005203 lldb::ThreadPlanSP &thread_plan_sp,
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005204 const EvaluateExpressionOptions &options,
Jim Inghamf48169b2010-11-30 02:22:11 +00005205 Stream &errors)
5206{
Jim Ingham8646d3c2014-05-05 02:47:44 +00005207 ExpressionResults return_value = eExpressionSetupError;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005208
Jim Ingham77787032011-01-20 02:03:18 +00005209 if (thread_plan_sp.get() == NULL)
5210 {
5211 errors.Printf("RunThreadPlan called with empty thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005212 return eExpressionSetupError;
Jim Ingham77787032011-01-20 02:03:18 +00005213 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005214
Jim Ingham7d7931d2013-03-28 00:05:34 +00005215 if (!thread_plan_sp->ValidatePlan(NULL))
5216 {
5217 errors.Printf ("RunThreadPlan called with an invalid thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005218 return eExpressionSetupError;
Jim Ingham7d7931d2013-03-28 00:05:34 +00005219 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005220
Greg Claytonc14ee322011-09-22 04:58:26 +00005221 if (exe_ctx.GetProcessPtr() != this)
5222 {
5223 errors.Printf("RunThreadPlan called on wrong process.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005224 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00005225 }
5226
5227 Thread *thread = exe_ctx.GetThreadPtr();
5228 if (thread == NULL)
5229 {
5230 errors.Printf("RunThreadPlan called with invalid thread.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005231 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00005232 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005233
Jim Inghamc60963c2015-10-12 19:11:03 +00005234 // We need to change some of the thread plan attributes for the thread plan runner. This will restore them
5235 // when we are done:
5236
5237 RestorePlanState thread_plan_restorer(thread_plan_sp);
5238
Jim Ingham17e5c4e2011-05-17 22:24:54 +00005239 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
5240 // For that to be true the plan can't be private - since private plans suppress themselves in the
5241 // GetCompletedPlan call.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005242
Jim Ingham17e5c4e2011-05-17 22:24:54 +00005243 thread_plan_sp->SetPrivate(false);
Jim Inghamc60963c2015-10-12 19:11:03 +00005244
5245 // The plans run with RunThreadPlan also need to be terminal master plans or when they are done we will end
5246 // up asking the plan above us whether we should stop, which may give the wrong answer.
5247
5248 thread_plan_sp->SetIsMasterPlan (true);
5249 thread_plan_sp->SetOkayToDiscard(false);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005250
Jim Ingham444586b2011-01-24 06:34:17 +00005251 if (m_private_state.GetValue() != eStateStopped)
5252 {
5253 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005254 return eExpressionSetupError;
Jim Ingham444586b2011-01-24 06:34:17 +00005255 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005256
Jim Ingham66243842011-08-13 00:56:10 +00005257 // Save the thread & frame from the exe_ctx for restoration after we run
Greg Claytonc14ee322011-09-22 04:58:26 +00005258 const uint32_t thread_idx_id = thread->GetIndexID();
Jason Molendab57e4a12013-11-04 09:33:30 +00005259 StackFrameSP selected_frame_sp = thread->GetSelectedFrame();
Jim Ingham11b0e052013-02-19 23:22:45 +00005260 if (!selected_frame_sp)
5261 {
5262 thread->SetSelectedFrame(0);
5263 selected_frame_sp = thread->GetSelectedFrame();
5264 if (!selected_frame_sp)
5265 {
5266 errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005267 return eExpressionSetupError;
Jim Ingham11b0e052013-02-19 23:22:45 +00005268 }
5269 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005270
Jim Ingham11b0e052013-02-19 23:22:45 +00005271 StackID ctx_frame_id = selected_frame_sp->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00005272
5273 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
5274 // so we should arrange to reset them as well.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005275
Greg Claytonc14ee322011-09-22 04:58:26 +00005276 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005277
Jim Ingham66243842011-08-13 00:56:10 +00005278 uint32_t selected_tid;
5279 StackID selected_stack_id;
Greg Clayton762f7132011-09-18 18:59:15 +00005280 if (selected_thread_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00005281 {
5282 selected_tid = selected_thread_sp->GetIndexID();
Jim Ingham66243842011-08-13 00:56:10 +00005283 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00005284 }
5285 else
5286 {
5287 selected_tid = LLDB_INVALID_THREAD_ID;
5288 }
5289
Zachary Turner39de3112014-09-09 20:54:56 +00005290 HostThread backup_private_state_thread;
Jason Molenda76513fd2014-10-15 23:39:31 +00005291 lldb::StateType old_state = eStateInvalid;
Jim Ingham076b3042012-04-10 01:21:57 +00005292 lldb::ThreadPlanSP stopper_base_plan_sp;
Jim Ingham372787f2012-04-07 00:00:41 +00005293
Greg Clayton5160ce52013-03-27 23:08:40 +00005294 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Zachary Turner39de3112014-09-09 20:54:56 +00005295 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
Jim Ingham372787f2012-04-07 00:00:41 +00005296 {
Jim Ingham076b3042012-04-10 01:21:57 +00005297 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
5298 // we are the thread that is generating public events.
Jim Ingham372787f2012-04-07 00:00:41 +00005299 // 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 +00005300 // we are fielding public events here.
5301 if (log)
Jason Molendad251c9d2012-11-17 01:41:04 +00005302 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 +00005303
Jim Ingham372787f2012-04-07 00:00:41 +00005304 backup_private_state_thread = m_private_state_thread;
Jim Ingham076b3042012-04-10 01:21:57 +00005305
5306 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
5307 // returning control here.
5308 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
5309 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
5310 // before the plan we want to run. Since base plans always stop and return control to the user, that will
5311 // do just what we want.
5312 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
5313 thread->QueueThreadPlan (stopper_base_plan_sp, false);
5314 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
5315 old_state = m_public_state.GetValue();
5316 m_public_state.SetValueNoLock(eStateStopped);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005317
Jim Ingham076b3042012-04-10 01:21:57 +00005318 // Now spin up the private state thread:
Jim Ingham372787f2012-04-07 00:00:41 +00005319 StartPrivateStateThread(true);
5320 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005321
Jim Ingham372787f2012-04-07 00:00:41 +00005322 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005323
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005324 if (options.GetDebug())
5325 {
5326 // In this case, we aren't actually going to run, we just want to stop right away.
5327 // Flush this thread so we will refetch the stacks and show the correct backtrace.
5328 // FIXME: To make this prettier we should invent some stop reason for this, but that
5329 // is only cosmetic, and this functionality is only of use to lldb developers who can
5330 // live with not pretty...
5331 thread->Flush();
Jim Ingham8646d3c2014-05-05 02:47:44 +00005332 return eExpressionStoppedForDebug;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005333 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005334
Jim Ingham1e7a9ee2011-01-23 21:14:08 +00005335 Listener listener("lldb.process.listener.run-thread-plan");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005336
Sean Callanana46ec452012-07-11 21:31:24 +00005337 lldb::EventSP event_to_broadcast_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005338
Jim Ingham77787032011-01-20 02:03:18 +00005339 {
Sean Callanana46ec452012-07-11 21:31:24 +00005340 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
5341 // restored on exit to the function.
5342 //
5343 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
5344 // is put into event_to_broadcast_sp for rebroadcasting.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005345
Sean Callanana46ec452012-07-11 21:31:24 +00005346 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005347
Jim Inghamf48169b2010-11-30 02:22:11 +00005348 if (log)
Jim Ingham0f16e732011-02-08 05:20:59 +00005349 {
5350 StreamString s;
Sean Callanana46ec452012-07-11 21:31:24 +00005351 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
Daniel Malead01b2952012-11-29 21:49:15 +00005352 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
Sean Callanana46ec452012-07-11 21:31:24 +00005353 thread->GetIndexID(),
5354 thread->GetID(),
5355 s.GetData());
5356 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005357
Sean Callanana46ec452012-07-11 21:31:24 +00005358 bool got_event;
5359 lldb::EventSP event_sp;
5360 lldb::StateType stop_state = lldb::eStateInvalid;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005361
Sean Callanana46ec452012-07-11 21:31:24 +00005362 TimeValue* timeout_ptr = NULL;
5363 TimeValue real_timeout;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005364
Jim Ingham0161b492013-02-09 01:29:05 +00005365 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 +00005366 bool do_resume = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005367 bool handle_running_event = true;
Jim Ingham35e1bda2012-10-16 21:41:58 +00005368 const uint64_t default_one_thread_timeout_usec = 250000;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005369
Jim Ingham0161b492013-02-09 01:29:05 +00005370 // This is just for accounting:
5371 uint32_t num_resumes = 0;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005372
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005373 uint32_t timeout_usec = options.GetTimeoutUsec();
Jim Inghamfd95f892014-04-22 01:41:52 +00005374 uint32_t one_thread_timeout_usec;
5375 uint32_t all_threads_timeout_usec = 0;
Jim Inghamfe1c3422014-04-16 02:24:48 +00005376
5377 // If we are going to run all threads the whole time, or if we are only going to run one thread,
5378 // then we don't need the first timeout. So we set the final timeout, and pretend we are after the
5379 // first timeout already.
5380
5381 if (!options.GetStopOthers() || !options.GetTryAllThreads())
Jim Ingham286fb1e2014-02-28 02:52:06 +00005382 {
5383 before_first_timeout = false;
Jim Inghamfd95f892014-04-22 01:41:52 +00005384 one_thread_timeout_usec = 0;
5385 all_threads_timeout_usec = timeout_usec;
Jim Ingham286fb1e2014-02-28 02:52:06 +00005386 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00005387 else
Jim Ingham0161b492013-02-09 01:29:05 +00005388 {
Jim Inghamfd95f892014-04-22 01:41:52 +00005389 uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005390
Jim Ingham914f4e72014-03-28 21:58:28 +00005391 // If the overall wait is forever, then we only need to set the one thread timeout:
5392 if (timeout_usec == 0)
5393 {
Ed Maste801335c2014-03-31 19:28:14 +00005394 if (option_one_thread_timeout != 0)
Jim Inghamfd95f892014-04-22 01:41:52 +00005395 one_thread_timeout_usec = option_one_thread_timeout;
Jim Ingham914f4e72014-03-28 21:58:28 +00005396 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005397 one_thread_timeout_usec = default_one_thread_timeout_usec;
Jim Ingham914f4e72014-03-28 21:58:28 +00005398 }
Jim Ingham0161b492013-02-09 01:29:05 +00005399 else
5400 {
Jim Ingham914f4e72014-03-28 21:58:28 +00005401 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout,
5402 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec.
5403 uint64_t computed_one_thread_timeout;
5404 if (option_one_thread_timeout != 0)
5405 {
5406 if (timeout_usec < option_one_thread_timeout)
5407 {
5408 errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005409 return eExpressionSetupError;
Jim Ingham914f4e72014-03-28 21:58:28 +00005410 }
5411 computed_one_thread_timeout = option_one_thread_timeout;
5412 }
5413 else
5414 {
5415 computed_one_thread_timeout = timeout_usec / 2;
5416 if (computed_one_thread_timeout > default_one_thread_timeout_usec)
5417 computed_one_thread_timeout = default_one_thread_timeout_usec;
5418 }
Jim Inghamfd95f892014-04-22 01:41:52 +00005419 one_thread_timeout_usec = computed_one_thread_timeout;
5420 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec;
Jim Ingham0161b492013-02-09 01:29:05 +00005421 }
Jim Ingham0161b492013-02-09 01:29:05 +00005422 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00005423
5424 if (log)
Jim Inghamfd95f892014-04-22 01:41:52 +00005425 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 +00005426 options.GetStopOthers(),
5427 options.GetTryAllThreads(),
Jim Inghamfd95f892014-04-22 01:41:52 +00005428 before_first_timeout,
5429 one_thread_timeout_usec,
5430 all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005431
Jim Ingham1460e4b2014-01-10 23:46:59 +00005432 // This isn't going to work if there are unfetched events on the queue.
5433 // Are there cases where we might want to run the remaining events here, and then try to
5434 // call the function? That's probably being too tricky for our own good.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005435
Jim Ingham1460e4b2014-01-10 23:46:59 +00005436 Event *other_events = listener.PeekAtNextEvent();
5437 if (other_events != NULL)
5438 {
5439 errors.Printf("Calling RunThreadPlan with pending events on the queue.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005440 return eExpressionSetupError;
Jim Ingham1460e4b2014-01-10 23:46:59 +00005441 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005442
Jim Ingham1460e4b2014-01-10 23:46:59 +00005443 // We also need to make sure that the next event is delivered. We might be calling a function as part of
5444 // a thread plan, in which case the last delivered event could be the running event, and we don't want
5445 // event coalescing to cause us to lose OUR running event...
5446 ForceNextEventDelivery();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005447
Jim Ingham8559a352012-11-26 23:52:18 +00005448 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
5449 // So don't call return anywhere within it.
Jim Ingham35878c42014-04-08 21:33:21 +00005450
5451#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5452 // It's pretty much impossible to write test cases for things like:
5453 // One thread timeout expires, I go to halt, but the process already stopped
5454 // on the function call stop breakpoint. Turning on this define will make us not
5455 // fetch the first event till after the halt. So if you run a quick function, it will have
5456 // completed, and the completion event will be waiting, when you interrupt for halt.
5457 // The expression evaluation should still succeed.
5458 bool miss_first_event = true;
5459#endif
Jim Inghamfd95f892014-04-22 01:41:52 +00005460 TimeValue one_thread_timeout;
5461 TimeValue final_timeout;
Eugene Zelenko8f30a652015-10-23 18:39:37 +00005462
Sean Callanana46ec452012-07-11 21:31:24 +00005463 while (1)
5464 {
5465 // We usually want to resume the process if we get to the top of the loop.
5466 // The only exception is if we get two running events with no intervening
5467 // stop, which can happen, we will just wait for then next stop event.
Jim Ingham0161b492013-02-09 01:29:05 +00005468 if (log)
5469 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.",
5470 do_resume,
5471 handle_running_event,
5472 before_first_timeout);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005473
Jim Ingham184e9812013-01-15 02:47:48 +00005474 if (do_resume || handle_running_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005475 {
5476 // Do the initial resume and wait for the running event before going further.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005477
Jim Ingham184e9812013-01-15 02:47:48 +00005478 if (do_resume)
Sean Callanana46ec452012-07-11 21:31:24 +00005479 {
Jim Ingham0161b492013-02-09 01:29:05 +00005480 num_resumes++;
Jim Ingham184e9812013-01-15 02:47:48 +00005481 Error resume_error = PrivateResume ();
5482 if (!resume_error.Success())
5483 {
Jim Ingham0161b492013-02-09 01:29:05 +00005484 errors.Printf("Error resuming inferior the %d time: \"%s\".\n",
5485 num_resumes,
5486 resume_error.AsCString());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005487 return_value = eExpressionSetupError;
Jim Ingham184e9812013-01-15 02:47:48 +00005488 break;
5489 }
Sean Callanana46ec452012-07-11 21:31:24 +00005490 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005491
Jim Ingham0161b492013-02-09 01:29:05 +00005492 TimeValue resume_timeout = TimeValue::Now();
5493 resume_timeout.OffsetWithMicroSeconds(500000);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005494
Jim Ingham0161b492013-02-09 01:29:05 +00005495 got_event = listener.WaitForEvent(&resume_timeout, event_sp);
Sean Callanana46ec452012-07-11 21:31:24 +00005496 if (!got_event)
5497 {
5498 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005499 log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.",
5500 num_resumes);
Sean Callanana46ec452012-07-11 21:31:24 +00005501
Jim Ingham0161b492013-02-09 01:29:05 +00005502 errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005503 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005504 break;
5505 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005506
Sean Callanana46ec452012-07-11 21:31:24 +00005507 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Ingham0161b492013-02-09 01:29:05 +00005508
Sean Callanana46ec452012-07-11 21:31:24 +00005509 if (stop_state != eStateRunning)
5510 {
Jim Ingham0161b492013-02-09 01:29:05 +00005511 bool restarted = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005512
Jim Ingham0161b492013-02-09 01:29:05 +00005513 if (stop_state == eStateStopped)
5514 {
5515 restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get());
5516 if (log)
5517 log->Printf("Process::RunThreadPlan(): didn't get running event after "
5518 "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).",
5519 num_resumes,
5520 StateAsCString(stop_state),
5521 restarted,
5522 do_resume,
5523 handle_running_event);
5524 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005525
Jim Ingham0161b492013-02-09 01:29:05 +00005526 if (restarted)
5527 {
5528 // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted
5529 // event here. But if I do, the best thing is to Halt and then get out of here.
Pavel Labath00fea632015-12-01 17:59:56 +00005530 Halt();
Jim Ingham0161b492013-02-09 01:29:05 +00005531 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005532
Jim Ingham35e1bda2012-10-16 21:41:58 +00005533 errors.Printf("Didn't get running event after initial resume, got %s instead.",
5534 StateAsCString(stop_state));
Jim Ingham8646d3c2014-05-05 02:47:44 +00005535 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005536 break;
5537 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005538
Sean Callanana46ec452012-07-11 21:31:24 +00005539 if (log)
5540 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
5541 // We need to call the function synchronously, so spin waiting for it to return.
5542 // If we get interrupted while executing, we're going to lose our context, and
5543 // won't be able to gather the result at this point.
5544 // We set the timeout AFTER the resume, since the resume takes some time and we
5545 // don't want to charge that to the timeout.
Sean Callanana46ec452012-07-11 21:31:24 +00005546 }
Jim Ingham0f16e732011-02-08 05:20:59 +00005547 else
5548 {
Sean Callanana46ec452012-07-11 21:31:24 +00005549 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005550 log->PutCString ("Process::RunThreadPlan(): waiting for next event.");
Jim Ingham0f16e732011-02-08 05:20:59 +00005551 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005552
Jim Ingham0161b492013-02-09 01:29:05 +00005553 if (before_first_timeout)
5554 {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005555 if (options.GetTryAllThreads())
Jim Inghamfd95f892014-04-22 01:41:52 +00005556 {
5557 one_thread_timeout = TimeValue::Now();
5558 one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005559 timeout_ptr = &one_thread_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005560 }
Jim Ingham0161b492013-02-09 01:29:05 +00005561 else
5562 {
5563 if (timeout_usec == 0)
5564 timeout_ptr = NULL;
5565 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005566 {
5567 final_timeout = TimeValue::Now();
5568 final_timeout.OffsetWithMicroSeconds (timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005569 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005570 }
Jim Ingham0161b492013-02-09 01:29:05 +00005571 }
5572 }
5573 else
5574 {
5575 if (timeout_usec == 0)
5576 timeout_ptr = NULL;
5577 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005578 {
5579 final_timeout = TimeValue::Now();
5580 final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005581 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005582 }
Jim Ingham0161b492013-02-09 01:29:05 +00005583 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005584
Jim Ingham0161b492013-02-09 01:29:05 +00005585 do_resume = true;
5586 handle_running_event = true;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005587
Sean Callanana46ec452012-07-11 21:31:24 +00005588 // Now wait for the process to stop again:
Sean Callanana46ec452012-07-11 21:31:24 +00005589 event_sp.reset();
Jim Ingham0f16e732011-02-08 05:20:59 +00005590
Jim Ingham0f16e732011-02-08 05:20:59 +00005591 if (log)
Jim Ingham20829ac2011-08-09 22:24:33 +00005592 {
Sean Callanana46ec452012-07-11 21:31:24 +00005593 if (timeout_ptr)
5594 {
Matt Kopec676a4872013-02-21 23:55:31 +00005595 log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64,
Jim Ingham0161b492013-02-09 01:29:05 +00005596 TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(),
5597 timeout_ptr->GetAsMicroSecondsSinceJan1_1970());
Sean Callanana46ec452012-07-11 21:31:24 +00005598 }
Jim Ingham20829ac2011-08-09 22:24:33 +00005599 else
Sean Callanana46ec452012-07-11 21:31:24 +00005600 {
5601 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
5602 }
5603 }
Jim Ingham35878c42014-04-08 21:33:21 +00005604
5605#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5606 // See comment above...
5607 if (miss_first_event)
5608 {
5609 usleep(1000);
5610 miss_first_event = false;
5611 got_event = false;
5612 }
5613 else
5614#endif
Sean Callanana46ec452012-07-11 21:31:24 +00005615 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005616
Sean Callanana46ec452012-07-11 21:31:24 +00005617 if (got_event)
5618 {
5619 if (event_sp.get())
5620 {
5621 bool keep_going = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005622 if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005623 {
Pavel Labath00fea632015-12-01 17:59:56 +00005624 Halt();
Jim Ingham8646d3c2014-05-05 02:47:44 +00005625 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005626 errors.Printf ("Execution halted by user interrupt.");
5627 if (log)
5628 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
Jim Ingham0161b492013-02-09 01:29:05 +00005629 break;
Jim Inghamcfc09352012-07-27 23:57:19 +00005630 }
5631 else
5632 {
5633 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5634 if (log)
5635 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005636
Jim Inghamcfc09352012-07-27 23:57:19 +00005637 switch (stop_state)
Sean Callanana46ec452012-07-11 21:31:24 +00005638 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005639 case lldb::eStateStopped:
Sean Callanana46ec452012-07-11 21:31:24 +00005640 {
Jim Ingham0161b492013-02-09 01:29:05 +00005641 // We stopped, figure out what we are going to do now.
Jim Inghamcfc09352012-07-27 23:57:19 +00005642 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
5643 if (!thread_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005644 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005645 // Ooh, our thread has vanished. Unlikely that this was successful execution...
Sean Callanana46ec452012-07-11 21:31:24 +00005646 if (log)
Jim Inghamcfc09352012-07-27 23:57:19 +00005647 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005648 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005649 }
5650 else
5651 {
Jim Ingham0161b492013-02-09 01:29:05 +00005652 // If we were restarted, we just need to go back up to fetch another event.
5653 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
Jim Inghamcfc09352012-07-27 23:57:19 +00005654 {
5655 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005656 {
5657 log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting.");
5658 }
5659 keep_going = true;
5660 do_resume = false;
5661 handle_running_event = true;
Jim Inghamcfc09352012-07-27 23:57:19 +00005662 }
5663 else
5664 {
Jim Ingham0161b492013-02-09 01:29:05 +00005665 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
5666 StopReason stop_reason = eStopReasonInvalid;
5667 if (stop_info_sp)
5668 stop_reason = stop_info_sp->GetStopReason();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005669
Jim Ingham0161b492013-02-09 01:29:05 +00005670 // FIXME: We only check if the stop reason is plan complete, should we make sure that
5671 // it is OUR plan that is complete?
5672 if (stop_reason == eStopReasonPlanComplete)
Jim Ingham184e9812013-01-15 02:47:48 +00005673 {
5674 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005675 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
Jim Inghamc60963c2015-10-12 19:11:03 +00005676
5677 // Restore the plan state so it will get reported as intended when we are done.
5678 thread_plan_restorer.Clean();
5679
Jim Ingham8646d3c2014-05-05 02:47:44 +00005680 return_value = eExpressionCompleted;
Jim Ingham184e9812013-01-15 02:47:48 +00005681 }
5682 else
5683 {
Jim Ingham0161b492013-02-09 01:29:05 +00005684 // Something restarted the target, so just wait for it to stop for real.
Jim Ingham184e9812013-01-15 02:47:48 +00005685 if (stop_reason == eStopReasonBreakpoint)
Jim Ingham0161b492013-02-09 01:29:05 +00005686 {
5687 if (log)
5688 log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005689 return_value = eExpressionHitBreakpoint;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005690 if (!options.DoesIgnoreBreakpoints())
Sean Callanan4b388c92013-07-30 19:54:09 +00005691 {
Jim Inghamc60963c2015-10-12 19:11:03 +00005692 // Restore the plan state and then force Private to false. We are
5693 // going to stop because of this plan so we need it to become a public
5694 // plan or it won't report correctly when we continue to its termination
5695 // later on.
5696 thread_plan_restorer.Clean();
5697 if (thread_plan_sp)
5698 thread_plan_sp->SetPrivate(false);
Sean Callanan4b388c92013-07-30 19:54:09 +00005699 event_to_broadcast_sp = event_sp;
5700 }
Jim Ingham0161b492013-02-09 01:29:05 +00005701 }
Jim Ingham184e9812013-01-15 02:47:48 +00005702 else
Jim Ingham0161b492013-02-09 01:29:05 +00005703 {
5704 if (log)
5705 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005706 if (!options.DoesUnwindOnError())
Sean Callanan4b388c92013-07-30 19:54:09 +00005707 event_to_broadcast_sp = event_sp;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005708 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005709 }
Jim Ingham184e9812013-01-15 02:47:48 +00005710 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005711 }
Sean Callanana46ec452012-07-11 21:31:24 +00005712 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005713 }
5714 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005715
Jim Inghamcfc09352012-07-27 23:57:19 +00005716 case lldb::eStateRunning:
Jim Ingham0161b492013-02-09 01:29:05 +00005717 // This shouldn't really happen, but sometimes we do get two running events without an
5718 // intervening stop, and in that case we should just go back to waiting for the stop.
Jim Inghamcfc09352012-07-27 23:57:19 +00005719 do_resume = false;
5720 keep_going = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005721 handle_running_event = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005722 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005723
Jim Inghamcfc09352012-07-27 23:57:19 +00005724 default:
5725 if (log)
5726 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005727
Jim Inghamcfc09352012-07-27 23:57:19 +00005728 if (stop_state == eStateExited)
5729 event_to_broadcast_sp = event_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005730
Sean Callananbf154da2012-08-08 17:35:10 +00005731 errors.Printf ("Execution stopped with unexpected state.\n");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005732 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005733 break;
5734 }
Sean Callanana46ec452012-07-11 21:31:24 +00005735 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005736
Sean Callanana46ec452012-07-11 21:31:24 +00005737 if (keep_going)
5738 continue;
5739 else
5740 break;
5741 }
5742 else
5743 {
5744 if (log)
5745 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005746 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005747 break;
5748 }
5749 }
5750 else
5751 {
5752 // If we didn't get an event that means we've timed out...
5753 // We will interrupt the process here. Depending on what we were asked to do we will
5754 // either exit, or try with all threads running for the same timeout.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005755
Sean Callanana46ec452012-07-11 21:31:24 +00005756 if (log) {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005757 if (options.GetTryAllThreads())
Sean Callanana46ec452012-07-11 21:31:24 +00005758 {
Jim Ingham0161b492013-02-09 01:29:05 +00005759 if (before_first_timeout)
Jim Inghamfe1c3422014-04-16 02:24:48 +00005760 {
5761 if (timeout_usec != 0)
5762 {
Jim Inghamfe1c3422014-04-16 02:24:48 +00005763 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Jim Inghamfd95f892014-04-22 01:41:52 +00005764 "running for %" PRIu32 " usec with all threads enabled.",
5765 all_threads_timeout_usec);
Jim Inghamfe1c3422014-04-16 02:24:48 +00005766 }
5767 else
5768 {
5769 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Ed Mastee61c7b02014-04-29 17:48:06 +00005770 "running forever with all threads enabled.");
Jim Inghamfe1c3422014-04-16 02:24:48 +00005771 }
5772 }
Sean Callanana46ec452012-07-11 21:31:24 +00005773 else
5774 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
Jason Molenda6a8658a2013-10-27 02:32:23 +00005775 "and timeout: %u timed out, abandoning execution.",
Jim Ingham35e1bda2012-10-16 21:41:58 +00005776 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005777 }
5778 else
Jason Molenda6a8658a2013-10-27 02:32:23 +00005779 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, "
Jim Ingham35e1bda2012-10-16 21:41:58 +00005780 "abandoning execution.",
5781 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005782 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005783
Jim Ingham0161b492013-02-09 01:29:05 +00005784 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target
5785 // could have stopped. That's fine, Halt will figure that out and send the appropriate Stopped event.
5786 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.) In
5787 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's
5788 // stopped event. That's what this while loop does.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005789
Jim Ingham0161b492013-02-09 01:29:05 +00005790 bool back_to_top = true;
5791 uint32_t try_halt_again = 0;
5792 bool do_halt = true;
5793 const uint32_t num_retries = 5;
5794 while (try_halt_again < num_retries)
Sean Callanana46ec452012-07-11 21:31:24 +00005795 {
Jim Ingham0161b492013-02-09 01:29:05 +00005796 Error halt_error;
5797 if (do_halt)
5798 {
5799 if (log)
5800 log->Printf ("Process::RunThreadPlan(): Running Halt.");
Pavel Labath00fea632015-12-01 17:59:56 +00005801 halt_error = Halt();
Jim Ingham0161b492013-02-09 01:29:05 +00005802 }
5803 if (halt_error.Success())
5804 {
5805 if (log)
5806 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005807
Jim Ingham0161b492013-02-09 01:29:05 +00005808 real_timeout = TimeValue::Now();
5809 real_timeout.OffsetWithMicroSeconds(500000);
5810
5811 got_event = listener.WaitForEvent(&real_timeout, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005812
Jim Ingham0161b492013-02-09 01:29:05 +00005813 if (got_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005814 {
Jim Ingham0161b492013-02-09 01:29:05 +00005815 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5816 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00005817 {
Jim Ingham0161b492013-02-09 01:29:05 +00005818 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
5819 if (stop_state == lldb::eStateStopped
5820 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
5821 log->PutCString (" Event was the Halt interruption event.");
Sean Callanana46ec452012-07-11 21:31:24 +00005822 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005823
Jim Ingham0161b492013-02-09 01:29:05 +00005824 if (stop_state == lldb::eStateStopped)
Sean Callanana46ec452012-07-11 21:31:24 +00005825 {
Jim Ingham0161b492013-02-09 01:29:05 +00005826 // Between the time we initiated the Halt and the time we delivered it, the process could have
5827 // already finished its job. Check that here:
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005828
Jim Ingham0161b492013-02-09 01:29:05 +00005829 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
5830 {
5831 if (log)
5832 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
5833 "Exiting wait loop.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005834 return_value = eExpressionCompleted;
Jim Ingham0161b492013-02-09 01:29:05 +00005835 back_to_top = false;
5836 break;
5837 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005838
Jim Ingham0161b492013-02-09 01:29:05 +00005839 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5840 {
5841 if (log)
5842 log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again... "
5843 "Exiting wait loop.");
5844 try_halt_again++;
5845 do_halt = false;
5846 continue;
5847 }
Sean Callanana46ec452012-07-11 21:31:24 +00005848
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005849 if (!options.GetTryAllThreads())
Jim Ingham0161b492013-02-09 01:29:05 +00005850 {
5851 if (log)
5852 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005853 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005854 back_to_top = false;
5855 break;
5856 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005857
Jim Ingham0161b492013-02-09 01:29:05 +00005858 if (before_first_timeout)
5859 {
5860 // Set all the other threads to run, and return to the top of the loop, which will continue;
5861 before_first_timeout = false;
5862 thread_plan_sp->SetStopOthers (false);
5863 if (log)
5864 log->PutCString ("Process::RunThreadPlan(): about to resume.");
Sean Callanana46ec452012-07-11 21:31:24 +00005865
Jim Ingham0161b492013-02-09 01:29:05 +00005866 back_to_top = true;
5867 break;
5868 }
5869 else
5870 {
5871 // Running all threads failed, so return Interrupted.
5872 if (log)
5873 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005874 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005875 back_to_top = false;
5876 break;
5877 }
Sean Callanana46ec452012-07-11 21:31:24 +00005878 }
5879 }
5880 else
Jim Ingham0161b492013-02-09 01:29:05 +00005881 { if (log)
5882 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
5883 "I'm getting out of here passing Interrupted.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005884 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005885 back_to_top = false;
5886 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005887 }
5888 }
Jim Ingham0161b492013-02-09 01:29:05 +00005889 else
5890 {
5891 try_halt_again++;
5892 continue;
5893 }
Sean Callanana46ec452012-07-11 21:31:24 +00005894 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005895
Jim Ingham0161b492013-02-09 01:29:05 +00005896 if (!back_to_top || try_halt_again > num_retries)
5897 break;
5898 else
5899 continue;
Sean Callanana46ec452012-07-11 21:31:24 +00005900 }
Sean Callanana46ec452012-07-11 21:31:24 +00005901 } // END WAIT LOOP
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005902
Sean Callanana46ec452012-07-11 21:31:24 +00005903 // 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 +00005904 if (backup_private_state_thread.IsJoinable())
Sean Callanana46ec452012-07-11 21:31:24 +00005905 {
5906 StopPrivateStateThread();
5907 Error error;
5908 m_private_state_thread = backup_private_state_thread;
Sean Callanan9a028512012-08-09 00:50:26 +00005909 if (stopper_base_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005910 {
5911 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
5912 }
Jason Molenda76513fd2014-10-15 23:39:31 +00005913 if (old_state != eStateInvalid)
5914 m_public_state.SetValueNoLock(old_state);
Sean Callanana46ec452012-07-11 21:31:24 +00005915 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005916
Jim Inghamc60963c2015-10-12 19:11:03 +00005917 if (return_value != eExpressionCompleted && log)
5918 {
5919 // Print a backtrace into the log so we can figure out where we are:
5920 StreamString s;
5921 s.PutCString("Thread state after unsuccessful completion: \n");
5922 thread->GetStackFrameStatus (s,
5923 0,
5924 UINT32_MAX,
5925 true,
5926 UINT32_MAX);
5927 log->PutCString(s.GetData());
5928
5929 }
Jim Ingham184e9812013-01-15 02:47:48 +00005930 // Restore the thread state if we are going to discard the plan execution. There are three cases where this
5931 // could happen:
5932 // 1) The execution successfully completed
5933 // 2) We hit a breakpoint, and ignore_breakpoints was true
5934 // 3) We got some other error, and discard_on_error was true
Jim Ingham8646d3c2014-05-05 02:47:44 +00005935 bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError())
5936 || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints());
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005937
Jim Ingham8646d3c2014-05-05 02:47:44 +00005938 if (return_value == eExpressionCompleted
Jim Ingham184e9812013-01-15 02:47:48 +00005939 || should_unwind)
Jim Ingham8559a352012-11-26 23:52:18 +00005940 {
5941 thread_plan_sp->RestoreThreadState();
5942 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005943
Sean Callanana46ec452012-07-11 21:31:24 +00005944 // Now do some processing on the results of the run:
Jim Ingham8646d3c2014-05-05 02:47:44 +00005945 if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint)
Sean Callanana46ec452012-07-11 21:31:24 +00005946 {
5947 if (log)
5948 {
5949 StreamString s;
5950 if (event_sp)
5951 event_sp->Dump (&s);
5952 else
5953 {
5954 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
5955 }
5956
5957 StreamString ts;
5958
5959 const char *event_explanation = NULL;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005960
Sean Callanana46ec452012-07-11 21:31:24 +00005961 do
5962 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005963 if (!event_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005964 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005965 event_explanation = "<no event>";
Sean Callanana46ec452012-07-11 21:31:24 +00005966 break;
5967 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005968 else if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005969 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005970 event_explanation = "<user interrupt>";
Sean Callanana46ec452012-07-11 21:31:24 +00005971 break;
5972 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005973 else
Sean Callanana46ec452012-07-11 21:31:24 +00005974 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005975 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
5976
5977 if (!event_data)
Sean Callanana46ec452012-07-11 21:31:24 +00005978 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005979 event_explanation = "<no event data>";
5980 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005981 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005982
Jim Inghamcfc09352012-07-27 23:57:19 +00005983 Process *process = event_data->GetProcessSP().get();
5984
5985 if (!process)
Sean Callanana46ec452012-07-11 21:31:24 +00005986 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005987 event_explanation = "<no process>";
5988 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005989 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005990
Jim Inghamcfc09352012-07-27 23:57:19 +00005991 ThreadList &thread_list = process->GetThreadList();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005992
Jim Inghamcfc09352012-07-27 23:57:19 +00005993 uint32_t num_threads = thread_list.GetSize();
5994 uint32_t thread_index;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005995
Jim Inghamcfc09352012-07-27 23:57:19 +00005996 ts.Printf("<%u threads> ", num_threads);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005997
Jim Inghamcfc09352012-07-27 23:57:19 +00005998 for (thread_index = 0;
5999 thread_index < num_threads;
6000 ++thread_index)
6001 {
6002 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006003
Jim Inghamcfc09352012-07-27 23:57:19 +00006004 if (!thread)
6005 {
6006 ts.Printf("<?> ");
6007 continue;
6008 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006009
Daniel Malead01b2952012-11-29 21:49:15 +00006010 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00006011 RegisterContext *register_context = thread->GetRegisterContext().get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006012
Jim Inghamcfc09352012-07-27 23:57:19 +00006013 if (register_context)
Daniel Malead01b2952012-11-29 21:49:15 +00006014 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
Jim Inghamcfc09352012-07-27 23:57:19 +00006015 else
6016 ts.Printf("[ip unknown] ");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006017
Jim Inghamc60963c2015-10-12 19:11:03 +00006018 // Show the private stop info here, the public stop info will be from the last natural stop.
6019 lldb::StopInfoSP stop_info_sp = thread->GetPrivateStopInfo();
Jim Inghamcfc09352012-07-27 23:57:19 +00006020 if (stop_info_sp)
6021 {
6022 const char *stop_desc = stop_info_sp->GetDescription();
6023 if (stop_desc)
6024 ts.PutCString (stop_desc);
6025 }
6026 ts.Printf(">");
6027 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006028
Jim Inghamcfc09352012-07-27 23:57:19 +00006029 event_explanation = ts.GetData();
Sean Callanana46ec452012-07-11 21:31:24 +00006030 }
Sean Callanana46ec452012-07-11 21:31:24 +00006031 } while (0);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006032
Jim Inghamcfc09352012-07-27 23:57:19 +00006033 if (event_explanation)
6034 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
Sean Callanana46ec452012-07-11 21:31:24 +00006035 else
Jim Inghamcfc09352012-07-27 23:57:19 +00006036 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
6037 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006038
Jim Inghame4483cf2013-09-27 01:13:01 +00006039 if (should_unwind)
Jim Inghamcfc09352012-07-27 23:57:19 +00006040 {
6041 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006042 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.",
6043 static_cast<void*>(thread_plan_sp.get()));
Jim Inghamcfc09352012-07-27 23:57:19 +00006044 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Inghamcfc09352012-07-27 23:57:19 +00006045 }
6046 else
6047 {
6048 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006049 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.",
6050 static_cast<void*>(thread_plan_sp.get()));
Sean Callanana46ec452012-07-11 21:31:24 +00006051 }
6052 }
Jim Ingham8646d3c2014-05-05 02:47:44 +00006053 else if (return_value == eExpressionSetupError)
Sean Callanana46ec452012-07-11 21:31:24 +00006054 {
6055 if (log)
6056 log->PutCString("Process::RunThreadPlan(): execution set up error.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006057
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006058 if (options.DoesUnwindOnError())
Jim Ingham0f16e732011-02-08 05:20:59 +00006059 {
Greg Claytonc14ee322011-09-22 04:58:26 +00006060 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Ingham0f16e732011-02-08 05:20:59 +00006061 }
Jim Inghamf48169b2010-11-30 02:22:11 +00006062 }
6063 else
6064 {
Sean Callanana46ec452012-07-11 21:31:24 +00006065 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
Jim Inghamf48169b2010-11-30 02:22:11 +00006066 {
Jim Ingham0f16e732011-02-08 05:20:59 +00006067 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00006068 log->PutCString("Process::RunThreadPlan(): thread plan is done");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006069 return_value = eExpressionCompleted;
Sean Callanana46ec452012-07-11 21:31:24 +00006070 }
6071 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
6072 {
6073 if (log)
6074 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006075 return_value = eExpressionDiscarded;
Sean Callanana46ec452012-07-11 21:31:24 +00006076 }
6077 else
6078 {
6079 if (log)
6080 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006081 if (options.DoesUnwindOnError() && thread_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00006082 {
6083 if (log)
Jim Ingham184e9812013-01-15 02:47:48 +00006084 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
Sean Callanana46ec452012-07-11 21:31:24 +00006085 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Sean Callanana46ec452012-07-11 21:31:24 +00006086 }
6087 }
6088 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006089
Sean Callanana46ec452012-07-11 21:31:24 +00006090 // Thread we ran the function in may have gone away because we ran the target
6091 // Check that it's still there, and if it is put it back in the context. Also restore the
6092 // frame in the context if it is still present.
6093 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
6094 if (thread)
6095 {
6096 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
6097 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006098
Sean Callanana46ec452012-07-11 21:31:24 +00006099 // Also restore the current process'es selected frame & thread, since this function calling may
6100 // be done behind the user's back.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006101
Sean Callanana46ec452012-07-11 21:31:24 +00006102 if (selected_tid != LLDB_INVALID_THREAD_ID)
6103 {
6104 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
6105 {
6106 // We were able to restore the selected thread, now restore the frame:
Daniel Maleaa012d3a2013-07-31 20:21:20 +00006107 Mutex::Locker lock(GetThreadList().GetMutex());
Jason Molendab57e4a12013-11-04 09:33:30 +00006108 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
Sean Callanana46ec452012-07-11 21:31:24 +00006109 if (old_frame_sp)
6110 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
Jim Inghamf48169b2010-11-30 02:22:11 +00006111 }
Jim Inghamf48169b2010-11-30 02:22:11 +00006112 }
6113 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006114
Sean Callanana46ec452012-07-11 21:31:24 +00006115 // If the process exited during the run of the thread plan, notify everyone.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006116
Sean Callanana46ec452012-07-11 21:31:24 +00006117 if (event_to_broadcast_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00006118 {
Sean Callanana46ec452012-07-11 21:31:24 +00006119 if (log)
6120 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
6121 BroadcastEvent(event_to_broadcast_sp);
Jim Inghamf48169b2010-11-30 02:22:11 +00006122 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006123
Jim Inghamf48169b2010-11-30 02:22:11 +00006124 return return_value;
6125}
6126
6127const char *
Jim Ingham1624a2d2014-05-05 02:26:40 +00006128Process::ExecutionResultAsCString (ExpressionResults result)
Jim Inghamf48169b2010-11-30 02:22:11 +00006129{
6130 const char *result_name;
6131
6132 switch (result)
6133 {
Jim Ingham8646d3c2014-05-05 02:47:44 +00006134 case eExpressionCompleted:
6135 result_name = "eExpressionCompleted";
Jim Inghamf48169b2010-11-30 02:22:11 +00006136 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006137 case eExpressionDiscarded:
6138 result_name = "eExpressionDiscarded";
Jim Inghamf48169b2010-11-30 02:22:11 +00006139 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006140 case eExpressionInterrupted:
6141 result_name = "eExpressionInterrupted";
Jim Inghamf48169b2010-11-30 02:22:11 +00006142 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006143 case eExpressionHitBreakpoint:
6144 result_name = "eExpressionHitBreakpoint";
Jim Ingham184e9812013-01-15 02:47:48 +00006145 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006146 case eExpressionSetupError:
6147 result_name = "eExpressionSetupError";
Jim Inghamf48169b2010-11-30 02:22:11 +00006148 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006149 case eExpressionParseError:
6150 result_name = "eExpressionParseError";
Jim Ingham1624a2d2014-05-05 02:26:40 +00006151 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006152 case eExpressionResultUnavailable:
6153 result_name = "eExpressionResultUnavailable";
Jim Ingham1624a2d2014-05-05 02:26:40 +00006154 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006155 case eExpressionTimedOut:
6156 result_name = "eExpressionTimedOut";
Jim Inghamf48169b2010-11-30 02:22:11 +00006157 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006158 case eExpressionStoppedForDebug:
6159 result_name = "eExpressionStoppedForDebug";
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006160 break;
Jim Inghamf48169b2010-11-30 02:22:11 +00006161 }
6162 return result_name;
6163}
6164
Greg Clayton7260f622011-04-18 08:33:37 +00006165void
6166Process::GetStatus (Stream &strm)
6167{
6168 const StateType state = GetState();
Greg Clayton2637f822011-11-17 01:23:07 +00006169 if (StateIsStoppedState(state, false))
Greg Clayton7260f622011-04-18 08:33:37 +00006170 {
6171 if (state == eStateExited)
6172 {
6173 int exit_status = GetExitStatus();
6174 const char *exit_description = GetExitDescription();
Daniel Malead01b2952012-11-29 21:49:15 +00006175 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
Greg Clayton7260f622011-04-18 08:33:37 +00006176 GetID(),
6177 exit_status,
6178 exit_status,
6179 exit_description ? exit_description : "");
6180 }
6181 else
6182 {
6183 if (state == eStateConnected)
6184 strm.Printf ("Connected to remote target.\n");
6185 else
Daniel Malead01b2952012-11-29 21:49:15 +00006186 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
Greg Clayton7260f622011-04-18 08:33:37 +00006187 }
6188 }
6189 else
6190 {
Daniel Malead01b2952012-11-29 21:49:15 +00006191 strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
Greg Clayton7260f622011-04-18 08:33:37 +00006192 }
6193}
6194
6195size_t
6196Process::GetThreadStatus (Stream &strm,
6197 bool only_threads_with_stop_reason,
6198 uint32_t start_frame,
6199 uint32_t num_frames,
6200 uint32_t num_frames_with_source)
6201{
6202 size_t num_thread_infos_dumped = 0;
6203
Jim Ingham4a65fb12014-03-07 11:20:03 +00006204 // You can't hold the thread list lock while calling Thread::GetStatus. That very well might run code (e.g. if we need it
6205 // to get return values or arguments.) For that to work the process has to be able to acquire it. So instead copy the thread
6206 // ID's, and look them up one by one:
6207
6208 uint32_t num_threads;
Greg Clayton332e8b12015-01-13 21:13:08 +00006209 std::vector<lldb::tid_t> thread_id_array;
Jim Ingham4a65fb12014-03-07 11:20:03 +00006210 //Scope for thread list locker;
6211 {
6212 Mutex::Locker locker (GetThreadList().GetMutex());
6213 ThreadList &curr_thread_list = GetThreadList();
6214 num_threads = curr_thread_list.GetSize();
6215 uint32_t idx;
Greg Clayton332e8b12015-01-13 21:13:08 +00006216 thread_id_array.resize(num_threads);
Jim Ingham4a65fb12014-03-07 11:20:03 +00006217 for (idx = 0; idx < num_threads; ++idx)
Greg Clayton332e8b12015-01-13 21:13:08 +00006218 thread_id_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID();
Jim Ingham4a65fb12014-03-07 11:20:03 +00006219 }
6220
Greg Clayton7260f622011-04-18 08:33:37 +00006221 for (uint32_t i = 0; i < num_threads; i++)
6222 {
Greg Clayton332e8b12015-01-13 21:13:08 +00006223 ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_id_array[i]));
Jim Ingham4a65fb12014-03-07 11:20:03 +00006224 if (thread_sp)
Greg Clayton7260f622011-04-18 08:33:37 +00006225 {
6226 if (only_threads_with_stop_reason)
6227 {
Jim Ingham4a65fb12014-03-07 11:20:03 +00006228 StopInfoSP stop_info_sp = thread_sp->GetStopInfo();
Jim Ingham5d88a062012-10-16 00:09:33 +00006229 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
Greg Clayton7260f622011-04-18 08:33:37 +00006230 continue;
6231 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00006232 thread_sp->GetStatus (strm,
Greg Clayton7260f622011-04-18 08:33:37 +00006233 start_frame,
6234 num_frames,
6235 num_frames_with_source);
6236 ++num_thread_infos_dumped;
6237 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00006238 else
6239 {
6240 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
6241 if (log)
6242 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus.");
Jim Ingham4a65fb12014-03-07 11:20:03 +00006243 }
Greg Clayton7260f622011-04-18 08:33:37 +00006244 }
6245 return num_thread_infos_dumped;
6246}
6247
Greg Claytona9f40ad2012-02-22 04:37:26 +00006248void
6249Process::AddInvalidMemoryRegion (const LoadRange &region)
6250{
6251 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
6252}
6253
6254bool
6255Process::RemoveInvalidMemoryRange (const LoadRange &region)
6256{
6257 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
6258}
6259
Jim Ingham372787f2012-04-07 00:00:41 +00006260void
6261Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
6262{
6263 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
6264}
6265
6266bool
6267Process::RunPreResumeActions ()
6268{
6269 bool result = true;
6270 while (!m_pre_resume_actions.empty())
6271 {
6272 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
6273 m_pre_resume_actions.pop_back();
6274 bool this_result = action.callback (action.baton);
Jason Molenda55710932014-11-17 20:10:15 +00006275 if (result == true)
6276 result = this_result;
Jim Ingham372787f2012-04-07 00:00:41 +00006277 }
6278 return result;
6279}
6280
6281void
6282Process::ClearPreResumeActions ()
6283{
6284 m_pre_resume_actions.clear();
6285}
Greg Claytona9f40ad2012-02-22 04:37:26 +00006286
Zachary Turner93749ab2015-03-03 21:51:25 +00006287ProcessRunLock &
6288Process::GetRunLock()
6289{
6290 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
6291 return m_private_run_lock;
6292 else
6293 return m_public_run_lock;
6294}
6295
Greg Claytonfa559e52012-05-18 02:38:05 +00006296void
6297Process::Flush ()
6298{
6299 m_thread_list.Flush();
Jason Molenda5e8dce42013-12-13 00:29:16 +00006300 m_extended_thread_list.Flush();
6301 m_extended_thread_stop_id = 0;
6302 m_queue_list.Clear();
6303 m_queue_list_stop_id = 0;
Greg Claytonfa559e52012-05-18 02:38:05 +00006304}
Greg Clayton90ba8112012-12-05 00:16:59 +00006305
6306void
6307Process::DidExec ()
6308{
Todd Fiala76e0fc92014-08-27 22:58:26 +00006309 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
6310 if (log)
6311 log->Printf ("Process::%s()", __FUNCTION__);
6312
Greg Clayton90ba8112012-12-05 00:16:59 +00006313 Target &target = GetTarget();
6314 target.CleanupProcess ();
Greg Claytonb35db632013-11-09 00:03:31 +00006315 target.ClearModules(false);
Greg Clayton90ba8112012-12-05 00:16:59 +00006316 m_dynamic_checkers_ap.reset();
6317 m_abi_sp.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00006318 m_system_runtime_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00006319 m_os_ap.reset();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006320 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00006321 m_jit_loaders_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00006322 m_image_tokens.clear();
6323 m_allocated_memory_cache.Clear();
6324 m_language_runtimes.clear();
Kuba Breckaafdf8422014-10-10 23:43:03 +00006325 m_instrumentation_runtimes.clear();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006326 m_thread_list.DiscardThreadPlans();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006327 m_memory_cache.Clear(true);
Greg Claytona97c4d22014-12-09 23:31:02 +00006328 m_stop_info_override_callback = NULL;
Greg Clayton90ba8112012-12-05 00:16:59 +00006329 DoDidExec();
6330 CompleteAttach ();
Greg Clayton095eeaa2013-11-05 23:28:00 +00006331 // Flush the process (threads and all stack frames) after running CompleteAttach()
6332 // in case the dynamic loader loaded things in new locations.
6333 Flush();
Greg Claytonb35db632013-11-09 00:03:31 +00006334
6335 // After we figure out what was loaded/unloaded in CompleteAttach,
6336 // we need to let the target know so it can do any cleanup it needs to.
6337 target.DidExec();
Greg Clayton90ba8112012-12-05 00:16:59 +00006338}
Greg Clayton095eeaa2013-11-05 23:28:00 +00006339
Jim Ingham1460e4b2014-01-10 23:46:59 +00006340addr_t
6341Process::ResolveIndirectFunction(const Address *address, Error &error)
6342{
6343 if (address == nullptr)
6344 {
Jean-Daniel Dupasef37711f2014-02-08 20:22:05 +00006345 error.SetErrorString("Invalid address argument");
Jim Ingham1460e4b2014-01-10 23:46:59 +00006346 return LLDB_INVALID_ADDRESS;
6347 }
6348
6349 addr_t function_addr = LLDB_INVALID_ADDRESS;
6350
6351 addr_t addr = address->GetLoadAddress(&GetTarget());
6352 std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr);
6353 if (iter != m_resolved_indirect_addresses.end())
6354 {
6355 function_addr = (*iter).second;
6356 }
6357 else
6358 {
6359 if (!InferiorCall(this, address, function_addr))
6360 {
6361 Symbol *symbol = address->CalculateSymbolContextSymbol();
6362 error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s",
6363 symbol ? symbol->GetName().AsCString() : "<UNKNOWN>");
6364 function_addr = LLDB_INVALID_ADDRESS;
6365 }
6366 else
6367 {
6368 m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr));
6369 }
6370 }
6371 return function_addr;
6372}
6373
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006374void
6375Process::ModulesDidLoad (ModuleList &module_list)
6376{
Kuba Breckaafdf8422014-10-10 23:43:03 +00006377 SystemRuntime *sys_runtime = GetSystemRuntime();
6378 if (sys_runtime)
6379 {
6380 sys_runtime->ModulesDidLoad (module_list);
6381 }
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006382
Kuba Breckaafdf8422014-10-10 23:43:03 +00006383 GetJITLoaders().ModulesDidLoad (module_list);
6384
6385 // Give runtimes a chance to be created.
6386 InstrumentationRuntime::ModulesDidLoad(module_list, this, m_instrumentation_runtimes);
6387
6388 // Tell runtimes about new modules.
6389 for (auto pos = m_instrumentation_runtimes.begin(); pos != m_instrumentation_runtimes.end(); ++pos)
6390 {
6391 InstrumentationRuntimeSP runtime = pos->second;
6392 runtime->ModulesDidLoad(module_list);
6393 }
6394
Greg Clayton35ca64b2015-04-16 17:13:34 +00006395 // Let any language runtimes we have already created know
6396 // about the modules that loaded.
6397
6398 // Iterate over a copy of this language runtime list in case
6399 // the language runtime ModulesDidLoad somehow causes the language
6400 // riuntime to be unloaded.
6401 LanguageRuntimeCollection language_runtimes(m_language_runtimes);
6402 for (const auto &pair: language_runtimes)
6403 {
6404 // We must check language_runtime_sp to make sure it is not
6405 // NULL as we might cache the fact that we didn't have a
6406 // language runtime for a language.
6407 LanguageRuntimeSP language_runtime_sp = pair.second;
6408 if (language_runtime_sp)
6409 language_runtime_sp->ModulesDidLoad(module_list);
6410 }
Ryan Brown65d4d5c2015-09-16 21:20:44 +00006411
6412 LoadOperatingSystemPlugin(false);
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006413}
Kuba Breckaa51ea382014-09-06 01:33:13 +00006414
Jason Molendaef7d6412015-08-06 03:27:10 +00006415void
6416Process::PrintWarning (uint64_t warning_type, void *repeat_key, const char *fmt, ...)
6417{
6418 bool print_warning = true;
6419
6420 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
6421 if (stream_sp.get() == nullptr)
6422 return;
6423 if (warning_type == eWarningsOptimization
6424 && GetWarningsOptimization() == false)
6425 {
6426 return;
6427 }
6428
6429 if (repeat_key != nullptr)
6430 {
6431 WarningsCollection::iterator it = m_warnings_issued.find (warning_type);
6432 if (it == m_warnings_issued.end())
6433 {
6434 m_warnings_issued[warning_type] = WarningsPointerSet();
6435 m_warnings_issued[warning_type].insert (repeat_key);
6436 }
6437 else
6438 {
6439 if (it->second.find (repeat_key) != it->second.end())
6440 {
6441 print_warning = false;
6442 }
6443 else
6444 {
6445 it->second.insert (repeat_key);
6446 }
6447 }
6448 }
6449
6450 if (print_warning)
6451 {
6452 va_list args;
6453 va_start (args, fmt);
6454 stream_sp->PrintfVarArg (fmt, args);
6455 va_end (args);
6456 }
6457}
6458
Jason Molenda484900b2015-08-10 07:55:25 +00006459void
6460Process::PrintWarningOptimization (const SymbolContext &sc)
6461{
6462 if (GetWarningsOptimization() == true
6463 && sc.module_sp.get()
6464 && sc.module_sp->GetFileSpec().GetFilename().IsEmpty() == false
6465 && sc.function
6466 && sc.function->GetIsOptimized() == true)
6467 {
6468 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());
6469 }
6470}
6471
Kuba Breckaa51ea382014-09-06 01:33:13 +00006472ThreadCollectionSP
6473Process::GetHistoryThreads(lldb::addr_t addr)
6474{
6475 ThreadCollectionSP threads;
Greg Clayton35ca64b2015-04-16 17:13:34 +00006476
Kuba Breckaa51ea382014-09-06 01:33:13 +00006477 const MemoryHistorySP &memory_history = MemoryHistory::FindPlugin(shared_from_this());
6478
6479 if (! memory_history.get()) {
6480 return threads;
6481 }
6482
6483 threads.reset(new ThreadCollection(memory_history->GetHistoryThreads(addr)));
6484
6485 return threads;
6486}
Kuba Brecka63927542014-10-11 01:59:32 +00006487
6488InstrumentationRuntimeSP
6489Process::GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type)
6490{
6491 InstrumentationRuntimeCollection::iterator pos;
6492 pos = m_instrumentation_runtimes.find (type);
6493 if (pos == m_instrumentation_runtimes.end())
6494 {
6495 return InstrumentationRuntimeSP();
6496 }
6497 else
6498 return (*pos).second;
6499}
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +00006500
6501bool
6502Process::GetModuleSpec(const FileSpec& module_file_spec,
6503 const ArchSpec& arch,
6504 ModuleSpec& module_spec)
6505{
6506 module_spec.Clear();
6507 return false;
6508}
Tamas Berghammer3cb132a2015-12-02 11:58:51 +00006509
6510size_t
6511Process::AddImageToken(lldb::addr_t image_ptr)
6512{
6513 m_image_tokens.push_back(image_ptr);
6514 return m_image_tokens.size() - 1;
6515}
6516
6517lldb::addr_t
6518Process::GetImagePtrFromToken(size_t token) const
6519{
6520 if (token < m_image_tokens.size())
6521 return m_image_tokens[token];
6522 return LLDB_INVALID_IMAGE_TOKEN;
6523}
6524
6525void
6526Process::ResetImageToken(size_t token)
6527{
6528 if (token < m_image_tokens.size())
6529 m_image_tokens[token] = LLDB_INVALID_IMAGE_TOKEN;
6530}