blob: 6bc9f2b0c9d816d68c4a40fd3b61c1af6f3db5c6 [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 (),
Greg Claytona97c4d22014-12-09 23:31:02 +0000762 m_stop_info_override_callback (NULL),
Greg Claytonc00ca312015-04-02 18:44:58 +0000763 m_finalizing (false),
764 m_finalize_called (false),
Greg Claytonf9b57b92013-05-10 23:48:10 +0000765 m_clear_thread_plans_on_stop (false),
Greg Claytonc00ca312015-04-02 18:44:58 +0000766 m_force_next_event_delivery (false),
Jim Ingham0161b492013-02-09 01:29:05 +0000767 m_last_broadcast_state (eStateInvalid),
Jason Molenda69b6b632013-03-05 03:33:59 +0000768 m_destroy_in_process (false),
Ewan Crawford90ff7912015-07-14 10:56:58 +0000769 m_can_interpret_function_calls(false),
Jason Molendaef7d6412015-08-06 03:27:10 +0000770 m_warnings_issued (),
Jason Molenda69b6b632013-03-05 03:33:59 +0000771 m_can_jit(eCanJITDontKnow)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000772{
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000773 CheckInWithManager ();
Caroline Tice1559a462010-09-27 00:30:10 +0000774
Greg Clayton5160ce52013-03-27 23:08:40 +0000775 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000776 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000777 log->Printf ("%p Process::Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000778
Todd Fiala4ceced32014-08-29 17:35:57 +0000779 if (!m_unix_signals_sp)
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000780 m_unix_signals_sp = std::make_shared<UnixSignals>();
Todd Fiala4ceced32014-08-29 17:35:57 +0000781
Greg Claytoncfd1ace2010-10-31 03:01:06 +0000782 SetEventName (eBroadcastBitStateChanged, "state-changed");
783 SetEventName (eBroadcastBitInterrupt, "interrupt");
784 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
785 SetEventName (eBroadcastBitSTDERR, "stderr-available");
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000786 SetEventName (eBroadcastBitProfileData, "profile-data-available");
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000787
Greg Clayton35a4cc52012-10-29 20:52:08 +0000788 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" );
789 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
790 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
791
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000792 listener.StartListeningForEvents (this,
793 eBroadcastBitStateChanged |
794 eBroadcastBitInterrupt |
795 eBroadcastBitSTDOUT |
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000796 eBroadcastBitSTDERR |
797 eBroadcastBitProfileData);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000798
799 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +0000800 eBroadcastBitStateChanged |
801 eBroadcastBitInterrupt);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000802
803 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
804 eBroadcastInternalStateControlStop |
805 eBroadcastInternalStateControlPause |
806 eBroadcastInternalStateControlResume);
Todd Fiala4ceced32014-08-29 17:35:57 +0000807 // We need something valid here, even if just the default UnixSignalsSP.
808 assert (m_unix_signals_sp && "null m_unix_signals_sp after initialization");
Pavel Labathf2991482015-10-20 10:33:17 +0000809
810 // Allow the platform to override the default cache line size
811 OptionValueSP value_sp =
812 m_collection_sp->GetPropertyAtIndex(nullptr, true, ePropertyMemCacheLineSize)->GetValue();
813 uint32_t platform_cache_line_size = target_sp->GetPlatform()->GetDefaultMemoryCacheLineSize();
814 if (! value_sp->OptionWasSet() && platform_cache_line_size != 0)
815 value_sp->SetUInt64Value(platform_cache_line_size);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000816}
817
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000818Process::~Process()
819{
Greg Clayton5160ce52013-03-27 23:08:40 +0000820 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000821 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000822 log->Printf ("%p Process::~Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000823 StopPrivateStateThread();
Zachary Turner39de3112014-09-09 20:54:56 +0000824
825 // ThreadList::Clear() will try to acquire this process's mutex, so
826 // explicitly clear the thread list here to ensure that the mutex
827 // is not destroyed before the thread list.
828 m_thread_list.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000829}
830
Greg Clayton67cc0632012-08-22 17:17:09 +0000831const ProcessPropertiesSP &
832Process::GetGlobalProperties()
833{
834 static ProcessPropertiesSP g_settings_sp;
835 if (!g_settings_sp)
Greg Clayton332e8b12015-01-13 21:13:08 +0000836 g_settings_sp.reset (new ProcessProperties (NULL));
Greg Clayton67cc0632012-08-22 17:17:09 +0000837 return g_settings_sp;
838}
839
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000840void
841Process::Finalize()
842{
Greg Claytonc00ca312015-04-02 18:44:58 +0000843 m_finalizing = true;
844
Ilia Kc7efd562015-03-26 07:40:40 +0000845 // Destroy this process if needed
846 switch (GetPrivateState())
847 {
848 case eStateConnected:
849 case eStateAttaching:
850 case eStateLaunching:
851 case eStateStopped:
852 case eStateRunning:
853 case eStateStepping:
854 case eStateCrashed:
855 case eStateSuspended:
Jason Molendaede31932015-04-17 05:01:58 +0000856 Destroy(false);
Ilia Kc7efd562015-03-26 07:40:40 +0000857 break;
858
859 case eStateInvalid:
860 case eStateUnloaded:
861 case eStateDetached:
862 case eStateExited:
863 break;
864 }
Greg Claytone24c4ac2011-11-17 04:46:02 +0000865
Greg Clayton1ed54f52011-10-01 00:45:15 +0000866 // Clear our broadcaster before we proceed with destroying
867 Broadcaster::Clear();
868
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000869 // Do any cleanup needed prior to being destructed... Subclasses
870 // that override this method should call this superclass method as well.
Jim Inghamd0a3e122011-02-16 17:54:55 +0000871
872 // We need to destroy the loader before the derived Process class gets destroyed
873 // since it is very likely that undoing the loader will require access to the real process.
Greg Clayton894f82f2012-01-20 23:08:34 +0000874 m_dynamic_checkers_ap.reset();
875 m_abi_sp.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +0000876 m_os_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +0000877 m_system_runtime_ap.reset();
Greg Clayton894f82f2012-01-20 23:08:34 +0000878 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +0000879 m_jit_loaders_ap.reset();
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000880 m_thread_list_real.Destroy();
Greg Claytone1cd1be2012-01-29 20:56:30 +0000881 m_thread_list.Destroy();
Jason Molenda864f1cc2013-11-11 05:20:44 +0000882 m_extended_thread_list.Destroy();
Jason Molenda5e8dce42013-12-13 00:29:16 +0000883 m_queue_list.Clear();
884 m_queue_list_stop_id = 0;
Greg Clayton894f82f2012-01-20 23:08:34 +0000885 std::vector<Notifications> empty_notifications;
886 m_notifications.swap(empty_notifications);
887 m_image_tokens.clear();
888 m_memory_cache.Clear();
889 m_allocated_memory_cache.Clear();
890 m_language_runtimes.clear();
Kuba Breckaafdf8422014-10-10 23:43:03 +0000891 m_instrumentation_runtimes.clear();
Greg Clayton894f82f2012-01-20 23:08:34 +0000892 m_next_event_action_ap.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +0000893 m_stop_info_override_callback = NULL;
Greg Clayton08765fa2015-05-28 03:24:30 +0000894 // Clear the last natural stop ID since it has a strong
895 // reference to this process
896 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
Greg Clayton35a4cc52012-10-29 20:52:08 +0000897//#ifdef LLDB_CONFIGURATION_DEBUG
898// StreamFile s(stdout, false);
899// EventSP event_sp;
900// while (m_private_state_listener.GetNextEvent(event_sp))
901// {
902// event_sp->Dump (&s);
903// s.EOL();
904// }
905//#endif
906 // We have to be very careful here as the m_private_state_listener might
907 // contain events that have ProcessSP values in them which can keep this
908 // process around forever. These events need to be cleared out.
909 m_private_state_listener.Clear();
Ed Maste64fad602013-07-29 20:58:06 +0000910 m_public_run_lock.TrySetRunning(); // This will do nothing if already locked
911 m_public_run_lock.SetStopped();
912 m_private_run_lock.TrySetRunning(); // This will do nothing if already locked
913 m_private_run_lock.SetStopped();
Jim Ingham4fc6cb92012-08-22 21:34:33 +0000914 m_finalize_called = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000915}
916
917void
918Process::RegisterNotificationCallbacks (const Notifications& callbacks)
919{
920 m_notifications.push_back(callbacks);
921 if (callbacks.initialize != NULL)
922 callbacks.initialize (callbacks.baton, this);
923}
924
925bool
926Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
927{
928 std::vector<Notifications>::iterator pos, end = m_notifications.end();
929 for (pos = m_notifications.begin(); pos != end; ++pos)
930 {
931 if (pos->baton == callbacks.baton &&
932 pos->initialize == callbacks.initialize &&
933 pos->process_state_changed == callbacks.process_state_changed)
934 {
935 m_notifications.erase(pos);
936 return true;
937 }
938 }
939 return false;
940}
941
942void
943Process::SynchronouslyNotifyStateChanged (StateType state)
944{
945 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
946 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
947 {
948 if (notification_pos->process_state_changed)
949 notification_pos->process_state_changed (notification_pos->baton, this, state);
950 }
951}
952
953// FIXME: We need to do some work on events before the general Listener sees them.
954// For instance if we are continuing from a breakpoint, we need to ensure that we do
955// the little "insert real insn, step & stop" trick. But we can't do that when the
956// event is delivered by the broadcaster - since that is done on the thread that is
957// waiting for new events, so if we needed more than one event for our handling, we would
958// stall. So instead we do it when we fetch the event off of the queue.
959//
960
961StateType
962Process::GetNextEvent (EventSP &event_sp)
963{
964 StateType state = eStateInvalid;
965
966 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
967 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
968
969 return state;
970}
971
Pavel Labath44464872015-05-27 12:40:32 +0000972void
973Process::SyncIOHandler (uint32_t iohandler_id, uint64_t timeout_msec)
Todd Fialaa3b89e22014-08-12 14:33:19 +0000974{
Todd Fialaa3b89e22014-08-12 14:33:19 +0000975 // don't sync (potentially context switch) in case where there is no process IO
Pavel Labath44464872015-05-27 12:40:32 +0000976 if (! m_process_input_reader)
977 return;
Todd Fialaa3b89e22014-08-12 14:33:19 +0000978
Pavel Labath44464872015-05-27 12:40:32 +0000979 TimeValue timeout = TimeValue::Now();
980 timeout.OffsetWithMicroSeconds(timeout_msec*1000);
981 uint32_t new_iohandler_id = 0;
982 m_iohandler_sync.WaitForValueNotEqualTo(iohandler_id, new_iohandler_id, &timeout);
Todd Fialaa3b89e22014-08-12 14:33:19 +0000983
Pavel Labath44464872015-05-27 12:40:32 +0000984 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
985 if (log)
986 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 +0000987}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000988
989StateType
Greg Claytondc6224e2014-10-21 01:00:42 +0000990Process::WaitForProcessToStop (const TimeValue *timeout,
991 EventSP *event_sp_ptr,
992 bool wait_always,
993 Listener *hijack_listener,
Pavel Labath19da1f12015-12-07 12:36:52 +0000994 Stream *stream,
995 bool use_run_lock)
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 Labath19da1f12015-12-07 12:36:52 +00001022 if (hijack_listener && use_run_lock)
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 Labath19da1f12015-12-07 12:36:52 +00001045 if (hijack_listener && use_run_lock)
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 Labath19da1f12015-12-07 12:36:52 +00001055 if (hijack_listener && use_run_lock)
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
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001311StateType
Greg Clayton44d93782014-01-27 23:43:24 +00001312Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, Listener *hijack_listener)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001313{
Greg Clayton5160ce52013-03-27 23:08:40 +00001314 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001315
1316 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001317 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1318 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001319
Greg Clayton44d93782014-01-27 23:43:24 +00001320 Listener *listener = hijack_listener;
1321 if (listener == NULL)
1322 listener = &m_listener;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001323
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001324 StateType state = eStateInvalid;
Greg Clayton44d93782014-01-27 23:43:24 +00001325 if (listener->WaitForEventForBroadcasterWithType (timeout,
1326 this,
1327 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1328 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001329 {
1330 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1331 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1332 else if (log)
1333 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1334 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001335
1336 if (log)
1337 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001338 __FUNCTION__, static_cast<const void*>(timeout),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001339 StateAsCString(state));
1340 return state;
1341}
1342
1343Event *
1344Process::PeekAtStateChangedEvents ()
1345{
Greg Clayton5160ce52013-03-27 23:08:40 +00001346 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001347
1348 if (log)
1349 log->Printf ("Process::%s...", __FUNCTION__);
1350
1351 Event *event_ptr;
Greg Clayton3fcbed62010-10-19 03:25:40 +00001352 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1353 eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001354 if (log)
1355 {
1356 if (event_ptr)
1357 {
1358 log->Printf ("Process::%s (event_ptr) => %s",
1359 __FUNCTION__,
1360 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1361 }
1362 else
1363 {
1364 log->Printf ("Process::%s no events found",
1365 __FUNCTION__);
1366 }
1367 }
1368 return event_ptr;
1369}
1370
1371StateType
1372Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1373{
Greg Clayton5160ce52013-03-27 23:08:40 +00001374 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001375
1376 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001377 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1378 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001379
1380 StateType state = eStateInvalid;
Greg Clayton6779606a2011-01-22 23:43:18 +00001381 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1382 &m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +00001383 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton6779606a2011-01-22 23:43:18 +00001384 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001385 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1386 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001387
1388 // This is a bit of a hack, but when we wait here we could very well return
1389 // to the command-line, and that could disable the log, which would render the
1390 // log we got above invalid.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001391 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001392 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1393 __FUNCTION__, static_cast<const void *>(timeout),
1394 state == eStateInvalid ? "TIMEOUT" : StateAsCString(state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001395 return state;
1396}
1397
1398bool
1399Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1400{
Greg Clayton5160ce52013-03-27 23:08:40 +00001401 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001402
1403 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001404 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1405 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001406
1407 if (control_only)
1408 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1409 else
1410 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1411}
1412
1413bool
1414Process::IsRunning () const
1415{
1416 return StateIsRunningState (m_public_state.GetValue());
1417}
1418
1419int
1420Process::GetExitStatus ()
1421{
Todd Fiala7b0917a2014-09-15 20:07:33 +00001422 Mutex::Locker locker (m_exit_status_mutex);
1423
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001424 if (m_public_state.GetValue() == eStateExited)
1425 return m_exit_status;
1426 return -1;
1427}
1428
1429const char *
1430Process::GetExitDescription ()
1431{
Todd Fiala7b0917a2014-09-15 20:07:33 +00001432 Mutex::Locker locker (m_exit_status_mutex);
1433
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001434 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1435 return m_exit_string.c_str();
1436 return NULL;
1437}
1438
Greg Clayton6779606a2011-01-22 23:43:18 +00001439bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001440Process::SetExitStatus (int status, const char *cstr)
1441{
Greg Clayton81e2b6b2015-06-01 23:14:09 +00001442 // Use a mutex to protect setting the exit status.
1443 Mutex::Locker locker (m_exit_status_mutex);
1444
Greg Clayton5160ce52013-03-27 23:08:40 +00001445 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Greg Clayton414f5d32011-01-25 02:58:48 +00001446 if (log)
1447 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1448 status, status,
1449 cstr ? "\"" : "",
1450 cstr ? cstr : "NULL",
1451 cstr ? "\"" : "");
1452
Greg Clayton6779606a2011-01-22 23:43:18 +00001453 // We were already in the exited state
1454 if (m_private_state.GetValue() == eStateExited)
Greg Clayton414f5d32011-01-25 02:58:48 +00001455 {
Greg Clayton385d6032011-01-26 23:47:29 +00001456 if (log)
1457 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton6779606a2011-01-22 23:43:18 +00001458 return false;
Greg Clayton414f5d32011-01-25 02:58:48 +00001459 }
Todd Fiala7b0917a2014-09-15 20:07:33 +00001460
Greg Clayton81e2b6b2015-06-01 23:14:09 +00001461 m_exit_status = status;
1462 if (cstr)
1463 m_exit_string = cstr;
1464 else
1465 m_exit_string.clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001466
Pavel Labatha9a43372015-09-03 09:30:17 +00001467 // When we exit, we don't need the input reader anymore
Greg Clayton5df78fa2015-05-23 03:54:53 +00001468 if (m_process_input_reader)
1469 {
1470 m_process_input_reader->SetIsDone(true);
1471 m_process_input_reader->Cancel();
1472 m_process_input_reader.reset();
1473 }
Greg Clayton10177aa2010-12-08 05:08:21 +00001474
Greg Clayton08765fa2015-05-28 03:24:30 +00001475 // Clear the last natural stop ID since it has a strong
1476 // reference to this process
1477 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
1478
Greg Clayton6779606a2011-01-22 23:43:18 +00001479 SetPrivateState (eStateExited);
Greg Clayton5df78fa2015-05-23 03:54:53 +00001480
1481 // Allow subclasses to do some cleanup
1482 DidExit ();
1483
Greg Clayton6779606a2011-01-22 23:43:18 +00001484 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001485}
1486
Jason Molendaa814f702015-11-05 23:03:44 +00001487bool
1488Process::IsAlive ()
1489{
1490 switch (m_private_state.GetValue())
1491 {
1492 case eStateInvalid:
1493 case eStateUnloaded:
1494 case eStateDetached:
1495 case eStateExited:
1496 return false;
1497
1498 case eStateConnected:
1499 case eStateAttaching:
1500 case eStateLaunching:
1501 case eStateStopped:
1502 case eStateRunning:
1503 case eStateStepping:
1504 case eStateCrashed:
1505 case eStateSuspended:
1506 return true;
1507 }
1508}
1509
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001510// This static callback can be used to watch for local child processes on
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00001511// the current host. The child process exits, the process will be
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001512// found in the global target list (we want to be completely sure that the
1513// lldb_private::Process doesn't go away before we can deliver the signal.
1514bool
Greg Claytone4e45922011-11-16 05:37:56 +00001515Process::SetProcessExitStatus (void *callback_baton,
1516 lldb::pid_t pid,
1517 bool exited,
1518 int signo, // Zero for no signal
1519 int exit_status // Exit value of process if signal is zero
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001520)
1521{
Greg Clayton5160ce52013-03-27 23:08:40 +00001522 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytone4e45922011-11-16 05:37:56 +00001523 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001524 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
Greg Claytone4e45922011-11-16 05:37:56 +00001525 callback_baton,
1526 pid,
1527 exited,
1528 signo,
1529 exit_status);
1530
1531 if (exited)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001532 {
Greg Clayton66111032010-06-23 01:19:29 +00001533 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001534 if (target_sp)
1535 {
1536 ProcessSP process_sp (target_sp->GetProcessSP());
1537 if (process_sp)
1538 {
1539 const char *signal_cstr = NULL;
1540 if (signo)
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00001541 signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001542
1543 process_sp->SetExitStatus (exit_status, signal_cstr);
1544 }
1545 }
1546 return true;
1547 }
1548 return false;
1549}
1550
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001551void
1552Process::UpdateThreadListIfNeeded ()
1553{
1554 const uint32_t stop_id = GetStopID();
1555 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1556 {
Greg Clayton2637f822011-11-17 01:23:07 +00001557 const StateType state = GetPrivateState();
1558 if (StateIsStoppedState (state, true))
1559 {
1560 Mutex::Locker locker (m_thread_list.GetMutex ());
Greg Claytone24c4ac2011-11-17 04:46:02 +00001561 // m_thread_list does have its own mutex, but we need to
1562 // hold onto the mutex between the call to UpdateThreadList(...)
1563 // and the os->UpdateThreadList(...) so it doesn't change on us
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001564 ThreadList &old_thread_list = m_thread_list;
1565 ThreadList real_thread_list(this);
Greg Clayton2637f822011-11-17 01:23:07 +00001566 ThreadList new_thread_list(this);
1567 // Always update the thread list with the protocol specific
Greg Clayton9fc13552012-04-10 00:18:59 +00001568 // thread list, but only update if "true" is returned
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001569 if (UpdateThreadList (m_thread_list_real, real_thread_list))
Greg Clayton9fc13552012-04-10 00:18:59 +00001570 {
Jim Ingham09437922013-03-01 20:04:25 +00001571 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since
1572 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is
1573 // shutting us down, causing a deadlock.
Pavel Labath862432c2015-11-03 16:05:18 +00001574 OperatingSystem *os = GetOperatingSystem ();
1575 if (os && !m_destroy_in_process)
Jim Ingham09437922013-03-01 20:04:25 +00001576 {
Pavel Labath862432c2015-11-03 16:05:18 +00001577 // Clear any old backing threads where memory threads might have been
1578 // backed by actual threads from the lldb_private::Process subclass
1579 size_t num_old_threads = old_thread_list.GetSize(false);
1580 for (size_t i=0; i<num_old_threads; ++i)
1581 old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread();
Greg Claytonb3ae8762013-04-12 20:07:46 +00001582
Pavel Labath862432c2015-11-03 16:05:18 +00001583 // Turn off dynamic types to ensure we don't run any expressions. Objective C
1584 // can run an expression to determine if a SBValue is a dynamic type or not
1585 // and we need to avoid this. OperatingSystem plug-ins can't run expressions
1586 // that require running code...
Greg Clayton15484402015-05-15 18:40:24 +00001587
Pavel Labath862432c2015-11-03 16:05:18 +00001588 Target &target = GetTarget();
1589 const lldb::DynamicValueType saved_prefer_dynamic = target.GetPreferDynamicValue ();
1590 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1591 target.SetPreferDynamicValue(lldb::eNoDynamicValues);
Greg Clayton15484402015-05-15 18:40:24 +00001592
Pavel Labath862432c2015-11-03 16:05:18 +00001593 // Now let the OperatingSystem plug-in update the thread list
Greg Clayton15484402015-05-15 18:40:24 +00001594
Pavel Labath862432c2015-11-03 16:05:18 +00001595 os->UpdateThreadList (old_thread_list, // Old list full of threads created by OS plug-in
1596 real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass
1597 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 +00001598
Pavel Labath862432c2015-11-03 16:05:18 +00001599 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1600 target.SetPreferDynamicValue(saved_prefer_dynamic);
1601 }
1602 else
1603 {
1604 // No OS plug-in, the new thread list is the same as the real thread list
1605 new_thread_list = real_thread_list;
Jim Ingham09437922013-03-01 20:04:25 +00001606 }
Jim Ingham02ff8e02013-06-22 00:55:02 +00001607
1608 m_thread_list_real.Update(real_thread_list);
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001609 m_thread_list.Update (new_thread_list);
1610 m_thread_list.SetStopID (stop_id);
Jason Molendaa6e91302013-11-19 05:44:41 +00001611
Jason Molenda4ff13262013-11-20 00:31:38 +00001612 if (GetLastNaturalStopID () != m_extended_thread_stop_id)
1613 {
1614 // Clear any extended threads that we may have accumulated previously
1615 m_extended_thread_list.Clear();
1616 m_extended_thread_stop_id = GetLastNaturalStopID ();
Jason Molenda5e8dce42013-12-13 00:29:16 +00001617
1618 m_queue_list.Clear();
1619 m_queue_list_stop_id = GetLastNaturalStopID ();
Jason Molenda4ff13262013-11-20 00:31:38 +00001620 }
Greg Clayton9fc13552012-04-10 00:18:59 +00001621 }
Greg Clayton2637f822011-11-17 01:23:07 +00001622 }
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001623 }
1624}
1625
Jason Molenda5e8dce42013-12-13 00:29:16 +00001626void
1627Process::UpdateQueueListIfNeeded ()
1628{
1629 if (m_system_runtime_ap.get())
1630 {
1631 if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID())
1632 {
1633 const StateType state = GetPrivateState();
1634 if (StateIsStoppedState (state, true))
1635 {
1636 m_system_runtime_ap->PopulateQueueList (m_queue_list);
1637 m_queue_list_stop_id = GetLastNaturalStopID();
1638 }
1639 }
1640 }
1641}
1642
Greg Claytona4d87472013-01-18 23:41:08 +00001643ThreadSP
1644Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1645{
1646 OperatingSystem *os = GetOperatingSystem ();
1647 if (os)
1648 return os->CreateThread(tid, context);
1649 return ThreadSP();
1650}
1651
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001652uint32_t
1653Process::GetNextThreadIndexID (uint64_t thread_id)
1654{
1655 return AssignIndexIDToThread(thread_id);
1656}
1657
1658bool
1659Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1660{
Eugene Zelenko8f30a652015-10-23 18:39:37 +00001661 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 +00001662}
1663
1664uint32_t
1665Process::AssignIndexIDToThread(uint64_t thread_id)
1666{
1667 uint32_t result = 0;
1668 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1669 if (iterator == m_thread_id_to_index_id_map.end())
1670 {
1671 result = ++m_thread_index_id;
1672 m_thread_id_to_index_id_map[thread_id] = result;
1673 }
1674 else
1675 {
1676 result = iterator->second;
1677 }
1678
1679 return result;
1680}
1681
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001682StateType
1683Process::GetState()
1684{
1685 // If any other threads access this we will need a mutex for it
1686 return m_public_state.GetValue ();
1687}
1688
Greg Claytondc6224e2014-10-21 01:00:42 +00001689bool
1690Process::StateChangedIsExternallyHijacked()
1691{
1692 if (IsHijackedForEvent(eBroadcastBitStateChanged))
1693 {
1694 if (strcmp(m_hijacking_listeners.back()->GetName(), "lldb.Process.ResumeSynchronous.hijack"))
1695 return true;
1696 }
1697 return false;
1698}
1699
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001700void
Jim Ingham221d51c2013-05-08 00:35:16 +00001701Process::SetPublicState (StateType new_state, bool restarted)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001702{
Greg Clayton5160ce52013-03-27 23:08:40 +00001703 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001704 if (log)
Jim Ingham221d51c2013-05-08 00:35:16 +00001705 log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted);
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001706 const StateType old_state = m_public_state.GetValue();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001707 m_public_state.SetValue (new_state);
Jim Ingham3b8285d2012-04-19 01:40:33 +00001708
1709 // On the transition from Run to Stopped, we unlock the writer end of the
1710 // run lock. The lock gets locked in Resume, which is the public API
1711 // to tell the program to run.
Greg Claytondc6224e2014-10-21 01:00:42 +00001712 if (!StateChangedIsExternallyHijacked())
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001713 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001714 if (new_state == eStateDetached)
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001715 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001716 if (log)
1717 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001718 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001719 }
1720 else
1721 {
1722 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1723 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
Jim Ingham221d51c2013-05-08 00:35:16 +00001724 if ((old_state_is_stopped != new_state_is_stopped))
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001725 {
Jim Ingham221d51c2013-05-08 00:35:16 +00001726 if (new_state_is_stopped && !restarted)
Sean Callanan8b0737f2012-06-02 01:16:20 +00001727 {
1728 if (log)
1729 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001730 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001731 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001732 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001733 }
1734 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001735}
1736
Jim Ingham3b8285d2012-04-19 01:40:33 +00001737Error
1738Process::Resume ()
1739{
Greg Clayton5160ce52013-03-27 23:08:40 +00001740 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Jim Ingham3b8285d2012-04-19 01:40:33 +00001741 if (log)
1742 log->Printf("Process::Resume -- locking run lock");
Ed Maste64fad602013-07-29 20:58:06 +00001743 if (!m_public_run_lock.TrySetRunning())
Jim Ingham3b8285d2012-04-19 01:40:33 +00001744 {
1745 Error error("Resume request failed - process still running.");
1746 if (log)
Ed Maste64fad602013-07-29 20:58:06 +00001747 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
Jim Ingham3b8285d2012-04-19 01:40:33 +00001748 return error;
1749 }
1750 return PrivateResume();
1751}
1752
Greg Claytondc6224e2014-10-21 01:00:42 +00001753Error
1754Process::ResumeSynchronous (Stream *stream)
1755{
1756 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1757 if (log)
1758 log->Printf("Process::ResumeSynchronous -- locking run lock");
1759 if (!m_public_run_lock.TrySetRunning())
1760 {
1761 Error error("Resume request failed - process still running.");
1762 if (log)
1763 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1764 return error;
1765 }
1766
1767 ListenerSP listener_sp (new Listener("lldb.Process.ResumeSynchronous.hijack"));
1768 HijackProcessEvents(listener_sp.get());
1769
1770 Error error = PrivateResume();
Ilia Kd8c14752015-04-30 13:10:32 +00001771 if (error.Success())
1772 {
1773 StateType state = WaitForProcessToStop (NULL, NULL, true, listener_sp.get(), stream);
1774 const bool must_be_alive = false; // eStateExited is ok, so this must be false
1775 if (!StateIsStoppedState(state, must_be_alive))
1776 error.SetErrorStringWithFormat("process not in stopped state after synchronous resume: %s", StateAsCString(state));
1777 }
Greg Claytondc6224e2014-10-21 01:00:42 +00001778
1779 // Undo the hijacking of process events...
1780 RestoreProcessEvents();
1781
Greg Claytondc6224e2014-10-21 01:00:42 +00001782 return error;
1783}
1784
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001785StateType
1786Process::GetPrivateState ()
1787{
1788 return m_private_state.GetValue();
1789}
1790
1791void
1792Process::SetPrivateState (StateType new_state)
1793{
Greg Claytonfb8b37a2014-07-14 23:09:29 +00001794 if (m_finalize_called)
1795 return;
1796
Greg Clayton5160ce52013-03-27 23:08:40 +00001797 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001798 bool state_changed = false;
1799
1800 if (log)
1801 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1802
Andrew Kaylor29d65742013-05-10 17:19:04 +00001803 Mutex::Locker thread_locker(m_thread_list.GetMutex());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001804 Mutex::Locker locker(m_private_state.GetMutex());
1805
1806 const StateType old_state = m_private_state.GetValueNoLock ();
1807 state_changed = old_state != new_state;
Ed Mastec29693f2013-07-02 16:35:47 +00001808
Greg Claytonaa49c832013-05-03 22:25:56 +00001809 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1810 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1811 if (old_state_is_stopped != new_state_is_stopped)
1812 {
1813 if (new_state_is_stopped)
Ed Maste64fad602013-07-29 20:58:06 +00001814 m_private_run_lock.SetStopped();
Greg Claytonaa49c832013-05-03 22:25:56 +00001815 else
Ed Maste64fad602013-07-29 20:58:06 +00001816 m_private_run_lock.SetRunning();
Greg Claytonaa49c832013-05-03 22:25:56 +00001817 }
Andrew Kaylor93132f52013-05-28 23:04:25 +00001818
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001819 if (state_changed)
1820 {
1821 m_private_state.SetValueNoLock (new_state);
Ilia K38810f42015-05-20 10:15:47 +00001822 EventSP event_sp (new Event (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state)));
Greg Clayton2637f822011-11-17 01:23:07 +00001823 if (StateIsStoppedState(new_state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001824 {
Andrew Kaylor29d65742013-05-10 17:19:04 +00001825 // Note, this currently assumes that all threads in the list
1826 // stop when the process stops. In the future we will want to
1827 // support a debugging model where some threads continue to run
1828 // while others are stopped. When that happens we will either need
1829 // a way for the thread list to identify which threads are stopping
1830 // or create a special thread list containing only threads which
1831 // actually stopped.
1832 //
1833 // The process plugin is responsible for managing the actual
1834 // behavior of the threads and should have stopped any threads
1835 // that are going to stop before we get here.
1836 m_thread_list.DidStop();
1837
Jim Ingham4b536182011-08-09 02:12:22 +00001838 m_mod_id.BumpStopID();
Ilia K38810f42015-05-20 10:15:47 +00001839 if (!m_mod_id.IsLastResumeForUserExpression())
1840 m_mod_id.SetStopEventForLastNaturalStopID(event_sp);
Greg Clayton58be07b2011-01-07 06:08:19 +00001841 m_memory_cache.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001842 if (log)
Jim Ingham4b536182011-08-09 02:12:22 +00001843 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001844 }
Ilia K38810f42015-05-20 10:15:47 +00001845
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001846 // Use our target to get a shared pointer to ourselves...
Greg Clayton35a4cc52012-10-29 20:52:08 +00001847 if (m_finalize_called && PrivateStateThreadIsValid() == false)
Ilia K38810f42015-05-20 10:15:47 +00001848 BroadcastEvent (event_sp);
Greg Clayton35a4cc52012-10-29 20:52:08 +00001849 else
Ilia K38810f42015-05-20 10:15:47 +00001850 m_private_state_broadcaster.BroadcastEvent (event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001851 }
1852 else
1853 {
1854 if (log)
Jason Molendafd54b362011-09-20 21:44:10 +00001855 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001856 }
1857}
1858
Jim Ingham0faa43f2011-11-08 03:00:11 +00001859void
1860Process::SetRunningUserExpression (bool on)
1861{
1862 m_mod_id.SetRunningUserExpression (on);
1863}
1864
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001865addr_t
1866Process::GetImageInfoAddress()
1867{
1868 return LLDB_INVALID_ADDRESS;
1869}
1870
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001871const lldb::ABISP &
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001872Process::GetABI()
1873{
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001874 if (!m_abi_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00001875 m_abi_sp = ABI::FindPlugin(GetTarget().GetArchitecture());
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001876 return m_abi_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001877}
1878
Jim Ingham22777012010-09-23 02:01:19 +00001879LanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001880Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001881{
Greg Claytonc00ca312015-04-02 18:44:58 +00001882 if (m_finalizing)
1883 return nullptr;
1884
Jim Ingham22777012010-09-23 02:01:19 +00001885 LanguageRuntimeCollection::iterator pos;
1886 pos = m_language_runtimes.find (language);
Jim Inghamab175242012-03-10 00:22:19 +00001887 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
Jim Ingham22777012010-09-23 02:01:19 +00001888 {
Jim Inghamab175242012-03-10 00:22:19 +00001889 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
Jim Ingham22777012010-09-23 02:01:19 +00001890
Jim Inghamab175242012-03-10 00:22:19 +00001891 m_language_runtimes[language] = runtime_sp;
1892 return runtime_sp.get();
Jim Ingham22777012010-09-23 02:01:19 +00001893 }
1894 else
1895 return (*pos).second.get();
1896}
1897
1898CPPLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001899Process::GetCPPLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001900{
Jim Inghamab175242012-03-10 00:22:19 +00001901 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00001902 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1903 return static_cast<CPPLanguageRuntime *> (runtime);
1904 return NULL;
1905}
1906
1907ObjCLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001908Process::GetObjCLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001909{
Jim Inghamab175242012-03-10 00:22:19 +00001910 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00001911 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1912 return static_cast<ObjCLanguageRuntime *> (runtime);
1913 return NULL;
1914}
1915
Enrico Granatafd4c84e2012-05-21 16:51:35 +00001916bool
1917Process::IsPossibleDynamicValue (ValueObject& in_value)
1918{
Greg Claytonc00ca312015-04-02 18:44:58 +00001919 if (m_finalizing)
1920 return false;
1921
Enrico Granatafd4c84e2012-05-21 16:51:35 +00001922 if (in_value.IsDynamic())
1923 return false;
1924 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1925
1926 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1927 {
1928 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1929 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1930 }
1931
1932 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1933 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1934 return true;
1935
1936 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1937 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1938}
1939
Zachary Turner93749ab2015-03-03 21:51:25 +00001940void
1941Process::SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers)
1942{
1943 m_dynamic_checkers_ap.reset(dynamic_checkers);
1944}
1945
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001946BreakpointSiteList &
1947Process::GetBreakpointSiteList()
1948{
1949 return m_breakpoint_site_list;
1950}
1951
1952const BreakpointSiteList &
1953Process::GetBreakpointSiteList() const
1954{
1955 return m_breakpoint_site_list;
1956}
1957
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001958void
1959Process::DisableAllBreakpointSites ()
1960{
Greg Claytond8cf1a12013-06-12 00:46:38 +00001961 m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void {
1962// bp_site->SetEnabled(true);
1963 DisableBreakpointSite(bp_site);
1964 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001965}
1966
1967Error
1968Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1969{
1970 Error error (DisableBreakpointSiteByID (break_id));
1971
1972 if (error.Success())
1973 m_breakpoint_site_list.Remove(break_id);
1974
1975 return error;
1976}
1977
1978Error
1979Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1980{
1981 Error error;
1982 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1983 if (bp_site_sp)
1984 {
1985 if (bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00001986 error = DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001987 }
1988 else
1989 {
Daniel Malead01b2952012-11-29 21:49:15 +00001990 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001991 }
1992
1993 return error;
1994}
1995
1996Error
1997Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
1998{
1999 Error error;
2000 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2001 if (bp_site_sp)
2002 {
2003 if (!bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00002004 error = EnableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002005 }
2006 else
2007 {
Daniel Malead01b2952012-11-29 21:49:15 +00002008 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002009 }
2010 return error;
2011}
2012
Stephen Wilson50bd94f2010-07-17 00:56:13 +00002013lldb::break_id_t
Greg Claytone1cd1be2012-01-29 20:56:30 +00002014Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002015{
Jim Ingham1460e4b2014-01-10 23:46:59 +00002016 addr_t load_addr = LLDB_INVALID_ADDRESS;
2017
2018 bool show_error = true;
2019 switch (GetState())
2020 {
2021 case eStateInvalid:
2022 case eStateUnloaded:
2023 case eStateConnected:
2024 case eStateAttaching:
2025 case eStateLaunching:
2026 case eStateDetached:
2027 case eStateExited:
2028 show_error = false;
2029 break;
2030
2031 case eStateStopped:
2032 case eStateRunning:
2033 case eStateStepping:
2034 case eStateCrashed:
2035 case eStateSuspended:
2036 show_error = IsAlive();
2037 break;
2038 }
2039
2040 // Reset the IsIndirect flag here, in case the location changes from
2041 // pointing to a indirect symbol to a regular symbol.
2042 owner->SetIsIndirect (false);
2043
2044 if (owner->ShouldResolveIndirectFunctions())
2045 {
2046 Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol();
2047 if (symbol && symbol->IsIndirect())
2048 {
2049 Error error;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002050 Address symbol_address = symbol->GetAddress();
2051 load_addr = ResolveIndirectFunction (&symbol_address, error);
Jim Ingham1460e4b2014-01-10 23:46:59 +00002052 if (!error.Success() && show_error)
2053 {
Zachary Turner7529df92015-09-01 20:02:29 +00002054 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2055 symbol->GetLoadAddress(&GetTarget()),
2056 owner->GetBreakpoint().GetID(),
2057 owner->GetID(),
2058 error.AsCString() ? error.AsCString() : "unknown error");
Jim Ingham1460e4b2014-01-10 23:46:59 +00002059 return LLDB_INVALID_BREAK_ID;
2060 }
2061 Address resolved_address(load_addr);
Zachary Turner7529df92015-09-01 20:02:29 +00002062 load_addr = resolved_address.GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002063 owner->SetIsIndirect(true);
2064 }
2065 else
Zachary Turner7529df92015-09-01 20:02:29 +00002066 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002067 }
2068 else
Zachary Turner7529df92015-09-01 20:02:29 +00002069 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
Jim Ingham1460e4b2014-01-10 23:46:59 +00002070
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002071 if (load_addr != LLDB_INVALID_ADDRESS)
2072 {
2073 BreakpointSiteSP bp_site_sp;
2074
2075 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
2076 // create a new breakpoint site and add it.
2077
2078 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
2079
2080 if (bp_site_sp)
2081 {
2082 bp_site_sp->AddOwner (owner);
2083 owner->SetBreakpointSite (bp_site_sp);
2084 return bp_site_sp->GetID();
2085 }
2086 else
2087 {
Greg Claytonc7bece562013-01-25 18:06:21 +00002088 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002089 if (bp_site_sp)
2090 {
Greg Claytoneb023e72013-10-11 19:48:25 +00002091 Error error = EnableBreakpointSite (bp_site_sp.get());
2092 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002093 {
2094 owner->SetBreakpointSite (bp_site_sp);
2095 return m_breakpoint_site_list.Add (bp_site_sp);
2096 }
Greg Claytoneb023e72013-10-11 19:48:25 +00002097 else
2098 {
Greg Claytonfbb76342013-11-20 21:07:01 +00002099 if (show_error)
2100 {
2101 // Report error for setting breakpoint...
Zachary Turner7529df92015-09-01 20:02:29 +00002102 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2103 load_addr,
2104 owner->GetBreakpoint().GetID(),
2105 owner->GetID(),
2106 error.AsCString() ? error.AsCString() : "unknown error");
Greg Claytonfbb76342013-11-20 21:07:01 +00002107 }
Greg Claytoneb023e72013-10-11 19:48:25 +00002108 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002109 }
2110 }
2111 }
2112 // We failed to enable the breakpoint
2113 return LLDB_INVALID_BREAK_ID;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002114}
2115
2116void
2117Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
2118{
2119 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
2120 if (num_owners == 0)
2121 {
Jim Inghamf1ff3bb2013-04-06 00:16:39 +00002122 // Don't try to disable the site if we don't have a live process anymore.
2123 if (IsAlive())
2124 DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002125 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
2126 }
2127}
2128
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002129size_t
2130Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
2131{
2132 size_t bytes_removed = 0;
Jim Ingham20c77192011-06-29 19:42:28 +00002133 BreakpointSiteList bp_sites_in_range;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002134
Jim Ingham20c77192011-06-29 19:42:28 +00002135 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002136 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002137 bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void {
2138 if (bp_site->GetType() == BreakpointSite::eSoftware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002139 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002140 addr_t intersect_addr;
2141 size_t intersect_size;
2142 size_t opcode_offset;
2143 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
Jim Ingham20c77192011-06-29 19:42:28 +00002144 {
2145 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
2146 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002147 assert(opcode_offset + intersect_size <= bp_site->GetByteSize());
Jim Ingham20c77192011-06-29 19:42:28 +00002148 size_t buf_offset = intersect_addr - bp_addr;
Greg Claytond8cf1a12013-06-12 00:46:38 +00002149 ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
Jim Ingham20c77192011-06-29 19:42:28 +00002150 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002151 }
Greg Claytond8cf1a12013-06-12 00:46:38 +00002152 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002153 }
2154 return bytes_removed;
2155}
2156
Greg Claytonded470d2011-03-19 01:12:21 +00002157size_t
2158Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
2159{
Zachary Turner7529df92015-09-01 20:02:29 +00002160 PlatformSP platform_sp (GetTarget().GetPlatform());
Greg Claytonded470d2011-03-19 01:12:21 +00002161 if (platform_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00002162 return platform_sp->GetSoftwareBreakpointTrapOpcode (GetTarget(), bp_site);
Greg Claytonded470d2011-03-19 01:12:21 +00002163 return 0;
2164}
2165
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002166Error
2167Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
2168{
2169 Error error;
2170 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002171 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002172 const addr_t bp_addr = bp_site->GetLoadAddress();
2173 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002174 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002175 if (bp_site->IsEnabled())
2176 {
2177 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002178 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 +00002179 return error;
2180 }
2181
2182 if (bp_addr == LLDB_INVALID_ADDRESS)
2183 {
2184 error.SetErrorString("BreakpointSite contains an invalid load address.");
2185 return error;
2186 }
2187 // Ask the lldb::Process subclass to fill in the correct software breakpoint
2188 // trap for the breakpoint site
2189 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
2190
2191 if (bp_opcode_size == 0)
2192 {
Daniel Malead01b2952012-11-29 21:49:15 +00002193 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002194 }
2195 else
2196 {
2197 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
2198
2199 if (bp_opcode_bytes == NULL)
2200 {
2201 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
2202 return error;
2203 }
2204
2205 // Save the original opcode by reading it
2206 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
2207 {
2208 // Write a software breakpoint in place of the original opcode
2209 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2210 {
2211 uint8_t verify_bp_opcode_bytes[64];
2212 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2213 {
2214 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
2215 {
2216 bp_site->SetEnabled(true);
2217 bp_site->SetType (BreakpointSite::eSoftware);
2218 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002219 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002220 bp_site->GetID(),
2221 (uint64_t)bp_addr);
2222 }
2223 else
Greg Clayton86edbf42011-10-26 00:56:27 +00002224 error.SetErrorString("failed to verify the breakpoint trap in memory.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002225 }
2226 else
2227 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
2228 }
2229 else
2230 error.SetErrorString("Unable to write breakpoint trap to memory.");
2231 }
2232 else
2233 error.SetErrorString("Unable to read memory at breakpoint address.");
2234 }
Stephen Wilson78a4feb2011-01-12 04:20:03 +00002235 if (log && error.Fail())
Daniel Malead01b2952012-11-29 21:49:15 +00002236 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002237 bp_site->GetID(),
2238 (uint64_t)bp_addr,
2239 error.AsCString());
2240 return error;
2241}
2242
2243Error
2244Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2245{
2246 Error error;
2247 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002248 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002249 addr_t bp_addr = bp_site->GetLoadAddress();
2250 lldb::user_id_t breakID = bp_site->GetID();
2251 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00002252 log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002253
2254 if (bp_site->IsHardware())
2255 {
2256 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2257 }
2258 else if (bp_site->IsEnabled())
2259 {
2260 const size_t break_op_size = bp_site->GetByteSize();
2261 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2262 if (break_op_size > 0)
2263 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00002264 // Clear a software breakpoint instruction
Greg Claytonc982c762010-07-09 20:39:50 +00002265 uint8_t curr_break_op[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002266 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002267 bool break_op_found = false;
2268
2269 // Read the breakpoint opcode
2270 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2271 {
2272 bool verify = false;
Bruce Mitchener58ef3912015-06-18 05:27:05 +00002273 // Make sure the breakpoint opcode exists at this address
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002274 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2275 {
2276 break_op_found = true;
2277 // We found a valid breakpoint opcode at this address, now restore
2278 // the saved opcode.
2279 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2280 {
2281 verify = true;
2282 }
2283 else
2284 error.SetErrorString("Memory write failed when restoring original opcode.");
2285 }
2286 else
2287 {
2288 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2289 // Set verify to true and so we can check if the original opcode has already been restored
2290 verify = true;
2291 }
2292
2293 if (verify)
2294 {
Greg Claytonc982c762010-07-09 20:39:50 +00002295 uint8_t verify_opcode[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002296 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002297 // Verify that our original opcode made it back to the inferior
2298 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2299 {
2300 // compare the memory we just read with the original opcode
2301 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2302 {
2303 // SUCCESS
2304 bp_site->SetEnabled(false);
2305 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002306 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 +00002307 return error;
2308 }
2309 else
2310 {
2311 if (break_op_found)
2312 error.SetErrorString("Failed to restore original opcode.");
2313 }
2314 }
2315 else
2316 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2317 }
2318 }
2319 else
2320 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2321 }
2322 }
2323 else
2324 {
2325 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002326 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 +00002327 return error;
2328 }
2329
2330 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002331 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002332 bp_site->GetID(),
2333 (uint64_t)bp_addr,
2334 error.AsCString());
2335 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002336}
2337
Greg Clayton58be07b2011-01-07 06:08:19 +00002338// Uncomment to verify memory caching works after making changes to caching code
2339//#define VERIFY_MEMORY_READS
2340
Sean Callanan64c0cf22012-06-07 22:26:42 +00002341size_t
2342Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2343{
Jason Molendaa7b5afa2013-11-15 00:17:32 +00002344 error.Clear();
Sean Callanan64c0cf22012-06-07 22:26:42 +00002345 if (!GetDisableMemoryCache())
2346 {
Greg Clayton58be07b2011-01-07 06:08:19 +00002347#if defined (VERIFY_MEMORY_READS)
Sean Callanan64c0cf22012-06-07 22:26:42 +00002348 // Memory caching is enabled, with debug verification
2349
2350 if (buf && size)
2351 {
2352 // Uncomment the line below to make sure memory caching is working.
2353 // I ran this through the test suite and got no assertions, so I am
2354 // pretty confident this is working well. If any changes are made to
2355 // memory caching, uncomment the line below and test your changes!
2356
2357 // Verify all memory reads by using the cache first, then redundantly
2358 // reading the same memory from the inferior and comparing to make sure
2359 // everything is exactly the same.
2360 std::string verify_buf (size, '\0');
2361 assert (verify_buf.size() == size);
2362 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2363 Error verify_error;
2364 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2365 assert (cache_bytes_read == verify_bytes_read);
2366 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2367 assert (verify_error.Success() == error.Success());
2368 return cache_bytes_read;
2369 }
2370 return 0;
2371#else // !defined(VERIFY_MEMORY_READS)
2372 // Memory caching is enabled, without debug verification
2373
2374 return m_memory_cache.Read (addr, buf, size, error);
2375#endif // defined (VERIFY_MEMORY_READS)
Greg Clayton58be07b2011-01-07 06:08:19 +00002376 }
Sean Callanan64c0cf22012-06-07 22:26:42 +00002377 else
2378 {
2379 // Memory caching is disabled
2380
2381 return ReadMemoryFromInferior (addr, buf, size, error);
2382 }
Greg Clayton58be07b2011-01-07 06:08:19 +00002383}
Greg Clayton58be07b2011-01-07 06:08:19 +00002384
Greg Clayton4c82d422012-05-18 23:20:01 +00002385size_t
2386Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2387{
Greg Claytonde87c0f2012-05-19 00:18:00 +00002388 char buf[256];
Greg Clayton4c82d422012-05-18 23:20:01 +00002389 out_str.clear();
2390 addr_t curr_addr = addr;
2391 while (1)
2392 {
2393 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2394 if (length == 0)
2395 break;
2396 out_str.append(buf, length);
2397 // If we got "length - 1" bytes, we didn't get the whole C string, we
2398 // need to read some more characters
2399 if (length == sizeof(buf) - 1)
2400 curr_addr += length;
2401 else
2402 break;
2403 }
2404 return out_str.size();
2405}
2406
Greg Clayton58be07b2011-01-07 06:08:19 +00002407size_t
Ashok Thirumurthi6ac9d132013-04-19 15:58:38 +00002408Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error,
2409 size_t type_width)
2410{
2411 size_t total_bytes_read = 0;
2412 if (dst && max_bytes && type_width && max_bytes >= type_width)
2413 {
2414 // Ensure a null terminator independent of the number of bytes that is read.
2415 memset (dst, 0, max_bytes);
2416 size_t bytes_left = max_bytes - type_width;
2417
2418 const char terminator[4] = {'\0', '\0', '\0', '\0'};
2419 assert(sizeof(terminator) >= type_width &&
2420 "Attempting to validate a string with more than 4 bytes per character!");
2421
2422 addr_t curr_addr = addr;
2423 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2424 char *curr_dst = dst;
2425
2426 error.Clear();
2427 while (bytes_left > 0 && error.Success())
2428 {
2429 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2430 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2431 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2432
2433 if (bytes_read == 0)
2434 break;
2435
2436 // Search for a null terminator of correct size and alignment in bytes_read
2437 size_t aligned_start = total_bytes_read - total_bytes_read % type_width;
2438 for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width)
2439 if (::strncmp(&dst[i], terminator, type_width) == 0)
2440 {
2441 error.Clear();
2442 return i;
2443 }
2444
2445 total_bytes_read += bytes_read;
2446 curr_dst += bytes_read;
2447 curr_addr += bytes_read;
2448 bytes_left -= bytes_read;
2449 }
2450 }
2451 else
2452 {
2453 if (max_bytes)
2454 error.SetErrorString("invalid arguments");
2455 }
2456 return total_bytes_read;
2457}
2458
2459// Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find
2460// null terminators.
2461size_t
Greg Claytone91b7952011-12-15 03:14:23 +00002462Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
Greg Clayton8b82f082011-04-12 05:54:46 +00002463{
2464 size_t total_cstr_len = 0;
2465 if (dst && dst_max_len)
2466 {
Greg Claytone91b7952011-12-15 03:14:23 +00002467 result_error.Clear();
Greg Clayton8b82f082011-04-12 05:54:46 +00002468 // NULL out everything just to be safe
2469 memset (dst, 0, dst_max_len);
2470 Error error;
2471 addr_t curr_addr = addr;
2472 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2473 size_t bytes_left = dst_max_len - 1;
2474 char *curr_dst = dst;
2475
2476 while (bytes_left > 0)
2477 {
2478 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2479 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2480 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2481
2482 if (bytes_read == 0)
2483 {
Greg Claytone91b7952011-12-15 03:14:23 +00002484 result_error = error;
Greg Clayton8b82f082011-04-12 05:54:46 +00002485 dst[total_cstr_len] = '\0';
2486 break;
2487 }
2488 const size_t len = strlen(curr_dst);
2489
2490 total_cstr_len += len;
2491
2492 if (len < bytes_to_read)
2493 break;
2494
2495 curr_dst += bytes_read;
2496 curr_addr += bytes_read;
2497 bytes_left -= bytes_read;
2498 }
2499 }
Greg Claytone91b7952011-12-15 03:14:23 +00002500 else
2501 {
2502 if (dst == NULL)
2503 result_error.SetErrorString("invalid arguments");
2504 else
2505 result_error.Clear();
2506 }
Greg Clayton8b82f082011-04-12 05:54:46 +00002507 return total_cstr_len;
2508}
2509
2510size_t
Greg Clayton58be07b2011-01-07 06:08:19 +00002511Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2512{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002513 if (buf == NULL || size == 0)
2514 return 0;
2515
2516 size_t bytes_read = 0;
2517 uint8_t *bytes = (uint8_t *)buf;
2518
2519 while (bytes_read < size)
2520 {
2521 const size_t curr_size = size - bytes_read;
2522 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2523 bytes + bytes_read,
2524 curr_size,
2525 error);
2526 bytes_read += curr_bytes_read;
2527 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2528 break;
2529 }
2530
2531 // Replace any software breakpoint opcodes that fall into this range back
2532 // into "buf" before we return
2533 if (bytes_read > 0)
2534 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2535 return bytes_read;
2536}
2537
Greg Clayton58a4c462010-12-16 20:01:20 +00002538uint64_t
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002539Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
Greg Clayton58a4c462010-12-16 20:01:20 +00002540{
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002541 Scalar scalar;
2542 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2543 return scalar.ULongLong(fail_value);
2544 return fail_value;
2545}
2546
2547addr_t
2548Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2549{
2550 Scalar scalar;
2551 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2552 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2553 return LLDB_INVALID_ADDRESS;
2554}
2555
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002556bool
2557Process::WritePointerToMemory (lldb::addr_t vm_addr,
2558 lldb::addr_t ptr_value,
2559 Error &error)
2560{
2561 Scalar scalar;
2562 const uint32_t addr_byte_size = GetAddressByteSize();
2563 if (addr_byte_size <= 4)
2564 scalar = (uint32_t)ptr_value;
Greg Clayton58a4c462010-12-16 20:01:20 +00002565 else
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002566 scalar = ptr_value;
2567 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
Greg Clayton58a4c462010-12-16 20:01:20 +00002568}
2569
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002570size_t
2571Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2572{
2573 size_t bytes_written = 0;
2574 const uint8_t *bytes = (const uint8_t *)buf;
2575
2576 while (bytes_written < size)
2577 {
2578 const size_t curr_size = size - bytes_written;
2579 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2580 bytes + bytes_written,
2581 curr_size,
2582 error);
2583 bytes_written += curr_bytes_written;
2584 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2585 break;
2586 }
2587 return bytes_written;
2588}
2589
2590size_t
2591Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2592{
Greg Clayton58be07b2011-01-07 06:08:19 +00002593#if defined (ENABLE_MEMORY_CACHING)
2594 m_memory_cache.Flush (addr, size);
2595#endif
2596
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002597 if (buf == NULL || size == 0)
2598 return 0;
Jim Ingham78a685a2011-04-16 00:01:13 +00002599
Jim Ingham4b536182011-08-09 02:12:22 +00002600 m_mod_id.BumpMemoryID();
Jim Ingham78a685a2011-04-16 00:01:13 +00002601
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002602 // We need to write any data that would go where any current software traps
2603 // (enabled software breakpoints) any software traps (breakpoints) that we
2604 // may have placed in our tasks memory.
2605
Greg Claytond8cf1a12013-06-12 00:46:38 +00002606 BreakpointSiteList bp_sites_in_range;
2607
2608 if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002609 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002610 // No breakpoint sites overlap
2611 if (bp_sites_in_range.IsEmpty())
2612 return WriteMemoryPrivate (addr, buf, size, error);
2613 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002614 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002615 const uint8_t *ubuf = (const uint8_t *)buf;
2616 uint64_t bytes_written = 0;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002617
Greg Claytond8cf1a12013-06-12 00:46:38 +00002618 bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void {
2619
2620 if (error.Success())
2621 {
2622 addr_t intersect_addr;
2623 size_t intersect_size;
2624 size_t opcode_offset;
2625 const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset);
Bruce Mitchener8a67bf72015-07-24 00:23:29 +00002626 UNUSED_IF_ASSERT_DISABLED(intersects);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002627 assert(intersects);
2628 assert(addr <= intersect_addr && intersect_addr < addr + size);
2629 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2630 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2631
2632 // Check for bytes before this breakpoint
2633 const addr_t curr_addr = addr + bytes_written;
2634 if (intersect_addr > curr_addr)
2635 {
2636 // There are some bytes before this breakpoint that we need to
2637 // just write to memory
2638 size_t curr_size = intersect_addr - curr_addr;
2639 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2640 ubuf + bytes_written,
2641 curr_size,
2642 error);
2643 bytes_written += curr_bytes_written;
2644 if (curr_bytes_written != curr_size)
2645 {
2646 // We weren't able to write all of the requested bytes, we
2647 // are done looping and will return the number of bytes that
2648 // we have written so far.
2649 if (error.Success())
2650 error.SetErrorToGenericError();
2651 }
2652 }
2653 // Now write any bytes that would cover up any software breakpoints
2654 // directly into the breakpoint opcode buffer
2655 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2656 bytes_written += intersect_size;
2657 }
2658 });
2659
2660 if (bytes_written < size)
Jason Molenda8b5f2cf2014-10-16 07:49:27 +00002661 WriteMemoryPrivate (addr + bytes_written,
2662 ubuf + bytes_written,
2663 size - bytes_written,
2664 error);
Greg Claytond8cf1a12013-06-12 00:46:38 +00002665 }
2666 }
2667 else
2668 {
2669 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002670 }
2671
2672 // Write any remaining bytes after the last breakpoint if we have any left
Greg Claytond8cf1a12013-06-12 00:46:38 +00002673 return 0; //bytes_written;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002674}
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002675
2676size_t
Greg Claytonc7bece562013-01-25 18:06:21 +00002677Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002678{
2679 if (byte_size == UINT32_MAX)
2680 byte_size = scalar.GetByteSize();
2681 if (byte_size > 0)
2682 {
2683 uint8_t buf[32];
2684 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2685 if (mem_size > 0)
2686 return WriteMemory(addr, buf, mem_size, error);
2687 else
2688 error.SetErrorString ("failed to get scalar as memory data");
2689 }
2690 else
2691 {
2692 error.SetErrorString ("invalid scalar value");
2693 }
2694 return 0;
2695}
2696
2697size_t
2698Process::ReadScalarIntegerFromMemory (addr_t addr,
2699 uint32_t byte_size,
2700 bool is_signed,
2701 Scalar &scalar,
2702 Error &error)
2703{
Greg Clayton7060f892013-05-01 23:41:30 +00002704 uint64_t uval = 0;
2705 if (byte_size == 0)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002706 {
Greg Clayton7060f892013-05-01 23:41:30 +00002707 error.SetErrorString ("byte size is zero");
2708 }
2709 else if (byte_size & (byte_size - 1))
2710 {
2711 error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size);
2712 }
2713 else if (byte_size <= sizeof(uval))
2714 {
2715 const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002716 if (bytes_read == byte_size)
2717 {
2718 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
Greg Claytonc7bece562013-01-25 18:06:21 +00002719 lldb::offset_t offset = 0;
Greg Clayton7060f892013-05-01 23:41:30 +00002720 if (byte_size <= 4)
2721 scalar = data.GetMaxU32 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002722 else
Greg Clayton7060f892013-05-01 23:41:30 +00002723 scalar = data.GetMaxU64 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002724 if (is_signed)
2725 scalar.SignExtend(byte_size * 8);
2726 return bytes_read;
2727 }
2728 }
2729 else
2730 {
2731 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2732 }
2733 return 0;
2734}
2735
Greg Claytond495c532011-05-17 03:37:42 +00002736#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002737addr_t
2738Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2739{
Jim Inghamf72ce3a2011-06-20 17:32:44 +00002740 if (GetPrivateState() != eStateStopped)
2741 return LLDB_INVALID_ADDRESS;
2742
Greg Claytond495c532011-05-17 03:37:42 +00002743#if defined (USE_ALLOCATE_MEMORY_CACHE)
2744 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2745#else
Greg Claytonb2daec92011-01-23 19:58:49 +00002746 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
Greg Clayton5160ce52013-03-27 23:08:40 +00002747 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002748 if (log)
Greg Clayton45989072013-10-23 18:24:30 +00002749 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 +00002750 (uint64_t)size,
Greg Claytond495c532011-05-17 03:37:42 +00002751 GetPermissionsAsCString (permissions),
Greg Claytonb2daec92011-01-23 19:58:49 +00002752 (uint64_t)allocated_addr,
Jim Ingham4b536182011-08-09 02:12:22 +00002753 m_mod_id.GetStopID(),
2754 m_mod_id.GetMemoryID());
Greg Claytonb2daec92011-01-23 19:58:49 +00002755 return allocated_addr;
Greg Claytond495c532011-05-17 03:37:42 +00002756#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002757}
2758
Jim Ingham2c381412015-11-04 20:32:27 +00002759addr_t
2760Process::CallocateMemory(size_t size, uint32_t permissions, Error &error)
2761{
2762 addr_t return_addr = AllocateMemory(size, permissions, error);
2763 if (error.Success())
2764 {
2765 std::string buffer(size, 0);
2766 WriteMemory(return_addr, buffer.c_str(), size, error);
2767 }
2768 return return_addr;
2769}
2770
Sean Callanan90539452011-09-20 23:01:51 +00002771bool
2772Process::CanJIT ()
2773{
Sean Callanana7b443a2012-02-14 22:50:38 +00002774 if (m_can_jit == eCanJITDontKnow)
2775 {
Todd Fialaaf245d12014-06-30 21:05:18 +00002776 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Sean Callanana7b443a2012-02-14 22:50:38 +00002777 Error err;
2778
2779 uint64_t allocated_memory = AllocateMemory(8,
2780 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2781 err);
2782
2783 if (err.Success())
Todd Fialaaf245d12014-06-30 21:05:18 +00002784 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002785 m_can_jit = eCanJITYes;
Todd Fialaaf245d12014-06-30 21:05:18 +00002786 if (log)
2787 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ());
2788 }
Sean Callanana7b443a2012-02-14 22:50:38 +00002789 else
Todd Fialaaf245d12014-06-30 21:05:18 +00002790 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002791 m_can_jit = eCanJITNo;
Todd Fialaaf245d12014-06-30 21:05:18 +00002792 if (log)
2793 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ());
2794 }
Sean Callanana7b443a2012-02-14 22:50:38 +00002795
2796 DeallocateMemory (allocated_memory);
2797 }
2798
Sean Callanan90539452011-09-20 23:01:51 +00002799 return m_can_jit == eCanJITYes;
2800}
2801
2802void
2803Process::SetCanJIT (bool can_jit)
2804{
2805 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2806}
2807
Ewan Crawford90ff7912015-07-14 10:56:58 +00002808void
2809Process::SetCanRunCode (bool can_run_code)
2810{
2811 SetCanJIT(can_run_code);
2812 m_can_interpret_function_calls = can_run_code;
2813}
2814
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002815Error
2816Process::DeallocateMemory (addr_t ptr)
2817{
Greg Claytond495c532011-05-17 03:37:42 +00002818 Error error;
2819#if defined (USE_ALLOCATE_MEMORY_CACHE)
2820 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2821 {
Daniel Malead01b2952012-11-29 21:49:15 +00002822 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
Greg Claytond495c532011-05-17 03:37:42 +00002823 }
2824#else
2825 error = DoDeallocateMemory (ptr);
Greg Claytonb2daec92011-01-23 19:58:49 +00002826
Greg Clayton5160ce52013-03-27 23:08:40 +00002827 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002828 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002829 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 +00002830 ptr,
2831 error.AsCString("SUCCESS"),
Jim Ingham4b536182011-08-09 02:12:22 +00002832 m_mod_id.GetStopID(),
2833 m_mod_id.GetMemoryID());
Greg Claytond495c532011-05-17 03:37:42 +00002834#endif
Greg Claytonb2daec92011-01-23 19:58:49 +00002835 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002836}
2837
Greg Claytonc9660542012-02-05 02:38:54 +00002838ModuleSP
Greg Claytonc859e2d2012-02-13 23:10:39 +00002839Process::ReadModuleFromMemory (const FileSpec& file_spec,
Andrew MacPherson17220c12014-03-05 10:12:43 +00002840 lldb::addr_t header_addr,
2841 size_t size_to_read)
Greg Claytonc9660542012-02-05 02:38:54 +00002842{
Jason Molenda08a32582015-07-25 02:39:42 +00002843 Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
2844 if (log)
2845 {
2846 log->Printf ("Process::ReadModuleFromMemory reading %s binary from memory", file_spec.GetPath().c_str());
2847 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002848 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
Greg Claytonc9660542012-02-05 02:38:54 +00002849 if (module_sp)
2850 {
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002851 Error error;
Andrew MacPherson17220c12014-03-05 10:12:43 +00002852 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read);
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002853 if (objfile)
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002854 return module_sp;
Greg Claytonc9660542012-02-05 02:38:54 +00002855 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002856 return ModuleSP();
Greg Claytonc9660542012-02-05 02:38:54 +00002857}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002858
Zachary Turner93749ab2015-03-03 21:51:25 +00002859bool
2860Process::GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions)
2861{
2862 MemoryRegionInfo range_info;
2863 permissions = 0;
2864 Error error (GetMemoryRegionInfo (load_addr, range_info));
2865 if (!error.Success())
2866 return false;
2867 if (range_info.GetReadable() == MemoryRegionInfo::eDontKnow
2868 || range_info.GetWritable() == MemoryRegionInfo::eDontKnow
2869 || range_info.GetExecutable() == MemoryRegionInfo::eDontKnow)
2870 {
2871 return false;
2872 }
2873
2874 if (range_info.GetReadable() == MemoryRegionInfo::eYes)
2875 permissions |= lldb::ePermissionsReadable;
2876
2877 if (range_info.GetWritable() == MemoryRegionInfo::eYes)
2878 permissions |= lldb::ePermissionsWritable;
2879
2880 if (range_info.GetExecutable() == MemoryRegionInfo::eYes)
2881 permissions |= lldb::ePermissionsExecutable;
2882
2883 return true;
2884}
2885
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002886Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00002887Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002888{
2889 Error error;
2890 error.SetErrorString("watchpoints are not supported");
2891 return error;
2892}
2893
2894Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00002895Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002896{
2897 Error error;
2898 error.SetErrorString("watchpoints are not supported");
2899 return error;
2900}
2901
2902StateType
2903Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2904{
2905 StateType state;
2906 // Now wait for the process to launch and return control to us, and then
2907 // call DidLaunch:
2908 while (1)
2909 {
Greg Clayton6779606a2011-01-22 23:43:18 +00002910 event_sp.reset();
2911 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2912
Greg Clayton2637f822011-11-17 01:23:07 +00002913 if (StateIsStoppedState(state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002914 break;
Greg Clayton6779606a2011-01-22 23:43:18 +00002915
2916 // If state is invalid, then we timed out
2917 if (state == eStateInvalid)
2918 break;
2919
2920 if (event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002921 HandlePrivateEvent (event_sp);
2922 }
2923 return state;
2924}
2925
Greg Clayton332e8b12015-01-13 21:13:08 +00002926void
2927Process::LoadOperatingSystemPlugin(bool flush)
2928{
2929 if (flush)
2930 m_thread_list.Clear();
2931 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2932 if (flush)
2933 Flush();
2934}
2935
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002936Error
Greg Claytonfbb76342013-11-20 21:07:01 +00002937Process::Launch (ProcessLaunchInfo &launch_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002938{
2939 Error error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002940 m_abi_sp.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00002941 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00002942 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00002943 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00002944 m_os_ap.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00002945 m_process_input_reader.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +00002946 m_stop_info_override_callback = NULL;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002947
Zachary Turner7529df92015-09-01 20:02:29 +00002948 Module *exe_module = GetTarget().GetExecutableModulePointer();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002949 if (exe_module)
2950 {
Greg Clayton2289fa42011-04-30 01:09:13 +00002951 char local_exec_file_path[PATH_MAX];
2952 char platform_exec_file_path[PATH_MAX];
2953 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2954 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002955 if (exe_module->GetFileSpec().Exists())
2956 {
Greg Claytonfbb76342013-11-20 21:07:01 +00002957 // Install anything that might need to be installed prior to launching.
2958 // For host systems, this will do nothing, but if we are connected to a
2959 // remote platform it will install any needed binaries
2960 error = GetTarget().Install(&launch_info);
2961 if (error.Fail())
2962 return error;
2963
Greg Clayton71337622011-02-24 22:24:29 +00002964 if (PrivateStateThreadIsValid ())
2965 PausePrivateStateThread ();
2966
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002967 error = WillLaunch (exe_module);
2968 if (error.Success())
2969 {
Jim Ingham221d51c2013-05-08 00:35:16 +00002970 const bool restarted = false;
2971 SetPublicState (eStateLaunching, restarted);
Greg Claytone24c4ac2011-11-17 04:46:02 +00002972 m_should_detach = false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002973
Ed Maste64fad602013-07-29 20:58:06 +00002974 if (m_public_run_lock.TrySetRunning())
Greg Clayton69fd4be2012-09-04 20:29:05 +00002975 {
2976 // Now launch using these arguments.
2977 error = DoLaunch (exe_module, launch_info);
2978 }
2979 else
2980 {
2981 // This shouldn't happen
2982 error.SetErrorString("failed to acquire process run lock");
2983 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002984
2985 if (error.Fail())
2986 {
2987 if (GetID() != LLDB_INVALID_PROCESS_ID)
2988 {
2989 SetID (LLDB_INVALID_PROCESS_ID);
2990 const char *error_string = error.AsCString();
2991 if (error_string == NULL)
2992 error_string = "launch failed";
2993 SetExitStatus (-1, error_string);
2994 }
2995 }
2996 else
2997 {
2998 EventSP event_sp;
Greg Clayton1a38ea72011-06-22 01:42:17 +00002999 TimeValue timeout_time;
3000 timeout_time = TimeValue::Now();
3001 timeout_time.OffsetWithSeconds(10);
3002 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003003
Greg Clayton1a38ea72011-06-22 01:42:17 +00003004 if (state == eStateInvalid || event_sp.get() == NULL)
3005 {
3006 // We were able to launch the process, but we failed to
3007 // catch the initial stop.
Tamas Berghammer04e63142015-02-23 10:59:54 +00003008 error.SetErrorString ("failed to catch stop after launch");
Greg Clayton1a38ea72011-06-22 01:42:17 +00003009 SetExitStatus (0, "failed to catch stop after launch");
Jason Molendaede31932015-04-17 05:01:58 +00003010 Destroy(false);
Greg Clayton1a38ea72011-06-22 01:42:17 +00003011 }
3012 else if (state == eStateStopped || state == eStateCrashed)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003013 {
3014 DidLaunch ();
3015
Greg Claytonc859e2d2012-02-13 23:10:39 +00003016 DynamicLoader *dyld = GetDynamicLoader ();
3017 if (dyld)
3018 dyld->DidLaunch();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003019
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003020 GetJITLoaders().DidLaunch();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003021
Jason Molendaeef51062013-11-05 03:57:19 +00003022 SystemRuntime *system_runtime = GetSystemRuntime ();
3023 if (system_runtime)
3024 system_runtime->DidLaunch();
3025
Greg Clayton332e8b12015-01-13 21:13:08 +00003026 LoadOperatingSystemPlugin(false);
Todd Fialaf72fa672014-10-07 16:05:21 +00003027
3028 // Note, the stop event was consumed above, but not handled. This was done
3029 // to give DidLaunch a chance to run. The target is either stopped or crashed.
3030 // Directly set the state. This is done to prevent a stop message with a bunch
3031 // of spurious output on thread status, as well as not pop a ProcessIOHandler.
3032 SetPublicState(state, false);
Greg Clayton71337622011-02-24 22:24:29 +00003033
3034 if (PrivateStateThreadIsValid ())
3035 ResumePrivateStateThread ();
3036 else
3037 StartPrivateStateThread ();
Greg Claytona97c4d22014-12-09 23:31:02 +00003038
3039 m_stop_info_override_callback = GetTarget().GetArchitecture().GetStopInfoOverrideCallback();
Ilia K6af632f2015-02-06 18:15:05 +00003040
3041 // Target was stopped at entry as was intended. Need to notify the listeners
3042 // about it.
Ilia K333fc182015-02-11 11:24:20 +00003043 if (state == eStateStopped && launch_info.GetFlags().Test(eLaunchFlagStopAtEntry))
Ilia K6af632f2015-02-06 18:15:05 +00003044 HandlePrivateEvent(event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003045 }
3046 else if (state == eStateExited)
3047 {
3048 // We exited while trying to launch somehow. Don't call DidLaunch as that's
3049 // not likely to work, and return an invalid pid.
3050 HandlePrivateEvent (event_sp);
3051 }
3052 }
3053 }
3054 }
3055 else
3056 {
Greg Clayton86edbf42011-10-26 00:56:27 +00003057 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003058 }
3059 }
3060 return error;
3061}
3062
Greg Claytonc3776bf2012-02-09 06:16:32 +00003063Error
3064Process::LoadCore ()
3065{
3066 Error error = DoLoadCore();
3067 if (error.Success())
3068 {
Greg Clayton35824e32015-02-20 20:59:47 +00003069 Listener listener ("lldb.process.load_core_listener");
Greg Clayton338d0bd2015-02-20 21:51:06 +00003070 HijackProcessEvents(&listener);
Greg Clayton35824e32015-02-20 20:59:47 +00003071
Greg Claytonc3776bf2012-02-09 06:16:32 +00003072 if (PrivateStateThreadIsValid ())
3073 ResumePrivateStateThread ();
3074 else
3075 StartPrivateStateThread ();
3076
Greg Claytonc859e2d2012-02-13 23:10:39 +00003077 DynamicLoader *dyld = GetDynamicLoader ();
3078 if (dyld)
3079 dyld->DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003080
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003081 GetJITLoaders().DidAttach();
Greg Claytonc859e2d2012-02-13 23:10:39 +00003082
Jason Molendaeef51062013-11-05 03:57:19 +00003083 SystemRuntime *system_runtime = GetSystemRuntime ();
3084 if (system_runtime)
3085 system_runtime->DidAttach();
3086
Greg Claytonc859e2d2012-02-13 23:10:39 +00003087 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Claytonc3776bf2012-02-09 06:16:32 +00003088 // We successfully loaded a core file, now pretend we stopped so we can
3089 // show all of the threads in the core file and explore the crashed
3090 // state.
3091 SetPrivateState (eStateStopped);
Greg Clayton35824e32015-02-20 20:59:47 +00003092
3093 // Wait indefinitely for a stopped event since we just posted one above...
3094 lldb::EventSP event_sp;
3095 listener.WaitForEvent (NULL, event_sp);
3096 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3097
3098 if (!StateIsStoppedState (state, false))
3099 {
3100 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3101 if (log)
3102 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3103 error.SetErrorString ("Did not get stopped event after loading the core file.");
3104 }
Greg Clayton338d0bd2015-02-20 21:51:06 +00003105 RestoreProcessEvents ();
Greg Claytonc3776bf2012-02-09 06:16:32 +00003106 }
3107 return error;
3108}
3109
Greg Claytonc859e2d2012-02-13 23:10:39 +00003110DynamicLoader *
3111Process::GetDynamicLoader ()
3112{
3113 if (m_dyld_ap.get() == NULL)
3114 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
3115 return m_dyld_ap.get();
3116}
Greg Claytonc3776bf2012-02-09 06:16:32 +00003117
Todd Fialaaf245d12014-06-30 21:05:18 +00003118const lldb::DataBufferSP
3119Process::GetAuxvData()
3120{
3121 return DataBufferSP ();
3122}
3123
Andrew MacPherson17220c12014-03-05 10:12:43 +00003124JITLoaderList &
3125Process::GetJITLoaders ()
3126{
3127 if (!m_jit_loaders_ap)
3128 {
3129 m_jit_loaders_ap.reset(new JITLoaderList());
3130 JITLoader::LoadPlugins(this, *m_jit_loaders_ap);
3131 }
3132 return *m_jit_loaders_ap;
3133}
3134
Jason Molendaeef51062013-11-05 03:57:19 +00003135SystemRuntime *
3136Process::GetSystemRuntime ()
3137{
3138 if (m_system_runtime_ap.get() == NULL)
3139 m_system_runtime_ap.reset (SystemRuntime::FindPlugin(this));
3140 return m_system_runtime_ap.get();
3141}
3142
Todd Fiala76e0fc92014-08-27 22:58:26 +00003143Process::AttachCompletionHandler::AttachCompletionHandler (Process *process, uint32_t exec_count) :
3144 NextEventAction (process),
3145 m_exec_count (exec_count)
3146{
3147 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3148 if (log)
3149 log->Printf ("Process::AttachCompletionHandler::%s process=%p, exec_count=%" PRIu32, __FUNCTION__, static_cast<void*>(process), exec_count);
3150}
Greg Claytonc3776bf2012-02-09 06:16:32 +00003151
Jim Inghambb3a2832011-01-29 01:49:25 +00003152Process::NextEventAction::EventActionResult
3153Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003154{
Todd Fiala76e0fc92014-08-27 22:58:26 +00003155 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3156
Jim Inghambb3a2832011-01-29 01:49:25 +00003157 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
Todd Fiala76e0fc92014-08-27 22:58:26 +00003158 if (log)
3159 log->Printf ("Process::AttachCompletionHandler::%s called with state %s (%d)", __FUNCTION__, StateAsCString(state), static_cast<int> (state));
3160
3161 switch (state)
Greg Clayton19388cf2010-10-18 01:45:30 +00003162 {
Zachary Turnerc62733b2015-05-20 18:31:17 +00003163 case eStateAttaching:
3164 return eEventActionSuccess;
3165
Greg Clayton513c26c2011-01-29 07:10:55 +00003166 case eStateRunning:
Greg Clayton71337622011-02-24 22:24:29 +00003167 case eStateConnected:
Greg Clayton513c26c2011-01-29 07:10:55 +00003168 return eEventActionRetry;
3169
3170 case eStateStopped:
3171 case eStateCrashed:
Greg Claytonc9ed4782011-11-12 02:10:56 +00003172 {
3173 // During attach, prior to sending the eStateStopped event,
Jim Inghamb1e2e842012-04-12 18:49:31 +00003174 // lldb_private::Process subclasses must set the new process ID.
Greg Claytonc9ed4782011-11-12 02:10:56 +00003175 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
Jim Ingham221d51c2013-05-08 00:35:16 +00003176 // We don't want these events to be reported, so go set the ShouldReportStop here:
3177 m_process->GetThreadList().SetShouldReportStop (eVoteNo);
3178
Greg Claytonc9ed4782011-11-12 02:10:56 +00003179 if (m_exec_count > 0)
3180 {
3181 --m_exec_count;
Todd Fiala76e0fc92014-08-27 22:58:26 +00003182
3183 if (log)
3184 log->Printf ("Process::AttachCompletionHandler::%s state %s: reduced remaining exec count to %" PRIu32 ", requesting resume", __FUNCTION__, StateAsCString(state), m_exec_count);
3185
Jim Ingham221d51c2013-05-08 00:35:16 +00003186 RequestResume();
Greg Claytonc9ed4782011-11-12 02:10:56 +00003187 return eEventActionRetry;
3188 }
3189 else
3190 {
Todd Fiala76e0fc92014-08-27 22:58:26 +00003191 if (log)
3192 log->Printf ("Process::AttachCompletionHandler::%s state %s: no more execs expected to start, continuing with attach", __FUNCTION__, StateAsCString(state));
3193
Greg Claytonc9ed4782011-11-12 02:10:56 +00003194 m_process->CompleteAttach ();
3195 return eEventActionSuccess;
3196 }
3197 }
Greg Clayton513c26c2011-01-29 07:10:55 +00003198 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00003199
Greg Clayton513c26c2011-01-29 07:10:55 +00003200 default:
3201 case eStateExited:
3202 case eStateInvalid:
Greg Clayton513c26c2011-01-29 07:10:55 +00003203 break;
Jim Inghambb3a2832011-01-29 01:49:25 +00003204 }
Greg Claytonc9ed4782011-11-12 02:10:56 +00003205
3206 m_exit_string.assign ("No valid Process");
3207 return eEventActionExit;
Jim Inghambb3a2832011-01-29 01:49:25 +00003208}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003209
Jim Inghambb3a2832011-01-29 01:49:25 +00003210Process::NextEventAction::EventActionResult
3211Process::AttachCompletionHandler::HandleBeingInterrupted()
3212{
3213 return eEventActionSuccess;
3214}
3215
3216const char *
3217Process::AttachCompletionHandler::GetExitString ()
3218{
3219 return m_exit_string.c_str();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003220}
3221
Greg Clayton8012cad2014-11-17 19:39:20 +00003222Listener &
3223ProcessAttachInfo::GetListenerForProcess (Debugger &debugger)
3224{
3225 if (m_listener_sp)
3226 return *m_listener_sp;
3227 else
3228 return debugger.GetListener();
3229}
3230
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003231Error
Greg Clayton144f3a92011-11-15 03:53:30 +00003232Process::Attach (ProcessAttachInfo &attach_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003233{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003234 m_abi_sp.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003235 m_process_input_reader.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003236 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003237 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00003238 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003239 m_os_ap.reset();
Greg Claytona97c4d22014-12-09 23:31:02 +00003240 m_stop_info_override_callback = NULL;
Jim Ingham5aee1622010-08-09 23:31:02 +00003241
Greg Clayton144f3a92011-11-15 03:53:30 +00003242 lldb::pid_t attach_pid = attach_info.GetProcessID();
Greg Claytone996fd32011-03-08 22:40:15 +00003243 Error error;
Greg Clayton144f3a92011-11-15 03:53:30 +00003244 if (attach_pid == LLDB_INVALID_PROCESS_ID)
Jim Ingham5aee1622010-08-09 23:31:02 +00003245 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003246 char process_name[PATH_MAX];
Jim Ingham4299fdb2011-09-15 01:10:17 +00003247
Greg Clayton144f3a92011-11-15 03:53:30 +00003248 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
Jim Ingham2ecb7422010-08-17 21:54:19 +00003249 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003250 const bool wait_for_launch = attach_info.GetWaitForLaunch();
3251
3252 if (wait_for_launch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003253 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003254 error = WillAttachToProcessWithName(process_name, wait_for_launch);
3255 if (error.Success())
3256 {
Ed Maste64fad602013-07-29 20:58:06 +00003257 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00003258 {
3259 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00003260 const bool restarted = false;
3261 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00003262 // Now attach using these arguments.
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00003263 error = DoAttachToProcessWithName (process_name, attach_info);
Greg Clayton926cce72012-10-12 16:10:12 +00003264 }
3265 else
3266 {
3267 // This shouldn't happen
3268 error.SetErrorString("failed to acquire process run lock");
3269 }
Greg Claytone24c4ac2011-11-17 04:46:02 +00003270
Greg Clayton144f3a92011-11-15 03:53:30 +00003271 if (error.Fail())
3272 {
3273 if (GetID() != LLDB_INVALID_PROCESS_ID)
3274 {
3275 SetID (LLDB_INVALID_PROCESS_ID);
3276 if (error.AsCString() == NULL)
3277 error.SetErrorString("attach failed");
3278
3279 SetExitStatus(-1, error.AsCString());
3280 }
3281 }
3282 else
3283 {
3284 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3285 StartPrivateStateThread();
3286 }
3287 return error;
3288 }
Greg Claytone996fd32011-03-08 22:40:15 +00003289 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003290 else
Greg Claytone996fd32011-03-08 22:40:15 +00003291 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003292 ProcessInstanceInfoList process_infos;
Zachary Turner7529df92015-09-01 20:02:29 +00003293 PlatformSP platform_sp (GetTarget().GetPlatform ());
Greg Clayton144f3a92011-11-15 03:53:30 +00003294
3295 if (platform_sp)
3296 {
3297 ProcessInstanceInfoMatch match_info;
3298 match_info.GetProcessInfo() = attach_info;
3299 match_info.SetNameMatchType (eNameMatchEquals);
3300 platform_sp->FindProcesses (match_info, process_infos);
3301 const uint32_t num_matches = process_infos.GetSize();
3302 if (num_matches == 1)
3303 {
3304 attach_pid = process_infos.GetProcessIDAtIndex(0);
3305 // Fall through and attach using the above process ID
3306 }
3307 else
3308 {
3309 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
3310 if (num_matches > 1)
Jim Ingham368ac222014-08-15 17:05:27 +00003311 {
3312 StreamString s;
3313 ProcessInstanceInfo::DumpTableHeader (s, platform_sp.get(), true, false);
3314 for (size_t i = 0; i < num_matches; i++)
3315 {
3316 process_infos.GetProcessInfoAtIndex(i).DumpAsTableRow(s, platform_sp.get(), true, false);
3317 }
3318 error.SetErrorStringWithFormat ("more than one process named %s:\n%s",
3319 process_name,
3320 s.GetData());
3321 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003322 else
3323 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
3324 }
3325 }
3326 else
3327 {
3328 error.SetErrorString ("invalid platform, can't find processes by name");
3329 return error;
3330 }
Greg Claytone996fd32011-03-08 22:40:15 +00003331 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003332 }
3333 else
Greg Clayton144f3a92011-11-15 03:53:30 +00003334 {
3335 error.SetErrorString ("invalid process name");
Greg Claytone996fd32011-03-08 22:40:15 +00003336 }
3337 }
Greg Clayton144f3a92011-11-15 03:53:30 +00003338
3339 if (attach_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00003340 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003341 error = WillAttachToProcessWithID(attach_pid);
Greg Claytone996fd32011-03-08 22:40:15 +00003342 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003343 {
Greg Clayton144f3a92011-11-15 03:53:30 +00003344
Ed Maste64fad602013-07-29 20:58:06 +00003345 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00003346 {
3347 // Now attach using these arguments.
3348 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00003349 const bool restarted = false;
3350 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00003351 error = DoAttachToProcessWithID (attach_pid, attach_info);
3352 }
3353 else
3354 {
3355 // This shouldn't happen
3356 error.SetErrorString("failed to acquire process run lock");
3357 }
3358
Greg Clayton144f3a92011-11-15 03:53:30 +00003359 if (error.Success())
3360 {
3361
3362 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3363 StartPrivateStateThread();
3364 }
3365 else
Greg Claytone996fd32011-03-08 22:40:15 +00003366 {
3367 if (GetID() != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00003368 SetID (LLDB_INVALID_PROCESS_ID);
Greg Claytone996fd32011-03-08 22:40:15 +00003369
Oleksiy Vyalov5d064742014-11-19 18:27:45 +00003370 const char *error_string = error.AsCString();
3371 if (error_string == NULL)
3372 error_string = "attach failed";
3373
3374 SetExitStatus(-1, error_string);
Greg Claytone996fd32011-03-08 22:40:15 +00003375 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003376 }
3377 }
3378 return error;
3379}
3380
Greg Clayton93d3c8332011-02-16 04:46:07 +00003381void
3382Process::CompleteAttach ()
3383{
Todd Fiala76e0fc92014-08-27 22:58:26 +00003384 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3385 if (log)
3386 log->Printf ("Process::%s()", __FUNCTION__);
3387
Greg Clayton93d3c8332011-02-16 04:46:07 +00003388 // Let the process subclass figure out at much as it can about the process
3389 // before we go looking for a dynamic loader plug-in.
Jim Inghambb006ce2014-08-02 00:33:35 +00003390 ArchSpec process_arch;
3391 DidAttach(process_arch);
3392
3393 if (process_arch.IsValid())
Todd Fiala76e0fc92014-08-27 22:58:26 +00003394 {
Zachary Turner7529df92015-09-01 20:02:29 +00003395 GetTarget().SetArchitecture(process_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003396 if (log)
3397 {
3398 const char *triple_str = process_arch.GetTriple().getTriple().c_str ();
3399 log->Printf ("Process::%s replacing process architecture with DidAttach() architecture: %s",
3400 __FUNCTION__,
3401 triple_str ? triple_str : "<null>");
3402 }
3403 }
Greg Clayton93d3c8332011-02-16 04:46:07 +00003404
Jim Ingham4299fdb2011-09-15 01:10:17 +00003405 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
3406 // the same as the one we've already set, switch architectures.
Zachary Turner7529df92015-09-01 20:02:29 +00003407 PlatformSP platform_sp (GetTarget().GetPlatform ());
Jim Ingham4299fdb2011-09-15 01:10:17 +00003408 assert (platform_sp.get());
3409 if (platform_sp)
3410 {
Zachary Turner7529df92015-09-01 20:02:29 +00003411 const ArchSpec &target_arch = GetTarget().GetArchitecture();
Greg Clayton1e0c8842013-01-11 20:49:54 +00003412 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
Greg Clayton70512312012-05-08 01:45:38 +00003413 {
3414 ArchSpec platform_arch;
3415 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3416 if (platform_sp)
3417 {
Zachary Turner7529df92015-09-01 20:02:29 +00003418 GetTarget().SetPlatform (platform_sp);
3419 GetTarget().SetArchitecture(platform_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003420 if (log)
3421 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 +00003422 }
3423 }
Jim Inghambb006ce2014-08-02 00:33:35 +00003424 else if (!process_arch.IsValid())
Greg Clayton70512312012-05-08 01:45:38 +00003425 {
3426 ProcessInstanceInfo process_info;
3427 platform_sp->GetProcessInfo (GetID(), process_info);
3428 const ArchSpec &process_arch = process_info.GetArchitecture();
Zachary Turner7529df92015-09-01 20:02:29 +00003429 if (process_arch.IsValid() && !GetTarget().GetArchitecture().IsExactMatch(process_arch))
Todd Fiala76e0fc92014-08-27 22:58:26 +00003430 {
Zachary Turner7529df92015-09-01 20:02:29 +00003431 GetTarget().SetArchitecture (process_arch);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003432 if (log)
3433 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 ());
3434 }
Greg Clayton70512312012-05-08 01:45:38 +00003435 }
Jim Ingham4299fdb2011-09-15 01:10:17 +00003436 }
3437
3438 // We have completed the attach, now it is time to find the dynamic loader
Greg Clayton93d3c8332011-02-16 04:46:07 +00003439 // plug-in
Greg Claytonc859e2d2012-02-13 23:10:39 +00003440 DynamicLoader *dyld = GetDynamicLoader ();
3441 if (dyld)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003442 {
Greg Claytonc859e2d2012-02-13 23:10:39 +00003443 dyld->DidAttach();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003444 if (log)
3445 {
Zachary Turner7529df92015-09-01 20:02:29 +00003446 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003447 log->Printf ("Process::%s after DynamicLoader::DidAttach(), target executable is %s (using %s plugin)",
3448 __FUNCTION__,
3449 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3450 dyld->GetPluginName().AsCString ("<unnamed>"));
3451 }
3452 }
Greg Clayton93d3c8332011-02-16 04:46:07 +00003453
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003454 GetJITLoaders().DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003455
Jason Molendaeef51062013-11-05 03:57:19 +00003456 SystemRuntime *system_runtime = GetSystemRuntime ();
3457 if (system_runtime)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003458 {
Jason Molendaeef51062013-11-05 03:57:19 +00003459 system_runtime->DidAttach();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003460 if (log)
3461 {
Zachary Turner7529df92015-09-01 20:02:29 +00003462 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003463 log->Printf ("Process::%s after SystemRuntime::DidAttach(), target executable is %s (using %s plugin)",
3464 __FUNCTION__,
3465 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3466 system_runtime->GetPluginName().AsCString("<unnamed>"));
3467 }
3468 }
Jason Molendaeef51062013-11-05 03:57:19 +00003469
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003470 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton93d3c8332011-02-16 04:46:07 +00003471 // Figure out which one is the executable, and set that in our target:
Zachary Turner7529df92015-09-01 20:02:29 +00003472 const ModuleList &target_modules = GetTarget().GetImages();
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003473 Mutex::Locker modules_locker(target_modules.GetMutex());
3474 size_t num_modules = target_modules.GetSize();
3475 ModuleSP new_executable_module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003476
Andy Gibbsa297a972013-06-19 19:04:53 +00003477 for (size_t i = 0; i < num_modules; i++)
Greg Clayton93d3c8332011-02-16 04:46:07 +00003478 {
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003479 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
Greg Clayton8b82f082011-04-12 05:54:46 +00003480 if (module_sp && module_sp->IsExecutable())
Greg Clayton93d3c8332011-02-16 04:46:07 +00003481 {
Zachary Turner7529df92015-09-01 20:02:29 +00003482 if (GetTarget().GetExecutableModulePointer() != module_sp.get())
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003483 new_executable_module_sp = module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003484 break;
3485 }
3486 }
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003487 if (new_executable_module_sp)
Todd Fiala76e0fc92014-08-27 22:58:26 +00003488 {
Zachary Turner7529df92015-09-01 20:02:29 +00003489 GetTarget().SetExecutableModule (new_executable_module_sp, false);
Todd Fiala76e0fc92014-08-27 22:58:26 +00003490 if (log)
3491 {
Zachary Turner7529df92015-09-01 20:02:29 +00003492 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
Todd Fiala76e0fc92014-08-27 22:58:26 +00003493 log->Printf ("Process::%s after looping through modules, target executable is %s",
3494 __FUNCTION__,
3495 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>");
3496 }
3497 }
Greg Claytona97c4d22014-12-09 23:31:02 +00003498
3499 m_stop_info_override_callback = process_arch.GetStopInfoOverrideCallback();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003500}
3501
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003502Error
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003503Process::ConnectRemote (Stream *strm, const char *remote_url)
Greg Claytonb766a732011-02-04 01:58:07 +00003504{
Greg Claytonb766a732011-02-04 01:58:07 +00003505 m_abi_sp.reset();
3506 m_process_input_reader.reset();
3507
3508 // Find the process and its architecture. Make sure it matches the architecture
3509 // of the current Target, and if not adjust it.
3510
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003511 Error error (DoConnectRemote (strm, remote_url));
Greg Claytonb766a732011-02-04 01:58:07 +00003512 if (error.Success())
3513 {
Greg Clayton71337622011-02-24 22:24:29 +00003514 if (GetID() != LLDB_INVALID_PROCESS_ID)
3515 {
Greg Clayton32e0a752011-03-30 18:16:51 +00003516 EventSP event_sp;
3517 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3518
3519 if (state == eStateStopped || state == eStateCrashed)
3520 {
3521 // If we attached and actually have a process on the other end, then
3522 // this ended up being the equivalent of an attach.
3523 CompleteAttach ();
3524
3525 // This delays passing the stopped event to listeners till
3526 // CompleteAttach gets a chance to complete...
3527 HandlePrivateEvent (event_sp);
3528
3529 }
Greg Clayton71337622011-02-24 22:24:29 +00003530 }
Greg Clayton32e0a752011-03-30 18:16:51 +00003531
3532 if (PrivateStateThreadIsValid ())
3533 ResumePrivateStateThread ();
3534 else
3535 StartPrivateStateThread ();
Greg Claytonb766a732011-02-04 01:58:07 +00003536 }
3537 return error;
3538}
3539
Greg Claytonb766a732011-02-04 01:58:07 +00003540Error
Jim Ingham3b8285d2012-04-19 01:40:33 +00003541Process::PrivateResume ()
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003542{
Greg Clayton5160ce52013-03-27 23:08:40 +00003543 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003544 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003545 log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s",
Jim Ingham4b536182011-08-09 02:12:22 +00003546 m_mod_id.GetStopID(),
Jim Ingham444586b2011-01-24 06:34:17 +00003547 StateAsCString(m_public_state.GetValue()),
3548 StateAsCString(m_private_state.GetValue()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003549
3550 Error error (WillResume());
3551 // Tell the process it is about to resume before the thread list
3552 if (error.Success())
3553 {
Johnny Chenc4221e42010-12-02 20:53:05 +00003554 // Now let the thread list know we are about to resume so it
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003555 // can let all of our threads know that they are about to be
3556 // resumed. Threads will each be called with
3557 // Thread::WillResume(StateType) where StateType contains the state
3558 // that they are supposed to have when the process is resumed
3559 // (suspended/running/stepping). Threads should also check
3560 // their resume signal in lldb::Thread::GetResumeSignal()
Jim Ingham221d51c2013-05-08 00:35:16 +00003561 // to see if they are supposed to start back up with a signal.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003562 if (m_thread_list.WillResume())
3563 {
Jim Ingham372787f2012-04-07 00:00:41 +00003564 // Last thing, do the PreResumeActions.
3565 if (!RunPreResumeActions())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003566 {
Jim Ingham0161b492013-02-09 01:29:05 +00003567 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming.");
Jim Ingham372787f2012-04-07 00:00:41 +00003568 }
3569 else
3570 {
3571 m_mod_id.BumpResumeID();
3572 error = DoResume();
3573 if (error.Success())
3574 {
3575 DidResume();
3576 m_thread_list.DidResume();
3577 if (log)
3578 log->Printf ("Process thinks the process has resumed.");
3579 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003580 }
3581 }
3582 else
3583 {
Jim Inghamd5ac1ab2015-01-19 23:51:51 +00003584 // Somebody wanted to run without running (e.g. we were faking a step from one frame of a set of inlined
3585 // frames that share the same PC to another.) So generate a continue & a stopped event,
Jim Ingham513c6bb2012-09-01 01:02:41 +00003586 // and let the world handle them.
3587 if (log)
3588 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3589
3590 SetPrivateState(eStateRunning);
3591 SetPrivateState(eStateStopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003592 }
3593 }
Jim Ingham444586b2011-01-24 06:34:17 +00003594 else if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003595 log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003596 return error;
3597}
3598
3599Error
Pavel Labath19da1f12015-12-07 12:36:52 +00003600Process::Halt (bool clear_thread_plans, bool use_run_lock)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003601{
Pavel Labath19da1f12015-12-07 12:36:52 +00003602 if (! StateIsRunningState(m_public_state.GetValue()))
3603 return Error("Process is not running.");
3604
Greg Claytonf9b57b92013-05-10 23:48:10 +00003605 // Don't clear the m_clear_thread_plans_on_stop, only set it to true if
3606 // in case it was already set and some thread plan logic calls halt on its
3607 // own.
3608 m_clear_thread_plans_on_stop |= clear_thread_plans;
3609
Jim Ingham0f16e732011-02-08 05:20:59 +00003610 Listener halt_listener ("lldb.process.halt_listener");
Pavel Labath19da1f12015-12-07 12:36:52 +00003611 HijackProcessEvents(&halt_listener);
Greg Clayton3af9ea52010-11-18 05:57:03 +00003612
Jim Inghambb3a2832011-01-29 01:49:25 +00003613 EventSP event_sp;
Jim Inghambb3a2832011-01-29 01:49:25 +00003614
Pavel Labath19da1f12015-12-07 12:36:52 +00003615 SendAsyncInterrupt();
3616
3617 if (m_public_state.GetValue() == eStateAttaching)
Jim Inghambb3a2832011-01-29 01:49:25 +00003618 {
Pavel Labath19da1f12015-12-07 12:36:52 +00003619 // Don't hijack and eat the eStateExited as the code that was doing
3620 // the attach will be waiting for this event...
3621 RestoreProcessEvents();
3622 SetExitStatus(SIGKILL, "Cancelled async attach.");
3623 Destroy (false);
3624 return Error();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003625 }
Jim Inghambb3a2832011-01-29 01:49:25 +00003626
Pavel Labath19da1f12015-12-07 12:36:52 +00003627 // Wait for 10 second for the process to stop.
3628 TimeValue timeout_time;
3629 timeout_time = TimeValue::Now();
3630 timeout_time.OffsetWithSeconds(10);
3631 StateType state = WaitForProcessToStop(&timeout_time, &event_sp, true, &halt_listener,
3632 nullptr, use_run_lock);
3633 RestoreProcessEvents();
Jim Inghambb3a2832011-01-29 01:49:25 +00003634
Pavel Labath19da1f12015-12-07 12:36:52 +00003635 if (state == eStateInvalid || ! event_sp)
3636 {
3637 // We timed out and didn't get a stop event...
3638 return Error("Halt timed out. State = %s", StateAsCString(GetState()));
3639 }
3640
3641 BroadcastEvent(event_sp);
3642
3643 return Error();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003644}
3645
3646Error
Pavel Labathfcc7f662015-10-07 15:11:11 +00003647Process::StopForDestroyOrDetach(lldb::EventSP &exit_event_sp)
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003648{
3649 Error error;
3650 if (m_public_state.GetValue() == eStateRunning)
3651 {
3652 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3653 if (log)
Pavel Labathfcc7f662015-10-07 15:11:11 +00003654 log->Printf("Process::%s() About to stop.", __FUNCTION__);
3655
3656 ListenerSP listener_sp (new Listener("lldb.Process.StopForDestroyOrDetach.hijack"));
3657 HijackProcessEvents(listener_sp.get());
3658
3659 SendAsyncInterrupt();
3660
3661 // Consume the interrupt event.
3662 TimeValue timeout (TimeValue::Now());
3663 timeout.OffsetWithSeconds(10);
3664
3665 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp, true, listener_sp.get());
3666
3667 RestoreProcessEvents();
3668
3669 // If the process exited while we were waiting for it to stop, put the exited event into
3670 // the shared pointer passed in and return. Our caller doesn't need to do anything else, since
3671 // they don't have a process anymore...
3672
3673 if (state == eStateExited || m_private_state.GetValue() == eStateExited)
Pavel Labathc8c77d42015-09-28 09:37:51 +00003674 {
3675 if (log)
Pavel Labathfcc7f662015-10-07 15:11:11 +00003676 log->Printf("Process::%s() Process exited while waiting to stop.", __FUNCTION__);
3677 return error;
3678 }
3679 else
3680 exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3681
3682 if (state != eStateStopped)
3683 {
3684 if (log)
3685 log->Printf("Process::%s() failed to stop, state is: %s", __FUNCTION__, StateAsCString(state));
3686 // If we really couldn't stop the process then we should just error out here, but if the
3687 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3688 StateType private_state = m_private_state.GetValue();
3689 if (private_state != eStateStopped)
3690 {
3691 return error;
3692 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003693 }
3694 }
3695 return error;
3696}
3697
3698Error
Jim Inghamacff8952013-05-02 00:27:30 +00003699Process::Detach (bool keep_stopped)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003700{
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003701 EventSP exit_event_sp;
3702 Error error;
3703 m_destroy_in_process = true;
3704
3705 error = WillDetach();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003706
3707 if (error.Success())
3708 {
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003709 if (DetachRequiresHalt())
3710 {
Pavel Labathfcc7f662015-10-07 15:11:11 +00003711 error = StopForDestroyOrDetach (exit_event_sp);
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003712 if (!error.Success())
3713 {
3714 m_destroy_in_process = false;
3715 return error;
3716 }
3717 else if (exit_event_sp)
3718 {
3719 // We shouldn't need to do anything else here. There's no process left to detach from...
3720 StopPrivateStateThread();
3721 m_destroy_in_process = false;
3722 return error;
3723 }
3724 }
3725
Andrew MacPhersonc3826b52014-03-25 19:59:36 +00003726 m_thread_list.DiscardThreadPlans();
3727 DisableAllBreakpointSites();
3728
Jim Inghamacff8952013-05-02 00:27:30 +00003729 error = DoDetach(keep_stopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003730 if (error.Success())
3731 {
3732 DidDetach();
3733 StopPrivateStateThread();
3734 }
Jim Inghamacff8952013-05-02 00:27:30 +00003735 else
3736 {
3737 return error;
3738 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003739 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003740 m_destroy_in_process = false;
3741
3742 // If we exited when we were waiting for a process to stop, then
3743 // forward the event here so we don't lose the event
3744 if (exit_event_sp)
3745 {
3746 // Directly broadcast our exited event because we shut down our
3747 // private state thread above
3748 BroadcastEvent(exit_event_sp);
3749 }
3750
3751 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3752 // the last events through the event system, in which case we might strand the write lock. Unlock
3753 // it here so when we do to tear down the process we don't get an error destroying the lock.
3754
Ed Maste64fad602013-07-29 20:58:06 +00003755 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003756 return error;
3757}
3758
3759Error
Jason Molendaede31932015-04-17 05:01:58 +00003760Process::Destroy (bool force_kill)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003761{
Pavel Labath19da1f12015-12-07 12:36:52 +00003762
Jim Ingham09437922013-03-01 20:04:25 +00003763 // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work
3764 // that might hinder the destruction. Remember to set this back to false when we are done. That way if the attempt
3765 // failed and the process stays around for some reason it won't be in a confused state.
Jason Molendaede31932015-04-17 05:01:58 +00003766
3767 if (force_kill)
3768 m_should_detach = false;
Jim Ingham09437922013-03-01 20:04:25 +00003769
Ilia Kfcc89a02015-03-26 07:08:47 +00003770 if (GetShouldDetach())
3771 {
3772 // FIXME: This will have to be a process setting:
3773 bool keep_stopped = false;
3774 Detach(keep_stopped);
3775 }
3776
Jim Ingham09437922013-03-01 20:04:25 +00003777 m_destroy_in_process = true;
3778
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003779 Error error (WillDestroy());
3780 if (error.Success())
3781 {
Greg Clayton85fb1b92012-09-11 02:33:37 +00003782 EventSP exit_event_sp;
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003783 if (DestroyRequiresHalt())
Jim Ingham04e0a222012-05-23 15:46:31 +00003784 {
Pavel Labathfcc7f662015-10-07 15:11:11 +00003785 error = StopForDestroyOrDetach(exit_event_sp);
Jim Ingham04e0a222012-05-23 15:46:31 +00003786 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003787
Jim Inghamaacc3182012-06-06 00:29:30 +00003788 if (m_public_state.GetValue() != eStateRunning)
3789 {
3790 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3791 // kill it, we don't want it hitting a breakpoint...
3792 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3793 // we're not going to have much luck doing this now.
3794 m_thread_list.DiscardThreadPlans();
3795 DisableAllBreakpointSites();
3796 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003797
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003798 error = DoDestroy();
3799 if (error.Success())
3800 {
3801 DidDestroy();
3802 StopPrivateStateThread();
3803 }
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003804 m_stdio_communication.Disconnect();
Greg Clayton23d54f42015-06-03 00:34:01 +00003805 m_stdio_communication.StopReadThread();
Vince Harrondf3f00f2015-02-10 21:09:04 +00003806 m_stdin_forward = false;
Greg Claytonb4874f12014-02-28 18:22:24 +00003807
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003808 if (m_process_input_reader)
Greg Claytonb4874f12014-02-28 18:22:24 +00003809 {
3810 m_process_input_reader->SetIsDone(true);
3811 m_process_input_reader->Cancel();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003812 m_process_input_reader.reset();
Greg Claytonb4874f12014-02-28 18:22:24 +00003813 }
3814
Greg Clayton85fb1b92012-09-11 02:33:37 +00003815 // If we exited when we were waiting for a process to stop, then
3816 // forward the event here so we don't lose the event
3817 if (exit_event_sp)
3818 {
3819 // Directly broadcast our exited event because we shut down our
3820 // private state thread above
3821 BroadcastEvent(exit_event_sp);
3822 }
3823
Jim Inghamb1e2e842012-04-12 18:49:31 +00003824 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3825 // the last events through the event system, in which case we might strand the write lock. Unlock
3826 // 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 +00003827 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003828 }
Jim Ingham09437922013-03-01 20:04:25 +00003829
3830 m_destroy_in_process = false;
3831
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003832 return error;
3833}
3834
3835Error
3836Process::Signal (int signal)
3837{
3838 Error error (WillSignal());
3839 if (error.Success())
3840 {
3841 error = DoSignal(signal);
3842 if (error.Success())
3843 DidSignal();
3844 }
3845 return error;
3846}
3847
Zachary Turner93749ab2015-03-03 21:51:25 +00003848void
Chaoren Linc963a222015-09-01 16:58:45 +00003849Process::SetUnixSignals(UnixSignalsSP &&signals_sp)
Zachary Turner93749ab2015-03-03 21:51:25 +00003850{
3851 assert (signals_sp && "null signals_sp");
3852 m_unix_signals_sp = signals_sp;
3853}
3854
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00003855const lldb::UnixSignalsSP &
Zachary Turner93749ab2015-03-03 21:51:25 +00003856Process::GetUnixSignals ()
3857{
3858 assert (m_unix_signals_sp && "null m_unix_signals_sp");
Chaoren Lin98d0a4b2015-07-14 01:09:28 +00003859 return m_unix_signals_sp;
Zachary Turner93749ab2015-03-03 21:51:25 +00003860}
3861
Greg Clayton514487e2011-02-15 21:59:32 +00003862lldb::ByteOrder
3863Process::GetByteOrder () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003864{
Zachary Turner7529df92015-09-01 20:02:29 +00003865 return GetTarget().GetArchitecture().GetByteOrder();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003866}
3867
3868uint32_t
Greg Clayton514487e2011-02-15 21:59:32 +00003869Process::GetAddressByteSize () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003870{
Zachary Turner7529df92015-09-01 20:02:29 +00003871 return GetTarget().GetArchitecture().GetAddressByteSize();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003872}
3873
3874bool
3875Process::ShouldBroadcastEvent (Event *event_ptr)
3876{
3877 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3878 bool return_value = true;
Greg Clayton5160ce52013-03-27 23:08:40 +00003879 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS));
Jim Ingham0161b492013-02-09 01:29:05 +00003880
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003881 switch (state)
3882 {
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003883 case eStateDetached:
3884 case eStateExited:
3885 case eStateUnloaded:
Pavel Labath3f5df532015-03-12 10:12:41 +00003886 m_stdio_communication.SynchronizeWithReadThread();
Pavel Labatha9a43372015-09-03 09:30:17 +00003887 m_stdio_communication.Disconnect();
3888 m_stdio_communication.StopReadThread();
3889 m_stdin_forward = false;
3890
Pavel Labath3f5df532015-03-12 10:12:41 +00003891 // fall-through
3892 case eStateConnected:
3893 case eStateAttaching:
3894 case eStateLaunching:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003895 // These events indicate changes in the state of the debugging session, always report them.
3896 return_value = true;
3897 break;
3898 case eStateInvalid:
3899 // We stopped for no apparent reason, don't report it.
3900 return_value = false;
3901 break;
3902 case eStateRunning:
3903 case eStateStepping:
3904 // If we've started the target running, we handle the cases where we
3905 // are already running and where there is a transition from stopped to
3906 // running differently.
3907 // running -> running: Automatically suppress extra running events
3908 // stopped -> running: Report except when there is one or more no votes
3909 // and no yes votes.
3910 SynchronouslyNotifyStateChanged (state);
Jim Ingham1460e4b2014-01-10 23:46:59 +00003911 if (m_force_next_event_delivery)
3912 return_value = true;
3913 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003914 {
Jim Ingham1460e4b2014-01-10 23:46:59 +00003915 switch (m_last_broadcast_state)
3916 {
3917 case eStateRunning:
3918 case eStateStepping:
3919 // We always suppress multiple runnings with no PUBLIC stop in between.
3920 return_value = false;
3921 break;
3922 default:
3923 // TODO: make this work correctly. For now always report
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00003924 // run if we aren't running so we don't miss any running
Jim Ingham1460e4b2014-01-10 23:46:59 +00003925 // events. If I run the lldb/test/thread/a.out file and
3926 // break at main.cpp:58, run and hit the breakpoints on
3927 // multiple threads, then somehow during the stepping over
3928 // of all breakpoints no run gets reported.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003929
Jim Ingham1460e4b2014-01-10 23:46:59 +00003930 // This is a transition from stop to run.
3931 switch (m_thread_list.ShouldReportRun (event_ptr))
3932 {
3933 case eVoteYes:
3934 case eVoteNoOpinion:
3935 return_value = true;
3936 break;
3937 case eVoteNo:
3938 return_value = false;
3939 break;
3940 }
3941 break;
3942 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003943 }
3944 break;
3945 case eStateStopped:
3946 case eStateCrashed:
3947 case eStateSuspended:
3948 {
3949 // We've stopped. First see if we're going to restart the target.
3950 // If we are going to stop, then we always broadcast the event.
3951 // 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 +00003952 // If no thread has an opinion, we don't report it.
Jim Ingham221d51c2013-05-08 00:35:16 +00003953
Pavel Labath3f5df532015-03-12 10:12:41 +00003954 m_stdio_communication.SynchronizeWithReadThread();
Jim Inghamcb4ca112012-05-16 01:32:14 +00003955 RefreshStateAfterStop ();
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003956 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003957 {
Greg Clayton3af9ea52010-11-18 05:57:03 +00003958 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003959 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003960 static_cast<void*>(event_ptr),
Jim Ingham0161b492013-02-09 01:29:05 +00003961 StateAsCString(state));
Jim Ingham35878c42014-04-08 21:33:21 +00003962 // Even though we know we are going to stop, we should let the threads have a look at the stop,
3963 // so they can properly set their state.
3964 m_thread_list.ShouldStop (event_ptr);
Jim Ingham0161b492013-02-09 01:29:05 +00003965 return_value = true;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003966 }
3967 else
3968 {
Jim Ingham221d51c2013-05-08 00:35:16 +00003969 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
3970 bool should_resume = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003971
Jim Ingham0161b492013-02-09 01:29:05 +00003972 // It makes no sense to ask "ShouldStop" if we've already been restarted...
3973 // Asking the thread list is also not likely to go well, since we are running again.
3974 // So in that case just report the event.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003975
Jim Ingham0161b492013-02-09 01:29:05 +00003976 if (!was_restarted)
3977 should_resume = m_thread_list.ShouldStop (event_ptr) == false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003978
Jim Ingham221d51c2013-05-08 00:35:16 +00003979 if (was_restarted || should_resume || m_resume_requested)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003980 {
Jim Ingham0161b492013-02-09 01:29:05 +00003981 Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr);
3982 if (log)
3983 log->Printf ("Process::ShouldBroadcastEvent: should_stop: %i state: %s was_restarted: %i stop_vote: %d.",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003984 should_resume, StateAsCString(state),
3985 was_restarted, stop_vote);
3986
Jim Ingham0161b492013-02-09 01:29:05 +00003987 switch (stop_vote)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003988 {
3989 case eVoteYes:
Jim Ingham0161b492013-02-09 01:29:05 +00003990 return_value = true;
3991 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003992 case eVoteNoOpinion:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003993 case eVoteNo:
3994 return_value = false;
3995 break;
3996 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003997
Jim Inghamcb95f342012-09-05 21:13:56 +00003998 if (!was_restarted)
Jim Ingham0161b492013-02-09 01:29:05 +00003999 {
4000 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004001 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s",
4002 static_cast<void*>(event_ptr),
4003 StateAsCString(state));
Jim Ingham0161b492013-02-09 01:29:05 +00004004 ProcessEventData::SetRestartedInEvent(event_ptr, true);
Jim Inghamcb95f342012-09-05 21:13:56 +00004005 PrivateResume ();
Jim Ingham0161b492013-02-09 01:29:05 +00004006 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004007 }
4008 else
4009 {
4010 return_value = true;
4011 SynchronouslyNotifyStateChanged (state);
4012 }
4013 }
4014 }
Jim Ingham0161b492013-02-09 01:29:05 +00004015 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004016 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004017
Jim Ingham1460e4b2014-01-10 23:46:59 +00004018 // Forcing the next event delivery is a one shot deal. So reset it here.
4019 m_force_next_event_delivery = false;
4020
Jim Ingham0161b492013-02-09 01:29:05 +00004021 // We do some coalescing of events (for instance two consecutive running events get coalesced.)
4022 // But we only coalesce against events we actually broadcast. So we use m_last_broadcast_state
4023 // to track that. NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done,
4024 // because the PublicState reflects the last event pulled off the queue, and there may be several
4025 // events stacked up on the queue unserviced. So the PublicState may not reflect the last broadcasted event
4026 // yet. m_last_broadcast_state gets updated here.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004027
Jim Ingham0161b492013-02-09 01:29:05 +00004028 if (return_value)
4029 m_last_broadcast_state = state;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004030
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004031 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004032 log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004033 static_cast<void*>(event_ptr), StateAsCString(state),
Jim Ingham0161b492013-02-09 01:29:05 +00004034 StateAsCString(m_last_broadcast_state),
4035 return_value ? "YES" : "NO");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004036 return return_value;
4037}
4038
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004039bool
Jim Ingham60c915e2015-06-23 21:02:45 +00004040Process::StartPrivateStateThread (bool is_secondary_thread)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004041{
Greg Clayton5160ce52013-03-27 23:08:40 +00004042 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004043
Greg Clayton8b82f082011-04-12 05:54:46 +00004044 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004045 if (log)
Greg Clayton8b82f082011-04-12 05:54:46 +00004046 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
4047
Jim Ingham60c915e2015-06-23 21:02:45 +00004048 if (!is_secondary_thread && already_running)
Greg Clayton8b82f082011-04-12 05:54:46 +00004049 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004050
4051 // Create a thread that watches our internal state and controls which
4052 // events make it to clients (into the DCProcess event queue).
Greg Clayton3e06bd92011-01-09 21:07:35 +00004053 char thread_name[1024];
Todd Fiala17096d72014-07-16 19:03:16 +00004054
Zachary Turner39de3112014-09-09 20:54:56 +00004055 if (HostInfo::GetMaxThreadNameLength() <= 30)
Todd Fiala17096d72014-07-16 19:03:16 +00004056 {
Zachary Turner39de3112014-09-09 20:54:56 +00004057 // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit.
4058 if (already_running)
4059 snprintf(thread_name, sizeof(thread_name), "intern-state-OV");
4060 else
4061 snprintf(thread_name, sizeof(thread_name), "intern-state");
Todd Fiala17096d72014-07-16 19:03:16 +00004062 }
Jim Ingham372787f2012-04-07 00:00:41 +00004063 else
Todd Fiala17096d72014-07-16 19:03:16 +00004064 {
4065 if (already_running)
Zachary Turner39de3112014-09-09 20:54:56 +00004066 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
Todd Fiala17096d72014-07-16 19:03:16 +00004067 else
Zachary Turner39de3112014-09-09 20:54:56 +00004068 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
Todd Fiala17096d72014-07-16 19:03:16 +00004069 }
4070
Jim Ingham076b3042012-04-10 01:21:57 +00004071 // Create the private state thread, and start it running.
Jim Ingham60c915e2015-06-23 21:02:45 +00004072 PrivateStateThreadArgs args = {this, is_secondary_thread};
Kate Stoneef8b4e22015-12-17 01:37:00 +00004073 m_private_state_thread = ThreadLauncher::LaunchThread(thread_name, Process::PrivateStateThread, (void *) &args, NULL, 8 * 1024 * 1024);
Zachary Turneracee96a2014-09-23 18:32:09 +00004074 if (m_private_state_thread.IsJoinable())
Jim Ingham076b3042012-04-10 01:21:57 +00004075 {
4076 ResumePrivateStateThread();
4077 return true;
4078 }
4079 else
4080 return false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004081}
4082
4083void
4084Process::PausePrivateStateThread ()
4085{
4086 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
4087}
4088
4089void
4090Process::ResumePrivateStateThread ()
4091{
4092 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
4093}
4094
4095void
4096Process::StopPrivateStateThread ()
4097{
Greg Clayton8b82f082011-04-12 05:54:46 +00004098 if (PrivateStateThreadIsValid ())
4099 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Jim Inghamb1e2e842012-04-12 18:49:31 +00004100 else
4101 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004102 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Jim Inghamb1e2e842012-04-12 18:49:31 +00004103 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004104 log->Printf ("Went to stop the private state thread, but it was already invalid.");
Jim Inghamb1e2e842012-04-12 18:49:31 +00004105 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004106}
4107
4108void
4109Process::ControlPrivateStateThread (uint32_t signal)
4110{
Greg Clayton5160ce52013-03-27 23:08:40 +00004111 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004112
4113 assert (signal == eBroadcastInternalStateControlStop ||
4114 signal == eBroadcastInternalStateControlPause ||
4115 signal == eBroadcastInternalStateControlResume);
4116
4117 if (log)
Greg Clayton7ecb3a02011-01-22 17:43:17 +00004118 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004119
Greg Clayton7ecb3a02011-01-22 17:43:17 +00004120 // Signal the private state thread. First we should copy this is case the
4121 // thread starts exiting since the private state thread will NULL this out
4122 // when it exits
Zachary Turner39de3112014-09-09 20:54:56 +00004123 HostThread private_state_thread(m_private_state_thread);
Zachary Turneracee96a2014-09-23 18:32:09 +00004124 if (private_state_thread.IsJoinable())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004125 {
4126 TimeValue timeout_time;
4127 bool timed_out;
4128
4129 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
4130
4131 timeout_time = TimeValue::Now();
4132 timeout_time.OffsetWithSeconds(2);
Jim Inghamb1e2e842012-04-12 18:49:31 +00004133 if (log)
4134 log->Printf ("Sending control event of type: %d.", signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004135 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
4136 m_private_state_control_wait.SetValue (false, eBroadcastNever);
4137
4138 if (signal == eBroadcastInternalStateControlStop)
4139 {
4140 if (timed_out)
Jim Inghamb1e2e842012-04-12 18:49:31 +00004141 {
Zachary Turner39de3112014-09-09 20:54:56 +00004142 Error error = private_state_thread.Cancel();
Jim Inghamb1e2e842012-04-12 18:49:31 +00004143 if (log)
4144 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
4145 }
4146 else
4147 {
4148 if (log)
4149 log->Printf ("The control event killed the private state thread without having to cancel.");
4150 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004151
4152 thread_result_t result = NULL;
Zachary Turner39de3112014-09-09 20:54:56 +00004153 private_state_thread.Join(&result);
4154 m_private_state_thread.Reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004155 }
4156 }
Jim Inghamb1e2e842012-04-12 18:49:31 +00004157 else
4158 {
4159 if (log)
4160 log->Printf ("Private state thread already dead, no need to signal it to stop.");
4161 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004162}
4163
4164void
Jim Inghamcfc09352012-07-27 23:57:19 +00004165Process::SendAsyncInterrupt ()
4166{
4167 if (PrivateStateThreadIsValid())
4168 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4169 else
4170 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4171}
4172
4173void
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004174Process::HandlePrivateEvent (EventSP &event_sp)
4175{
Greg Clayton5160ce52013-03-27 23:08:40 +00004176 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham221d51c2013-05-08 00:35:16 +00004177 m_resume_requested = false;
4178
Greg Clayton414f5d32011-01-25 02:58:48 +00004179 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghambb3a2832011-01-29 01:49:25 +00004180
4181 // First check to see if anybody wants a shot at this event:
Jim Ingham754ab982011-01-29 04:05:41 +00004182 if (m_next_event_action_ap.get() != NULL)
Jim Inghambb3a2832011-01-29 01:49:25 +00004183 {
Jim Ingham754ab982011-01-29 04:05:41 +00004184 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Ingham0161b492013-02-09 01:29:05 +00004185 if (log)
4186 log->Printf ("Ran next event action, result was %d.", action_result);
4187
Jim Inghambb3a2832011-01-29 01:49:25 +00004188 switch (action_result)
4189 {
4190 case NextEventAction::eEventActionSuccess:
4191 SetNextEventAction(NULL);
4192 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00004193
Jim Inghambb3a2832011-01-29 01:49:25 +00004194 case NextEventAction::eEventActionRetry:
4195 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00004196
Jim Inghambb3a2832011-01-29 01:49:25 +00004197 case NextEventAction::eEventActionExit:
Jim Ingham2a5fdd42011-01-29 01:57:31 +00004198 // Handle Exiting Here. If we already got an exited event,
4199 // we should just propagate it. Otherwise, swallow this event,
4200 // and set our state to exit so the next event will kill us.
4201 if (new_state != eStateExited)
4202 {
4203 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham754ab982011-01-29 04:05:41 +00004204 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Jim Ingham2a5fdd42011-01-29 01:57:31 +00004205 SetNextEventAction(NULL);
4206 return;
4207 }
4208 SetNextEventAction(NULL);
Jim Inghambb3a2832011-01-29 01:49:25 +00004209 break;
4210 }
4211 }
4212
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004213 // See if we should broadcast this state to external clients?
4214 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004215
4216 if (should_broadcast)
4217 {
Greg Claytonb4874f12014-02-28 18:22:24 +00004218 const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004219 if (log)
4220 {
Daniel Malead01b2952012-11-29 21:49:15 +00004221 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
Greg Clayton414f5d32011-01-25 02:58:48 +00004222 __FUNCTION__,
4223 GetID(),
4224 StateAsCString(new_state),
4225 StateAsCString (GetState ()),
Greg Claytonb4874f12014-02-28 18:22:24 +00004226 is_hijacked ? "hijacked" : "public");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004227 }
Jim Ingham9575d842011-03-11 03:53:59 +00004228 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton414f5d32011-01-25 02:58:48 +00004229 if (StateIsRunningState (new_state))
Greg Clayton44d93782014-01-27 23:43:24 +00004230 {
4231 // Only push the input handler if we aren't fowarding events,
4232 // as this means the curses GUI is in use...
Todd Fialaf72fa672014-10-07 16:05:21 +00004233 // Or don't push it if we are launching since it will come up stopped.
Zachary Turnerc62733b2015-05-20 18:31:17 +00004234 if (!GetTarget().GetDebugger().IsForwardingEvents() && new_state != eStateLaunching &&
4235 new_state != eStateAttaching)
Pavel Labath44464872015-05-27 12:40:32 +00004236 {
Greg Clayton44d93782014-01-27 23:43:24 +00004237 PushProcessIOHandler ();
Pavel Labath44464872015-05-27 12:40:32 +00004238 m_iohandler_sync.SetValue(m_iohandler_sync.GetValue()+1, eBroadcastAlways);
4239 if (log)
4240 log->Printf("Process::%s updated m_iohandler_sync to %d", __FUNCTION__, m_iohandler_sync.GetValue());
4241 }
Greg Clayton44d93782014-01-27 23:43:24 +00004242 }
Greg Claytonb4874f12014-02-28 18:22:24 +00004243 else if (StateIsStoppedState(new_state, false))
4244 {
4245 if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
4246 {
4247 // If the lldb_private::Debugger is handling the events, we don't
4248 // want to pop the process IOHandler here, we want to do it when
4249 // we receive the stopped event so we can carefully control when
4250 // the process IOHandler is popped because when we stop we want to
4251 // display some text stating how and why we stopped, then maybe some
4252 // process/thread/frame info, and then we want the "(lldb) " prompt
4253 // to show up. If we pop the process IOHandler here, then we will
4254 // cause the command interpreter to become the top IOHandler after
4255 // the process pops off and it will update its prompt right away...
4256 // See the Debugger.cpp file where it calls the function as
4257 // "process_sp->PopProcessIOHandler()" to see where I am talking about.
4258 // Otherwise we end up getting overlapping "(lldb) " prompts and
4259 // garbled output.
4260 //
4261 // If we aren't handling the events in the debugger (which is indicated
4262 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we
4263 // are hijacked, then we always pop the process IO handler manually.
4264 // Hijacking happens when the internal process state thread is running
4265 // thread plans, or when commands want to run in synchronous mode
4266 // and they call "process->WaitForProcessToStop()". An example of something
4267 // that will hijack the events is a simple expression:
4268 //
4269 // (lldb) expr (int)puts("hello")
4270 //
4271 // This will cause the internal process state thread to resume and halt
4272 // the process (and _it_ will hijack the eBroadcastBitStateChanged
4273 // events) and we do need the IO handler to be pushed and popped
4274 // correctly.
4275
Zachary Turner7529df92015-09-01 20:02:29 +00004276 if (is_hijacked || GetTarget().GetDebugger().IsHandlingEvents() == false)
Greg Claytonb4874f12014-02-28 18:22:24 +00004277 PopProcessIOHandler ();
4278 }
4279 }
Jim Ingham9575d842011-03-11 03:53:59 +00004280
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004281 BroadcastEvent (event_sp);
4282 }
4283 else
4284 {
4285 if (log)
4286 {
Daniel Malead01b2952012-11-29 21:49:15 +00004287 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
Greg Clayton414f5d32011-01-25 02:58:48 +00004288 __FUNCTION__,
4289 GetID(),
4290 StateAsCString(new_state),
Jason Molendafd54b362011-09-20 21:44:10 +00004291 StateAsCString (GetState ()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004292 }
4293 }
Pavel Labath19da1f12015-12-07 12:36:52 +00004294}
4295
4296Error
4297Process::HaltPrivate()
4298{
4299 EventSP event_sp;
4300 Error error (WillHalt());
4301 if (error.Fail())
4302 return error;
4303
4304 // Ask the process subclass to actually halt our process
4305 bool caused_stop;
4306 error = DoHalt(caused_stop);
4307
4308 DidHalt();
4309 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004310}
4311
Virgile Bellob2f1fb22013-08-23 12:44:05 +00004312thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004313Process::PrivateStateThread (void *arg)
4314{
Jim Ingham60c915e2015-06-23 21:02:45 +00004315 PrivateStateThreadArgs *real_args = static_cast<PrivateStateThreadArgs *> (arg);
4316 thread_result_t result = real_args->process->RunPrivateStateThread(real_args->is_secondary_thread);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004317 return result;
4318}
4319
Virgile Bellob2f1fb22013-08-23 12:44:05 +00004320thread_result_t
Jim Ingham60c915e2015-06-23 21:02:45 +00004321Process::RunPrivateStateThread (bool is_secondary_thread)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004322{
Jim Ingham076b3042012-04-10 01:21:57 +00004323 bool control_only = true;
Jim Inghamb1e2e842012-04-12 18:49:31 +00004324 m_private_state_control_wait.SetValue (false, eBroadcastNever);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004325
Greg Clayton5160ce52013-03-27 23:08:40 +00004326 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004327 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004328 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...",
4329 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004330
4331 bool exit_now = false;
Pavel Labath19da1f12015-12-07 12:36:52 +00004332 bool interrupt_requested = false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004333 while (!exit_now)
4334 {
4335 EventSP event_sp;
4336 WaitForEventsPrivate (NULL, event_sp, control_only);
4337 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
4338 {
Jim Inghamb1e2e842012-04-12 18:49:31 +00004339 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004340 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d",
4341 __FUNCTION__, static_cast<void*>(this), GetID(),
4342 event_sp->GetType());
Jim Inghamb1e2e842012-04-12 18:49:31 +00004343
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004344 switch (event_sp->GetType())
4345 {
4346 case eBroadcastInternalStateControlStop:
4347 exit_now = true;
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004348 break; // doing any internal state management below
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004349
4350 case eBroadcastInternalStateControlPause:
4351 control_only = true;
4352 break;
4353
4354 case eBroadcastInternalStateControlResume:
4355 control_only = false;
4356 break;
4357 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004358
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004359 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004360 continue;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004361 }
Jim Inghamcfc09352012-07-27 23:57:19 +00004362 else if (event_sp->GetType() == eBroadcastBitInterrupt)
4363 {
4364 if (m_public_state.GetValue() == eStateAttaching)
4365 {
4366 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004367 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.",
4368 __FUNCTION__, static_cast<void*>(this),
4369 GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00004370 BroadcastEvent (eBroadcastBitInterrupt, NULL);
4371 }
Pavel Labath19da1f12015-12-07 12:36:52 +00004372 else if(StateIsRunningState(m_last_broadcast_state))
Jim Inghamcfc09352012-07-27 23:57:19 +00004373 {
4374 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004375 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.",
4376 __FUNCTION__, static_cast<void*>(this),
4377 GetID());
Pavel Labath19da1f12015-12-07 12:36:52 +00004378 Error error = HaltPrivate();
4379 if (error.Fail() && log)
4380 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") failed to halt the process: %s",
4381 __FUNCTION__, static_cast<void*>(this),
4382 GetID(), error.AsCString());
4383 // Halt should generate a stopped event. Make a note of the fact that we were
4384 // doing the interrupt, so we can set the interrupted flag after we receive the
4385 // event. We deliberately set this to true even if HaltPrivate failed, so that we
4386 // can interrupt on the next natural stop.
4387 interrupt_requested = true;
4388 }
4389 else
4390 {
4391 // This can happen when someone (e.g. Process::Halt) sees that we are running and
4392 // sends an interrupt request, but the process actually stops before we receive
4393 // it. In that case, we can just ignore the request. We use
4394 // m_last_broadcast_state, because the Stopped event may not have been popped of
4395 // the event queue yet, which is when the public state gets updated.
4396 if (log)
4397 log->Printf("Process::%s ignoring interrupt as we have already stopped.", __FUNCTION__);
Jim Inghamcfc09352012-07-27 23:57:19 +00004398 }
4399 continue;
4400 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004401
4402 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4403
4404 if (internal_state != eStateInvalid)
4405 {
Greg Claytonf9b57b92013-05-10 23:48:10 +00004406 if (m_clear_thread_plans_on_stop &&
4407 StateIsStoppedState(internal_state, true))
4408 {
4409 m_clear_thread_plans_on_stop = false;
4410 m_thread_list.DiscardThreadPlans();
4411 }
Pavel Labath19da1f12015-12-07 12:36:52 +00004412
4413 if (interrupt_requested)
4414 {
4415 if (StateIsStoppedState (internal_state, true))
4416 {
4417 // We requested the interrupt, so mark this as such in the stop event so
4418 // clients can tell an interrupted process from a natural stop
4419 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
4420 interrupt_requested = false;
4421 }
4422 else if (log)
4423 {
4424 log->Printf("Process::%s interrupt_requested, but a non-stopped state '%s' received.",
4425 __FUNCTION__, StateAsCString(internal_state));
4426 }
4427 }
4428
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004429 HandlePrivateEvent (event_sp);
4430 }
4431
Greg Clayton58d1c9a2010-10-18 04:14:23 +00004432 if (internal_state == eStateInvalid ||
4433 internal_state == eStateExited ||
4434 internal_state == eStateDetached )
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004435 {
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004436 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004437 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...",
4438 __FUNCTION__, static_cast<void*>(this), GetID(),
4439 StateAsCString(internal_state));
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004440
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004441 break;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004442 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004443 }
4444
Caroline Tice20ad3c42010-10-29 21:48:37 +00004445 // Verify log is still enabled before attempting to write to it...
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004446 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004447 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...",
4448 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004449
Jim Ingham60c915e2015-06-23 21:02:45 +00004450 // If we are a secondary thread, then the primary thread we are working for will have already
4451 // acquired the public_run_lock, and isn't done with what it was doing yet, so don't
4452 // try to change it on the way out.
4453 if (!is_secondary_thread)
4454 m_public_run_lock.SetStopped();
Greg Clayton6ed95942011-01-22 07:12:45 +00004455 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Zachary Turner39de3112014-09-09 20:54:56 +00004456 m_private_state_thread.Reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004457 return NULL;
4458}
4459
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004460//------------------------------------------------------------------
4461// Process Event Data
4462//------------------------------------------------------------------
4463
4464Process::ProcessEventData::ProcessEventData () :
4465 EventData (),
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004466 m_process_wp (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004467 m_state (eStateInvalid),
Greg Claytonc982c762010-07-09 20:39:50 +00004468 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004469 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004470 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004471{
4472}
4473
4474Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
4475 EventData (),
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004476 m_process_wp (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004477 m_state (state),
Greg Claytonc982c762010-07-09 20:39:50 +00004478 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004479 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004480 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004481{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004482 if (process_sp)
4483 m_process_wp = process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004484}
4485
Eugene Zelenko8f30a652015-10-23 18:39:37 +00004486Process::ProcessEventData::~ProcessEventData() = default;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004487
4488const ConstString &
4489Process::ProcessEventData::GetFlavorString ()
4490{
4491 static ConstString g_flavor ("Process::ProcessEventData");
4492 return g_flavor;
4493}
4494
4495const ConstString &
4496Process::ProcessEventData::GetFlavor () const
4497{
4498 return ProcessEventData::GetFlavorString ();
4499}
4500
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004501void
4502Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
4503{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004504 ProcessSP process_sp(m_process_wp.lock());
4505
4506 if (!process_sp)
4507 return;
4508
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004509 // This function gets called twice for each event, once when the event gets pulled
Jim Inghama8604692011-05-22 21:45:01 +00004510 // off of the private process event queue, and then any number of times, first when it gets pulled off of
4511 // the public event queue, then other times when we're pretending that this is where we stopped at the
4512 // end of expression evaluation. m_update_state is used to distinguish these
4513 // three cases; it is 0 when we're just pulling it off for private handling,
Jim Ingham221d51c2013-05-08 00:35:16 +00004514 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Jim Inghama8604692011-05-22 21:45:01 +00004515 if (m_update_state != 1)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004516 return;
Jim Ingham0161b492013-02-09 01:29:05 +00004517
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004518 process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr));
Jim Ingham35878c42014-04-08 21:33:21 +00004519
4520 // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had
4521 // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may
4522 // end up restarting the process.
4523 if (m_interrupted)
4524 return;
4525
4526 // If we're stopped and haven't restarted, then do the StopInfo actions here:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004527 if (m_state == eStateStopped && ! m_restarted)
Greg Clayton2e309072015-07-17 23:42:28 +00004528 {
4529 // Let process subclasses know we are about to do a public stop and
4530 // do anything they might need to in order to speed up register and
4531 // memory accesses.
4532 process_sp->WillPublicStop();
4533
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004534 ThreadList &curr_thread_list = process_sp->GetThreadList();
Greg Clayton61e7a582011-12-01 23:28:38 +00004535 uint32_t num_threads = curr_thread_list.GetSize();
4536 uint32_t idx;
Greg Claytonf4b47e12010-08-04 01:40:35 +00004537
Jim Ingham4b536182011-08-09 02:12:22 +00004538 // The actions might change one of the thread's stop_info's opinions about whether we should
4539 // stop the process, so we need to query that as we go.
Jim Ingham0faa43f2011-11-08 03:00:11 +00004540
4541 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
4542 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
4543 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
4544 // 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
4545 // against this list & bag out if anything differs.
Greg Clayton61e7a582011-12-01 23:28:38 +00004546 std::vector<uint32_t> thread_index_array(num_threads);
Jim Ingham0faa43f2011-11-08 03:00:11 +00004547 for (idx = 0; idx < num_threads; ++idx)
4548 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
4549
Jim Inghamc7078c22012-12-13 22:24:15 +00004550 // Use this to track whether we should continue from here. We will only continue the target running if
4551 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running,
4552 // then it doesn't matter what the other threads say...
4553
4554 bool still_should_stop = false;
Jim Ingham4b536182011-08-09 02:12:22 +00004555
Jim Ingham0ad7e052013-04-25 02:04:59 +00004556 // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a
4557 // valid stop reason. In that case we should just stop, because we have no way of telling what the right
4558 // thing to do is, and it's better to let the user decide than continue behind their backs.
4559
4560 bool does_anybody_have_an_opinion = false;
4561
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004562 for (idx = 0; idx < num_threads; ++idx)
4563 {
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004564 curr_thread_list = process_sp->GetThreadList();
Jim Ingham0faa43f2011-11-08 03:00:11 +00004565 if (curr_thread_list.GetSize() != num_threads)
4566 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004567 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004568 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004569 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 +00004570 break;
4571 }
4572
4573 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
4574
4575 if (thread_sp->GetIndexID() != thread_index_array[idx])
4576 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004577 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004578 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004579 log->Printf("The thread at position %u changed from %u to %u while processing event.",
Jim Ingham87c665f2011-12-01 20:26:15 +00004580 idx,
4581 thread_index_array[idx],
4582 thread_sp->GetIndexID());
Jim Ingham0faa43f2011-11-08 03:00:11 +00004583 break;
4584 }
4585
Jim Inghamb15bfc72010-10-20 00:39:53 +00004586 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
Jim Ingham5d88a062012-10-16 00:09:33 +00004587 if (stop_info_sp && stop_info_sp->IsValid())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004588 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004589 does_anybody_have_an_opinion = true;
Jim Ingham0161b492013-02-09 01:29:05 +00004590 bool this_thread_wants_to_stop;
4591 if (stop_info_sp->GetOverrideShouldStop())
Jim Ingham4b536182011-08-09 02:12:22 +00004592 {
Jim Ingham0161b492013-02-09 01:29:05 +00004593 this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue();
4594 }
4595 else
4596 {
4597 stop_info_sp->PerformAction(event_ptr);
4598 // The stop action might restart the target. If it does, then we want to mark that in the
4599 // event so that whoever is receiving it will know to wait for the running event and reflect
4600 // that state appropriately.
4601 // We also need to stop processing actions, since they aren't expecting the target to be running.
4602
4603 // FIXME: we might have run.
4604 if (stop_info_sp->HasTargetRunSinceMe())
4605 {
4606 SetRestarted (true);
4607 break;
4608 }
4609
4610 this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
Jim Ingham4b536182011-08-09 02:12:22 +00004611 }
Jim Inghamc7078c22012-12-13 22:24:15 +00004612
Jim Inghamc7078c22012-12-13 22:24:15 +00004613 if (still_should_stop == false)
4614 still_should_stop = this_thread_wants_to_stop;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004615 }
4616 }
Ashok Thirumurthicf7c55e2013-04-18 14:38:20 +00004617
Jim Inghama8ca6e22013-05-03 23:04:37 +00004618 if (!GetRestarted())
Jim Ingham9575d842011-03-11 03:53:59 +00004619 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004620 if (!still_should_stop && does_anybody_have_an_opinion)
Jim Ingham4b536182011-08-09 02:12:22 +00004621 {
4622 // We've been asked to continue, so do that here.
Jim Ingham9575d842011-03-11 03:53:59 +00004623 SetRestarted(true);
Jim Ingham3b8285d2012-04-19 01:40:33 +00004624 // Use the public resume method here, since this is just
4625 // extending a public resume.
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004626 process_sp->PrivateResume();
Jim Ingham4b536182011-08-09 02:12:22 +00004627 }
4628 else
4629 {
4630 // If we didn't restart, run the Stop Hooks here:
4631 // They might also restart the target, so watch for that.
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004632 process_sp->GetTarget().RunStopHooks();
4633 if (process_sp->GetPrivateState() == eStateRunning)
Jim Ingham4b536182011-08-09 02:12:22 +00004634 SetRestarted(true);
4635 }
Jim Ingham9575d842011-03-11 03:53:59 +00004636 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004637 }
4638}
4639
4640void
4641Process::ProcessEventData::Dump (Stream *s) const
4642{
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004643 ProcessSP process_sp(m_process_wp.lock());
4644
4645 if (process_sp)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004646 s->Printf(" process = %p (pid = %" PRIu64 "), ",
Greg Claytonaeb3b8b2015-05-29 03:20:37 +00004647 static_cast<void*>(process_sp.get()), process_sp->GetID());
4648 else
4649 s->PutCString(" process = NULL, ");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004650
Greg Clayton8b82f082011-04-12 05:54:46 +00004651 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004652}
4653
4654const Process::ProcessEventData *
4655Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
4656{
4657 if (event_ptr)
4658 {
4659 const EventData *event_data = event_ptr->GetData();
4660 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4661 return static_cast <const ProcessEventData *> (event_ptr->GetData());
4662 }
4663 return NULL;
4664}
4665
4666ProcessSP
4667Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4668{
4669 ProcessSP process_sp;
4670 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4671 if (data)
4672 process_sp = data->GetProcessSP();
4673 return process_sp;
4674}
4675
4676StateType
4677Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4678{
4679 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4680 if (data == NULL)
4681 return eStateInvalid;
4682 else
4683 return data->GetState();
4684}
4685
4686bool
4687Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4688{
4689 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4690 if (data == NULL)
4691 return false;
4692 else
4693 return data->GetRestarted();
4694}
4695
4696void
4697Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4698{
4699 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4700 if (data != NULL)
4701 data->SetRestarted(new_value);
4702}
4703
Jim Ingham0161b492013-02-09 01:29:05 +00004704size_t
4705Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr)
4706{
4707 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4708 if (data != NULL)
4709 return data->GetNumRestartedReasons();
4710 else
4711 return 0;
4712}
4713
4714const char *
4715Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx)
4716{
4717 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4718 if (data != NULL)
4719 return data->GetRestartedReasonAtIndex(idx);
4720 else
4721 return NULL;
4722}
4723
4724void
4725Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason)
4726{
4727 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4728 if (data != NULL)
4729 data->AddRestartedReason(reason);
4730}
4731
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004732bool
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004733Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4734{
4735 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4736 if (data == NULL)
4737 return false;
4738 else
4739 return data->GetInterrupted ();
4740}
4741
4742void
4743Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4744{
4745 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4746 if (data != NULL)
4747 data->SetInterrupted(new_value);
4748}
4749
4750bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004751Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4752{
4753 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4754 if (data)
4755 {
4756 data->SetUpdateStateOnRemoval();
4757 return true;
4758 }
4759 return false;
4760}
4761
Greg Claytond9e416c2012-02-18 05:35:26 +00004762lldb::TargetSP
4763Process::CalculateTarget ()
4764{
Zachary Turner7529df92015-09-01 20:02:29 +00004765 return m_target_sp.lock();
Greg Claytond9e416c2012-02-18 05:35:26 +00004766}
4767
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004768void
Greg Clayton0603aa92010-10-04 01:05:56 +00004769Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004770{
Zachary Turner7529df92015-09-01 20:02:29 +00004771 exe_ctx.SetTargetPtr (&GetTarget());
Greg Claytonc14ee322011-09-22 04:58:26 +00004772 exe_ctx.SetProcessPtr (this);
4773 exe_ctx.SetThreadPtr(NULL);
4774 exe_ctx.SetFramePtr (NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004775}
4776
Greg Claytone996fd32011-03-08 22:40:15 +00004777//uint32_t
4778//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4779//{
4780// return 0;
4781//}
4782//
4783//ArchSpec
4784//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
4785//{
4786// return Host::GetArchSpecForExistingProcess (pid);
4787//}
4788//
4789//ArchSpec
4790//Process::GetArchSpecForExistingProcess (const char *process_name)
4791//{
4792// return Host::GetArchSpecForExistingProcess (process_name);
4793//}
4794//
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004795void
4796Process::AppendSTDOUT (const char * s, size_t len)
4797{
Greg Clayton3af9ea52010-11-18 05:57:03 +00004798 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004799 m_stdout_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00004800 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004801}
4802
4803void
Greg Clayton93e86192011-11-13 04:45:22 +00004804Process::AppendSTDERR (const char * s, size_t len)
4805{
4806 Mutex::Locker locker (m_stdio_communication_mutex);
4807 m_stderr_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00004808 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
Greg Clayton93e86192011-11-13 04:45:22 +00004809}
4810
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004811void
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004812Process::BroadcastAsyncProfileData(const std::string &one_profile_data)
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004813{
4814 Mutex::Locker locker (m_profile_data_comm_mutex);
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004815 m_profile_data.push_back(one_profile_data);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004816 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
4817}
4818
4819size_t
4820Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
4821{
4822 Mutex::Locker locker(m_profile_data_comm_mutex);
Han Ming Ong929a94f2012-11-29 22:14:45 +00004823 if (m_profile_data.empty())
4824 return 0;
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004825
4826 std::string &one_profile_data = m_profile_data.front();
4827 size_t bytes_available = one_profile_data.size();
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004828 if (bytes_available > 0)
4829 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004830 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004831 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004832 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")",
4833 static_cast<void*>(buf),
4834 static_cast<uint64_t>(buf_size));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004835 if (bytes_available > buf_size)
4836 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004837 memcpy(buf, one_profile_data.c_str(), buf_size);
4838 one_profile_data.erase(0, buf_size);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004839 bytes_available = buf_size;
4840 }
4841 else
4842 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004843 memcpy(buf, one_profile_data.c_str(), bytes_available);
Han Ming Ong929a94f2012-11-29 22:14:45 +00004844 m_profile_data.erase(m_profile_data.begin());
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004845 }
4846 }
4847 return bytes_available;
4848}
4849
Greg Clayton93e86192011-11-13 04:45:22 +00004850//------------------------------------------------------------------
4851// Process STDIO
4852//------------------------------------------------------------------
4853
4854size_t
4855Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
4856{
4857 Mutex::Locker locker(m_stdio_communication_mutex);
4858 size_t bytes_available = m_stdout_data.size();
4859 if (bytes_available > 0)
4860 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004861 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00004862 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004863 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")",
4864 static_cast<void*>(buf),
4865 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00004866 if (bytes_available > buf_size)
4867 {
4868 memcpy(buf, m_stdout_data.c_str(), buf_size);
4869 m_stdout_data.erase(0, buf_size);
4870 bytes_available = buf_size;
4871 }
4872 else
4873 {
4874 memcpy(buf, m_stdout_data.c_str(), bytes_available);
4875 m_stdout_data.clear();
4876 }
4877 }
4878 return bytes_available;
4879}
4880
Greg Clayton93e86192011-11-13 04:45:22 +00004881size_t
4882Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
4883{
4884 Mutex::Locker locker(m_stdio_communication_mutex);
4885 size_t bytes_available = m_stderr_data.size();
4886 if (bytes_available > 0)
4887 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004888 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00004889 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004890 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")",
4891 static_cast<void*>(buf),
4892 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00004893 if (bytes_available > buf_size)
4894 {
4895 memcpy(buf, m_stderr_data.c_str(), buf_size);
4896 m_stderr_data.erase(0, buf_size);
4897 bytes_available = buf_size;
4898 }
4899 else
4900 {
4901 memcpy(buf, m_stderr_data.c_str(), bytes_available);
4902 m_stderr_data.clear();
4903 }
4904 }
4905 return bytes_available;
4906}
4907
4908void
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004909Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
4910{
4911 Process *process = (Process *) baton;
4912 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
4913}
4914
Greg Clayton44d93782014-01-27 23:43:24 +00004915class IOHandlerProcessSTDIO :
4916 public IOHandler
4917{
4918public:
4919 IOHandlerProcessSTDIO (Process *process,
4920 int write_fd) :
Kate Stonee30f11d2014-11-17 19:06:59 +00004921 IOHandler(process->GetTarget().GetDebugger(), IOHandler::Type::ProcessIO),
Greg Clayton44d93782014-01-27 23:43:24 +00004922 m_process (process),
4923 m_read_file (),
4924 m_write_file (write_fd, false),
Greg Clayton100eb932014-07-02 21:10:39 +00004925 m_pipe ()
Greg Clayton44d93782014-01-27 23:43:24 +00004926 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004927 m_pipe.CreateNew(false);
Greg Clayton44d93782014-01-27 23:43:24 +00004928 m_read_file.SetDescriptor(GetInputFD(), false);
4929 }
4930
Eugene Zelenko8f30a652015-10-23 18:39:37 +00004931 ~IOHandlerProcessSTDIO() override = default;
4932
Greg Clayton44d93782014-01-27 23:43:24 +00004933 // Each IOHandler gets to run until it is done. It should read data
4934 // from the "in" and place output into "out" and "err and return
4935 // when done.
Pavel Labath44464872015-05-27 12:40:32 +00004936 void
4937 Run () override
Greg Clayton44d93782014-01-27 23:43:24 +00004938 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004939 if (!m_read_file.IsValid() || !m_write_file.IsValid() || !m_pipe.CanRead() || !m_pipe.CanWrite())
Greg Clayton44d93782014-01-27 23:43:24 +00004940 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004941 SetIsDone(true);
4942 return;
4943 }
4944
4945 SetIsDone(false);
4946 const int read_fd = m_read_file.GetDescriptor();
4947 TerminalState terminal_state;
4948 terminal_state.Save (read_fd, false);
4949 Terminal terminal(read_fd);
4950 terminal.SetCanonical(false);
4951 terminal.SetEcho(false);
Deepak Panickal914b8d92014-01-31 18:48:46 +00004952// FD_ZERO, FD_SET are not supported on windows
Hafiz Abid Qadeer6eff1012014-03-12 10:45:23 +00004953#ifndef _WIN32
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004954 const int pipe_read_fd = m_pipe.GetReadFileDescriptor();
4955 while (!GetIsDone())
4956 {
4957 fd_set read_fdset;
4958 FD_ZERO (&read_fdset);
4959 FD_SET (read_fd, &read_fdset);
4960 FD_SET (pipe_read_fd, &read_fdset);
4961 const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1;
4962 int num_set_fds = select (nfds, &read_fdset, NULL, NULL, NULL);
4963 if (num_set_fds < 0)
4964 {
4965 const int select_errno = errno;
4966
4967 if (select_errno != EINTR)
4968 SetIsDone(true);
4969 }
4970 else if (num_set_fds > 0)
4971 {
4972 char ch = 0;
4973 size_t n;
4974 if (FD_ISSET (read_fd, &read_fdset))
Greg Clayton44d93782014-01-27 23:43:24 +00004975 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004976 n = 1;
4977 if (m_read_file.Read(&ch, n).Success() && n == 1)
Greg Clayton44d93782014-01-27 23:43:24 +00004978 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004979 if (m_write_file.Write(&ch, n).Fail() || n != 1)
Greg Clayton44d93782014-01-27 23:43:24 +00004980 SetIsDone(true);
4981 }
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004982 else
4983 SetIsDone(true);
4984 }
4985 if (FD_ISSET (pipe_read_fd, &read_fdset))
4986 {
4987 size_t bytes_read;
4988 // Consume the interrupt byte
4989 Error error = m_pipe.Read(&ch, 1, bytes_read);
4990 if (error.Success())
Greg Clayton44d93782014-01-27 23:43:24 +00004991 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004992 switch (ch)
Greg Clayton44d93782014-01-27 23:43:24 +00004993 {
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004994 case 'q':
Greg Clayton44d93782014-01-27 23:43:24 +00004995 SetIsDone(true);
Pavel Labathfb7d5b82015-05-28 13:41:08 +00004996 break;
4997 case 'i':
4998 if (StateIsRunningState(m_process->GetState()))
Pavel Labathfcc7f662015-10-07 15:11:11 +00004999 m_process->SendAsyncInterrupt();
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005000 break;
Greg Clayton44d93782014-01-27 23:43:24 +00005001 }
5002 }
5003 }
Greg Clayton44d93782014-01-27 23:43:24 +00005004 }
Greg Clayton44d93782014-01-27 23:43:24 +00005005 }
Pavel Labathfb7d5b82015-05-28 13:41:08 +00005006#endif
5007 terminal_state.Restore();
Greg Clayton44d93782014-01-27 23:43:24 +00005008 }
5009
Pavel Labath44464872015-05-27 12:40:32 +00005010 void
5011 Cancel () override
Greg Clayton44d93782014-01-27 23:43:24 +00005012 {
Greg Clayton19e11352014-02-26 22:47:33 +00005013 char ch = 'q'; // Send 'q' for quit
Zachary Turner0b9d3ee2014-12-17 18:02:19 +00005014 size_t bytes_written = 0;
5015 m_pipe.Write(&ch, 1, bytes_written);
Greg Clayton44d93782014-01-27 23:43:24 +00005016 }
Greg Claytone68f5d62014-02-24 22:50:57 +00005017
Pavel Labath44464872015-05-27 12:40:32 +00005018 bool
5019 Interrupt () override
Greg Claytone68f5d62014-02-24 22:50:57 +00005020 {
Greg Clayton19e11352014-02-26 22:47:33 +00005021 // Do only things that are safe to do in an interrupt context (like in
5022 // a SIGINT handler), like write 1 byte to a file descriptor. This will
5023 // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte
Pavel Labathfcc7f662015-10-07 15:11:11 +00005024 // that was written to the pipe and then call m_process->SendAsyncInterrupt()
5025 // from a much safer location in code.
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00005026 if (m_active)
5027 {
5028 char ch = 'i'; // Send 'i' for interrupt
Zachary Turner0b9d3ee2014-12-17 18:02:19 +00005029 size_t bytes_written = 0;
5030 Error result = m_pipe.Write(&ch, 1, bytes_written);
5031 return result.Success();
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00005032 }
5033 else
5034 {
5035 // This IOHandler might be pushed on the stack, but not being run currently
5036 // so do the right thing if we aren't actively watching for STDIN by sending
5037 // the interrupt to the process. Otherwise the write to the pipe above would
5038 // do nothing. This can happen when the command interpreter is running and
5039 // gets a "expression ...". It will be on the IOHandler thread and sending
5040 // the input is complete to the delegate which will cause the expression to
5041 // run, which will push the process IO handler, but not run it.
5042
5043 if (StateIsRunningState(m_process->GetState()))
5044 {
5045 m_process->SendAsyncInterrupt();
5046 return true;
5047 }
5048 }
5049 return false;
Greg Claytone68f5d62014-02-24 22:50:57 +00005050 }
Greg Clayton44d93782014-01-27 23:43:24 +00005051
Pavel Labath44464872015-05-27 12:40:32 +00005052 void
5053 GotEOF() override
Greg Clayton44d93782014-01-27 23:43:24 +00005054 {
Greg Clayton44d93782014-01-27 23:43:24 +00005055 }
5056
5057protected:
5058 Process *m_process;
5059 File m_read_file; // Read from this file (usually actual STDIN for LLDB
5060 File m_write_file; // Write to this file (usually the master pty for getting io to debuggee)
Greg Clayton100eb932014-07-02 21:10:39 +00005061 Pipe m_pipe;
Greg Clayton44d93782014-01-27 23:43:24 +00005062};
5063
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005064void
Greg Clayton44d93782014-01-27 23:43:24 +00005065Process::SetSTDIOFileDescriptor (int fd)
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005066{
5067 // First set up the Read Thread for reading/handling process I/O
5068
Greg Clayton44d93782014-01-27 23:43:24 +00005069 std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005070
5071 if (conn_ap.get())
5072 {
5073 m_stdio_communication.SetConnection (conn_ap.release());
5074 if (m_stdio_communication.IsConnected())
5075 {
5076 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
5077 m_stdio_communication.StartReadThread();
5078
5079 // Now read thread is set up, set up input reader.
5080
5081 if (!m_process_input_reader.get())
Greg Clayton44d93782014-01-27 23:43:24 +00005082 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005083 }
5084 }
5085}
5086
Greg Claytonb4874f12014-02-28 18:22:24 +00005087bool
Greg Clayton6fea17e2014-03-03 19:15:20 +00005088Process::ProcessIOHandlerIsActive ()
5089{
5090 IOHandlerSP io_handler_sp (m_process_input_reader);
5091 if (io_handler_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00005092 return GetTarget().GetDebugger().IsTopIOHandler (io_handler_sp);
Greg Clayton6fea17e2014-03-03 19:15:20 +00005093 return false;
5094}
5095bool
Greg Clayton44d93782014-01-27 23:43:24 +00005096Process::PushProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005097{
Greg Clayton44d93782014-01-27 23:43:24 +00005098 IOHandlerSP io_handler_sp (m_process_input_reader);
5099 if (io_handler_sp)
5100 {
Pavel Labath44464872015-05-27 12:40:32 +00005101 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
5102 if (log)
5103 log->Printf("Process::%s pushing IO handler", __FUNCTION__);
5104
Greg Clayton44d93782014-01-27 23:43:24 +00005105 io_handler_sp->SetIsDone(false);
Zachary Turner7529df92015-09-01 20:02:29 +00005106 GetTarget().GetDebugger().PushIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00005107 return true;
Greg Clayton44d93782014-01-27 23:43:24 +00005108 }
Greg Claytonb4874f12014-02-28 18:22:24 +00005109 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005110}
5111
Greg Claytonb4874f12014-02-28 18:22:24 +00005112bool
Greg Clayton44d93782014-01-27 23:43:24 +00005113Process::PopProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005114{
Greg Clayton44d93782014-01-27 23:43:24 +00005115 IOHandlerSP io_handler_sp (m_process_input_reader);
5116 if (io_handler_sp)
Zachary Turner7529df92015-09-01 20:02:29 +00005117 return GetTarget().GetDebugger().PopIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00005118 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00005119}
5120
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00005121// The process needs to know about installed plug-ins
Greg Clayton99d0faf2010-11-18 23:32:35 +00005122void
Caroline Tice20bd37f2011-03-10 22:14:10 +00005123Process::SettingsInitialize ()
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005124{
Greg Clayton6920b522012-08-22 18:39:03 +00005125 Thread::SettingsInitialize ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00005126}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005127
Greg Clayton99d0faf2010-11-18 23:32:35 +00005128void
Caroline Tice20bd37f2011-03-10 22:14:10 +00005129Process::SettingsTerminate ()
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00005130{
Greg Clayton6920b522012-08-22 18:39:03 +00005131 Thread::SettingsTerminate ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00005132}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00005133
Jim Inghamc60963c2015-10-12 19:11:03 +00005134namespace
5135{
5136 // RestorePlanState is used to record the "is private", "is master" and "okay to discard" fields of
5137 // the plan we are running, and reset it on Clean or on destruction.
5138 // It will only reset the state once, so you can call Clean and then monkey with the state and it
5139 // won't get reset on you again.
5140
5141 class RestorePlanState
5142 {
5143 public:
5144 RestorePlanState (lldb::ThreadPlanSP thread_plan_sp) :
5145 m_thread_plan_sp(thread_plan_sp),
5146 m_already_reset(false)
5147 {
5148 if (m_thread_plan_sp)
5149 {
5150 m_private = m_thread_plan_sp->GetPrivate();
5151 m_is_master = m_thread_plan_sp->IsMasterPlan();
5152 m_okay_to_discard = m_thread_plan_sp->OkayToDiscard();
5153 }
5154 }
5155
5156 ~RestorePlanState()
5157 {
5158 Clean();
5159 }
5160
5161 void
5162 Clean ()
5163 {
5164 if (!m_already_reset && m_thread_plan_sp)
5165 {
5166 m_already_reset = true;
5167 m_thread_plan_sp->SetPrivate(m_private);
5168 m_thread_plan_sp->SetIsMasterPlan (m_is_master);
5169 m_thread_plan_sp->SetOkayToDiscard(m_okay_to_discard);
5170 }
5171 }
Eugene Zelenko8f30a652015-10-23 18:39:37 +00005172
Jim Inghamc60963c2015-10-12 19:11:03 +00005173 private:
5174 lldb::ThreadPlanSP m_thread_plan_sp;
5175 bool m_already_reset;
5176 bool m_private;
5177 bool m_is_master;
5178 bool m_okay_to_discard;
5179 };
Eugene Zelenko8f30a652015-10-23 18:39:37 +00005180} // anonymous namespace
Jim Inghamc60963c2015-10-12 19:11:03 +00005181
Jim Ingham1624a2d2014-05-05 02:26:40 +00005182ExpressionResults
Jim Inghamf48169b2010-11-30 02:22:11 +00005183Process::RunThreadPlan (ExecutionContext &exe_ctx,
Jim Ingham372787f2012-04-07 00:00:41 +00005184 lldb::ThreadPlanSP &thread_plan_sp,
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005185 const EvaluateExpressionOptions &options,
Jim Inghamf48169b2010-11-30 02:22:11 +00005186 Stream &errors)
5187{
Jim Ingham8646d3c2014-05-05 02:47:44 +00005188 ExpressionResults return_value = eExpressionSetupError;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005189
Jim Ingham77787032011-01-20 02:03:18 +00005190 if (thread_plan_sp.get() == NULL)
5191 {
5192 errors.Printf("RunThreadPlan called with empty thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005193 return eExpressionSetupError;
Jim Ingham77787032011-01-20 02:03:18 +00005194 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005195
Jim Ingham7d7931d2013-03-28 00:05:34 +00005196 if (!thread_plan_sp->ValidatePlan(NULL))
5197 {
5198 errors.Printf ("RunThreadPlan called with an invalid thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005199 return eExpressionSetupError;
Jim Ingham7d7931d2013-03-28 00:05:34 +00005200 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005201
Greg Claytonc14ee322011-09-22 04:58:26 +00005202 if (exe_ctx.GetProcessPtr() != this)
5203 {
5204 errors.Printf("RunThreadPlan called on wrong process.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005205 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00005206 }
5207
5208 Thread *thread = exe_ctx.GetThreadPtr();
5209 if (thread == NULL)
5210 {
5211 errors.Printf("RunThreadPlan called with invalid thread.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005212 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00005213 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005214
Jim Inghamc60963c2015-10-12 19:11:03 +00005215 // We need to change some of the thread plan attributes for the thread plan runner. This will restore them
5216 // when we are done:
5217
5218 RestorePlanState thread_plan_restorer(thread_plan_sp);
5219
Jim Ingham17e5c4e2011-05-17 22:24:54 +00005220 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
5221 // For that to be true the plan can't be private - since private plans suppress themselves in the
5222 // GetCompletedPlan call.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005223
Jim Ingham17e5c4e2011-05-17 22:24:54 +00005224 thread_plan_sp->SetPrivate(false);
Jim Inghamc60963c2015-10-12 19:11:03 +00005225
5226 // The plans run with RunThreadPlan also need to be terminal master plans or when they are done we will end
5227 // up asking the plan above us whether we should stop, which may give the wrong answer.
5228
5229 thread_plan_sp->SetIsMasterPlan (true);
5230 thread_plan_sp->SetOkayToDiscard(false);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005231
Jim Ingham444586b2011-01-24 06:34:17 +00005232 if (m_private_state.GetValue() != eStateStopped)
5233 {
5234 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005235 return eExpressionSetupError;
Jim Ingham444586b2011-01-24 06:34:17 +00005236 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005237
Jim Ingham66243842011-08-13 00:56:10 +00005238 // Save the thread & frame from the exe_ctx for restoration after we run
Greg Claytonc14ee322011-09-22 04:58:26 +00005239 const uint32_t thread_idx_id = thread->GetIndexID();
Jason Molendab57e4a12013-11-04 09:33:30 +00005240 StackFrameSP selected_frame_sp = thread->GetSelectedFrame();
Jim Ingham11b0e052013-02-19 23:22:45 +00005241 if (!selected_frame_sp)
5242 {
5243 thread->SetSelectedFrame(0);
5244 selected_frame_sp = thread->GetSelectedFrame();
5245 if (!selected_frame_sp)
5246 {
5247 errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005248 return eExpressionSetupError;
Jim Ingham11b0e052013-02-19 23:22:45 +00005249 }
5250 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005251
Jim Ingham11b0e052013-02-19 23:22:45 +00005252 StackID ctx_frame_id = selected_frame_sp->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00005253
5254 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
5255 // so we should arrange to reset them as well.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005256
Greg Claytonc14ee322011-09-22 04:58:26 +00005257 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005258
Jim Ingham66243842011-08-13 00:56:10 +00005259 uint32_t selected_tid;
5260 StackID selected_stack_id;
Greg Clayton762f7132011-09-18 18:59:15 +00005261 if (selected_thread_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00005262 {
5263 selected_tid = selected_thread_sp->GetIndexID();
Jim Ingham66243842011-08-13 00:56:10 +00005264 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00005265 }
5266 else
5267 {
5268 selected_tid = LLDB_INVALID_THREAD_ID;
5269 }
5270
Zachary Turner39de3112014-09-09 20:54:56 +00005271 HostThread backup_private_state_thread;
Jason Molenda76513fd2014-10-15 23:39:31 +00005272 lldb::StateType old_state = eStateInvalid;
Jim Ingham076b3042012-04-10 01:21:57 +00005273 lldb::ThreadPlanSP stopper_base_plan_sp;
Jim Ingham372787f2012-04-07 00:00:41 +00005274
Greg Clayton5160ce52013-03-27 23:08:40 +00005275 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Zachary Turner39de3112014-09-09 20:54:56 +00005276 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
Jim Ingham372787f2012-04-07 00:00:41 +00005277 {
Jim Ingham076b3042012-04-10 01:21:57 +00005278 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
5279 // we are the thread that is generating public events.
Jim Ingham372787f2012-04-07 00:00:41 +00005280 // 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 +00005281 // we are fielding public events here.
5282 if (log)
Jason Molendad251c9d2012-11-17 01:41:04 +00005283 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 +00005284
Jim Ingham372787f2012-04-07 00:00:41 +00005285 backup_private_state_thread = m_private_state_thread;
Jim Ingham076b3042012-04-10 01:21:57 +00005286
5287 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
5288 // returning control here.
5289 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
5290 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
5291 // before the plan we want to run. Since base plans always stop and return control to the user, that will
5292 // do just what we want.
5293 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
5294 thread->QueueThreadPlan (stopper_base_plan_sp, false);
5295 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
5296 old_state = m_public_state.GetValue();
5297 m_public_state.SetValueNoLock(eStateStopped);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005298
Jim Ingham076b3042012-04-10 01:21:57 +00005299 // Now spin up the private state thread:
Jim Ingham372787f2012-04-07 00:00:41 +00005300 StartPrivateStateThread(true);
5301 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005302
Jim Ingham372787f2012-04-07 00:00:41 +00005303 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005304
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005305 if (options.GetDebug())
5306 {
5307 // In this case, we aren't actually going to run, we just want to stop right away.
5308 // Flush this thread so we will refetch the stacks and show the correct backtrace.
5309 // FIXME: To make this prettier we should invent some stop reason for this, but that
5310 // is only cosmetic, and this functionality is only of use to lldb developers who can
5311 // live with not pretty...
5312 thread->Flush();
Jim Ingham8646d3c2014-05-05 02:47:44 +00005313 return eExpressionStoppedForDebug;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005314 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005315
Jim Ingham1e7a9ee2011-01-23 21:14:08 +00005316 Listener listener("lldb.process.listener.run-thread-plan");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005317
Sean Callanana46ec452012-07-11 21:31:24 +00005318 lldb::EventSP event_to_broadcast_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005319
Jim Ingham77787032011-01-20 02:03:18 +00005320 {
Sean Callanana46ec452012-07-11 21:31:24 +00005321 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
5322 // restored on exit to the function.
5323 //
5324 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
5325 // is put into event_to_broadcast_sp for rebroadcasting.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005326
Sean Callanana46ec452012-07-11 21:31:24 +00005327 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005328
Jim Inghamf48169b2010-11-30 02:22:11 +00005329 if (log)
Jim Ingham0f16e732011-02-08 05:20:59 +00005330 {
5331 StreamString s;
Sean Callanana46ec452012-07-11 21:31:24 +00005332 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
Daniel Malead01b2952012-11-29 21:49:15 +00005333 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
Sean Callanana46ec452012-07-11 21:31:24 +00005334 thread->GetIndexID(),
5335 thread->GetID(),
5336 s.GetData());
5337 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005338
Sean Callanana46ec452012-07-11 21:31:24 +00005339 bool got_event;
5340 lldb::EventSP event_sp;
5341 lldb::StateType stop_state = lldb::eStateInvalid;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005342
Sean Callanana46ec452012-07-11 21:31:24 +00005343 TimeValue* timeout_ptr = NULL;
5344 TimeValue real_timeout;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005345
Jim Ingham0161b492013-02-09 01:29:05 +00005346 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 +00005347 bool do_resume = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005348 bool handle_running_event = true;
Jim Ingham35e1bda2012-10-16 21:41:58 +00005349 const uint64_t default_one_thread_timeout_usec = 250000;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005350
Jim Ingham0161b492013-02-09 01:29:05 +00005351 // This is just for accounting:
5352 uint32_t num_resumes = 0;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005353
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005354 uint32_t timeout_usec = options.GetTimeoutUsec();
Jim Inghamfd95f892014-04-22 01:41:52 +00005355 uint32_t one_thread_timeout_usec;
5356 uint32_t all_threads_timeout_usec = 0;
Jim Inghamfe1c3422014-04-16 02:24:48 +00005357
5358 // If we are going to run all threads the whole time, or if we are only going to run one thread,
5359 // then we don't need the first timeout. So we set the final timeout, and pretend we are after the
5360 // first timeout already.
5361
5362 if (!options.GetStopOthers() || !options.GetTryAllThreads())
Jim Ingham286fb1e2014-02-28 02:52:06 +00005363 {
5364 before_first_timeout = false;
Jim Inghamfd95f892014-04-22 01:41:52 +00005365 one_thread_timeout_usec = 0;
5366 all_threads_timeout_usec = timeout_usec;
Jim Ingham286fb1e2014-02-28 02:52:06 +00005367 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00005368 else
Jim Ingham0161b492013-02-09 01:29:05 +00005369 {
Jim Inghamfd95f892014-04-22 01:41:52 +00005370 uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005371
Jim Ingham914f4e72014-03-28 21:58:28 +00005372 // If the overall wait is forever, then we only need to set the one thread timeout:
5373 if (timeout_usec == 0)
5374 {
Ed Maste801335c2014-03-31 19:28:14 +00005375 if (option_one_thread_timeout != 0)
Jim Inghamfd95f892014-04-22 01:41:52 +00005376 one_thread_timeout_usec = option_one_thread_timeout;
Jim Ingham914f4e72014-03-28 21:58:28 +00005377 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005378 one_thread_timeout_usec = default_one_thread_timeout_usec;
Jim Ingham914f4e72014-03-28 21:58:28 +00005379 }
Jim Ingham0161b492013-02-09 01:29:05 +00005380 else
5381 {
Jim Ingham914f4e72014-03-28 21:58:28 +00005382 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout,
5383 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec.
5384 uint64_t computed_one_thread_timeout;
5385 if (option_one_thread_timeout != 0)
5386 {
5387 if (timeout_usec < option_one_thread_timeout)
5388 {
5389 errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005390 return eExpressionSetupError;
Jim Ingham914f4e72014-03-28 21:58:28 +00005391 }
5392 computed_one_thread_timeout = option_one_thread_timeout;
5393 }
5394 else
5395 {
5396 computed_one_thread_timeout = timeout_usec / 2;
5397 if (computed_one_thread_timeout > default_one_thread_timeout_usec)
5398 computed_one_thread_timeout = default_one_thread_timeout_usec;
5399 }
Jim Inghamfd95f892014-04-22 01:41:52 +00005400 one_thread_timeout_usec = computed_one_thread_timeout;
5401 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec;
Jim Ingham0161b492013-02-09 01:29:05 +00005402 }
Jim Ingham0161b492013-02-09 01:29:05 +00005403 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00005404
5405 if (log)
Jim Inghamfd95f892014-04-22 01:41:52 +00005406 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 +00005407 options.GetStopOthers(),
5408 options.GetTryAllThreads(),
Jim Inghamfd95f892014-04-22 01:41:52 +00005409 before_first_timeout,
5410 one_thread_timeout_usec,
5411 all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005412
Jim Ingham1460e4b2014-01-10 23:46:59 +00005413 // This isn't going to work if there are unfetched events on the queue.
5414 // Are there cases where we might want to run the remaining events here, and then try to
5415 // call the function? That's probably being too tricky for our own good.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005416
Jim Ingham1460e4b2014-01-10 23:46:59 +00005417 Event *other_events = listener.PeekAtNextEvent();
5418 if (other_events != NULL)
5419 {
5420 errors.Printf("Calling RunThreadPlan with pending events on the queue.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005421 return eExpressionSetupError;
Jim Ingham1460e4b2014-01-10 23:46:59 +00005422 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005423
Jim Ingham1460e4b2014-01-10 23:46:59 +00005424 // We also need to make sure that the next event is delivered. We might be calling a function as part of
5425 // a thread plan, in which case the last delivered event could be the running event, and we don't want
5426 // event coalescing to cause us to lose OUR running event...
5427 ForceNextEventDelivery();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005428
Jim Ingham8559a352012-11-26 23:52:18 +00005429 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
5430 // So don't call return anywhere within it.
Jim Ingham35878c42014-04-08 21:33:21 +00005431
5432#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5433 // It's pretty much impossible to write test cases for things like:
5434 // One thread timeout expires, I go to halt, but the process already stopped
5435 // on the function call stop breakpoint. Turning on this define will make us not
5436 // fetch the first event till after the halt. So if you run a quick function, it will have
5437 // completed, and the completion event will be waiting, when you interrupt for halt.
5438 // The expression evaluation should still succeed.
5439 bool miss_first_event = true;
5440#endif
Jim Inghamfd95f892014-04-22 01:41:52 +00005441 TimeValue one_thread_timeout;
5442 TimeValue final_timeout;
Eugene Zelenko8f30a652015-10-23 18:39:37 +00005443
Sean Callanana46ec452012-07-11 21:31:24 +00005444 while (1)
5445 {
5446 // We usually want to resume the process if we get to the top of the loop.
5447 // The only exception is if we get two running events with no intervening
5448 // stop, which can happen, we will just wait for then next stop event.
Jim Ingham0161b492013-02-09 01:29:05 +00005449 if (log)
5450 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.",
5451 do_resume,
5452 handle_running_event,
5453 before_first_timeout);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005454
Jim Ingham184e9812013-01-15 02:47:48 +00005455 if (do_resume || handle_running_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005456 {
5457 // Do the initial resume and wait for the running event before going further.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005458
Jim Ingham184e9812013-01-15 02:47:48 +00005459 if (do_resume)
Sean Callanana46ec452012-07-11 21:31:24 +00005460 {
Jim Ingham0161b492013-02-09 01:29:05 +00005461 num_resumes++;
Jim Ingham184e9812013-01-15 02:47:48 +00005462 Error resume_error = PrivateResume ();
5463 if (!resume_error.Success())
5464 {
Jim Ingham0161b492013-02-09 01:29:05 +00005465 errors.Printf("Error resuming inferior the %d time: \"%s\".\n",
5466 num_resumes,
5467 resume_error.AsCString());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005468 return_value = eExpressionSetupError;
Jim Ingham184e9812013-01-15 02:47:48 +00005469 break;
5470 }
Sean Callanana46ec452012-07-11 21:31:24 +00005471 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005472
Jim Ingham0161b492013-02-09 01:29:05 +00005473 TimeValue resume_timeout = TimeValue::Now();
5474 resume_timeout.OffsetWithMicroSeconds(500000);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005475
Jim Ingham0161b492013-02-09 01:29:05 +00005476 got_event = listener.WaitForEvent(&resume_timeout, event_sp);
Sean Callanana46ec452012-07-11 21:31:24 +00005477 if (!got_event)
5478 {
5479 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005480 log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.",
5481 num_resumes);
Sean Callanana46ec452012-07-11 21:31:24 +00005482
Jim Ingham0161b492013-02-09 01:29:05 +00005483 errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005484 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005485 break;
5486 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005487
Sean Callanana46ec452012-07-11 21:31:24 +00005488 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Ingham0161b492013-02-09 01:29:05 +00005489
Sean Callanana46ec452012-07-11 21:31:24 +00005490 if (stop_state != eStateRunning)
5491 {
Jim Ingham0161b492013-02-09 01:29:05 +00005492 bool restarted = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005493
Jim Ingham0161b492013-02-09 01:29:05 +00005494 if (stop_state == eStateStopped)
5495 {
5496 restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get());
5497 if (log)
5498 log->Printf("Process::RunThreadPlan(): didn't get running event after "
5499 "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).",
5500 num_resumes,
5501 StateAsCString(stop_state),
5502 restarted,
5503 do_resume,
5504 handle_running_event);
5505 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005506
Jim Ingham0161b492013-02-09 01:29:05 +00005507 if (restarted)
5508 {
5509 // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted
5510 // event here. But if I do, the best thing is to Halt and then get out of here.
Pavel Labath19da1f12015-12-07 12:36:52 +00005511 const bool clear_thread_plans = false;
5512 const bool use_run_lock = false;
5513 Halt(clear_thread_plans, use_run_lock);
Jim Ingham0161b492013-02-09 01:29:05 +00005514 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005515
Jim Ingham35e1bda2012-10-16 21:41:58 +00005516 errors.Printf("Didn't get running event after initial resume, got %s instead.",
5517 StateAsCString(stop_state));
Jim Ingham8646d3c2014-05-05 02:47:44 +00005518 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005519 break;
5520 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005521
Sean Callanana46ec452012-07-11 21:31:24 +00005522 if (log)
5523 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
5524 // We need to call the function synchronously, so spin waiting for it to return.
5525 // If we get interrupted while executing, we're going to lose our context, and
5526 // won't be able to gather the result at this point.
5527 // We set the timeout AFTER the resume, since the resume takes some time and we
5528 // don't want to charge that to the timeout.
Sean Callanana46ec452012-07-11 21:31:24 +00005529 }
Jim Ingham0f16e732011-02-08 05:20:59 +00005530 else
5531 {
Sean Callanana46ec452012-07-11 21:31:24 +00005532 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005533 log->PutCString ("Process::RunThreadPlan(): waiting for next event.");
Jim Ingham0f16e732011-02-08 05:20:59 +00005534 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005535
Jim Ingham0161b492013-02-09 01:29:05 +00005536 if (before_first_timeout)
5537 {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005538 if (options.GetTryAllThreads())
Jim Inghamfd95f892014-04-22 01:41:52 +00005539 {
5540 one_thread_timeout = TimeValue::Now();
5541 one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005542 timeout_ptr = &one_thread_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005543 }
Jim Ingham0161b492013-02-09 01:29:05 +00005544 else
5545 {
5546 if (timeout_usec == 0)
5547 timeout_ptr = NULL;
5548 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005549 {
5550 final_timeout = TimeValue::Now();
5551 final_timeout.OffsetWithMicroSeconds (timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005552 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005553 }
Jim Ingham0161b492013-02-09 01:29:05 +00005554 }
5555 }
5556 else
5557 {
5558 if (timeout_usec == 0)
5559 timeout_ptr = NULL;
5560 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005561 {
5562 final_timeout = TimeValue::Now();
5563 final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005564 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005565 }
Jim Ingham0161b492013-02-09 01:29:05 +00005566 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005567
Jim Ingham0161b492013-02-09 01:29:05 +00005568 do_resume = true;
5569 handle_running_event = true;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005570
Sean Callanana46ec452012-07-11 21:31:24 +00005571 // Now wait for the process to stop again:
Sean Callanana46ec452012-07-11 21:31:24 +00005572 event_sp.reset();
Jim Ingham0f16e732011-02-08 05:20:59 +00005573
Jim Ingham0f16e732011-02-08 05:20:59 +00005574 if (log)
Jim Ingham20829ac2011-08-09 22:24:33 +00005575 {
Sean Callanana46ec452012-07-11 21:31:24 +00005576 if (timeout_ptr)
5577 {
Matt Kopec676a4872013-02-21 23:55:31 +00005578 log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64,
Jim Ingham0161b492013-02-09 01:29:05 +00005579 TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(),
5580 timeout_ptr->GetAsMicroSecondsSinceJan1_1970());
Sean Callanana46ec452012-07-11 21:31:24 +00005581 }
Jim Ingham20829ac2011-08-09 22:24:33 +00005582 else
Sean Callanana46ec452012-07-11 21:31:24 +00005583 {
5584 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
5585 }
5586 }
Jim Ingham35878c42014-04-08 21:33:21 +00005587
5588#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5589 // See comment above...
5590 if (miss_first_event)
5591 {
5592 usleep(1000);
5593 miss_first_event = false;
5594 got_event = false;
5595 }
5596 else
5597#endif
Sean Callanana46ec452012-07-11 21:31:24 +00005598 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005599
Sean Callanana46ec452012-07-11 21:31:24 +00005600 if (got_event)
5601 {
5602 if (event_sp.get())
5603 {
5604 bool keep_going = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005605 if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005606 {
Pavel Labath19da1f12015-12-07 12:36:52 +00005607 const bool clear_thread_plans = false;
5608 const bool use_run_lock = false;
5609 Halt(clear_thread_plans, use_run_lock);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005610 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005611 errors.Printf ("Execution halted by user interrupt.");
5612 if (log)
5613 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
Jim Ingham0161b492013-02-09 01:29:05 +00005614 break;
Jim Inghamcfc09352012-07-27 23:57:19 +00005615 }
5616 else
5617 {
5618 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5619 if (log)
5620 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005621
Jim Inghamcfc09352012-07-27 23:57:19 +00005622 switch (stop_state)
Sean Callanana46ec452012-07-11 21:31:24 +00005623 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005624 case lldb::eStateStopped:
Sean Callanana46ec452012-07-11 21:31:24 +00005625 {
Jim Ingham0161b492013-02-09 01:29:05 +00005626 // We stopped, figure out what we are going to do now.
Jim Inghamcfc09352012-07-27 23:57:19 +00005627 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
5628 if (!thread_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005629 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005630 // Ooh, our thread has vanished. Unlikely that this was successful execution...
Sean Callanana46ec452012-07-11 21:31:24 +00005631 if (log)
Jim Inghamcfc09352012-07-27 23:57:19 +00005632 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005633 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005634 }
5635 else
5636 {
Jim Ingham0161b492013-02-09 01:29:05 +00005637 // If we were restarted, we just need to go back up to fetch another event.
5638 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
Jim Inghamcfc09352012-07-27 23:57:19 +00005639 {
5640 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005641 {
5642 log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting.");
5643 }
5644 keep_going = true;
5645 do_resume = false;
5646 handle_running_event = true;
Jim Inghamcfc09352012-07-27 23:57:19 +00005647 }
5648 else
5649 {
Jim Ingham0161b492013-02-09 01:29:05 +00005650 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
5651 StopReason stop_reason = eStopReasonInvalid;
5652 if (stop_info_sp)
5653 stop_reason = stop_info_sp->GetStopReason();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005654
Jim Ingham0161b492013-02-09 01:29:05 +00005655 // FIXME: We only check if the stop reason is plan complete, should we make sure that
5656 // it is OUR plan that is complete?
5657 if (stop_reason == eStopReasonPlanComplete)
Jim Ingham184e9812013-01-15 02:47:48 +00005658 {
5659 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005660 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
Jim Inghamc60963c2015-10-12 19:11:03 +00005661
5662 // Restore the plan state so it will get reported as intended when we are done.
5663 thread_plan_restorer.Clean();
5664
Jim Ingham8646d3c2014-05-05 02:47:44 +00005665 return_value = eExpressionCompleted;
Jim Ingham184e9812013-01-15 02:47:48 +00005666 }
5667 else
5668 {
Jim Ingham0161b492013-02-09 01:29:05 +00005669 // Something restarted the target, so just wait for it to stop for real.
Jim Ingham184e9812013-01-15 02:47:48 +00005670 if (stop_reason == eStopReasonBreakpoint)
Jim Ingham0161b492013-02-09 01:29:05 +00005671 {
5672 if (log)
5673 log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005674 return_value = eExpressionHitBreakpoint;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005675 if (!options.DoesIgnoreBreakpoints())
Sean Callanan4b388c92013-07-30 19:54:09 +00005676 {
Jim Inghamc60963c2015-10-12 19:11:03 +00005677 // Restore the plan state and then force Private to false. We are
5678 // going to stop because of this plan so we need it to become a public
5679 // plan or it won't report correctly when we continue to its termination
5680 // later on.
5681 thread_plan_restorer.Clean();
5682 if (thread_plan_sp)
5683 thread_plan_sp->SetPrivate(false);
Sean Callanan4b388c92013-07-30 19:54:09 +00005684 event_to_broadcast_sp = event_sp;
5685 }
Jim Ingham0161b492013-02-09 01:29:05 +00005686 }
Jim Ingham184e9812013-01-15 02:47:48 +00005687 else
Jim Ingham0161b492013-02-09 01:29:05 +00005688 {
5689 if (log)
5690 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005691 if (!options.DoesUnwindOnError())
Sean Callanan4b388c92013-07-30 19:54:09 +00005692 event_to_broadcast_sp = event_sp;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005693 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005694 }
Jim Ingham184e9812013-01-15 02:47:48 +00005695 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005696 }
Sean Callanana46ec452012-07-11 21:31:24 +00005697 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005698 }
5699 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005700
Jim Inghamcfc09352012-07-27 23:57:19 +00005701 case lldb::eStateRunning:
Jim Ingham0161b492013-02-09 01:29:05 +00005702 // This shouldn't really happen, but sometimes we do get two running events without an
5703 // intervening stop, and in that case we should just go back to waiting for the stop.
Jim Inghamcfc09352012-07-27 23:57:19 +00005704 do_resume = false;
5705 keep_going = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005706 handle_running_event = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005707 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005708
Jim Inghamcfc09352012-07-27 23:57:19 +00005709 default:
5710 if (log)
5711 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005712
Jim Inghamcfc09352012-07-27 23:57:19 +00005713 if (stop_state == eStateExited)
5714 event_to_broadcast_sp = event_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005715
Sean Callananbf154da2012-08-08 17:35:10 +00005716 errors.Printf ("Execution stopped with unexpected state.\n");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005717 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005718 break;
5719 }
Sean Callanana46ec452012-07-11 21:31:24 +00005720 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005721
Sean Callanana46ec452012-07-11 21:31:24 +00005722 if (keep_going)
5723 continue;
5724 else
5725 break;
5726 }
5727 else
5728 {
5729 if (log)
5730 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005731 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005732 break;
5733 }
5734 }
5735 else
5736 {
5737 // If we didn't get an event that means we've timed out...
5738 // We will interrupt the process here. Depending on what we were asked to do we will
5739 // either exit, or try with all threads running for the same timeout.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005740
Sean Callanana46ec452012-07-11 21:31:24 +00005741 if (log) {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005742 if (options.GetTryAllThreads())
Sean Callanana46ec452012-07-11 21:31:24 +00005743 {
Jim Ingham0161b492013-02-09 01:29:05 +00005744 if (before_first_timeout)
Jim Inghamfe1c3422014-04-16 02:24:48 +00005745 {
5746 if (timeout_usec != 0)
5747 {
Jim Inghamfe1c3422014-04-16 02:24:48 +00005748 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Jim Inghamfd95f892014-04-22 01:41:52 +00005749 "running for %" PRIu32 " usec with all threads enabled.",
5750 all_threads_timeout_usec);
Jim Inghamfe1c3422014-04-16 02:24:48 +00005751 }
5752 else
5753 {
5754 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Ed Mastee61c7b02014-04-29 17:48:06 +00005755 "running forever with all threads enabled.");
Jim Inghamfe1c3422014-04-16 02:24:48 +00005756 }
5757 }
Sean Callanana46ec452012-07-11 21:31:24 +00005758 else
5759 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
Jason Molenda6a8658a2013-10-27 02:32:23 +00005760 "and timeout: %u timed out, abandoning execution.",
Jim Ingham35e1bda2012-10-16 21:41:58 +00005761 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005762 }
5763 else
Jason Molenda6a8658a2013-10-27 02:32:23 +00005764 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, "
Jim Ingham35e1bda2012-10-16 21:41:58 +00005765 "abandoning execution.",
5766 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005767 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005768
Jim Ingham0161b492013-02-09 01:29:05 +00005769 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target
5770 // could have stopped. That's fine, Halt will figure that out and send the appropriate Stopped event.
5771 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.) In
5772 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's
5773 // stopped event. That's what this while loop does.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005774
Jim Ingham0161b492013-02-09 01:29:05 +00005775 bool back_to_top = true;
5776 uint32_t try_halt_again = 0;
5777 bool do_halt = true;
5778 const uint32_t num_retries = 5;
5779 while (try_halt_again < num_retries)
Sean Callanana46ec452012-07-11 21:31:24 +00005780 {
Jim Ingham0161b492013-02-09 01:29:05 +00005781 Error halt_error;
5782 if (do_halt)
5783 {
5784 if (log)
5785 log->Printf ("Process::RunThreadPlan(): Running Halt.");
Pavel Labath19da1f12015-12-07 12:36:52 +00005786 const bool clear_thread_plans = false;
5787 const bool use_run_lock = false;
5788 Halt(clear_thread_plans, use_run_lock);
Jim Ingham0161b492013-02-09 01:29:05 +00005789 }
5790 if (halt_error.Success())
5791 {
5792 if (log)
5793 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005794
Jim Ingham0161b492013-02-09 01:29:05 +00005795 real_timeout = TimeValue::Now();
5796 real_timeout.OffsetWithMicroSeconds(500000);
5797
5798 got_event = listener.WaitForEvent(&real_timeout, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005799
Jim Ingham0161b492013-02-09 01:29:05 +00005800 if (got_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005801 {
Jim Ingham0161b492013-02-09 01:29:05 +00005802 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5803 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00005804 {
Jim Ingham0161b492013-02-09 01:29:05 +00005805 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
5806 if (stop_state == lldb::eStateStopped
5807 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
5808 log->PutCString (" Event was the Halt interruption event.");
Sean Callanana46ec452012-07-11 21:31:24 +00005809 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005810
Jim Ingham0161b492013-02-09 01:29:05 +00005811 if (stop_state == lldb::eStateStopped)
Sean Callanana46ec452012-07-11 21:31:24 +00005812 {
Jim Ingham0161b492013-02-09 01:29:05 +00005813 // Between the time we initiated the Halt and the time we delivered it, the process could have
5814 // already finished its job. Check that here:
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005815
Jim Ingham0161b492013-02-09 01:29:05 +00005816 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
5817 {
5818 if (log)
5819 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
5820 "Exiting wait loop.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005821 return_value = eExpressionCompleted;
Jim Ingham0161b492013-02-09 01:29:05 +00005822 back_to_top = false;
5823 break;
5824 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005825
Jim Ingham0161b492013-02-09 01:29:05 +00005826 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5827 {
5828 if (log)
5829 log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again... "
5830 "Exiting wait loop.");
5831 try_halt_again++;
5832 do_halt = false;
5833 continue;
5834 }
Sean Callanana46ec452012-07-11 21:31:24 +00005835
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005836 if (!options.GetTryAllThreads())
Jim Ingham0161b492013-02-09 01:29:05 +00005837 {
5838 if (log)
5839 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005840 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005841 back_to_top = false;
5842 break;
5843 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005844
Jim Ingham0161b492013-02-09 01:29:05 +00005845 if (before_first_timeout)
5846 {
5847 // Set all the other threads to run, and return to the top of the loop, which will continue;
5848 before_first_timeout = false;
5849 thread_plan_sp->SetStopOthers (false);
5850 if (log)
5851 log->PutCString ("Process::RunThreadPlan(): about to resume.");
Sean Callanana46ec452012-07-11 21:31:24 +00005852
Jim Ingham0161b492013-02-09 01:29:05 +00005853 back_to_top = true;
5854 break;
5855 }
5856 else
5857 {
5858 // Running all threads failed, so return Interrupted.
5859 if (log)
5860 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005861 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005862 back_to_top = false;
5863 break;
5864 }
Sean Callanana46ec452012-07-11 21:31:24 +00005865 }
5866 }
5867 else
Jim Ingham0161b492013-02-09 01:29:05 +00005868 { if (log)
5869 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
5870 "I'm getting out of here passing Interrupted.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005871 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005872 back_to_top = false;
5873 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005874 }
5875 }
Jim Ingham0161b492013-02-09 01:29:05 +00005876 else
5877 {
5878 try_halt_again++;
5879 continue;
5880 }
Sean Callanana46ec452012-07-11 21:31:24 +00005881 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005882
Jim Ingham0161b492013-02-09 01:29:05 +00005883 if (!back_to_top || try_halt_again > num_retries)
5884 break;
5885 else
5886 continue;
Sean Callanana46ec452012-07-11 21:31:24 +00005887 }
Sean Callanana46ec452012-07-11 21:31:24 +00005888 } // END WAIT LOOP
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005889
Sean Callanana46ec452012-07-11 21:31:24 +00005890 // 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 +00005891 if (backup_private_state_thread.IsJoinable())
Sean Callanana46ec452012-07-11 21:31:24 +00005892 {
5893 StopPrivateStateThread();
5894 Error error;
5895 m_private_state_thread = backup_private_state_thread;
Sean Callanan9a028512012-08-09 00:50:26 +00005896 if (stopper_base_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005897 {
5898 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
5899 }
Jason Molenda76513fd2014-10-15 23:39:31 +00005900 if (old_state != eStateInvalid)
5901 m_public_state.SetValueNoLock(old_state);
Sean Callanana46ec452012-07-11 21:31:24 +00005902 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005903
Jim Inghamc60963c2015-10-12 19:11:03 +00005904 if (return_value != eExpressionCompleted && log)
5905 {
5906 // Print a backtrace into the log so we can figure out where we are:
5907 StreamString s;
5908 s.PutCString("Thread state after unsuccessful completion: \n");
5909 thread->GetStackFrameStatus (s,
5910 0,
5911 UINT32_MAX,
5912 true,
5913 UINT32_MAX);
5914 log->PutCString(s.GetData());
5915
5916 }
Jim Ingham184e9812013-01-15 02:47:48 +00005917 // Restore the thread state if we are going to discard the plan execution. There are three cases where this
5918 // could happen:
5919 // 1) The execution successfully completed
5920 // 2) We hit a breakpoint, and ignore_breakpoints was true
5921 // 3) We got some other error, and discard_on_error was true
Jim Ingham8646d3c2014-05-05 02:47:44 +00005922 bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError())
5923 || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints());
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005924
Jim Ingham8646d3c2014-05-05 02:47:44 +00005925 if (return_value == eExpressionCompleted
Jim Ingham184e9812013-01-15 02:47:48 +00005926 || should_unwind)
Jim Ingham8559a352012-11-26 23:52:18 +00005927 {
5928 thread_plan_sp->RestoreThreadState();
5929 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005930
Sean Callanana46ec452012-07-11 21:31:24 +00005931 // Now do some processing on the results of the run:
Jim Ingham8646d3c2014-05-05 02:47:44 +00005932 if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint)
Sean Callanana46ec452012-07-11 21:31:24 +00005933 {
5934 if (log)
5935 {
5936 StreamString s;
5937 if (event_sp)
5938 event_sp->Dump (&s);
5939 else
5940 {
5941 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
5942 }
5943
5944 StreamString ts;
5945
5946 const char *event_explanation = NULL;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005947
Sean Callanana46ec452012-07-11 21:31:24 +00005948 do
5949 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005950 if (!event_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005951 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005952 event_explanation = "<no event>";
Sean Callanana46ec452012-07-11 21:31:24 +00005953 break;
5954 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005955 else if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005956 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005957 event_explanation = "<user interrupt>";
Sean Callanana46ec452012-07-11 21:31:24 +00005958 break;
5959 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005960 else
Sean Callanana46ec452012-07-11 21:31:24 +00005961 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005962 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
5963
5964 if (!event_data)
Sean Callanana46ec452012-07-11 21:31:24 +00005965 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005966 event_explanation = "<no event data>";
5967 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005968 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005969
Jim Inghamcfc09352012-07-27 23:57:19 +00005970 Process *process = event_data->GetProcessSP().get();
5971
5972 if (!process)
Sean Callanana46ec452012-07-11 21:31:24 +00005973 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005974 event_explanation = "<no process>";
5975 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005976 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005977
Jim Inghamcfc09352012-07-27 23:57:19 +00005978 ThreadList &thread_list = process->GetThreadList();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005979
Jim Inghamcfc09352012-07-27 23:57:19 +00005980 uint32_t num_threads = thread_list.GetSize();
5981 uint32_t thread_index;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005982
Jim Inghamcfc09352012-07-27 23:57:19 +00005983 ts.Printf("<%u threads> ", num_threads);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005984
Jim Inghamcfc09352012-07-27 23:57:19 +00005985 for (thread_index = 0;
5986 thread_index < num_threads;
5987 ++thread_index)
5988 {
5989 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005990
Jim Inghamcfc09352012-07-27 23:57:19 +00005991 if (!thread)
5992 {
5993 ts.Printf("<?> ");
5994 continue;
5995 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005996
Daniel Malead01b2952012-11-29 21:49:15 +00005997 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00005998 RegisterContext *register_context = thread->GetRegisterContext().get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005999
Jim Inghamcfc09352012-07-27 23:57:19 +00006000 if (register_context)
Daniel Malead01b2952012-11-29 21:49:15 +00006001 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
Jim Inghamcfc09352012-07-27 23:57:19 +00006002 else
6003 ts.Printf("[ip unknown] ");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006004
Jim Inghamc60963c2015-10-12 19:11:03 +00006005 // Show the private stop info here, the public stop info will be from the last natural stop.
6006 lldb::StopInfoSP stop_info_sp = thread->GetPrivateStopInfo();
Jim Inghamcfc09352012-07-27 23:57:19 +00006007 if (stop_info_sp)
6008 {
6009 const char *stop_desc = stop_info_sp->GetDescription();
6010 if (stop_desc)
6011 ts.PutCString (stop_desc);
6012 }
6013 ts.Printf(">");
6014 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006015
Jim Inghamcfc09352012-07-27 23:57:19 +00006016 event_explanation = ts.GetData();
Sean Callanana46ec452012-07-11 21:31:24 +00006017 }
Sean Callanana46ec452012-07-11 21:31:24 +00006018 } while (0);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006019
Jim Inghamcfc09352012-07-27 23:57:19 +00006020 if (event_explanation)
6021 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
Sean Callanana46ec452012-07-11 21:31:24 +00006022 else
Jim Inghamcfc09352012-07-27 23:57:19 +00006023 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
6024 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006025
Jim Inghame4483cf2013-09-27 01:13:01 +00006026 if (should_unwind)
Jim Inghamcfc09352012-07-27 23:57:19 +00006027 {
6028 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006029 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.",
6030 static_cast<void*>(thread_plan_sp.get()));
Jim Inghamcfc09352012-07-27 23:57:19 +00006031 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Inghamcfc09352012-07-27 23:57:19 +00006032 }
6033 else
6034 {
6035 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006036 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.",
6037 static_cast<void*>(thread_plan_sp.get()));
Sean Callanana46ec452012-07-11 21:31:24 +00006038 }
6039 }
Jim Ingham8646d3c2014-05-05 02:47:44 +00006040 else if (return_value == eExpressionSetupError)
Sean Callanana46ec452012-07-11 21:31:24 +00006041 {
6042 if (log)
6043 log->PutCString("Process::RunThreadPlan(): execution set up error.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006044
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006045 if (options.DoesUnwindOnError())
Jim Ingham0f16e732011-02-08 05:20:59 +00006046 {
Greg Claytonc14ee322011-09-22 04:58:26 +00006047 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Ingham0f16e732011-02-08 05:20:59 +00006048 }
Jim Inghamf48169b2010-11-30 02:22:11 +00006049 }
6050 else
6051 {
Sean Callanana46ec452012-07-11 21:31:24 +00006052 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
Jim Inghamf48169b2010-11-30 02:22:11 +00006053 {
Jim Ingham0f16e732011-02-08 05:20:59 +00006054 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00006055 log->PutCString("Process::RunThreadPlan(): thread plan is done");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006056 return_value = eExpressionCompleted;
Sean Callanana46ec452012-07-11 21:31:24 +00006057 }
6058 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
6059 {
6060 if (log)
6061 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
Jim Ingham8646d3c2014-05-05 02:47:44 +00006062 return_value = eExpressionDiscarded;
Sean Callanana46ec452012-07-11 21:31:24 +00006063 }
6064 else
6065 {
6066 if (log)
6067 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006068 if (options.DoesUnwindOnError() && thread_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00006069 {
6070 if (log)
Jim Ingham184e9812013-01-15 02:47:48 +00006071 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
Sean Callanana46ec452012-07-11 21:31:24 +00006072 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Sean Callanana46ec452012-07-11 21:31:24 +00006073 }
6074 }
6075 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006076
Sean Callanana46ec452012-07-11 21:31:24 +00006077 // Thread we ran the function in may have gone away because we ran the target
6078 // Check that it's still there, and if it is put it back in the context. Also restore the
6079 // frame in the context if it is still present.
6080 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
6081 if (thread)
6082 {
6083 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
6084 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006085
Sean Callanana46ec452012-07-11 21:31:24 +00006086 // Also restore the current process'es selected frame & thread, since this function calling may
6087 // be done behind the user's back.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006088
Sean Callanana46ec452012-07-11 21:31:24 +00006089 if (selected_tid != LLDB_INVALID_THREAD_ID)
6090 {
6091 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
6092 {
6093 // We were able to restore the selected thread, now restore the frame:
Daniel Maleaa012d3a2013-07-31 20:21:20 +00006094 Mutex::Locker lock(GetThreadList().GetMutex());
Jason Molendab57e4a12013-11-04 09:33:30 +00006095 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
Sean Callanana46ec452012-07-11 21:31:24 +00006096 if (old_frame_sp)
6097 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
Jim Inghamf48169b2010-11-30 02:22:11 +00006098 }
Jim Inghamf48169b2010-11-30 02:22:11 +00006099 }
6100 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006101
Sean Callanana46ec452012-07-11 21:31:24 +00006102 // If the process exited during the run of the thread plan, notify everyone.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006103
Sean Callanana46ec452012-07-11 21:31:24 +00006104 if (event_to_broadcast_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00006105 {
Sean Callanana46ec452012-07-11 21:31:24 +00006106 if (log)
6107 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
6108 BroadcastEvent(event_to_broadcast_sp);
Jim Inghamf48169b2010-11-30 02:22:11 +00006109 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00006110
Jim Inghamf48169b2010-11-30 02:22:11 +00006111 return return_value;
6112}
6113
6114const char *
Jim Ingham1624a2d2014-05-05 02:26:40 +00006115Process::ExecutionResultAsCString (ExpressionResults result)
Jim Inghamf48169b2010-11-30 02:22:11 +00006116{
6117 const char *result_name;
6118
6119 switch (result)
6120 {
Jim Ingham8646d3c2014-05-05 02:47:44 +00006121 case eExpressionCompleted:
6122 result_name = "eExpressionCompleted";
Jim Inghamf48169b2010-11-30 02:22:11 +00006123 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006124 case eExpressionDiscarded:
6125 result_name = "eExpressionDiscarded";
Jim Inghamf48169b2010-11-30 02:22:11 +00006126 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006127 case eExpressionInterrupted:
6128 result_name = "eExpressionInterrupted";
Jim Inghamf48169b2010-11-30 02:22:11 +00006129 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006130 case eExpressionHitBreakpoint:
6131 result_name = "eExpressionHitBreakpoint";
Jim Ingham184e9812013-01-15 02:47:48 +00006132 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006133 case eExpressionSetupError:
6134 result_name = "eExpressionSetupError";
Jim Inghamf48169b2010-11-30 02:22:11 +00006135 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006136 case eExpressionParseError:
6137 result_name = "eExpressionParseError";
Jim Ingham1624a2d2014-05-05 02:26:40 +00006138 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006139 case eExpressionResultUnavailable:
6140 result_name = "eExpressionResultUnavailable";
Jim Ingham1624a2d2014-05-05 02:26:40 +00006141 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006142 case eExpressionTimedOut:
6143 result_name = "eExpressionTimedOut";
Jim Inghamf48169b2010-11-30 02:22:11 +00006144 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00006145 case eExpressionStoppedForDebug:
6146 result_name = "eExpressionStoppedForDebug";
Jim Ingham6fbc48b2013-11-07 00:11:47 +00006147 break;
Jim Inghamf48169b2010-11-30 02:22:11 +00006148 }
6149 return result_name;
6150}
6151
Greg Clayton7260f622011-04-18 08:33:37 +00006152void
6153Process::GetStatus (Stream &strm)
6154{
6155 const StateType state = GetState();
Greg Clayton2637f822011-11-17 01:23:07 +00006156 if (StateIsStoppedState(state, false))
Greg Clayton7260f622011-04-18 08:33:37 +00006157 {
6158 if (state == eStateExited)
6159 {
6160 int exit_status = GetExitStatus();
6161 const char *exit_description = GetExitDescription();
Daniel Malead01b2952012-11-29 21:49:15 +00006162 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
Greg Clayton7260f622011-04-18 08:33:37 +00006163 GetID(),
6164 exit_status,
6165 exit_status,
6166 exit_description ? exit_description : "");
6167 }
6168 else
6169 {
6170 if (state == eStateConnected)
6171 strm.Printf ("Connected to remote target.\n");
6172 else
Daniel Malead01b2952012-11-29 21:49:15 +00006173 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
Greg Clayton7260f622011-04-18 08:33:37 +00006174 }
6175 }
6176 else
6177 {
Daniel Malead01b2952012-11-29 21:49:15 +00006178 strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
Greg Clayton7260f622011-04-18 08:33:37 +00006179 }
6180}
6181
6182size_t
6183Process::GetThreadStatus (Stream &strm,
6184 bool only_threads_with_stop_reason,
6185 uint32_t start_frame,
6186 uint32_t num_frames,
6187 uint32_t num_frames_with_source)
6188{
6189 size_t num_thread_infos_dumped = 0;
6190
Jim Ingham4a65fb12014-03-07 11:20:03 +00006191 // You can't hold the thread list lock while calling Thread::GetStatus. That very well might run code (e.g. if we need it
6192 // to get return values or arguments.) For that to work the process has to be able to acquire it. So instead copy the thread
6193 // ID's, and look them up one by one:
6194
6195 uint32_t num_threads;
Greg Clayton332e8b12015-01-13 21:13:08 +00006196 std::vector<lldb::tid_t> thread_id_array;
Jim Ingham4a65fb12014-03-07 11:20:03 +00006197 //Scope for thread list locker;
6198 {
6199 Mutex::Locker locker (GetThreadList().GetMutex());
6200 ThreadList &curr_thread_list = GetThreadList();
6201 num_threads = curr_thread_list.GetSize();
6202 uint32_t idx;
Greg Clayton332e8b12015-01-13 21:13:08 +00006203 thread_id_array.resize(num_threads);
Jim Ingham4a65fb12014-03-07 11:20:03 +00006204 for (idx = 0; idx < num_threads; ++idx)
Greg Clayton332e8b12015-01-13 21:13:08 +00006205 thread_id_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID();
Jim Ingham4a65fb12014-03-07 11:20:03 +00006206 }
6207
Greg Clayton7260f622011-04-18 08:33:37 +00006208 for (uint32_t i = 0; i < num_threads; i++)
6209 {
Greg Clayton332e8b12015-01-13 21:13:08 +00006210 ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_id_array[i]));
Jim Ingham4a65fb12014-03-07 11:20:03 +00006211 if (thread_sp)
Greg Clayton7260f622011-04-18 08:33:37 +00006212 {
6213 if (only_threads_with_stop_reason)
6214 {
Jim Ingham4a65fb12014-03-07 11:20:03 +00006215 StopInfoSP stop_info_sp = thread_sp->GetStopInfo();
Jim Ingham5d88a062012-10-16 00:09:33 +00006216 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
Greg Clayton7260f622011-04-18 08:33:37 +00006217 continue;
6218 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00006219 thread_sp->GetStatus (strm,
Greg Clayton7260f622011-04-18 08:33:37 +00006220 start_frame,
6221 num_frames,
6222 num_frames_with_source);
6223 ++num_thread_infos_dumped;
6224 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00006225 else
6226 {
6227 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
6228 if (log)
6229 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus.");
Jim Ingham4a65fb12014-03-07 11:20:03 +00006230 }
Greg Clayton7260f622011-04-18 08:33:37 +00006231 }
6232 return num_thread_infos_dumped;
6233}
6234
Greg Claytona9f40ad2012-02-22 04:37:26 +00006235void
6236Process::AddInvalidMemoryRegion (const LoadRange &region)
6237{
6238 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
6239}
6240
6241bool
6242Process::RemoveInvalidMemoryRange (const LoadRange &region)
6243{
6244 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
6245}
6246
Jim Ingham372787f2012-04-07 00:00:41 +00006247void
6248Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
6249{
6250 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
6251}
6252
6253bool
6254Process::RunPreResumeActions ()
6255{
6256 bool result = true;
6257 while (!m_pre_resume_actions.empty())
6258 {
6259 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
6260 m_pre_resume_actions.pop_back();
6261 bool this_result = action.callback (action.baton);
Jason Molenda55710932014-11-17 20:10:15 +00006262 if (result == true)
6263 result = this_result;
Jim Ingham372787f2012-04-07 00:00:41 +00006264 }
6265 return result;
6266}
6267
6268void
6269Process::ClearPreResumeActions ()
6270{
6271 m_pre_resume_actions.clear();
6272}
Greg Claytona9f40ad2012-02-22 04:37:26 +00006273
Zachary Turner93749ab2015-03-03 21:51:25 +00006274ProcessRunLock &
6275Process::GetRunLock()
6276{
6277 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
6278 return m_private_run_lock;
6279 else
6280 return m_public_run_lock;
6281}
6282
Greg Claytonfa559e52012-05-18 02:38:05 +00006283void
6284Process::Flush ()
6285{
6286 m_thread_list.Flush();
Jason Molenda5e8dce42013-12-13 00:29:16 +00006287 m_extended_thread_list.Flush();
6288 m_extended_thread_stop_id = 0;
6289 m_queue_list.Clear();
6290 m_queue_list_stop_id = 0;
Greg Claytonfa559e52012-05-18 02:38:05 +00006291}
Greg Clayton90ba8112012-12-05 00:16:59 +00006292
6293void
6294Process::DidExec ()
6295{
Todd Fiala76e0fc92014-08-27 22:58:26 +00006296 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
6297 if (log)
6298 log->Printf ("Process::%s()", __FUNCTION__);
6299
Greg Clayton90ba8112012-12-05 00:16:59 +00006300 Target &target = GetTarget();
6301 target.CleanupProcess ();
Greg Claytonb35db632013-11-09 00:03:31 +00006302 target.ClearModules(false);
Greg Clayton90ba8112012-12-05 00:16:59 +00006303 m_dynamic_checkers_ap.reset();
6304 m_abi_sp.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00006305 m_system_runtime_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00006306 m_os_ap.reset();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006307 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00006308 m_jit_loaders_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00006309 m_image_tokens.clear();
6310 m_allocated_memory_cache.Clear();
6311 m_language_runtimes.clear();
Kuba Breckaafdf8422014-10-10 23:43:03 +00006312 m_instrumentation_runtimes.clear();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006313 m_thread_list.DiscardThreadPlans();
Greg Clayton15fc2be2013-05-21 01:00:52 +00006314 m_memory_cache.Clear(true);
Greg Claytona97c4d22014-12-09 23:31:02 +00006315 m_stop_info_override_callback = NULL;
Greg Clayton90ba8112012-12-05 00:16:59 +00006316 DoDidExec();
6317 CompleteAttach ();
Greg Clayton095eeaa2013-11-05 23:28:00 +00006318 // Flush the process (threads and all stack frames) after running CompleteAttach()
6319 // in case the dynamic loader loaded things in new locations.
6320 Flush();
Greg Claytonb35db632013-11-09 00:03:31 +00006321
6322 // After we figure out what was loaded/unloaded in CompleteAttach,
6323 // we need to let the target know so it can do any cleanup it needs to.
6324 target.DidExec();
Greg Clayton90ba8112012-12-05 00:16:59 +00006325}
Greg Clayton095eeaa2013-11-05 23:28:00 +00006326
Jim Ingham1460e4b2014-01-10 23:46:59 +00006327addr_t
6328Process::ResolveIndirectFunction(const Address *address, Error &error)
6329{
6330 if (address == nullptr)
6331 {
Jean-Daniel Dupasef37711f2014-02-08 20:22:05 +00006332 error.SetErrorString("Invalid address argument");
Jim Ingham1460e4b2014-01-10 23:46:59 +00006333 return LLDB_INVALID_ADDRESS;
6334 }
6335
6336 addr_t function_addr = LLDB_INVALID_ADDRESS;
6337
6338 addr_t addr = address->GetLoadAddress(&GetTarget());
6339 std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr);
6340 if (iter != m_resolved_indirect_addresses.end())
6341 {
6342 function_addr = (*iter).second;
6343 }
6344 else
6345 {
6346 if (!InferiorCall(this, address, function_addr))
6347 {
6348 Symbol *symbol = address->CalculateSymbolContextSymbol();
6349 error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s",
6350 symbol ? symbol->GetName().AsCString() : "<UNKNOWN>");
6351 function_addr = LLDB_INVALID_ADDRESS;
6352 }
6353 else
6354 {
6355 m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr));
6356 }
6357 }
6358 return function_addr;
6359}
6360
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006361void
6362Process::ModulesDidLoad (ModuleList &module_list)
6363{
Kuba Breckaafdf8422014-10-10 23:43:03 +00006364 SystemRuntime *sys_runtime = GetSystemRuntime();
6365 if (sys_runtime)
6366 {
6367 sys_runtime->ModulesDidLoad (module_list);
6368 }
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006369
Kuba Breckaafdf8422014-10-10 23:43:03 +00006370 GetJITLoaders().ModulesDidLoad (module_list);
6371
6372 // Give runtimes a chance to be created.
6373 InstrumentationRuntime::ModulesDidLoad(module_list, this, m_instrumentation_runtimes);
6374
6375 // Tell runtimes about new modules.
6376 for (auto pos = m_instrumentation_runtimes.begin(); pos != m_instrumentation_runtimes.end(); ++pos)
6377 {
6378 InstrumentationRuntimeSP runtime = pos->second;
6379 runtime->ModulesDidLoad(module_list);
6380 }
6381
Greg Clayton35ca64b2015-04-16 17:13:34 +00006382 // Let any language runtimes we have already created know
6383 // about the modules that loaded.
6384
6385 // Iterate over a copy of this language runtime list in case
6386 // the language runtime ModulesDidLoad somehow causes the language
6387 // riuntime to be unloaded.
6388 LanguageRuntimeCollection language_runtimes(m_language_runtimes);
6389 for (const auto &pair: language_runtimes)
6390 {
6391 // We must check language_runtime_sp to make sure it is not
6392 // NULL as we might cache the fact that we didn't have a
6393 // language runtime for a language.
6394 LanguageRuntimeSP language_runtime_sp = pair.second;
6395 if (language_runtime_sp)
6396 language_runtime_sp->ModulesDidLoad(module_list);
6397 }
Ryan Brown65d4d5c2015-09-16 21:20:44 +00006398
6399 LoadOperatingSystemPlugin(false);
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00006400}
Kuba Breckaa51ea382014-09-06 01:33:13 +00006401
Jason Molendaef7d6412015-08-06 03:27:10 +00006402void
Sean Callanan77decf52015-12-09 01:25:01 +00006403Process::PrintWarning (uint64_t warning_type, const void *repeat_key, const char *fmt, ...)
Jason Molendaef7d6412015-08-06 03:27:10 +00006404{
6405 bool print_warning = true;
6406
6407 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
6408 if (stream_sp.get() == nullptr)
6409 return;
6410 if (warning_type == eWarningsOptimization
6411 && GetWarningsOptimization() == false)
6412 {
6413 return;
6414 }
6415
6416 if (repeat_key != nullptr)
6417 {
6418 WarningsCollection::iterator it = m_warnings_issued.find (warning_type);
6419 if (it == m_warnings_issued.end())
6420 {
6421 m_warnings_issued[warning_type] = WarningsPointerSet();
6422 m_warnings_issued[warning_type].insert (repeat_key);
6423 }
6424 else
6425 {
6426 if (it->second.find (repeat_key) != it->second.end())
6427 {
6428 print_warning = false;
6429 }
6430 else
6431 {
6432 it->second.insert (repeat_key);
6433 }
6434 }
6435 }
6436
6437 if (print_warning)
6438 {
6439 va_list args;
6440 va_start (args, fmt);
6441 stream_sp->PrintfVarArg (fmt, args);
6442 va_end (args);
6443 }
6444}
6445
Jason Molenda484900b2015-08-10 07:55:25 +00006446void
6447Process::PrintWarningOptimization (const SymbolContext &sc)
6448{
6449 if (GetWarningsOptimization() == true
6450 && sc.module_sp.get()
6451 && sc.module_sp->GetFileSpec().GetFilename().IsEmpty() == false
6452 && sc.function
6453 && sc.function->GetIsOptimized() == true)
6454 {
6455 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());
6456 }
6457}
6458
Kuba Breckaa51ea382014-09-06 01:33:13 +00006459ThreadCollectionSP
6460Process::GetHistoryThreads(lldb::addr_t addr)
6461{
6462 ThreadCollectionSP threads;
Greg Clayton35ca64b2015-04-16 17:13:34 +00006463
Kuba Breckaa51ea382014-09-06 01:33:13 +00006464 const MemoryHistorySP &memory_history = MemoryHistory::FindPlugin(shared_from_this());
6465
6466 if (! memory_history.get()) {
6467 return threads;
6468 }
6469
6470 threads.reset(new ThreadCollection(memory_history->GetHistoryThreads(addr)));
6471
6472 return threads;
6473}
Kuba Brecka63927542014-10-11 01:59:32 +00006474
6475InstrumentationRuntimeSP
6476Process::GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type)
6477{
6478 InstrumentationRuntimeCollection::iterator pos;
6479 pos = m_instrumentation_runtimes.find (type);
6480 if (pos == m_instrumentation_runtimes.end())
6481 {
6482 return InstrumentationRuntimeSP();
6483 }
6484 else
6485 return (*pos).second;
6486}
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +00006487
6488bool
6489Process::GetModuleSpec(const FileSpec& module_file_spec,
6490 const ArchSpec& arch,
6491 ModuleSpec& module_spec)
6492{
6493 module_spec.Clear();
6494 return false;
6495}
Tamas Berghammer3cb132a2015-12-02 11:58:51 +00006496
6497size_t
6498Process::AddImageToken(lldb::addr_t image_ptr)
6499{
6500 m_image_tokens.push_back(image_ptr);
6501 return m_image_tokens.size() - 1;
6502}
6503
6504lldb::addr_t
6505Process::GetImagePtrFromToken(size_t token) const
6506{
6507 if (token < m_image_tokens.size())
6508 return m_image_tokens[token];
6509 return LLDB_INVALID_IMAGE_TOKEN;
6510}
6511
6512void
6513Process::ResetImageToken(size_t token)
6514{
6515 if (token < m_image_tokens.size())
6516 m_image_tokens[token] = LLDB_INVALID_IMAGE_TOKEN;
Enrico Granataf3129cb2015-12-03 23:53:45 +00006517}