1 //===-- Process.cpp ---------------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 // C Includes
11 // C++ Includes
12 // Other libraries and framework includes
13 // Project includes
14 #include "lldb/Target/Process.h"
15 #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"
20 #include "lldb/Core/Module.h"
21 #include "lldb/Core/ModuleSpec.h"
22 #include "lldb/Core/PluginManager.h"
23 #include "lldb/Core/State.h"
24 #include "lldb/Core/StreamFile.h"
25 #include "lldb/Expression/UserExpression.h"
26 #include "lldb/Expression/IRDynamicChecks.h"
27 #include "lldb/Host/ConnectionFileDescriptor.h"
28 #include "lldb/Host/FileSystem.h"
29 #include "lldb/Host/Host.h"
30 #include "lldb/Host/HostInfo.h"
31 #include "lldb/Host/Pipe.h"
32 #include "lldb/Host/Terminal.h"
33 #include "lldb/Host/ThreadLauncher.h"
34 #include "lldb/Interpreter/CommandInterpreter.h"
35 #include "lldb/Interpreter/OptionValueProperties.h"
36 #include "lldb/Symbol/Function.h"
37 #include "lldb/Symbol/Symbol.h"
38 #include "lldb/Target/ABI.h"
39 #include "lldb/Target/DynamicLoader.h"
40 #include "lldb/Target/InstrumentationRuntime.h"
41 #include "lldb/Target/JITLoader.h"
42 #include "lldb/Target/JITLoaderList.h"
43 #include "lldb/Target/MemoryHistory.h"
44 #include "lldb/Target/MemoryRegionInfo.h"
45 #include "lldb/Target/OperatingSystem.h"
46 #include "lldb/Target/LanguageRuntime.h"
47 #include "lldb/Target/CPPLanguageRuntime.h"
48 #include "lldb/Target/ObjCLanguageRuntime.h"
49 #include "lldb/Target/Platform.h"
50 #include "lldb/Target/RegisterContext.h"
51 #include "lldb/Target/StopInfo.h"
52 #include "lldb/Target/SystemRuntime.h"
53 #include "lldb/Target/Target.h"
54 #include "lldb/Target/TargetList.h"
55 #include "lldb/Target/Thread.h"
56 #include "lldb/Target/ThreadPlan.h"
57 #include "lldb/Target/ThreadPlanBase.h"
58 #include "lldb/Target/UnixSignals.h"
59 #include "lldb/Utility/NameMatches.h"
60 #include "Plugins/Process/Utility/InferiorCallPOSIX.h"
61 
62 using namespace lldb;
63 using namespace lldb_private;
64 
65 // 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 
75 class ProcessOptionValueProperties : public OptionValueProperties
76 {
77 public:
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 
91     const Property *
92     GetPropertyAtIndex(const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const override
93     {
94         // When getting the value for a key from the process options, we will always
95         // 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 
111 static PropertyDefinition
112 g_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." },
115     { "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;\"" },
117     { "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." },
119     { "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." },
120     { "stop-on-sharedlibrary-events" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, stop when a shared library is loaded or unloaded." },
121     { "detach-keeps-stopped" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, detach will attempt to keep the process stopped." },
122     { "memory-cache-line-size" , OptionValue::eTypeUInt64, false, 512, NULL, NULL, "The memory cache line size" },
123     { "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." },
124     {  NULL                  , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL  }
125 };
126 
127 enum {
128     ePropertyDisableMemCache,
129     ePropertyExtraStartCommand,
130     ePropertyIgnoreBreakpointsInExpressions,
131     ePropertyUnwindOnErrorInExpressions,
132     ePropertyPythonOSPluginPath,
133     ePropertyStopOnSharedLibraryEvents,
134     ePropertyDetachKeepsStopped,
135     ePropertyMemCacheLineSize,
136     ePropertyWarningOptimization
137 };
138 
139 ProcessProperties::ProcessProperties (lldb_private::Process *process) :
140     Properties (),
141     m_process (process) // Can be NULL for global ProcessProperties
142 {
143     if (process == NULL)
144     {
145         // Global process properties, set them up one time
146         m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
147         m_collection_sp->Initialize(g_properties);
148         m_collection_sp->AppendProperty(ConstString("thread"),
149                                         ConstString("Settings specific to threads."),
150                                         true,
151                                         Thread::GetGlobalProperties()->GetValueProperties());
152     }
153     else
154     {
155         m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
156         m_collection_sp->SetValueChangedCallback(ePropertyPythonOSPluginPath, ProcessProperties::OptionValueChangedCallback, this);
157     }
158 }
159 
160 ProcessProperties::~ProcessProperties() = default;
161 
162 void
163 ProcessProperties::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 
170 bool
171 ProcessProperties::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 
177 uint64_t
178 ProcessProperties::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 
184 Args
185 ProcessProperties::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 
193 void
194 ProcessProperties::SetExtraStartupCommands (const Args &args)
195 {
196     const uint32_t idx = ePropertyExtraStartCommand;
197     m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
198 }
199 
200 FileSpec
201 ProcessProperties::GetPythonOSPluginPath () const
202 {
203     const uint32_t idx = ePropertyPythonOSPluginPath;
204     return m_collection_sp->GetPropertyAtIndexAsFileSpec(NULL, idx);
205 }
206 
207 void
208 ProcessProperties::SetPythonOSPluginPath (const FileSpec &file)
209 {
210     const uint32_t idx = ePropertyPythonOSPluginPath;
211     m_collection_sp->SetPropertyAtIndexAsFileSpec(NULL, idx, file);
212 }
213 
214 bool
215 ProcessProperties::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 
221 void
222 ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore)
223 {
224     const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
225     m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
226 }
227 
228 bool
229 ProcessProperties::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 
235 void
236 ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore)
237 {
238     const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
239     m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
240 }
241 
242 bool
243 ProcessProperties::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 
249 void
250 ProcessProperties::SetStopOnSharedLibraryEvents (bool stop)
251 {
252     const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
253     m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
254 }
255 
256 bool
257 ProcessProperties::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 
263 void
264 ProcessProperties::SetDetachKeepsStopped (bool stop)
265 {
266     const uint32_t idx = ePropertyDetachKeepsStopped;
267     m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
268 }
269 
270 bool
271 ProcessProperties::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 
277 void
278 ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
279 {
280     const char *cstr;
281     if (m_pid != LLDB_INVALID_PROCESS_ID)
282         s.Printf ("    pid = %" PRIu64 "\n", m_pid);
283 
284     if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
285         s.Printf (" parent = %" PRIu64 "\n", m_parent_pid);
286 
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     }
294     const uint32_t argc = m_arguments.GetArgumentCount();
295     if (argc > 0)
296     {
297         for (uint32_t i=0; i<argc; i++)
298         {
299             const char *arg = m_arguments.GetArgumentAtIndex(i);
300             if (i < 10)
301                 s.Printf (" arg[%u] = %s\n", i, arg);
302             else
303                 s.Printf ("arg[%u] = %s\n", i, arg);
304         }
305     }
306 
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 
320     if (m_arch.IsValid())
321     {
322         s.Printf ("   arch = ");
323         m_arch.DumpTriple(s);
324         s.EOL();
325     }
326 
327     if (m_uid != UINT32_MAX)
328     {
329         cstr = platform->GetUserName (m_uid);
330         s.Printf ("    uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
331     }
332     if (m_gid != UINT32_MAX)
333     {
334         cstr = platform->GetGroupName (m_gid);
335         s.Printf ("    gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
336     }
337     if (m_euid != UINT32_MAX)
338     {
339         cstr = platform->GetUserName (m_euid);
340         s.Printf ("   euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
341     }
342     if (m_egid != UINT32_MAX)
343     {
344         cstr = platform->GetGroupName (m_egid);
345         s.Printf ("   egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
346     }
347 }
348 
349 void
350 ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
351 {
352     const char *label;
353     if (show_args || verbose)
354         label = "ARGUMENTS";
355     else
356         label = "NAME";
357 
358     if (verbose)
359     {
360         s.Printf     ("PID    PARENT USER       GROUP      EFF USER   EFF GROUP  TRIPLE                   %s\n", label);
361         s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
362     }
363     else
364     {
365         s.Printf     ("PID    PARENT USER       TRIPLE                   %s\n", label);
366         s.PutCString ("====== ====== ========== ======================== ============================\n");
367     }
368 }
369 
370 void
371 ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
372 {
373     if (m_pid != LLDB_INVALID_PROCESS_ID)
374     {
375         const char *cstr;
376         s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid);
377 
378         StreamString arch_strm;
379         if (m_arch.IsValid())
380             m_arch.DumpTriple(arch_strm);
381 
382         if (verbose)
383         {
384             cstr = platform->GetUserName (m_uid);
385             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
386                 s.Printf ("%-10s ", cstr);
387             else
388                 s.Printf ("%-10u ", m_uid);
389 
390             cstr = platform->GetGroupName (m_gid);
391             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
392                 s.Printf ("%-10s ", cstr);
393             else
394                 s.Printf ("%-10u ", m_gid);
395 
396             cstr = platform->GetUserName (m_euid);
397             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
398                 s.Printf ("%-10s ", cstr);
399             else
400                 s.Printf ("%-10u ", m_euid);
401 
402             cstr = platform->GetGroupName (m_egid);
403             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
404                 s.Printf ("%-10s ", cstr);
405             else
406                 s.Printf ("%-10u ", m_egid);
407 
408             s.Printf ("%-24s ", arch_strm.GetString().c_str());
409         }
410         else
411         {
412             s.Printf ("%-10s %-24s ",
413                       platform->GetUserName (m_euid),
414                       arch_strm.GetString().c_str());
415         }
416 
417         if (verbose || show_args)
418         {
419             const uint32_t argc = m_arguments.GetArgumentCount();
420             if (argc > 0)
421             {
422                 for (uint32_t i=0; i<argc; i++)
423                 {
424                     if (i > 0)
425                         s.PutChar (' ');
426                     s.PutCString (m_arguments.GetArgumentAtIndex(i));
427                 }
428             }
429         }
430         else
431         {
432             s.PutCString (GetName());
433         }
434 
435         s.EOL();
436     }
437 }
438 
439 Error
440 ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
441 {
442     Error error;
443     const int short_option = m_getopt_table[option_idx].val;
444 
445     switch (short_option)
446     {
447         case 's':   // Stop at program entry point
448             launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
449             break;
450 
451         case 'i':   // STDIN for read only
452         {
453             FileAction action;
454             if (action.Open(STDIN_FILENO, FileSpec{option_arg, false}, true, false))
455                 launch_info.AppendFileAction (action);
456             break;
457         }
458 
459         case 'o':   // Open STDOUT for write only
460         {
461             FileAction action;
462             if (action.Open(STDOUT_FILENO, FileSpec{option_arg, false}, false, true))
463                 launch_info.AppendFileAction (action);
464             break;
465         }
466 
467         case 'e':   // STDERR for write only
468         {
469             FileAction action;
470             if (action.Open(STDERR_FILENO, FileSpec{option_arg, false}, false, true))
471                 launch_info.AppendFileAction (action);
472             break;
473         }
474 
475         case 'p':   // Process plug-in name
476             launch_info.SetProcessPluginName (option_arg);
477             break;
478 
479         case 'n':   // Disable STDIO
480         {
481             FileAction action;
482             const FileSpec dev_null{FileSystem::DEV_NULL, false};
483             if (action.Open(STDIN_FILENO, dev_null, true, false))
484                 launch_info.AppendFileAction (action);
485             if (action.Open(STDOUT_FILENO, dev_null, false, true))
486                 launch_info.AppendFileAction (action);
487             if (action.Open(STDERR_FILENO, dev_null, false, true))
488                 launch_info.AppendFileAction (action);
489             break;
490         }
491 
492         case 'w':
493             launch_info.SetWorkingDirectory(FileSpec{option_arg, false});
494             break;
495 
496         case 't':   // Open process in new terminal window
497             launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
498             break;
499 
500         case 'a':
501             if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
502                 launch_info.GetArchitecture().SetTriple (option_arg);
503             break;
504 
505         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>");
513             break;
514         }
515 
516         case 'X':   // shell expand args.
517         {
518             bool success;
519             const bool expand_args = Args::StringToBoolean (option_arg, true, &success);
520             if (success)
521                 launch_info.SetShellExpandArguments(expand_args);
522             else
523                 error.SetErrorStringWithFormat ("Invalid boolean value for shell-expand-args option: '%s'", option_arg ? option_arg : "<null>");
524             break;
525         }
526 
527         case 'c':
528             if (option_arg && option_arg[0])
529                 launch_info.SetShell (FileSpec(option_arg, false));
530             else
531                 launch_info.SetShell (HostInfo::GetDefaultShell());
532             break;
533 
534         case 'v':
535             launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
536             break;
537 
538         default:
539             error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
540             break;
541     }
542     return error;
543 }
544 
545 OptionDefinition
546 ProcessLaunchCommandOptions::g_option_table[] =
547 {
548 { 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."},
549 { 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."},
550 { 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."},
554 { 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)."},
555 
556 { 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>."},
559 
560 { LLDB_OPT_SET_2  , false, "tty",           't', OptionParser::eNoArgument,       NULL, NULL, 0, eArgTypeNone,    "Start the process in a terminal (not supported on all platforms)."},
561 
562 { 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."},
563 { 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."},
564 { 0               , false, NULL,             0,  0,                 NULL, NULL, 0, eArgTypeNone,    NULL }
565 };
566 
567 bool
568 ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
569 {
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 
579 bool
580 ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
581 {
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 
593     if (m_match_info.UserIDIsValid () &&
594         m_match_info.GetUserID() != proc_info.GetUserID())
595         return false;
596 
597     if (m_match_info.GroupIDIsValid () &&
598         m_match_info.GetGroupID() != proc_info.GetGroupID())
599         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() &&
610         !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture()))
611         return false;
612     return true;
613 }
614 
615 bool
616 ProcessInstanceInfoMatch::MatchAllProcesses () const
617 {
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 
627     if (m_match_info.UserIDIsValid ())
628         return false;
629 
630     if (m_match_info.GroupIDIsValid ())
631         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;
646 }
647 
648 void
649 ProcessInstanceInfoMatch::Clear()
650 {
651     m_match_info.Clear();
652     m_name_match_type = eNameMatchIgnore;
653     m_match_all_users = false;
654 }
655 
656 ProcessSP
657 Process::FindPlugin (lldb::TargetSP target_sp, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
658 {
659     static uint32_t g_process_unique_id = 0;
660 
661     ProcessSP process_sp;
662     ProcessCreateInstance create_callback = NULL;
663     if (plugin_name)
664     {
665         ConstString const_plugin_name(plugin_name);
666         create_callback  = PluginManager::GetProcessCreateCallbackForPluginName (const_plugin_name);
667         if (create_callback)
668         {
669             process_sp = create_callback(target_sp, listener, crash_file_path);
670             if (process_sp)
671             {
672                 if (process_sp->CanDebug(target_sp, true))
673                 {
674                     process_sp->m_process_unique_id = ++g_process_unique_id;
675                 }
676                 else
677                     process_sp.reset();
678             }
679         }
680     }
681     else
682     {
683         for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
684         {
685             process_sp = create_callback(target_sp, listener, crash_file_path);
686             if (process_sp)
687             {
688                 if (process_sp->CanDebug(target_sp, false))
689                 {
690                     process_sp->m_process_unique_id = ++g_process_unique_id;
691                     break;
692                 }
693                 else
694                     process_sp.reset();
695             }
696         }
697     }
698     return process_sp;
699 }
700 
701 ConstString &
702 Process::GetStaticBroadcasterClass ()
703 {
704     static ConstString class_name ("lldb.process");
705     return class_name;
706 }
707 
708 Process::Process(lldb::TargetSP target_sp, Listener &listener) :
709     Process(target_sp, listener, UnixSignals::Create(HostInfo::GetArchitecture()))
710 {
711     // This constructor just delegates to the full Process constructor,
712     // defaulting to using the Host's UnixSignals.
713 }
714 
715 Process::Process(lldb::TargetSP target_sp, Listener &listener, const UnixSignalsSP &unix_signals_sp) :
716     ProcessProperties (this),
717     UserID (LLDB_INVALID_PROCESS_ID),
718     Broadcaster (&(target_sp->GetDebugger()), Process::GetStaticBroadcasterClass().AsCString()),
719     m_target_sp (target_sp),
720     m_public_state (eStateUnloaded),
721     m_private_state (eStateUnloaded),
722     m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
723     m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
724     m_private_state_listener ("lldb.process.internal_state_listener"),
725     m_private_state_control_wait(),
726     m_mod_id (),
727     m_process_unique_id(0),
728     m_thread_index_id (0),
729     m_thread_id_to_index_id_map (),
730     m_exit_status (-1),
731     m_exit_string (),
732     m_exit_status_mutex(),
733     m_thread_mutex (Mutex::eMutexTypeRecursive),
734     m_thread_list_real (this),
735     m_thread_list (this),
736     m_extended_thread_list (this),
737     m_extended_thread_stop_id (0),
738     m_queue_list (this),
739     m_queue_list_stop_id (0),
740     m_notifications (),
741     m_image_tokens (),
742     m_listener (listener),
743     m_breakpoint_site_list (),
744     m_dynamic_checkers_ap (),
745     m_unix_signals_sp (unix_signals_sp),
746     m_abi_sp (),
747     m_process_input_reader (),
748     m_stdio_communication ("process.stdio"),
749     m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
750     m_stdin_forward (false),
751     m_stdout_data (),
752     m_stderr_data (),
753     m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive),
754     m_profile_data (),
755     m_iohandler_sync (0),
756     m_memory_cache (*this),
757     m_allocated_memory_cache (*this),
758     m_should_detach (false),
759     m_next_event_action_ap(),
760     m_public_run_lock (),
761     m_private_run_lock (),
762     m_currently_handling_event(false),
763     m_stop_info_override_callback (NULL),
764     m_finalizing (false),
765     m_finalize_called (false),
766     m_clear_thread_plans_on_stop (false),
767     m_force_next_event_delivery (false),
768     m_last_broadcast_state (eStateInvalid),
769     m_destroy_in_process (false),
770     m_can_interpret_function_calls(false),
771     m_warnings_issued (),
772     m_can_jit(eCanJITDontKnow)
773 {
774     CheckInWithManager ();
775 
776     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
777     if (log)
778         log->Printf ("%p Process::Process()", static_cast<void*>(this));
779 
780     if (!m_unix_signals_sp)
781         m_unix_signals_sp = std::make_shared<UnixSignals>();
782 
783     SetEventName (eBroadcastBitStateChanged, "state-changed");
784     SetEventName (eBroadcastBitInterrupt, "interrupt");
785     SetEventName (eBroadcastBitSTDOUT, "stdout-available");
786     SetEventName (eBroadcastBitSTDERR, "stderr-available");
787     SetEventName (eBroadcastBitProfileData, "profile-data-available");
788 
789     m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop  , "control-stop"  );
790     m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
791     m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
792 
793     listener.StartListeningForEvents (this,
794                                       eBroadcastBitStateChanged |
795                                       eBroadcastBitInterrupt |
796                                       eBroadcastBitSTDOUT |
797                                       eBroadcastBitSTDERR |
798                                       eBroadcastBitProfileData);
799 
800     m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
801                                                      eBroadcastBitStateChanged |
802                                                      eBroadcastBitInterrupt);
803 
804     m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
805                                                      eBroadcastInternalStateControlStop |
806                                                      eBroadcastInternalStateControlPause |
807                                                      eBroadcastInternalStateControlResume);
808     // We need something valid here, even if just the default UnixSignalsSP.
809     assert (m_unix_signals_sp && "null m_unix_signals_sp after initialization");
810 
811     // Allow the platform to override the default cache line size
812     OptionValueSP value_sp =
813         m_collection_sp->GetPropertyAtIndex(nullptr, true, ePropertyMemCacheLineSize)->GetValue();
814     uint32_t platform_cache_line_size = target_sp->GetPlatform()->GetDefaultMemoryCacheLineSize();
815     if (! value_sp->OptionWasSet() && platform_cache_line_size != 0)
816         value_sp->SetUInt64Value(platform_cache_line_size);
817 }
818 
819 Process::~Process()
820 {
821     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
822     if (log)
823         log->Printf ("%p Process::~Process()", static_cast<void*>(this));
824     StopPrivateStateThread();
825 
826     // ThreadList::Clear() will try to acquire this process's mutex, so
827     // explicitly clear the thread list here to ensure that the mutex
828     // is not destroyed before the thread list.
829     m_thread_list.Clear();
830 }
831 
832 const ProcessPropertiesSP &
833 Process::GetGlobalProperties()
834 {
835     static ProcessPropertiesSP g_settings_sp;
836     if (!g_settings_sp)
837         g_settings_sp.reset (new ProcessProperties (NULL));
838     return g_settings_sp;
839 }
840 
841 void
842 Process::Finalize()
843 {
844     m_finalizing = true;
845 
846     // Destroy this process if needed
847     switch (GetPrivateState())
848     {
849         case eStateConnected:
850         case eStateAttaching:
851         case eStateLaunching:
852         case eStateStopped:
853         case eStateRunning:
854         case eStateStepping:
855         case eStateCrashed:
856         case eStateSuspended:
857             Destroy(false);
858             break;
859 
860         case eStateInvalid:
861         case eStateUnloaded:
862         case eStateDetached:
863         case eStateExited:
864             break;
865     }
866 
867     // Clear our broadcaster before we proceed with destroying
868     Broadcaster::Clear();
869 
870     // Do any cleanup needed prior to being destructed... Subclasses
871     // that override this method should call this superclass method as well.
872 
873     // We need to destroy the loader before the derived Process class gets destroyed
874     // since it is very likely that undoing the loader will require access to the real process.
875     m_dynamic_checkers_ap.reset();
876     m_abi_sp.reset();
877     m_os_ap.reset();
878     m_system_runtime_ap.reset();
879     m_dyld_ap.reset();
880     m_jit_loaders_ap.reset();
881     m_thread_list_real.Destroy();
882     m_thread_list.Destroy();
883     m_extended_thread_list.Destroy();
884     m_queue_list.Clear();
885     m_queue_list_stop_id = 0;
886     std::vector<Notifications> empty_notifications;
887     m_notifications.swap(empty_notifications);
888     m_image_tokens.clear();
889     m_memory_cache.Clear();
890     m_allocated_memory_cache.Clear();
891     m_language_runtimes.clear();
892     m_instrumentation_runtimes.clear();
893     m_next_event_action_ap.reset();
894     m_stop_info_override_callback = NULL;
895     // Clear the last natural stop ID since it has a strong
896     // reference to this process
897     m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
898 //#ifdef LLDB_CONFIGURATION_DEBUG
899 //    StreamFile s(stdout, false);
900 //    EventSP event_sp;
901 //    while (m_private_state_listener.GetNextEvent(event_sp))
902 //    {
903 //        event_sp->Dump (&s);
904 //        s.EOL();
905 //    }
906 //#endif
907     // We have to be very careful here as the m_private_state_listener might
908     // contain events that have ProcessSP values in them which can keep this
909     // process around forever. These events need to be cleared out.
910     m_private_state_listener.Clear();
911     m_public_run_lock.TrySetRunning(); // This will do nothing if already locked
912     m_public_run_lock.SetStopped();
913     m_private_run_lock.TrySetRunning(); // This will do nothing if already locked
914     m_private_run_lock.SetStopped();
915     m_finalize_called = true;
916 }
917 
918 void
919 Process::RegisterNotificationCallbacks (const Notifications& callbacks)
920 {
921     m_notifications.push_back(callbacks);
922     if (callbacks.initialize != NULL)
923         callbacks.initialize (callbacks.baton, this);
924 }
925 
926 bool
927 Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
928 {
929     std::vector<Notifications>::iterator pos, end = m_notifications.end();
930     for (pos = m_notifications.begin(); pos != end; ++pos)
931     {
932         if (pos->baton == callbacks.baton &&
933             pos->initialize == callbacks.initialize &&
934             pos->process_state_changed == callbacks.process_state_changed)
935         {
936             m_notifications.erase(pos);
937             return true;
938         }
939     }
940     return false;
941 }
942 
943 void
944 Process::SynchronouslyNotifyStateChanged (StateType state)
945 {
946     std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
947     for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
948     {
949         if (notification_pos->process_state_changed)
950             notification_pos->process_state_changed (notification_pos->baton, this, state);
951     }
952 }
953 
954 // FIXME: We need to do some work on events before the general Listener sees them.
955 // For instance if we are continuing from a breakpoint, we need to ensure that we do
956 // the little "insert real insn, step & stop" trick.  But we can't do that when the
957 // event is delivered by the broadcaster - since that is done on the thread that is
958 // waiting for new events, so if we needed more than one event for our handling, we would
959 // stall.  So instead we do it when we fetch the event off of the queue.
960 //
961 
962 StateType
963 Process::GetNextEvent (EventSP &event_sp)
964 {
965     StateType state = eStateInvalid;
966 
967     if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
968         state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
969 
970     return state;
971 }
972 
973 void
974 Process::SyncIOHandler (uint32_t iohandler_id, uint64_t timeout_msec)
975 {
976     // don't sync (potentially context switch) in case where there is no process IO
977     if (! m_process_input_reader)
978         return;
979 
980     TimeValue timeout = TimeValue::Now();
981     timeout.OffsetWithMicroSeconds(timeout_msec*1000);
982     uint32_t new_iohandler_id = 0;
983     m_iohandler_sync.WaitForValueNotEqualTo(iohandler_id, new_iohandler_id, &timeout);
984 
985     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
986     if (log)
987         log->Printf("Process::%s waited for m_iohandler_sync to change from %u, new value is %u", __FUNCTION__, iohandler_id, new_iohandler_id);
988 }
989 
990 StateType
991 Process::WaitForProcessToStop (const TimeValue *timeout,
992                                EventSP *event_sp_ptr,
993                                bool wait_always,
994                                Listener *hijack_listener,
995                                Stream *stream)
996 {
997     // 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.
1000     if (event_sp_ptr)
1001         event_sp_ptr->reset();
1002     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 
1008     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1009     if (log)
1010         log->Printf ("Process::%s (timeout = %p)", __FUNCTION__,
1011                      static_cast<const void*>(timeout));
1012 
1013     if (!wait_always &&
1014         StateIsStoppedState(state, true) &&
1015         StateIsStoppedState(GetPrivateState(), true))
1016     {
1017         if (log)
1018             log->Printf("Process::%s returning without waiting for events; process private and public states are already 'stopped'.",
1019                         __FUNCTION__);
1020         // We need to toggle the run lock as this won't get done in
1021         // SetPublicState() if the process is hijacked.
1022         if (hijack_listener)
1023             m_public_run_lock.SetStopped();
1024         return state;
1025     }
1026 
1027     while (state != eStateInvalid)
1028     {
1029         EventSP event_sp;
1030         state = WaitForStateChangedEvents (timeout, event_sp, hijack_listener);
1031         if (event_sp_ptr && event_sp)
1032             *event_sp_ptr = event_sp;
1033 
1034         bool pop_process_io_handler = hijack_listener != NULL;
1035         Process::HandleProcessStateChangedEvent (event_sp, stream, pop_process_io_handler);
1036 
1037         switch (state)
1038         {
1039         case eStateCrashed:
1040         case eStateDetached:
1041         case eStateExited:
1042         case eStateUnloaded:
1043             // We need to toggle the run lock as this won't get done in
1044             // SetPublicState() if the process is hijacked.
1045             if (hijack_listener)
1046                 m_public_run_lock.SetStopped();
1047             return state;
1048         case eStateStopped:
1049             if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1050                 continue;
1051             else
1052             {
1053                 // We need to toggle the run lock as this won't get done in
1054                 // SetPublicState() if the process is hijacked.
1055                 if (hijack_listener)
1056                     m_public_run_lock.SetStopped();
1057                 return state;
1058             }
1059         default:
1060             continue;
1061         }
1062     }
1063     return state;
1064 }
1065 
1066 bool
1067 Process::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:
1087         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 
1102         case eStateConnected:
1103         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;
1167 
1168                         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 
1180                                  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();
1186                                     if (process_sp->GetUnixSignals()->GetShouldStop(signo))
1187                                     {
1188                                         if (!other_thread)
1189                                             other_thread = thread;
1190                                     }
1191                                     break;
1192                                 }
1193                                 case eStopReasonTrace:
1194                                 case eStopReasonBreakpoint:
1195                                 case eStopReasonWatchpoint:
1196                                 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 
1268 StateType
1269 Process::WaitForState(const TimeValue *timeout,
1270                       const StateType *match_states,
1271                       const uint32_t num_match_states)
1272 {
1273     EventSP event_sp;
1274     uint32_t i;
1275     StateType state = GetState();
1276     while (state != eStateInvalid)
1277     {
1278         // 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 
1283         state = WaitForStateChangedEvents (timeout, event_sp, NULL);
1284 
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 
1294 bool
1295 Process::HijackProcessEvents (Listener *listener)
1296 {
1297     if (listener != NULL)
1298     {
1299         return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
1300     }
1301     else
1302         return false;
1303 }
1304 
1305 void
1306 Process::RestoreProcessEvents ()
1307 {
1308     RestoreBroadcaster();
1309 }
1310 
1311 bool
1312 Process::HijackPrivateProcessEvents (Listener *listener)
1313 {
1314     if (listener != NULL)
1315     {
1316         return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
1317     }
1318     else
1319         return false;
1320 }
1321 
1322 void
1323 Process::RestorePrivateProcessEvents ()
1324 {
1325     m_private_state_broadcaster.RestoreBroadcaster();
1326 }
1327 
1328 StateType
1329 Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, Listener *hijack_listener)
1330 {
1331     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1332 
1333     if (log)
1334         log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1335                      static_cast<const void*>(timeout));
1336 
1337     Listener *listener = hijack_listener;
1338     if (listener == NULL)
1339         listener = &m_listener;
1340 
1341     StateType state = eStateInvalid;
1342     if (listener->WaitForEventForBroadcasterWithType (timeout,
1343                                                       this,
1344                                                       eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1345                                                       event_sp))
1346     {
1347         if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1348             state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1349         else if (log)
1350             log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1351     }
1352 
1353     if (log)
1354         log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1355                      __FUNCTION__, static_cast<const void*>(timeout),
1356                      StateAsCString(state));
1357     return state;
1358 }
1359 
1360 Event *
1361 Process::PeekAtStateChangedEvents ()
1362 {
1363     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1364 
1365     if (log)
1366         log->Printf ("Process::%s...", __FUNCTION__);
1367 
1368     Event *event_ptr;
1369     event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1370                                                                   eBroadcastBitStateChanged);
1371     if (log)
1372     {
1373         if (event_ptr)
1374         {
1375             log->Printf ("Process::%s (event_ptr) => %s",
1376                          __FUNCTION__,
1377                          StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1378         }
1379         else
1380         {
1381             log->Printf ("Process::%s no events found",
1382                          __FUNCTION__);
1383         }
1384     }
1385     return event_ptr;
1386 }
1387 
1388 StateType
1389 Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1390 {
1391     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1392 
1393     if (log)
1394         log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1395                      static_cast<const void*>(timeout));
1396 
1397     StateType state = eStateInvalid;
1398     if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1399                                                                      &m_private_state_broadcaster,
1400                                                                      eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1401                                                                      event_sp))
1402         if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1403             state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1404 
1405     // This is a bit of a hack, but when we wait here we could very well return
1406     // to the command-line, and that could disable the log, which would render the
1407     // log we got above invalid.
1408     if (log)
1409         log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1410                      __FUNCTION__, static_cast<const void *>(timeout),
1411                      state == eStateInvalid ? "TIMEOUT" : StateAsCString(state));
1412     return state;
1413 }
1414 
1415 bool
1416 Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1417 {
1418     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1419 
1420     if (log)
1421         log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1422                      static_cast<const void*>(timeout));
1423 
1424     if (control_only)
1425         return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1426     else
1427         return m_private_state_listener.WaitForEvent(timeout, event_sp);
1428 }
1429 
1430 bool
1431 Process::IsRunning () const
1432 {
1433     return StateIsRunningState (m_public_state.GetValue());
1434 }
1435 
1436 int
1437 Process::GetExitStatus ()
1438 {
1439     Mutex::Locker locker (m_exit_status_mutex);
1440 
1441     if (m_public_state.GetValue() == eStateExited)
1442         return m_exit_status;
1443     return -1;
1444 }
1445 
1446 const char *
1447 Process::GetExitDescription ()
1448 {
1449     Mutex::Locker locker (m_exit_status_mutex);
1450 
1451     if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1452         return m_exit_string.c_str();
1453     return NULL;
1454 }
1455 
1456 bool
1457 Process::SetExitStatus (int status, const char *cstr)
1458 {
1459     // Use a mutex to protect setting the exit status.
1460     Mutex::Locker locker (m_exit_status_mutex);
1461 
1462     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1463     if (log)
1464         log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1465                     status, status,
1466                     cstr ? "\"" : "",
1467                     cstr ? cstr : "NULL",
1468                     cstr ? "\"" : "");
1469 
1470     // We were already in the exited state
1471     if (m_private_state.GetValue() == eStateExited)
1472     {
1473         if (log)
1474             log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
1475         return false;
1476     }
1477 
1478     m_exit_status = status;
1479     if (cstr)
1480         m_exit_string = cstr;
1481     else
1482         m_exit_string.clear();
1483 
1484     // When we exit, we don't need the input reader anymore
1485     if (m_process_input_reader)
1486     {
1487         m_process_input_reader->SetIsDone(true);
1488         m_process_input_reader->Cancel();
1489         m_process_input_reader.reset();
1490     }
1491 
1492     // Clear the last natural stop ID since it has a strong
1493     // reference to this process
1494     m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
1495 
1496     SetPrivateState (eStateExited);
1497 
1498     // Allow subclasses to do some cleanup
1499     DidExit ();
1500 
1501     return true;
1502 }
1503 
1504 bool
1505 Process::IsAlive ()
1506 {
1507     switch (m_private_state.GetValue())
1508     {
1509         case eStateInvalid:
1510         case eStateUnloaded:
1511         case eStateDetached:
1512         case eStateExited:
1513             return false;
1514 
1515         case eStateConnected:
1516         case eStateAttaching:
1517         case eStateLaunching:
1518         case eStateStopped:
1519         case eStateRunning:
1520         case eStateStepping:
1521         case eStateCrashed:
1522         case eStateSuspended:
1523             return true;
1524     }
1525 }
1526 
1527 // This static callback can be used to watch for local child processes on
1528 // the current host. The child process exits, the process will be
1529 // found in the global target list (we want to be completely sure that the
1530 // lldb_private::Process doesn't go away before we can deliver the signal.
1531 bool
1532 Process::SetProcessExitStatus (void *callback_baton,
1533                                lldb::pid_t pid,
1534                                bool exited,
1535                                int signo,          // Zero for no signal
1536                                int exit_status     // Exit value of process if signal is zero
1537 )
1538 {
1539     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
1540     if (log)
1541         log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
1542                      callback_baton,
1543                      pid,
1544                      exited,
1545                      signo,
1546                      exit_status);
1547 
1548     if (exited)
1549     {
1550         TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
1551         if (target_sp)
1552         {
1553             ProcessSP process_sp (target_sp->GetProcessSP());
1554             if (process_sp)
1555             {
1556                 const char *signal_cstr = NULL;
1557                 if (signo)
1558                     signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
1559 
1560                 process_sp->SetExitStatus (exit_status, signal_cstr);
1561             }
1562         }
1563         return true;
1564     }
1565     return false;
1566 }
1567 
1568 void
1569 Process::UpdateThreadListIfNeeded ()
1570 {
1571     const uint32_t stop_id = GetStopID();
1572     if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1573     {
1574         const StateType state = GetPrivateState();
1575         if (StateIsStoppedState (state, true))
1576         {
1577             Mutex::Locker locker (m_thread_list.GetMutex ());
1578             // m_thread_list does have its own mutex, but we need to
1579             // hold onto the mutex between the call to UpdateThreadList(...)
1580             // and the os->UpdateThreadList(...) so it doesn't change on us
1581             ThreadList &old_thread_list = m_thread_list;
1582             ThreadList real_thread_list(this);
1583             ThreadList new_thread_list(this);
1584             // Always update the thread list with the protocol specific
1585             // thread list, but only update if "true" is returned
1586             if (UpdateThreadList (m_thread_list_real, real_thread_list))
1587             {
1588                 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since
1589                 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is
1590                 // shutting us down, causing a deadlock.
1591                 OperatingSystem *os = GetOperatingSystem ();
1592                 if (os && !m_destroy_in_process)
1593                 {
1594                     // Clear any old backing threads where memory threads might have been
1595                     // backed by actual threads from the lldb_private::Process subclass
1596                     size_t num_old_threads = old_thread_list.GetSize(false);
1597                     for (size_t i=0; i<num_old_threads; ++i)
1598                         old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread();
1599 
1600                     // Turn off dynamic types to ensure we don't run any expressions. Objective C
1601                     // can run an expression to determine if a SBValue is a dynamic type or not
1602                     // and we need to avoid this. OperatingSystem plug-ins can't run expressions
1603                     // that require running code...
1604 
1605                     Target &target = GetTarget();
1606                     const lldb::DynamicValueType saved_prefer_dynamic = target.GetPreferDynamicValue ();
1607                     if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1608                         target.SetPreferDynamicValue(lldb::eNoDynamicValues);
1609 
1610                     // Now let the OperatingSystem plug-in update the thread list
1611 
1612                     os->UpdateThreadList (old_thread_list,  // Old list full of threads created by OS plug-in
1613                                           real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass
1614                                           new_thread_list); // The new thread list that we will show to the user that gets filled in
1615 
1616                     if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1617                         target.SetPreferDynamicValue(saved_prefer_dynamic);
1618                 }
1619                 else
1620                 {
1621                     // No OS plug-in, the new thread list is the same as the real thread list
1622                     new_thread_list = real_thread_list;
1623                 }
1624 
1625                 m_thread_list_real.Update(real_thread_list);
1626                 m_thread_list.Update (new_thread_list);
1627                 m_thread_list.SetStopID (stop_id);
1628 
1629                 if (GetLastNaturalStopID () != m_extended_thread_stop_id)
1630                 {
1631                     // Clear any extended threads that we may have accumulated previously
1632                     m_extended_thread_list.Clear();
1633                     m_extended_thread_stop_id = GetLastNaturalStopID ();
1634 
1635                     m_queue_list.Clear();
1636                     m_queue_list_stop_id = GetLastNaturalStopID ();
1637                 }
1638             }
1639         }
1640     }
1641 }
1642 
1643 void
1644 Process::UpdateQueueListIfNeeded ()
1645 {
1646     if (m_system_runtime_ap.get())
1647     {
1648         if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID())
1649         {
1650             const StateType state = GetPrivateState();
1651             if (StateIsStoppedState (state, true))
1652             {
1653                 m_system_runtime_ap->PopulateQueueList (m_queue_list);
1654                 m_queue_list_stop_id = GetLastNaturalStopID();
1655             }
1656         }
1657     }
1658 }
1659 
1660 ThreadSP
1661 Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1662 {
1663     OperatingSystem *os = GetOperatingSystem ();
1664     if (os)
1665         return os->CreateThread(tid, context);
1666     return ThreadSP();
1667 }
1668 
1669 uint32_t
1670 Process::GetNextThreadIndexID (uint64_t thread_id)
1671 {
1672     return AssignIndexIDToThread(thread_id);
1673 }
1674 
1675 bool
1676 Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1677 {
1678     return (m_thread_id_to_index_id_map.find(thread_id) != m_thread_id_to_index_id_map.end());
1679 }
1680 
1681 uint32_t
1682 Process::AssignIndexIDToThread(uint64_t thread_id)
1683 {
1684     uint32_t result = 0;
1685     std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1686     if (iterator == m_thread_id_to_index_id_map.end())
1687     {
1688         result = ++m_thread_index_id;
1689         m_thread_id_to_index_id_map[thread_id] = result;
1690     }
1691     else
1692     {
1693         result = iterator->second;
1694     }
1695 
1696     return result;
1697 }
1698 
1699 StateType
1700 Process::GetState()
1701 {
1702     // If any other threads access this we will need a mutex for it
1703     return m_public_state.GetValue ();
1704 }
1705 
1706 bool
1707 Process::StateChangedIsExternallyHijacked()
1708 {
1709     if (IsHijackedForEvent(eBroadcastBitStateChanged))
1710     {
1711         if (strcmp(m_hijacking_listeners.back()->GetName(), "lldb.Process.ResumeSynchronous.hijack"))
1712             return true;
1713     }
1714     return false;
1715 }
1716 
1717 void
1718 Process::SetPublicState (StateType new_state, bool restarted)
1719 {
1720     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1721     if (log)
1722         log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted);
1723     const StateType old_state = m_public_state.GetValue();
1724     m_public_state.SetValue (new_state);
1725 
1726     // On the transition from Run to Stopped, we unlock the writer end of the
1727     // run lock.  The lock gets locked in Resume, which is the public API
1728     // to tell the program to run.
1729     if (!StateChangedIsExternallyHijacked())
1730     {
1731         if (new_state == eStateDetached)
1732         {
1733             if (log)
1734                 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
1735             m_public_run_lock.SetStopped();
1736         }
1737         else
1738         {
1739             const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1740             const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1741             if ((old_state_is_stopped != new_state_is_stopped))
1742             {
1743                 if (new_state_is_stopped && !restarted)
1744                 {
1745                     if (log)
1746                         log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
1747                     m_public_run_lock.SetStopped();
1748                 }
1749             }
1750         }
1751     }
1752 }
1753 
1754 Error
1755 Process::Resume ()
1756 {
1757     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1758     if (log)
1759         log->Printf("Process::Resume -- locking run lock");
1760     if (!m_public_run_lock.TrySetRunning())
1761     {
1762         Error error("Resume request failed - process still running.");
1763         if (log)
1764             log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1765         return error;
1766     }
1767     return PrivateResume();
1768 }
1769 
1770 Error
1771 Process::ResumeSynchronous (Stream *stream)
1772 {
1773     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1774     if (log)
1775         log->Printf("Process::ResumeSynchronous -- locking run lock");
1776     if (!m_public_run_lock.TrySetRunning())
1777     {
1778         Error error("Resume request failed - process still running.");
1779         if (log)
1780             log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1781         return error;
1782     }
1783 
1784     ListenerSP listener_sp (new Listener("lldb.Process.ResumeSynchronous.hijack"));
1785     HijackProcessEvents(listener_sp.get());
1786 
1787     Error error = PrivateResume();
1788     if (error.Success())
1789     {
1790         StateType state = WaitForProcessToStop (NULL, NULL, true, listener_sp.get(), stream);
1791         const bool must_be_alive = false; // eStateExited is ok, so this must be false
1792         if (!StateIsStoppedState(state, must_be_alive))
1793             error.SetErrorStringWithFormat("process not in stopped state after synchronous resume: %s", StateAsCString(state));
1794     }
1795 
1796     // Undo the hijacking of process events...
1797     RestoreProcessEvents();
1798 
1799     return error;
1800 }
1801 
1802 StateType
1803 Process::GetPrivateState ()
1804 {
1805     return m_private_state.GetValue();
1806 }
1807 
1808 void
1809 Process::SetPrivateState (StateType new_state)
1810 {
1811     if (m_finalize_called)
1812         return;
1813 
1814     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1815     bool state_changed = false;
1816 
1817     if (log)
1818         log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1819 
1820     Mutex::Locker thread_locker(m_thread_list.GetMutex());
1821     Mutex::Locker locker(m_private_state.GetMutex());
1822 
1823     const StateType old_state = m_private_state.GetValueNoLock ();
1824     state_changed = old_state != new_state;
1825 
1826     const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1827     const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1828     if (old_state_is_stopped != new_state_is_stopped)
1829     {
1830         if (new_state_is_stopped)
1831             m_private_run_lock.SetStopped();
1832         else
1833             m_private_run_lock.SetRunning();
1834     }
1835 
1836     if (state_changed)
1837     {
1838         m_private_state.SetValueNoLock (new_state);
1839         EventSP event_sp (new Event (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state)));
1840         if (StateIsStoppedState(new_state, false))
1841         {
1842             // Note, this currently assumes that all threads in the list
1843             // stop when the process stops.  In the future we will want to
1844             // support a debugging model where some threads continue to run
1845             // while others are stopped.  When that happens we will either need
1846             // a way for the thread list to identify which threads are stopping
1847             // or create a special thread list containing only threads which
1848             // actually stopped.
1849             //
1850             // The process plugin is responsible for managing the actual
1851             // behavior of the threads and should have stopped any threads
1852             // that are going to stop before we get here.
1853             m_thread_list.DidStop();
1854 
1855             m_mod_id.BumpStopID();
1856             if (!m_mod_id.IsLastResumeForUserExpression())
1857                 m_mod_id.SetStopEventForLastNaturalStopID(event_sp);
1858             m_memory_cache.Clear();
1859             if (log)
1860                 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
1861         }
1862 
1863         // Use our target to get a shared pointer to ourselves...
1864         if (m_finalize_called && PrivateStateThreadIsValid() == false)
1865             BroadcastEvent (event_sp);
1866         else
1867             m_private_state_broadcaster.BroadcastEvent (event_sp);
1868     }
1869     else
1870     {
1871         if (log)
1872             log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
1873     }
1874 }
1875 
1876 void
1877 Process::SetRunningUserExpression (bool on)
1878 {
1879     m_mod_id.SetRunningUserExpression (on);
1880 }
1881 
1882 addr_t
1883 Process::GetImageInfoAddress()
1884 {
1885     return LLDB_INVALID_ADDRESS;
1886 }
1887 
1888 const lldb::ABISP &
1889 Process::GetABI()
1890 {
1891     if (!m_abi_sp)
1892         m_abi_sp = ABI::FindPlugin(GetTarget().GetArchitecture());
1893     return m_abi_sp;
1894 }
1895 
1896 LanguageRuntime *
1897 Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
1898 {
1899     if (m_finalizing)
1900         return nullptr;
1901 
1902     LanguageRuntimeCollection::iterator pos;
1903     pos = m_language_runtimes.find (language);
1904     if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
1905     {
1906         lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
1907 
1908         m_language_runtimes[language] = runtime_sp;
1909         return runtime_sp.get();
1910     }
1911     else
1912         return (*pos).second.get();
1913 }
1914 
1915 CPPLanguageRuntime *
1916 Process::GetCPPLanguageRuntime (bool retry_if_null)
1917 {
1918     LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
1919     if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1920         return static_cast<CPPLanguageRuntime *> (runtime);
1921     return NULL;
1922 }
1923 
1924 ObjCLanguageRuntime *
1925 Process::GetObjCLanguageRuntime (bool retry_if_null)
1926 {
1927     LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
1928     if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1929         return static_cast<ObjCLanguageRuntime *> (runtime);
1930     return NULL;
1931 }
1932 
1933 bool
1934 Process::IsPossibleDynamicValue (ValueObject& in_value)
1935 {
1936     if (m_finalizing)
1937         return false;
1938 
1939     if (in_value.IsDynamic())
1940         return false;
1941     LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1942 
1943     if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1944     {
1945         LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1946         return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1947     }
1948 
1949     LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1950     if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1951         return true;
1952 
1953     LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1954     return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1955 }
1956 
1957 void
1958 Process::SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers)
1959 {
1960     m_dynamic_checkers_ap.reset(dynamic_checkers);
1961 }
1962 
1963 BreakpointSiteList &
1964 Process::GetBreakpointSiteList()
1965 {
1966     return m_breakpoint_site_list;
1967 }
1968 
1969 const BreakpointSiteList &
1970 Process::GetBreakpointSiteList() const
1971 {
1972     return m_breakpoint_site_list;
1973 }
1974 
1975 void
1976 Process::DisableAllBreakpointSites ()
1977 {
1978     m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void {
1979 //        bp_site->SetEnabled(true);
1980         DisableBreakpointSite(bp_site);
1981     });
1982 }
1983 
1984 Error
1985 Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1986 {
1987     Error error (DisableBreakpointSiteByID (break_id));
1988 
1989     if (error.Success())
1990         m_breakpoint_site_list.Remove(break_id);
1991 
1992     return error;
1993 }
1994 
1995 Error
1996 Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1997 {
1998     Error error;
1999     BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2000     if (bp_site_sp)
2001     {
2002         if (bp_site_sp->IsEnabled())
2003             error = DisableBreakpointSite (bp_site_sp.get());
2004     }
2005     else
2006     {
2007         error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
2008     }
2009 
2010     return error;
2011 }
2012 
2013 Error
2014 Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
2015 {
2016     Error error;
2017     BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2018     if (bp_site_sp)
2019     {
2020         if (!bp_site_sp->IsEnabled())
2021             error = EnableBreakpointSite (bp_site_sp.get());
2022     }
2023     else
2024     {
2025         error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
2026     }
2027     return error;
2028 }
2029 
2030 lldb::break_id_t
2031 Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
2032 {
2033     addr_t load_addr = LLDB_INVALID_ADDRESS;
2034 
2035     bool show_error = true;
2036     switch (GetState())
2037     {
2038         case eStateInvalid:
2039         case eStateUnloaded:
2040         case eStateConnected:
2041         case eStateAttaching:
2042         case eStateLaunching:
2043         case eStateDetached:
2044         case eStateExited:
2045             show_error = false;
2046             break;
2047 
2048         case eStateStopped:
2049         case eStateRunning:
2050         case eStateStepping:
2051         case eStateCrashed:
2052         case eStateSuspended:
2053             show_error = IsAlive();
2054             break;
2055     }
2056 
2057     // Reset the IsIndirect flag here, in case the location changes from
2058     // pointing to a indirect symbol to a regular symbol.
2059     owner->SetIsIndirect (false);
2060 
2061     if (owner->ShouldResolveIndirectFunctions())
2062     {
2063         Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol();
2064         if (symbol && symbol->IsIndirect())
2065         {
2066             Error error;
2067             Address symbol_address = symbol->GetAddress();
2068             load_addr = ResolveIndirectFunction (&symbol_address, error);
2069             if (!error.Success() && show_error)
2070             {
2071                 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2072                                                                    symbol->GetLoadAddress(&GetTarget()),
2073                                                                    owner->GetBreakpoint().GetID(),
2074                                                                    owner->GetID(),
2075                                                                    error.AsCString() ? error.AsCString() : "unknown error");
2076                 return LLDB_INVALID_BREAK_ID;
2077             }
2078             Address resolved_address(load_addr);
2079             load_addr = resolved_address.GetOpcodeLoadAddress (&GetTarget());
2080             owner->SetIsIndirect(true);
2081         }
2082         else
2083             load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
2084     }
2085     else
2086         load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
2087 
2088     if (load_addr != LLDB_INVALID_ADDRESS)
2089     {
2090         BreakpointSiteSP bp_site_sp;
2091 
2092         // Look up this breakpoint site.  If it exists, then add this new owner, otherwise
2093         // create a new breakpoint site and add it.
2094 
2095         bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
2096 
2097         if (bp_site_sp)
2098         {
2099             bp_site_sp->AddOwner (owner);
2100             owner->SetBreakpointSite (bp_site_sp);
2101             return bp_site_sp->GetID();
2102         }
2103         else
2104         {
2105             bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
2106             if (bp_site_sp)
2107             {
2108                 Error error = EnableBreakpointSite (bp_site_sp.get());
2109                 if (error.Success())
2110                 {
2111                     owner->SetBreakpointSite (bp_site_sp);
2112                     return m_breakpoint_site_list.Add (bp_site_sp);
2113                 }
2114                 else
2115                 {
2116                     if (show_error)
2117                     {
2118                         // Report error for setting breakpoint...
2119                         GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2120                                                                            load_addr,
2121                                                                            owner->GetBreakpoint().GetID(),
2122                                                                            owner->GetID(),
2123                                                                            error.AsCString() ? error.AsCString() : "unknown error");
2124                     }
2125                 }
2126             }
2127         }
2128     }
2129     // We failed to enable the breakpoint
2130     return LLDB_INVALID_BREAK_ID;
2131 }
2132 
2133 void
2134 Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
2135 {
2136     uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
2137     if (num_owners == 0)
2138     {
2139         // Don't try to disable the site if we don't have a live process anymore.
2140         if (IsAlive())
2141             DisableBreakpointSite (bp_site_sp.get());
2142         m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
2143     }
2144 }
2145 
2146 size_t
2147 Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
2148 {
2149     size_t bytes_removed = 0;
2150     BreakpointSiteList bp_sites_in_range;
2151 
2152     if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
2153     {
2154         bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void {
2155             if (bp_site->GetType() == BreakpointSite::eSoftware)
2156             {
2157                 addr_t intersect_addr;
2158                 size_t intersect_size;
2159                 size_t opcode_offset;
2160                 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
2161                 {
2162                     assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
2163                     assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
2164                     assert(opcode_offset + intersect_size <= bp_site->GetByteSize());
2165                     size_t buf_offset = intersect_addr - bp_addr;
2166                     ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
2167                 }
2168             }
2169         });
2170     }
2171     return bytes_removed;
2172 }
2173 
2174 size_t
2175 Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
2176 {
2177     PlatformSP platform_sp (GetTarget().GetPlatform());
2178     if (platform_sp)
2179         return platform_sp->GetSoftwareBreakpointTrapOpcode (GetTarget(), bp_site);
2180     return 0;
2181 }
2182 
2183 Error
2184 Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
2185 {
2186     Error error;
2187     assert (bp_site != NULL);
2188     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
2189     const addr_t bp_addr = bp_site->GetLoadAddress();
2190     if (log)
2191         log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
2192     if (bp_site->IsEnabled())
2193     {
2194         if (log)
2195             log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
2196         return error;
2197     }
2198 
2199     if (bp_addr == LLDB_INVALID_ADDRESS)
2200     {
2201         error.SetErrorString("BreakpointSite contains an invalid load address.");
2202         return error;
2203     }
2204     // Ask the lldb::Process subclass to fill in the correct software breakpoint
2205     // trap for the breakpoint site
2206     const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
2207 
2208     if (bp_opcode_size == 0)
2209     {
2210         error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
2211     }
2212     else
2213     {
2214         const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
2215 
2216         if (bp_opcode_bytes == NULL)
2217         {
2218             error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
2219             return error;
2220         }
2221 
2222         // Save the original opcode by reading it
2223         if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
2224         {
2225             // Write a software breakpoint in place of the original opcode
2226             if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2227             {
2228                 uint8_t verify_bp_opcode_bytes[64];
2229                 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2230                 {
2231                     if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
2232                     {
2233                         bp_site->SetEnabled(true);
2234                         bp_site->SetType (BreakpointSite::eSoftware);
2235                         if (log)
2236                             log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
2237                                          bp_site->GetID(),
2238                                          (uint64_t)bp_addr);
2239                     }
2240                     else
2241                         error.SetErrorString("failed to verify the breakpoint trap in memory.");
2242                 }
2243                 else
2244                     error.SetErrorString("Unable to read memory to verify breakpoint trap.");
2245             }
2246             else
2247                 error.SetErrorString("Unable to write breakpoint trap to memory.");
2248         }
2249         else
2250             error.SetErrorString("Unable to read memory at breakpoint address.");
2251     }
2252     if (log && error.Fail())
2253         log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
2254                      bp_site->GetID(),
2255                      (uint64_t)bp_addr,
2256                      error.AsCString());
2257     return error;
2258 }
2259 
2260 Error
2261 Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2262 {
2263     Error error;
2264     assert (bp_site != NULL);
2265     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
2266     addr_t bp_addr = bp_site->GetLoadAddress();
2267     lldb::user_id_t breakID = bp_site->GetID();
2268     if (log)
2269         log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
2270 
2271     if (bp_site->IsHardware())
2272     {
2273         error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2274     }
2275     else if (bp_site->IsEnabled())
2276     {
2277         const size_t break_op_size = bp_site->GetByteSize();
2278         const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2279         if (break_op_size > 0)
2280         {
2281             // Clear a software breakpoint instruction
2282             uint8_t curr_break_op[8];
2283             assert (break_op_size <= sizeof(curr_break_op));
2284             bool break_op_found = false;
2285 
2286             // Read the breakpoint opcode
2287             if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2288             {
2289                 bool verify = false;
2290                 // Make sure the breakpoint opcode exists at this address
2291                 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2292                 {
2293                     break_op_found = true;
2294                     // We found a valid breakpoint opcode at this address, now restore
2295                     // the saved opcode.
2296                     if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2297                     {
2298                         verify = true;
2299                     }
2300                     else
2301                         error.SetErrorString("Memory write failed when restoring original opcode.");
2302                 }
2303                 else
2304                 {
2305                     error.SetErrorString("Original breakpoint trap is no longer in memory.");
2306                     // Set verify to true and so we can check if the original opcode has already been restored
2307                     verify = true;
2308                 }
2309 
2310                 if (verify)
2311                 {
2312                     uint8_t verify_opcode[8];
2313                     assert (break_op_size < sizeof(verify_opcode));
2314                     // Verify that our original opcode made it back to the inferior
2315                     if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2316                     {
2317                         // compare the memory we just read with the original opcode
2318                         if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2319                         {
2320                             // SUCCESS
2321                             bp_site->SetEnabled(false);
2322                             if (log)
2323                                 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
2324                             return error;
2325                         }
2326                         else
2327                         {
2328                             if (break_op_found)
2329                                 error.SetErrorString("Failed to restore original opcode.");
2330                         }
2331                     }
2332                     else
2333                         error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2334                 }
2335             }
2336             else
2337                 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2338         }
2339     }
2340     else
2341     {
2342         if (log)
2343             log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
2344         return error;
2345     }
2346 
2347     if (log)
2348         log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
2349                      bp_site->GetID(),
2350                      (uint64_t)bp_addr,
2351                      error.AsCString());
2352     return error;
2353 }
2354 
2355 // Uncomment to verify memory caching works after making changes to caching code
2356 //#define VERIFY_MEMORY_READS
2357 
2358 size_t
2359 Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2360 {
2361     error.Clear();
2362     if (!GetDisableMemoryCache())
2363     {
2364 #if defined (VERIFY_MEMORY_READS)
2365         // Memory caching is enabled, with debug verification
2366 
2367         if (buf && size)
2368         {
2369             // Uncomment the line below to make sure memory caching is working.
2370             // I ran this through the test suite and got no assertions, so I am
2371             // pretty confident this is working well. If any changes are made to
2372             // memory caching, uncomment the line below and test your changes!
2373 
2374             // Verify all memory reads by using the cache first, then redundantly
2375             // reading the same memory from the inferior and comparing to make sure
2376             // everything is exactly the same.
2377             std::string verify_buf (size, '\0');
2378             assert (verify_buf.size() == size);
2379             const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2380             Error verify_error;
2381             const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2382             assert (cache_bytes_read == verify_bytes_read);
2383             assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2384             assert (verify_error.Success() == error.Success());
2385             return cache_bytes_read;
2386         }
2387         return 0;
2388 #else // !defined(VERIFY_MEMORY_READS)
2389         // Memory caching is enabled, without debug verification
2390 
2391         return m_memory_cache.Read (addr, buf, size, error);
2392 #endif // defined (VERIFY_MEMORY_READS)
2393     }
2394     else
2395     {
2396         // Memory caching is disabled
2397 
2398         return ReadMemoryFromInferior (addr, buf, size, error);
2399     }
2400 }
2401 
2402 size_t
2403 Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2404 {
2405     char buf[256];
2406     out_str.clear();
2407     addr_t curr_addr = addr;
2408     while (1)
2409     {
2410         size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2411         if (length == 0)
2412             break;
2413         out_str.append(buf, length);
2414         // If we got "length - 1" bytes, we didn't get the whole C string, we
2415         // need to read some more characters
2416         if (length == sizeof(buf) - 1)
2417             curr_addr += length;
2418         else
2419             break;
2420     }
2421     return out_str.size();
2422 }
2423 
2424 size_t
2425 Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error,
2426                                 size_t type_width)
2427 {
2428     size_t total_bytes_read = 0;
2429     if (dst && max_bytes && type_width && max_bytes >= type_width)
2430     {
2431         // Ensure a null terminator independent of the number of bytes that is read.
2432         memset (dst, 0, max_bytes);
2433         size_t bytes_left = max_bytes - type_width;
2434 
2435         const char terminator[4] = {'\0', '\0', '\0', '\0'};
2436         assert(sizeof(terminator) >= type_width &&
2437                "Attempting to validate a string with more than 4 bytes per character!");
2438 
2439         addr_t curr_addr = addr;
2440         const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2441         char *curr_dst = dst;
2442 
2443         error.Clear();
2444         while (bytes_left > 0 && error.Success())
2445         {
2446             addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2447             addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2448             size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2449 
2450             if (bytes_read == 0)
2451                 break;
2452 
2453             // Search for a null terminator of correct size and alignment in bytes_read
2454             size_t aligned_start = total_bytes_read - total_bytes_read % type_width;
2455             for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width)
2456                 if (::strncmp(&dst[i], terminator, type_width) == 0)
2457                 {
2458                     error.Clear();
2459                     return i;
2460                 }
2461 
2462             total_bytes_read += bytes_read;
2463             curr_dst += bytes_read;
2464             curr_addr += bytes_read;
2465             bytes_left -= bytes_read;
2466         }
2467     }
2468     else
2469     {
2470         if (max_bytes)
2471             error.SetErrorString("invalid arguments");
2472     }
2473     return total_bytes_read;
2474 }
2475 
2476 // Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find
2477 // null terminators.
2478 size_t
2479 Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
2480 {
2481     size_t total_cstr_len = 0;
2482     if (dst && dst_max_len)
2483     {
2484         result_error.Clear();
2485         // NULL out everything just to be safe
2486         memset (dst, 0, dst_max_len);
2487         Error error;
2488         addr_t curr_addr = addr;
2489         const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2490         size_t bytes_left = dst_max_len - 1;
2491         char *curr_dst = dst;
2492 
2493         while (bytes_left > 0)
2494         {
2495             addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2496             addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2497             size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2498 
2499             if (bytes_read == 0)
2500             {
2501                 result_error = error;
2502                 dst[total_cstr_len] = '\0';
2503                 break;
2504             }
2505             const size_t len = strlen(curr_dst);
2506 
2507             total_cstr_len += len;
2508 
2509             if (len < bytes_to_read)
2510                 break;
2511 
2512             curr_dst += bytes_read;
2513             curr_addr += bytes_read;
2514             bytes_left -= bytes_read;
2515         }
2516     }
2517     else
2518     {
2519         if (dst == NULL)
2520             result_error.SetErrorString("invalid arguments");
2521         else
2522             result_error.Clear();
2523     }
2524     return total_cstr_len;
2525 }
2526 
2527 size_t
2528 Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2529 {
2530     if (buf == NULL || size == 0)
2531         return 0;
2532 
2533     size_t bytes_read = 0;
2534     uint8_t *bytes = (uint8_t *)buf;
2535 
2536     while (bytes_read < size)
2537     {
2538         const size_t curr_size = size - bytes_read;
2539         const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2540                                                      bytes + bytes_read,
2541                                                      curr_size,
2542                                                      error);
2543         bytes_read += curr_bytes_read;
2544         if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2545             break;
2546     }
2547 
2548     // Replace any software breakpoint opcodes that fall into this range back
2549     // into "buf" before we return
2550     if (bytes_read > 0)
2551         RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2552     return bytes_read;
2553 }
2554 
2555 uint64_t
2556 Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
2557 {
2558     Scalar scalar;
2559     if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2560         return scalar.ULongLong(fail_value);
2561     return fail_value;
2562 }
2563 
2564 addr_t
2565 Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2566 {
2567     Scalar scalar;
2568     if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2569         return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2570     return LLDB_INVALID_ADDRESS;
2571 }
2572 
2573 bool
2574 Process::WritePointerToMemory (lldb::addr_t vm_addr,
2575                                lldb::addr_t ptr_value,
2576                                Error &error)
2577 {
2578     Scalar scalar;
2579     const uint32_t addr_byte_size = GetAddressByteSize();
2580     if (addr_byte_size <= 4)
2581         scalar = (uint32_t)ptr_value;
2582     else
2583         scalar = ptr_value;
2584     return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
2585 }
2586 
2587 size_t
2588 Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2589 {
2590     size_t bytes_written = 0;
2591     const uint8_t *bytes = (const uint8_t *)buf;
2592 
2593     while (bytes_written < size)
2594     {
2595         const size_t curr_size = size - bytes_written;
2596         const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2597                                                          bytes + bytes_written,
2598                                                          curr_size,
2599                                                          error);
2600         bytes_written += curr_bytes_written;
2601         if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2602             break;
2603     }
2604     return bytes_written;
2605 }
2606 
2607 size_t
2608 Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2609 {
2610 #if defined (ENABLE_MEMORY_CACHING)
2611     m_memory_cache.Flush (addr, size);
2612 #endif
2613 
2614     if (buf == NULL || size == 0)
2615         return 0;
2616 
2617     m_mod_id.BumpMemoryID();
2618 
2619     // We need to write any data that would go where any current software traps
2620     // (enabled software breakpoints) any software traps (breakpoints) that we
2621     // may have placed in our tasks memory.
2622 
2623     BreakpointSiteList bp_sites_in_range;
2624 
2625     if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range))
2626     {
2627         // No breakpoint sites overlap
2628         if (bp_sites_in_range.IsEmpty())
2629             return WriteMemoryPrivate (addr, buf, size, error);
2630         else
2631         {
2632             const uint8_t *ubuf = (const uint8_t *)buf;
2633             uint64_t bytes_written = 0;
2634 
2635             bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void {
2636 
2637                 if (error.Success())
2638                 {
2639                     addr_t intersect_addr;
2640                     size_t intersect_size;
2641                     size_t opcode_offset;
2642                     const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset);
2643                     UNUSED_IF_ASSERT_DISABLED(intersects);
2644                     assert(intersects);
2645                     assert(addr <= intersect_addr && intersect_addr < addr + size);
2646                     assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2647                     assert(opcode_offset + intersect_size <= bp->GetByteSize());
2648 
2649                     // Check for bytes before this breakpoint
2650                     const addr_t curr_addr = addr + bytes_written;
2651                     if (intersect_addr > curr_addr)
2652                     {
2653                         // There are some bytes before this breakpoint that we need to
2654                         // just write to memory
2655                         size_t curr_size = intersect_addr - curr_addr;
2656                         size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2657                                                                         ubuf + bytes_written,
2658                                                                         curr_size,
2659                                                                         error);
2660                         bytes_written += curr_bytes_written;
2661                         if (curr_bytes_written != curr_size)
2662                         {
2663                             // We weren't able to write all of the requested bytes, we
2664                             // are done looping and will return the number of bytes that
2665                             // we have written so far.
2666                             if (error.Success())
2667                                 error.SetErrorToGenericError();
2668                         }
2669                     }
2670                     // Now write any bytes that would cover up any software breakpoints
2671                     // directly into the breakpoint opcode buffer
2672                     ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2673                     bytes_written += intersect_size;
2674                 }
2675             });
2676 
2677             if (bytes_written < size)
2678                 WriteMemoryPrivate (addr + bytes_written,
2679                                     ubuf + bytes_written,
2680                                     size - bytes_written,
2681                                     error);
2682         }
2683     }
2684     else
2685     {
2686         return WriteMemoryPrivate (addr, buf, size, error);
2687     }
2688 
2689     // Write any remaining bytes after the last breakpoint if we have any left
2690     return 0; //bytes_written;
2691 }
2692 
2693 size_t
2694 Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
2695 {
2696     if (byte_size == UINT32_MAX)
2697         byte_size = scalar.GetByteSize();
2698     if (byte_size > 0)
2699     {
2700         uint8_t buf[32];
2701         const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2702         if (mem_size > 0)
2703             return WriteMemory(addr, buf, mem_size, error);
2704         else
2705             error.SetErrorString ("failed to get scalar as memory data");
2706     }
2707     else
2708     {
2709         error.SetErrorString ("invalid scalar value");
2710     }
2711     return 0;
2712 }
2713 
2714 size_t
2715 Process::ReadScalarIntegerFromMemory (addr_t addr,
2716                                       uint32_t byte_size,
2717                                       bool is_signed,
2718                                       Scalar &scalar,
2719                                       Error &error)
2720 {
2721     uint64_t uval = 0;
2722     if (byte_size == 0)
2723     {
2724         error.SetErrorString ("byte size is zero");
2725     }
2726     else if (byte_size & (byte_size - 1))
2727     {
2728         error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size);
2729     }
2730     else if (byte_size <= sizeof(uval))
2731     {
2732         const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
2733         if (bytes_read == byte_size)
2734         {
2735             DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
2736             lldb::offset_t offset = 0;
2737             if (byte_size <= 4)
2738                 scalar = data.GetMaxU32 (&offset, byte_size);
2739             else
2740                 scalar = data.GetMaxU64 (&offset, byte_size);
2741             if (is_signed)
2742                 scalar.SignExtend(byte_size * 8);
2743             return bytes_read;
2744         }
2745     }
2746     else
2747     {
2748         error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2749     }
2750     return 0;
2751 }
2752 
2753 #define USE_ALLOCATE_MEMORY_CACHE 1
2754 addr_t
2755 Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2756 {
2757     if (GetPrivateState() != eStateStopped)
2758         return LLDB_INVALID_ADDRESS;
2759 
2760 #if defined (USE_ALLOCATE_MEMORY_CACHE)
2761     return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2762 #else
2763     addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
2764     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2765     if (log)
2766         log->Printf("Process::AllocateMemory(size=%" PRIu64 ", permissions=%s) => 0x%16.16" PRIx64 " (m_stop_id = %u m_memory_id = %u)",
2767                     (uint64_t)size,
2768                     GetPermissionsAsCString (permissions),
2769                     (uint64_t)allocated_addr,
2770                     m_mod_id.GetStopID(),
2771                     m_mod_id.GetMemoryID());
2772     return allocated_addr;
2773 #endif
2774 }
2775 
2776 addr_t
2777 Process::CallocateMemory(size_t size, uint32_t permissions, Error &error)
2778 {
2779     addr_t return_addr = AllocateMemory(size, permissions, error);
2780     if (error.Success())
2781     {
2782         std::string buffer(size, 0);
2783         WriteMemory(return_addr, buffer.c_str(), size, error);
2784     }
2785     return return_addr;
2786 }
2787 
2788 bool
2789 Process::CanJIT ()
2790 {
2791     if (m_can_jit == eCanJITDontKnow)
2792     {
2793         Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2794         Error err;
2795 
2796         uint64_t allocated_memory = AllocateMemory(8,
2797                                                    ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2798                                                    err);
2799 
2800         if (err.Success())
2801         {
2802             m_can_jit = eCanJITYes;
2803             if (log)
2804                 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ());
2805         }
2806         else
2807         {
2808             m_can_jit = eCanJITNo;
2809             if (log)
2810                 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ());
2811         }
2812 
2813         DeallocateMemory (allocated_memory);
2814     }
2815 
2816     return m_can_jit == eCanJITYes;
2817 }
2818 
2819 void
2820 Process::SetCanJIT (bool can_jit)
2821 {
2822     m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2823 }
2824 
2825 void
2826 Process::SetCanRunCode (bool can_run_code)
2827 {
2828     SetCanJIT(can_run_code);
2829     m_can_interpret_function_calls = can_run_code;
2830 }
2831 
2832 Error
2833 Process::DeallocateMemory (addr_t ptr)
2834 {
2835     Error error;
2836 #if defined (USE_ALLOCATE_MEMORY_CACHE)
2837     if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2838     {
2839         error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
2840     }
2841 #else
2842     error = DoDeallocateMemory (ptr);
2843 
2844     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2845     if (log)
2846         log->Printf("Process::DeallocateMemory(addr=0x%16.16" PRIx64 ") => err = %s (m_stop_id = %u, m_memory_id = %u)",
2847                     ptr,
2848                     error.AsCString("SUCCESS"),
2849                     m_mod_id.GetStopID(),
2850                     m_mod_id.GetMemoryID());
2851 #endif
2852     return error;
2853 }
2854 
2855 ModuleSP
2856 Process::ReadModuleFromMemory (const FileSpec& file_spec,
2857                                lldb::addr_t header_addr,
2858                                size_t size_to_read)
2859 {
2860     Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
2861     if (log)
2862     {
2863         log->Printf ("Process::ReadModuleFromMemory reading %s binary from memory", file_spec.GetPath().c_str());
2864     }
2865     ModuleSP module_sp (new Module (file_spec, ArchSpec()));
2866     if (module_sp)
2867     {
2868         Error error;
2869         ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read);
2870         if (objfile)
2871             return module_sp;
2872     }
2873     return ModuleSP();
2874 }
2875 
2876 bool
2877 Process::GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions)
2878 {
2879     MemoryRegionInfo range_info;
2880     permissions = 0;
2881     Error error (GetMemoryRegionInfo (load_addr, range_info));
2882     if (!error.Success())
2883         return false;
2884     if (range_info.GetReadable() == MemoryRegionInfo::eDontKnow
2885         || range_info.GetWritable() == MemoryRegionInfo::eDontKnow
2886         || range_info.GetExecutable() == MemoryRegionInfo::eDontKnow)
2887     {
2888         return false;
2889     }
2890 
2891     if (range_info.GetReadable() == MemoryRegionInfo::eYes)
2892         permissions |= lldb::ePermissionsReadable;
2893 
2894     if (range_info.GetWritable() == MemoryRegionInfo::eYes)
2895         permissions |= lldb::ePermissionsWritable;
2896 
2897     if (range_info.GetExecutable() == MemoryRegionInfo::eYes)
2898         permissions |= lldb::ePermissionsExecutable;
2899 
2900     return true;
2901 }
2902 
2903 Error
2904 Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
2905 {
2906     Error error;
2907     error.SetErrorString("watchpoints are not supported");
2908     return error;
2909 }
2910 
2911 Error
2912 Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
2913 {
2914     Error error;
2915     error.SetErrorString("watchpoints are not supported");
2916     return error;
2917 }
2918 
2919 StateType
2920 Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2921 {
2922     StateType state;
2923     // Now wait for the process to launch and return control to us, and then
2924     // call DidLaunch:
2925     while (1)
2926     {
2927         event_sp.reset();
2928         state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2929 
2930         if (StateIsStoppedState(state, false))
2931             break;
2932 
2933         // If state is invalid, then we timed out
2934         if (state == eStateInvalid)
2935             break;
2936 
2937         if (event_sp)
2938             HandlePrivateEvent (event_sp);
2939     }
2940     return state;
2941 }
2942 
2943 void
2944 Process::LoadOperatingSystemPlugin(bool flush)
2945 {
2946     if (flush)
2947         m_thread_list.Clear();
2948     m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2949     if (flush)
2950         Flush();
2951 }
2952 
2953 Error
2954 Process::Launch (ProcessLaunchInfo &launch_info)
2955 {
2956     Error error;
2957     m_abi_sp.reset();
2958     m_dyld_ap.reset();
2959     m_jit_loaders_ap.reset();
2960     m_system_runtime_ap.reset();
2961     m_os_ap.reset();
2962     m_process_input_reader.reset();
2963     m_stop_info_override_callback = NULL;
2964 
2965     Module *exe_module = GetTarget().GetExecutableModulePointer();
2966     if (exe_module)
2967     {
2968         char local_exec_file_path[PATH_MAX];
2969         char platform_exec_file_path[PATH_MAX];
2970         exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2971         exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
2972         if (exe_module->GetFileSpec().Exists())
2973         {
2974             // Install anything that might need to be installed prior to launching.
2975             // For host systems, this will do nothing, but if we are connected to a
2976             // remote platform it will install any needed binaries
2977             error = GetTarget().Install(&launch_info);
2978             if (error.Fail())
2979                 return error;
2980 
2981             if (PrivateStateThreadIsValid ())
2982                 PausePrivateStateThread ();
2983 
2984             error = WillLaunch (exe_module);
2985             if (error.Success())
2986             {
2987                 const bool restarted = false;
2988                 SetPublicState (eStateLaunching, restarted);
2989                 m_should_detach = false;
2990 
2991                 if (m_public_run_lock.TrySetRunning())
2992                 {
2993                     // Now launch using these arguments.
2994                     error = DoLaunch (exe_module, launch_info);
2995                 }
2996                 else
2997                 {
2998                     // This shouldn't happen
2999                     error.SetErrorString("failed to acquire process run lock");
3000                 }
3001 
3002                 if (error.Fail())
3003                 {
3004                     if (GetID() != LLDB_INVALID_PROCESS_ID)
3005                     {
3006                         SetID (LLDB_INVALID_PROCESS_ID);
3007                         const char *error_string = error.AsCString();
3008                         if (error_string == NULL)
3009                             error_string = "launch failed";
3010                         SetExitStatus (-1, error_string);
3011                     }
3012                 }
3013                 else
3014                 {
3015                     EventSP event_sp;
3016                     TimeValue timeout_time;
3017                     timeout_time = TimeValue::Now();
3018                     timeout_time.OffsetWithSeconds(10);
3019                     StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
3020 
3021                     if (state == eStateInvalid || event_sp.get() == NULL)
3022                     {
3023                         // We were able to launch the process, but we failed to
3024                         // catch the initial stop.
3025                         error.SetErrorString ("failed to catch stop after launch");
3026                         SetExitStatus (0, "failed to catch stop after launch");
3027                         Destroy(false);
3028                     }
3029                     else if (state == eStateStopped || state == eStateCrashed)
3030                     {
3031                         DidLaunch ();
3032 
3033                         DynamicLoader *dyld = GetDynamicLoader ();
3034                         if (dyld)
3035                             dyld->DidLaunch();
3036 
3037                         GetJITLoaders().DidLaunch();
3038 
3039                         SystemRuntime *system_runtime = GetSystemRuntime ();
3040                         if (system_runtime)
3041                             system_runtime->DidLaunch();
3042 
3043                         LoadOperatingSystemPlugin(false);
3044 
3045                         // Note, the stop event was consumed above, but not handled. This was done
3046                         // to give DidLaunch a chance to run. The target is either stopped or crashed.
3047                         // Directly set the state.  This is done to prevent a stop message with a bunch
3048                         // of spurious output on thread status, as well as not pop a ProcessIOHandler.
3049                         SetPublicState(state, false);
3050 
3051                         if (PrivateStateThreadIsValid ())
3052                             ResumePrivateStateThread ();
3053                         else
3054                             StartPrivateStateThread ();
3055 
3056                         m_stop_info_override_callback = GetTarget().GetArchitecture().GetStopInfoOverrideCallback();
3057 
3058                         // Target was stopped at entry as was intended. Need to notify the listeners
3059                         // about it.
3060                         if (state == eStateStopped && launch_info.GetFlags().Test(eLaunchFlagStopAtEntry))
3061                             HandlePrivateEvent(event_sp);
3062                     }
3063                     else if (state == eStateExited)
3064                     {
3065                         // We exited while trying to launch somehow.  Don't call DidLaunch as that's
3066                         // not likely to work, and return an invalid pid.
3067                         HandlePrivateEvent (event_sp);
3068                     }
3069                 }
3070             }
3071         }
3072         else
3073         {
3074             error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
3075         }
3076     }
3077     return error;
3078 }
3079 
3080 Error
3081 Process::LoadCore ()
3082 {
3083     Error error = DoLoadCore();
3084     if (error.Success())
3085     {
3086         Listener listener ("lldb.process.load_core_listener");
3087         HijackProcessEvents(&listener);
3088 
3089         if (PrivateStateThreadIsValid ())
3090             ResumePrivateStateThread ();
3091         else
3092             StartPrivateStateThread ();
3093 
3094         DynamicLoader *dyld = GetDynamicLoader ();
3095         if (dyld)
3096             dyld->DidAttach();
3097 
3098         GetJITLoaders().DidAttach();
3099 
3100         SystemRuntime *system_runtime = GetSystemRuntime ();
3101         if (system_runtime)
3102             system_runtime->DidAttach();
3103 
3104         m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
3105         // We successfully loaded a core file, now pretend we stopped so we can
3106         // show all of the threads in the core file and explore the crashed
3107         // state.
3108         SetPrivateState (eStateStopped);
3109 
3110         // Wait indefinitely for a stopped event since we just posted one above...
3111         lldb::EventSP event_sp;
3112         listener.WaitForEvent (NULL, event_sp);
3113         StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3114 
3115         if (!StateIsStoppedState (state, false))
3116         {
3117             Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3118             if (log)
3119                 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3120             error.SetErrorString ("Did not get stopped event after loading the core file.");
3121         }
3122         RestoreProcessEvents ();
3123     }
3124     return error;
3125 }
3126 
3127 DynamicLoader *
3128 Process::GetDynamicLoader ()
3129 {
3130     if (m_dyld_ap.get() == NULL)
3131         m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
3132     return m_dyld_ap.get();
3133 }
3134 
3135 const lldb::DataBufferSP
3136 Process::GetAuxvData()
3137 {
3138     return DataBufferSP ();
3139 }
3140 
3141 JITLoaderList &
3142 Process::GetJITLoaders ()
3143 {
3144     if (!m_jit_loaders_ap)
3145     {
3146         m_jit_loaders_ap.reset(new JITLoaderList());
3147         JITLoader::LoadPlugins(this, *m_jit_loaders_ap);
3148     }
3149     return *m_jit_loaders_ap;
3150 }
3151 
3152 SystemRuntime *
3153 Process::GetSystemRuntime ()
3154 {
3155     if (m_system_runtime_ap.get() == NULL)
3156         m_system_runtime_ap.reset (SystemRuntime::FindPlugin(this));
3157     return m_system_runtime_ap.get();
3158 }
3159 
3160 Process::AttachCompletionHandler::AttachCompletionHandler (Process *process, uint32_t exec_count) :
3161     NextEventAction (process),
3162     m_exec_count (exec_count)
3163 {
3164     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3165     if (log)
3166         log->Printf ("Process::AttachCompletionHandler::%s process=%p, exec_count=%" PRIu32, __FUNCTION__, static_cast<void*>(process), exec_count);
3167 }
3168 
3169 Process::NextEventAction::EventActionResult
3170 Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
3171 {
3172     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3173 
3174     StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
3175     if (log)
3176         log->Printf ("Process::AttachCompletionHandler::%s called with state %s (%d)", __FUNCTION__, StateAsCString(state), static_cast<int> (state));
3177 
3178     switch (state)
3179     {
3180         case eStateAttaching:
3181             return eEventActionSuccess;
3182 
3183         case eStateRunning:
3184         case eStateConnected:
3185             return eEventActionRetry;
3186 
3187         case eStateStopped:
3188         case eStateCrashed:
3189             {
3190                 // During attach, prior to sending the eStateStopped event,
3191                 // lldb_private::Process subclasses must set the new process ID.
3192                 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
3193                 // We don't want these events to be reported, so go set the ShouldReportStop here:
3194                 m_process->GetThreadList().SetShouldReportStop (eVoteNo);
3195 
3196                 if (m_exec_count > 0)
3197                 {
3198                     --m_exec_count;
3199 
3200                     if (log)
3201                         log->Printf ("Process::AttachCompletionHandler::%s state %s: reduced remaining exec count to %" PRIu32 ", requesting resume", __FUNCTION__, StateAsCString(state), m_exec_count);
3202 
3203                     RequestResume();
3204                     return eEventActionRetry;
3205                 }
3206                 else
3207                 {
3208                     if (log)
3209                         log->Printf ("Process::AttachCompletionHandler::%s state %s: no more execs expected to start, continuing with attach", __FUNCTION__, StateAsCString(state));
3210 
3211                     m_process->CompleteAttach ();
3212                     return eEventActionSuccess;
3213                 }
3214             }
3215             break;
3216 
3217         default:
3218         case eStateExited:
3219         case eStateInvalid:
3220             break;
3221     }
3222 
3223     m_exit_string.assign ("No valid Process");
3224     return eEventActionExit;
3225 }
3226 
3227 Process::NextEventAction::EventActionResult
3228 Process::AttachCompletionHandler::HandleBeingInterrupted()
3229 {
3230     return eEventActionSuccess;
3231 }
3232 
3233 const char *
3234 Process::AttachCompletionHandler::GetExitString ()
3235 {
3236     return m_exit_string.c_str();
3237 }
3238 
3239 Listener &
3240 ProcessAttachInfo::GetListenerForProcess (Debugger &debugger)
3241 {
3242     if (m_listener_sp)
3243         return *m_listener_sp;
3244     else
3245         return debugger.GetListener();
3246 }
3247 
3248 Error
3249 Process::Attach (ProcessAttachInfo &attach_info)
3250 {
3251     m_abi_sp.reset();
3252     m_process_input_reader.reset();
3253     m_dyld_ap.reset();
3254     m_jit_loaders_ap.reset();
3255     m_system_runtime_ap.reset();
3256     m_os_ap.reset();
3257     m_stop_info_override_callback = NULL;
3258 
3259     lldb::pid_t attach_pid = attach_info.GetProcessID();
3260     Error error;
3261     if (attach_pid == LLDB_INVALID_PROCESS_ID)
3262     {
3263         char process_name[PATH_MAX];
3264 
3265         if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
3266         {
3267             const bool wait_for_launch = attach_info.GetWaitForLaunch();
3268 
3269             if (wait_for_launch)
3270             {
3271                 error = WillAttachToProcessWithName(process_name, wait_for_launch);
3272                 if (error.Success())
3273                 {
3274                     if (m_public_run_lock.TrySetRunning())
3275                     {
3276                         m_should_detach = true;
3277                         const bool restarted = false;
3278                         SetPublicState (eStateAttaching, restarted);
3279                         // Now attach using these arguments.
3280                         error = DoAttachToProcessWithName (process_name, attach_info);
3281                     }
3282                     else
3283                     {
3284                         // This shouldn't happen
3285                         error.SetErrorString("failed to acquire process run lock");
3286                     }
3287 
3288                     if (error.Fail())
3289                     {
3290                         if (GetID() != LLDB_INVALID_PROCESS_ID)
3291                         {
3292                             SetID (LLDB_INVALID_PROCESS_ID);
3293                             if (error.AsCString() == NULL)
3294                                 error.SetErrorString("attach failed");
3295 
3296                             SetExitStatus(-1, error.AsCString());
3297                         }
3298                     }
3299                     else
3300                     {
3301                         SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3302                         StartPrivateStateThread();
3303                     }
3304                     return error;
3305                 }
3306             }
3307             else
3308             {
3309                 ProcessInstanceInfoList process_infos;
3310                 PlatformSP platform_sp (GetTarget().GetPlatform ());
3311 
3312                 if (platform_sp)
3313                 {
3314                     ProcessInstanceInfoMatch match_info;
3315                     match_info.GetProcessInfo() = attach_info;
3316                     match_info.SetNameMatchType (eNameMatchEquals);
3317                     platform_sp->FindProcesses (match_info, process_infos);
3318                     const uint32_t num_matches = process_infos.GetSize();
3319                     if (num_matches == 1)
3320                     {
3321                         attach_pid = process_infos.GetProcessIDAtIndex(0);
3322                         // Fall through and attach using the above process ID
3323                     }
3324                     else
3325                     {
3326                         match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
3327                         if (num_matches > 1)
3328                         {
3329                             StreamString s;
3330                             ProcessInstanceInfo::DumpTableHeader (s, platform_sp.get(), true, false);
3331                             for (size_t i = 0; i < num_matches; i++)
3332                             {
3333                                 process_infos.GetProcessInfoAtIndex(i).DumpAsTableRow(s, platform_sp.get(), true, false);
3334                             }
3335                             error.SetErrorStringWithFormat ("more than one process named %s:\n%s",
3336                                                             process_name,
3337                                                             s.GetData());
3338                         }
3339                         else
3340                             error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
3341                     }
3342                 }
3343                 else
3344                 {
3345                     error.SetErrorString ("invalid platform, can't find processes by name");
3346                     return error;
3347                 }
3348             }
3349         }
3350         else
3351         {
3352             error.SetErrorString ("invalid process name");
3353         }
3354     }
3355 
3356     if (attach_pid != LLDB_INVALID_PROCESS_ID)
3357     {
3358         error = WillAttachToProcessWithID(attach_pid);
3359         if (error.Success())
3360         {
3361 
3362             if (m_public_run_lock.TrySetRunning())
3363             {
3364                 // Now attach using these arguments.
3365                 m_should_detach = true;
3366                 const bool restarted = false;
3367                 SetPublicState (eStateAttaching, restarted);
3368                 error = DoAttachToProcessWithID (attach_pid, attach_info);
3369             }
3370             else
3371             {
3372                 // This shouldn't happen
3373                 error.SetErrorString("failed to acquire process run lock");
3374             }
3375 
3376             if (error.Success())
3377             {
3378 
3379                 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3380                 StartPrivateStateThread();
3381             }
3382             else
3383             {
3384                 if (GetID() != LLDB_INVALID_PROCESS_ID)
3385                     SetID (LLDB_INVALID_PROCESS_ID);
3386 
3387                 const char *error_string = error.AsCString();
3388                 if (error_string == NULL)
3389                     error_string = "attach failed";
3390 
3391                 SetExitStatus(-1, error_string);
3392             }
3393         }
3394     }
3395     return error;
3396 }
3397 
3398 void
3399 Process::CompleteAttach ()
3400 {
3401     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3402     if (log)
3403         log->Printf ("Process::%s()", __FUNCTION__);
3404 
3405     // Let the process subclass figure out at much as it can about the process
3406     // before we go looking for a dynamic loader plug-in.
3407     ArchSpec process_arch;
3408     DidAttach(process_arch);
3409 
3410     if (process_arch.IsValid())
3411     {
3412         GetTarget().SetArchitecture(process_arch);
3413         if (log)
3414         {
3415             const char *triple_str = process_arch.GetTriple().getTriple().c_str ();
3416             log->Printf ("Process::%s replacing process architecture with DidAttach() architecture: %s",
3417                          __FUNCTION__,
3418                          triple_str ? triple_str : "<null>");
3419         }
3420     }
3421 
3422     // We just attached.  If we have a platform, ask it for the process architecture, and if it isn't
3423     // the same as the one we've already set, switch architectures.
3424     PlatformSP platform_sp (GetTarget().GetPlatform ());
3425     assert (platform_sp.get());
3426     if (platform_sp)
3427     {
3428         const ArchSpec &target_arch = GetTarget().GetArchitecture();
3429         if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
3430         {
3431             ArchSpec platform_arch;
3432             platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3433             if (platform_sp)
3434             {
3435                 GetTarget().SetPlatform (platform_sp);
3436                 GetTarget().SetArchitecture(platform_arch);
3437                 if (log)
3438                     log->Printf ("Process::%s switching platform to %s and architecture to %s based on info from attach", __FUNCTION__, platform_sp->GetName().AsCString (""), platform_arch.GetTriple().getTriple().c_str ());
3439             }
3440         }
3441         else if (!process_arch.IsValid())
3442         {
3443             ProcessInstanceInfo process_info;
3444             platform_sp->GetProcessInfo (GetID(), process_info);
3445             const ArchSpec &process_arch = process_info.GetArchitecture();
3446             if (process_arch.IsValid() && !GetTarget().GetArchitecture().IsExactMatch(process_arch))
3447             {
3448                 GetTarget().SetArchitecture (process_arch);
3449                 if (log)
3450                     log->Printf ("Process::%s switching architecture to %s based on info the platform retrieved for pid %" PRIu64, __FUNCTION__, process_arch.GetTriple().getTriple().c_str (), GetID ());
3451             }
3452         }
3453     }
3454 
3455     // We have completed the attach, now it is time to find the dynamic loader
3456     // plug-in
3457     DynamicLoader *dyld = GetDynamicLoader ();
3458     if (dyld)
3459     {
3460         dyld->DidAttach();
3461         if (log)
3462         {
3463             ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
3464             log->Printf ("Process::%s after DynamicLoader::DidAttach(), target executable is %s (using %s plugin)",
3465                          __FUNCTION__,
3466                          exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3467                          dyld->GetPluginName().AsCString ("<unnamed>"));
3468         }
3469     }
3470 
3471     GetJITLoaders().DidAttach();
3472 
3473     SystemRuntime *system_runtime = GetSystemRuntime ();
3474     if (system_runtime)
3475     {
3476         system_runtime->DidAttach();
3477         if (log)
3478         {
3479             ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
3480             log->Printf ("Process::%s after SystemRuntime::DidAttach(), target executable is %s (using %s plugin)",
3481                          __FUNCTION__,
3482                          exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3483                          system_runtime->GetPluginName().AsCString("<unnamed>"));
3484         }
3485     }
3486 
3487     m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
3488     // Figure out which one is the executable, and set that in our target:
3489     const ModuleList &target_modules = GetTarget().GetImages();
3490     Mutex::Locker modules_locker(target_modules.GetMutex());
3491     size_t num_modules = target_modules.GetSize();
3492     ModuleSP new_executable_module_sp;
3493 
3494     for (size_t i = 0; i < num_modules; i++)
3495     {
3496         ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
3497         if (module_sp && module_sp->IsExecutable())
3498         {
3499             if (GetTarget().GetExecutableModulePointer() != module_sp.get())
3500                 new_executable_module_sp = module_sp;
3501             break;
3502         }
3503     }
3504     if (new_executable_module_sp)
3505     {
3506         GetTarget().SetExecutableModule (new_executable_module_sp, false);
3507         if (log)
3508         {
3509             ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
3510             log->Printf ("Process::%s after looping through modules, target executable is %s",
3511                          __FUNCTION__,
3512                          exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>");
3513         }
3514     }
3515 
3516     m_stop_info_override_callback = process_arch.GetStopInfoOverrideCallback();
3517 }
3518 
3519 Error
3520 Process::ConnectRemote (Stream *strm, const char *remote_url)
3521 {
3522     m_abi_sp.reset();
3523     m_process_input_reader.reset();
3524 
3525     // Find the process and its architecture.  Make sure it matches the architecture
3526     // of the current Target, and if not adjust it.
3527 
3528     Error error (DoConnectRemote (strm, remote_url));
3529     if (error.Success())
3530     {
3531         if (GetID() != LLDB_INVALID_PROCESS_ID)
3532         {
3533             EventSP event_sp;
3534             StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3535 
3536             if (state == eStateStopped || state == eStateCrashed)
3537             {
3538                 // If we attached and actually have a process on the other end, then
3539                 // this ended up being the equivalent of an attach.
3540                 CompleteAttach ();
3541 
3542                 // This delays passing the stopped event to listeners till
3543                 // CompleteAttach gets a chance to complete...
3544                 HandlePrivateEvent (event_sp);
3545 
3546             }
3547         }
3548 
3549         if (PrivateStateThreadIsValid ())
3550             ResumePrivateStateThread ();
3551         else
3552             StartPrivateStateThread ();
3553     }
3554     return error;
3555 }
3556 
3557 Error
3558 Process::PrivateResume ()
3559 {
3560     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
3561     if (log)
3562         log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s",
3563                     m_mod_id.GetStopID(),
3564                     StateAsCString(m_public_state.GetValue()),
3565                     StateAsCString(m_private_state.GetValue()));
3566 
3567     Error error (WillResume());
3568     // Tell the process it is about to resume before the thread list
3569     if (error.Success())
3570     {
3571         // Now let the thread list know we are about to resume so it
3572         // can let all of our threads know that they are about to be
3573         // resumed. Threads will each be called with
3574         // Thread::WillResume(StateType) where StateType contains the state
3575         // that they are supposed to have when the process is resumed
3576         // (suspended/running/stepping). Threads should also check
3577         // their resume signal in lldb::Thread::GetResumeSignal()
3578         // to see if they are supposed to start back up with a signal.
3579         if (m_thread_list.WillResume())
3580         {
3581             // Last thing, do the PreResumeActions.
3582             if (!RunPreResumeActions())
3583             {
3584                 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming.");
3585             }
3586             else
3587             {
3588                 m_mod_id.BumpResumeID();
3589                 error = DoResume();
3590                 if (error.Success())
3591                 {
3592                     DidResume();
3593                     m_thread_list.DidResume();
3594                     if (log)
3595                         log->Printf ("Process thinks the process has resumed.");
3596                 }
3597             }
3598         }
3599         else
3600         {
3601             // Somebody wanted to run without running (e.g. we were faking a step from one frame of a set of inlined
3602             // frames that share the same PC to another.)  So generate a continue & a stopped event,
3603             // and let the world handle them.
3604             if (log)
3605                 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3606 
3607             SetPrivateState(eStateRunning);
3608             SetPrivateState(eStateStopped);
3609         }
3610     }
3611     else if (log)
3612         log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>"));
3613     return error;
3614 }
3615 
3616 Error
3617 Process::Halt (bool clear_thread_plans)
3618 {
3619     // Don't clear the m_clear_thread_plans_on_stop, only set it to true if
3620     // in case it was already set and some thread plan logic calls halt on its
3621     // own.
3622     m_clear_thread_plans_on_stop |= clear_thread_plans;
3623 
3624     // First make sure we aren't in the middle of handling an event, or we might restart.  This is pretty weak, since
3625     // we could just straightaway get another event.  It just narrows the window...
3626     m_currently_handling_event.WaitForValueEqualTo(false);
3627 
3628 
3629     // Pause our private state thread so we can ensure no one else eats
3630     // the stop event out from under us.
3631     Listener halt_listener ("lldb.process.halt_listener");
3632     HijackPrivateProcessEvents(&halt_listener);
3633 
3634     EventSP event_sp;
3635     Error error (WillHalt());
3636 
3637     bool restored_process_events = false;
3638     if (error.Success())
3639     {
3640 
3641         bool caused_stop = false;
3642 
3643         // Ask the process subclass to actually halt our process
3644         error = DoHalt(caused_stop);
3645         if (error.Success())
3646         {
3647             if (m_public_state.GetValue() == eStateAttaching)
3648             {
3649                 // Don't hijack and eat the eStateExited as the code that was doing
3650                 // the attach will be waiting for this event...
3651                 RestorePrivateProcessEvents();
3652                 restored_process_events = true;
3653                 SetExitStatus(SIGKILL, "Cancelled async attach.");
3654                 Destroy (false);
3655             }
3656             else
3657             {
3658                 // If "caused_stop" is true, then DoHalt stopped the process. If
3659                 // "caused_stop" is false, the process was already stopped.
3660                 // If the DoHalt caused the process to stop, then we want to catch
3661                 // this event and set the interrupted bool to true before we pass
3662                 // this along so clients know that the process was interrupted by
3663                 // a halt command.
3664                 if (caused_stop)
3665                 {
3666                     // Wait for 1 second for the process to stop.
3667                     TimeValue timeout_time;
3668                     timeout_time = TimeValue::Now();
3669                     timeout_time.OffsetWithSeconds(10);
3670                     bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3671                     StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3672 
3673                     if (!got_event || state == eStateInvalid)
3674                     {
3675                         // We timeout out and didn't get a stop event...
3676                         error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
3677                     }
3678                     else
3679                     {
3680                         if (StateIsStoppedState (state, false))
3681                         {
3682                             // We caused the process to interrupt itself, so mark this
3683                             // as such in the stop event so clients can tell an interrupted
3684                             // process from a natural stop
3685                             ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3686                         }
3687                         else
3688                         {
3689                             Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3690                             if (log)
3691                                 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3692                             error.SetErrorString ("Did not get stopped event after halt.");
3693                         }
3694                     }
3695                 }
3696                 DidHalt();
3697             }
3698         }
3699     }
3700     // Resume our private state thread before we post the event (if any)
3701     if (!restored_process_events)
3702         RestorePrivateProcessEvents();
3703 
3704     // Post any event we might have consumed. If all goes well, we will have
3705     // stopped the process, intercepted the event and set the interrupted
3706     // bool in the event.  Post it to the private event queue and that will end up
3707     // correctly setting the state.
3708     if (event_sp)
3709         m_private_state_broadcaster.BroadcastEvent(event_sp);
3710 
3711     return error;
3712 }
3713 
3714 Error
3715 Process::StopForDestroyOrDetach(lldb::EventSP &exit_event_sp)
3716 {
3717     Error error;
3718     if (m_public_state.GetValue() == eStateRunning)
3719     {
3720         Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3721         if (log)
3722             log->Printf("Process::%s() About to stop.", __FUNCTION__);
3723 
3724         ListenerSP listener_sp (new Listener("lldb.Process.StopForDestroyOrDetach.hijack"));
3725         HijackProcessEvents(listener_sp.get());
3726 
3727         SendAsyncInterrupt();
3728 
3729         // Consume the interrupt event.
3730         TimeValue timeout (TimeValue::Now());
3731         timeout.OffsetWithSeconds(10);
3732 
3733         StateType state = WaitForProcessToStop (&timeout, &exit_event_sp, true, listener_sp.get());
3734 
3735         RestoreProcessEvents();
3736 
3737         // If the process exited while we were waiting for it to stop, put the exited event into
3738         // the shared pointer passed in and return.  Our caller doesn't need to do anything else, since
3739         // they don't have a process anymore...
3740 
3741         if (state == eStateExited || m_private_state.GetValue() == eStateExited)
3742         {
3743             if (log)
3744                 log->Printf("Process::%s() Process exited while waiting to stop.", __FUNCTION__);
3745             return error;
3746         }
3747         else
3748             exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3749 
3750         if (state != eStateStopped)
3751         {
3752             if (log)
3753                 log->Printf("Process::%s() failed to stop, state is: %s", __FUNCTION__, StateAsCString(state));
3754             // If we really couldn't stop the process then we should just error out here, but if the
3755             // lower levels just bobbled sending the event and we really are stopped, then continue on.
3756             StateType private_state = m_private_state.GetValue();
3757             if (private_state != eStateStopped)
3758             {
3759                 return error;
3760             }
3761         }
3762     }
3763     return error;
3764 }
3765 
3766 Error
3767 Process::Detach (bool keep_stopped)
3768 {
3769     EventSP exit_event_sp;
3770     Error error;
3771     m_destroy_in_process = true;
3772 
3773     error = WillDetach();
3774 
3775     if (error.Success())
3776     {
3777         if (DetachRequiresHalt())
3778         {
3779             error = StopForDestroyOrDetach (exit_event_sp);
3780             if (!error.Success())
3781             {
3782                 m_destroy_in_process = false;
3783                 return error;
3784             }
3785             else if (exit_event_sp)
3786             {
3787                 // We shouldn't need to do anything else here.  There's no process left to detach from...
3788                 StopPrivateStateThread();
3789                 m_destroy_in_process = false;
3790                 return error;
3791             }
3792         }
3793 
3794         m_thread_list.DiscardThreadPlans();
3795         DisableAllBreakpointSites();
3796 
3797         error = DoDetach(keep_stopped);
3798         if (error.Success())
3799         {
3800             DidDetach();
3801             StopPrivateStateThread();
3802         }
3803         else
3804         {
3805             return error;
3806         }
3807     }
3808     m_destroy_in_process = false;
3809 
3810     // If we exited when we were waiting for a process to stop, then
3811     // forward the event here so we don't lose the event
3812     if (exit_event_sp)
3813     {
3814         // Directly broadcast our exited event because we shut down our
3815         // private state thread above
3816         BroadcastEvent(exit_event_sp);
3817     }
3818 
3819     // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3820     // the last events through the event system, in which case we might strand the write lock.  Unlock
3821     // it here so when we do to tear down the process we don't get an error destroying the lock.
3822 
3823     m_public_run_lock.SetStopped();
3824     return error;
3825 }
3826 
3827 Error
3828 Process::Destroy (bool force_kill)
3829 {
3830 
3831     // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work
3832     // that might hinder the destruction.  Remember to set this back to false when we are done.  That way if the attempt
3833     // failed and the process stays around for some reason it won't be in a confused state.
3834 
3835     if (force_kill)
3836         m_should_detach = false;
3837 
3838     if (GetShouldDetach())
3839     {
3840         // FIXME: This will have to be a process setting:
3841         bool keep_stopped = false;
3842         Detach(keep_stopped);
3843     }
3844 
3845     m_destroy_in_process = true;
3846 
3847     Error error (WillDestroy());
3848     if (error.Success())
3849     {
3850         EventSP exit_event_sp;
3851         if (DestroyRequiresHalt())
3852         {
3853             error = StopForDestroyOrDetach(exit_event_sp);
3854         }
3855 
3856         if (m_public_state.GetValue() != eStateRunning)
3857         {
3858             // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3859             // kill it, we don't want it hitting a breakpoint...
3860             // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3861             // we're not going to have much luck doing this now.
3862             m_thread_list.DiscardThreadPlans();
3863             DisableAllBreakpointSites();
3864         }
3865 
3866         error = DoDestroy();
3867         if (error.Success())
3868         {
3869             DidDestroy();
3870             StopPrivateStateThread();
3871         }
3872         m_stdio_communication.Disconnect();
3873         m_stdio_communication.StopReadThread();
3874         m_stdin_forward = false;
3875 
3876         if (m_process_input_reader)
3877         {
3878             m_process_input_reader->SetIsDone(true);
3879             m_process_input_reader->Cancel();
3880             m_process_input_reader.reset();
3881         }
3882 
3883         // If we exited when we were waiting for a process to stop, then
3884         // forward the event here so we don't lose the event
3885         if (exit_event_sp)
3886         {
3887             // Directly broadcast our exited event because we shut down our
3888             // private state thread above
3889             BroadcastEvent(exit_event_sp);
3890         }
3891 
3892         // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3893         // the last events through the event system, in which case we might strand the write lock.  Unlock
3894         // it here so when we do to tear down the process we don't get an error destroying the lock.
3895         m_public_run_lock.SetStopped();
3896     }
3897 
3898     m_destroy_in_process = false;
3899 
3900     return error;
3901 }
3902 
3903 Error
3904 Process::Signal (int signal)
3905 {
3906     Error error (WillSignal());
3907     if (error.Success())
3908     {
3909         error = DoSignal(signal);
3910         if (error.Success())
3911             DidSignal();
3912     }
3913     return error;
3914 }
3915 
3916 void
3917 Process::SetUnixSignals(UnixSignalsSP &&signals_sp)
3918 {
3919     assert (signals_sp && "null signals_sp");
3920     m_unix_signals_sp = signals_sp;
3921 }
3922 
3923 const lldb::UnixSignalsSP &
3924 Process::GetUnixSignals ()
3925 {
3926     assert (m_unix_signals_sp && "null m_unix_signals_sp");
3927     return m_unix_signals_sp;
3928 }
3929 
3930 lldb::ByteOrder
3931 Process::GetByteOrder () const
3932 {
3933     return GetTarget().GetArchitecture().GetByteOrder();
3934 }
3935 
3936 uint32_t
3937 Process::GetAddressByteSize () const
3938 {
3939     return GetTarget().GetArchitecture().GetAddressByteSize();
3940 }
3941 
3942 bool
3943 Process::ShouldBroadcastEvent (Event *event_ptr)
3944 {
3945     const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3946     bool return_value = true;
3947     Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS));
3948 
3949     switch (state)
3950     {
3951         case eStateDetached:
3952         case eStateExited:
3953         case eStateUnloaded:
3954             m_stdio_communication.SynchronizeWithReadThread();
3955             m_stdio_communication.Disconnect();
3956             m_stdio_communication.StopReadThread();
3957             m_stdin_forward = false;
3958 
3959             // fall-through
3960         case eStateConnected:
3961         case eStateAttaching:
3962         case eStateLaunching:
3963             // These events indicate changes in the state of the debugging session, always report them.
3964             return_value = true;
3965             break;
3966         case eStateInvalid:
3967             // We stopped for no apparent reason, don't report it.
3968             return_value = false;
3969             break;
3970         case eStateRunning:
3971         case eStateStepping:
3972             // If we've started the target running, we handle the cases where we
3973             // are already running and where there is a transition from stopped to
3974             // running differently.
3975             // running -> running: Automatically suppress extra running events
3976             // stopped -> running: Report except when there is one or more no votes
3977             //     and no yes votes.
3978             SynchronouslyNotifyStateChanged (state);
3979             if (m_force_next_event_delivery)
3980                 return_value = true;
3981             else
3982             {
3983                 switch (m_last_broadcast_state)
3984                 {
3985                     case eStateRunning:
3986                     case eStateStepping:
3987                         // We always suppress multiple runnings with no PUBLIC stop in between.
3988                         return_value = false;
3989                         break;
3990                     default:
3991                         // TODO: make this work correctly. For now always report
3992                         // run if we aren't running so we don't miss any running
3993                         // events. If I run the lldb/test/thread/a.out file and
3994                         // break at main.cpp:58, run and hit the breakpoints on
3995                         // multiple threads, then somehow during the stepping over
3996                         // of all breakpoints no run gets reported.
3997 
3998                         // This is a transition from stop to run.
3999                         switch (m_thread_list.ShouldReportRun (event_ptr))
4000                         {
4001                             case eVoteYes:
4002                             case eVoteNoOpinion:
4003                                 return_value = true;
4004                                 break;
4005                             case eVoteNo:
4006                                 return_value = false;
4007                                 break;
4008                         }
4009                         break;
4010                 }
4011             }
4012             break;
4013         case eStateStopped:
4014         case eStateCrashed:
4015         case eStateSuspended:
4016         {
4017             // We've stopped.  First see if we're going to restart the target.
4018             // If we are going to stop, then we always broadcast the event.
4019             // If we aren't going to stop, let the thread plans decide if we're going to report this event.
4020             // If no thread has an opinion, we don't report it.
4021 
4022             m_stdio_communication.SynchronizeWithReadThread();
4023             RefreshStateAfterStop ();
4024             if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
4025             {
4026                 if (log)
4027                     log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s",
4028                                  static_cast<void*>(event_ptr),
4029                                  StateAsCString(state));
4030                 // Even though we know we are going to stop, we should let the threads have a look at the stop,
4031                 // so they can properly set their state.
4032                 m_thread_list.ShouldStop (event_ptr);
4033                 return_value = true;
4034             }
4035             else
4036             {
4037                 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
4038                 bool should_resume = false;
4039 
4040                 // It makes no sense to ask "ShouldStop" if we've already been restarted...
4041                 // Asking the thread list is also not likely to go well, since we are running again.
4042                 // So in that case just report the event.
4043 
4044                 if (!was_restarted)
4045                     should_resume = m_thread_list.ShouldStop (event_ptr) == false;
4046 
4047                 if (was_restarted || should_resume || m_resume_requested)
4048                 {
4049                     Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr);
4050                     if (log)
4051                         log->Printf ("Process::ShouldBroadcastEvent: should_stop: %i state: %s was_restarted: %i stop_vote: %d.",
4052                                      should_resume, StateAsCString(state),
4053                                      was_restarted, stop_vote);
4054 
4055                     switch (stop_vote)
4056                     {
4057                         case eVoteYes:
4058                             return_value = true;
4059                             break;
4060                         case eVoteNoOpinion:
4061                         case eVoteNo:
4062                             return_value = false;
4063                             break;
4064                     }
4065 
4066                     if (!was_restarted)
4067                     {
4068                         if (log)
4069                             log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s",
4070                                          static_cast<void*>(event_ptr),
4071                                          StateAsCString(state));
4072                         ProcessEventData::SetRestartedInEvent(event_ptr, true);
4073                         PrivateResume ();
4074                     }
4075                 }
4076                 else
4077                 {
4078                     return_value = true;
4079                     SynchronouslyNotifyStateChanged (state);
4080                 }
4081             }
4082         }
4083         break;
4084     }
4085 
4086     // Forcing the next event delivery is a one shot deal.  So reset it here.
4087     m_force_next_event_delivery = false;
4088 
4089     // We do some coalescing of events (for instance two consecutive running events get coalesced.)
4090     // But we only coalesce against events we actually broadcast.  So we use m_last_broadcast_state
4091     // to track that.  NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done,
4092     // because the PublicState reflects the last event pulled off the queue, and there may be several
4093     // events stacked up on the queue unserviced.  So the PublicState may not reflect the last broadcasted event
4094     // yet.  m_last_broadcast_state gets updated here.
4095 
4096     if (return_value)
4097         m_last_broadcast_state = state;
4098 
4099     if (log)
4100         log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s",
4101                      static_cast<void*>(event_ptr), StateAsCString(state),
4102                      StateAsCString(m_last_broadcast_state),
4103                      return_value ? "YES" : "NO");
4104     return return_value;
4105 }
4106 
4107 bool
4108 Process::StartPrivateStateThread (bool is_secondary_thread)
4109 {
4110     Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
4111 
4112     bool already_running = PrivateStateThreadIsValid ();
4113     if (log)
4114         log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
4115 
4116     if (!is_secondary_thread && already_running)
4117         return true;
4118 
4119     // Create a thread that watches our internal state and controls which
4120     // events make it to clients (into the DCProcess event queue).
4121     char thread_name[1024];
4122 
4123     if (HostInfo::GetMaxThreadNameLength() <= 30)
4124     {
4125         // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit.
4126         if (already_running)
4127             snprintf(thread_name, sizeof(thread_name), "intern-state-OV");
4128         else
4129             snprintf(thread_name, sizeof(thread_name), "intern-state");
4130     }
4131     else
4132     {
4133         if (already_running)
4134             snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
4135         else
4136             snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
4137     }
4138 
4139     // Create the private state thread, and start it running.
4140     PrivateStateThreadArgs args = {this, is_secondary_thread};
4141     m_private_state_thread = ThreadLauncher::LaunchThread(thread_name, Process::PrivateStateThread, (void *) &args, NULL);
4142     if (m_private_state_thread.IsJoinable())
4143     {
4144         ResumePrivateStateThread();
4145         return true;
4146     }
4147     else
4148         return false;
4149 }
4150 
4151 void
4152 Process::PausePrivateStateThread ()
4153 {
4154     ControlPrivateStateThread (eBroadcastInternalStateControlPause);
4155 }
4156 
4157 void
4158 Process::ResumePrivateStateThread ()
4159 {
4160     ControlPrivateStateThread (eBroadcastInternalStateControlResume);
4161 }
4162 
4163 void
4164 Process::StopPrivateStateThread ()
4165 {
4166     if (PrivateStateThreadIsValid ())
4167         ControlPrivateStateThread (eBroadcastInternalStateControlStop);
4168     else
4169     {
4170         Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
4171         if (log)
4172             log->Printf ("Went to stop the private state thread, but it was already invalid.");
4173     }
4174 }
4175 
4176 void
4177 Process::ControlPrivateStateThread (uint32_t signal)
4178 {
4179     Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
4180 
4181     assert (signal == eBroadcastInternalStateControlStop ||
4182             signal == eBroadcastInternalStateControlPause ||
4183             signal == eBroadcastInternalStateControlResume);
4184 
4185     if (log)
4186         log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
4187 
4188     // Signal the private state thread. First we should copy this is case the
4189     // thread starts exiting since the private state thread will NULL this out
4190     // when it exits
4191     HostThread private_state_thread(m_private_state_thread);
4192     if (private_state_thread.IsJoinable())
4193     {
4194         TimeValue timeout_time;
4195         bool timed_out;
4196 
4197         m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
4198 
4199         timeout_time = TimeValue::Now();
4200         timeout_time.OffsetWithSeconds(2);
4201         if (log)
4202             log->Printf ("Sending control event of type: %d.", signal);
4203         m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
4204         m_private_state_control_wait.SetValue (false, eBroadcastNever);
4205 
4206         if (signal == eBroadcastInternalStateControlStop)
4207         {
4208             if (timed_out)
4209             {
4210                 Error error = private_state_thread.Cancel();
4211                 if (log)
4212                     log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
4213             }
4214             else
4215             {
4216                 if (log)
4217                     log->Printf ("The control event killed the private state thread without having to cancel.");
4218             }
4219 
4220             thread_result_t result = NULL;
4221             private_state_thread.Join(&result);
4222             m_private_state_thread.Reset();
4223         }
4224     }
4225     else
4226     {
4227         if (log)
4228             log->Printf ("Private state thread already dead, no need to signal it to stop.");
4229     }
4230 }
4231 
4232 void
4233 Process::SendAsyncInterrupt ()
4234 {
4235     if (PrivateStateThreadIsValid())
4236         m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4237     else
4238         BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4239 }
4240 
4241 void
4242 Process::HandlePrivateEvent (EventSP &event_sp)
4243 {
4244     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4245     m_resume_requested = false;
4246 
4247     m_currently_handling_event.SetValue(true, eBroadcastNever);
4248 
4249     const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4250 
4251     // First check to see if anybody wants a shot at this event:
4252     if (m_next_event_action_ap.get() != NULL)
4253     {
4254         NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
4255         if (log)
4256             log->Printf ("Ran next event action, result was %d.", action_result);
4257 
4258         switch (action_result)
4259         {
4260             case NextEventAction::eEventActionSuccess:
4261                 SetNextEventAction(NULL);
4262                 break;
4263 
4264             case NextEventAction::eEventActionRetry:
4265                 break;
4266 
4267             case NextEventAction::eEventActionExit:
4268                 // Handle Exiting Here.  If we already got an exited event,
4269                 // we should just propagate it.  Otherwise, swallow this event,
4270                 // and set our state to exit so the next event will kill us.
4271                 if (new_state != eStateExited)
4272                 {
4273                     // FIXME: should cons up an exited event, and discard this one.
4274                     SetExitStatus(0, m_next_event_action_ap->GetExitString());
4275                     m_currently_handling_event.SetValue(false, eBroadcastAlways);
4276                     SetNextEventAction(NULL);
4277                     return;
4278                 }
4279                 SetNextEventAction(NULL);
4280                 break;
4281         }
4282     }
4283 
4284     // See if we should broadcast this state to external clients?
4285     const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
4286 
4287     if (should_broadcast)
4288     {
4289         const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged);
4290         if (log)
4291         {
4292             log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
4293                          __FUNCTION__,
4294                          GetID(),
4295                          StateAsCString(new_state),
4296                          StateAsCString (GetState ()),
4297                          is_hijacked ? "hijacked" : "public");
4298         }
4299         Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
4300         if (StateIsRunningState (new_state))
4301         {
4302             // Only push the input handler if we aren't fowarding events,
4303             // as this means the curses GUI is in use...
4304             // Or don't push it if we are launching since it will come up stopped.
4305             if (!GetTarget().GetDebugger().IsForwardingEvents() && new_state != eStateLaunching &&
4306                 new_state != eStateAttaching)
4307             {
4308                 PushProcessIOHandler ();
4309                 m_iohandler_sync.SetValue(m_iohandler_sync.GetValue()+1, eBroadcastAlways);
4310                 if (log)
4311                     log->Printf("Process::%s updated m_iohandler_sync to %d", __FUNCTION__, m_iohandler_sync.GetValue());
4312             }
4313         }
4314         else if (StateIsStoppedState(new_state, false))
4315         {
4316             if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
4317             {
4318                 // If the lldb_private::Debugger is handling the events, we don't
4319                 // want to pop the process IOHandler here, we want to do it when
4320                 // we receive the stopped event so we can carefully control when
4321                 // the process IOHandler is popped because when we stop we want to
4322                 // display some text stating how and why we stopped, then maybe some
4323                 // process/thread/frame info, and then we want the "(lldb) " prompt
4324                 // to show up. If we pop the process IOHandler here, then we will
4325                 // cause the command interpreter to become the top IOHandler after
4326                 // the process pops off and it will update its prompt right away...
4327                 // See the Debugger.cpp file where it calls the function as
4328                 // "process_sp->PopProcessIOHandler()" to see where I am talking about.
4329                 // Otherwise we end up getting overlapping "(lldb) " prompts and
4330                 // garbled output.
4331                 //
4332                 // If we aren't handling the events in the debugger (which is indicated
4333                 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we
4334                 // are hijacked, then we always pop the process IO handler manually.
4335                 // Hijacking happens when the internal process state thread is running
4336                 // thread plans, or when commands want to run in synchronous mode
4337                 // and they call "process->WaitForProcessToStop()". An example of something
4338                 // that will hijack the events is a simple expression:
4339                 //
4340                 //  (lldb) expr (int)puts("hello")
4341                 //
4342                 // This will cause the internal process state thread to resume and halt
4343                 // the process (and _it_ will hijack the eBroadcastBitStateChanged
4344                 // events) and we do need the IO handler to be pushed and popped
4345                 // correctly.
4346 
4347                 if (is_hijacked || GetTarget().GetDebugger().IsHandlingEvents() == false)
4348                     PopProcessIOHandler ();
4349             }
4350         }
4351 
4352         BroadcastEvent (event_sp);
4353     }
4354     else
4355     {
4356         if (log)
4357         {
4358             log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
4359                          __FUNCTION__,
4360                          GetID(),
4361                          StateAsCString(new_state),
4362                          StateAsCString (GetState ()));
4363         }
4364     }
4365     m_currently_handling_event.SetValue(false, eBroadcastAlways);
4366 }
4367 
4368 thread_result_t
4369 Process::PrivateStateThread (void *arg)
4370 {
4371     PrivateStateThreadArgs *real_args = static_cast<PrivateStateThreadArgs *> (arg);
4372     thread_result_t result = real_args->process->RunPrivateStateThread(real_args->is_secondary_thread);
4373     return result;
4374 }
4375 
4376 thread_result_t
4377 Process::RunPrivateStateThread (bool is_secondary_thread)
4378 {
4379     bool control_only = true;
4380     m_private_state_control_wait.SetValue (false, eBroadcastNever);
4381 
4382     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4383     if (log)
4384         log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...",
4385                      __FUNCTION__, static_cast<void*>(this), GetID());
4386 
4387     bool exit_now = false;
4388     while (!exit_now)
4389     {
4390         EventSP event_sp;
4391         WaitForEventsPrivate (NULL, event_sp, control_only);
4392         if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
4393         {
4394             if (log)
4395                 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d",
4396                              __FUNCTION__, static_cast<void*>(this), GetID(),
4397                              event_sp->GetType());
4398 
4399             switch (event_sp->GetType())
4400             {
4401             case eBroadcastInternalStateControlStop:
4402                 exit_now = true;
4403                 break;      // doing any internal state management below
4404 
4405             case eBroadcastInternalStateControlPause:
4406                 control_only = true;
4407                 break;
4408 
4409             case eBroadcastInternalStateControlResume:
4410                 control_only = false;
4411                 break;
4412             }
4413 
4414             m_private_state_control_wait.SetValue (true, eBroadcastAlways);
4415             continue;
4416         }
4417         else if (event_sp->GetType() == eBroadcastBitInterrupt)
4418         {
4419             if (m_public_state.GetValue() == eStateAttaching)
4420             {
4421                 if (log)
4422                     log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.",
4423                                  __FUNCTION__, static_cast<void*>(this),
4424                                  GetID());
4425                 BroadcastEvent (eBroadcastBitInterrupt, NULL);
4426             }
4427             else
4428             {
4429                 if (log)
4430                     log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.",
4431                                  __FUNCTION__, static_cast<void*>(this),
4432                                  GetID());
4433                 Halt();
4434             }
4435             continue;
4436         }
4437 
4438         const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4439 
4440         if (internal_state != eStateInvalid)
4441         {
4442             if (m_clear_thread_plans_on_stop &&
4443                 StateIsStoppedState(internal_state, true))
4444             {
4445                 m_clear_thread_plans_on_stop = false;
4446                 m_thread_list.DiscardThreadPlans();
4447             }
4448             HandlePrivateEvent (event_sp);
4449         }
4450 
4451         if (internal_state == eStateInvalid ||
4452             internal_state == eStateExited  ||
4453             internal_state == eStateDetached )
4454         {
4455             if (log)
4456                 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...",
4457                              __FUNCTION__, static_cast<void*>(this), GetID(),
4458                              StateAsCString(internal_state));
4459 
4460             break;
4461         }
4462     }
4463 
4464     // Verify log is still enabled before attempting to write to it...
4465     if (log)
4466         log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...",
4467                      __FUNCTION__, static_cast<void*>(this), GetID());
4468 
4469     // If we are a secondary thread, then the primary thread we are working for will have already
4470     // acquired the public_run_lock, and isn't done with what it was doing yet, so don't
4471     // try to change it on the way out.
4472     if (!is_secondary_thread)
4473         m_public_run_lock.SetStopped();
4474     m_private_state_control_wait.SetValue (true, eBroadcastAlways);
4475     m_private_state_thread.Reset();
4476     return NULL;
4477 }
4478 
4479 //------------------------------------------------------------------
4480 // Process Event Data
4481 //------------------------------------------------------------------
4482 
4483 Process::ProcessEventData::ProcessEventData () :
4484     EventData (),
4485     m_process_wp (),
4486     m_state (eStateInvalid),
4487     m_restarted (false),
4488     m_update_state (0),
4489     m_interrupted (false)
4490 {
4491 }
4492 
4493 Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
4494     EventData (),
4495     m_process_wp (),
4496     m_state (state),
4497     m_restarted (false),
4498     m_update_state (0),
4499     m_interrupted (false)
4500 {
4501     if (process_sp)
4502         m_process_wp = process_sp;
4503 }
4504 
4505 Process::ProcessEventData::~ProcessEventData() = default;
4506 
4507 const ConstString &
4508 Process::ProcessEventData::GetFlavorString ()
4509 {
4510     static ConstString g_flavor ("Process::ProcessEventData");
4511     return g_flavor;
4512 }
4513 
4514 const ConstString &
4515 Process::ProcessEventData::GetFlavor () const
4516 {
4517     return ProcessEventData::GetFlavorString ();
4518 }
4519 
4520 void
4521 Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
4522 {
4523     ProcessSP process_sp(m_process_wp.lock());
4524 
4525     if (!process_sp)
4526         return;
4527 
4528     // This function gets called twice for each event, once when the event gets pulled
4529     // off of the private process event queue, and then any number of times, first when it gets pulled off of
4530     // the public event queue, then other times when we're pretending that this is where we stopped at the
4531     // end of expression evaluation.  m_update_state is used to distinguish these
4532     // three cases; it is 0 when we're just pulling it off for private handling,
4533     // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
4534     if (m_update_state != 1)
4535         return;
4536 
4537     process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr));
4538 
4539     // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had
4540     // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may
4541     // end up restarting the process.
4542     if (m_interrupted)
4543         return;
4544 
4545     // If we're stopped and haven't restarted, then do the StopInfo actions here:
4546     if (m_state == eStateStopped && ! m_restarted)
4547     {
4548         // Let process subclasses know we are about to do a public stop and
4549         // do anything they might need to in order to speed up register and
4550         // memory accesses.
4551         process_sp->WillPublicStop();
4552 
4553         ThreadList &curr_thread_list = process_sp->GetThreadList();
4554         uint32_t num_threads = curr_thread_list.GetSize();
4555         uint32_t idx;
4556 
4557         // The actions might change one of the thread's stop_info's opinions about whether we should
4558         // stop the process, so we need to query that as we go.
4559 
4560         // One other complication here, is that we try to catch any case where the target has run (except for expressions)
4561         // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
4562         // that would cause our iteration here to crash.  We could make a copy of the thread list, but we'd really like
4563         // to also know if it has changed at all, so we make up a vector of the thread ID's and check what we get back
4564         // against this list & bag out if anything differs.
4565         std::vector<uint32_t> thread_index_array(num_threads);
4566         for (idx = 0; idx < num_threads; ++idx)
4567             thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
4568 
4569         // Use this to track whether we should continue from here.  We will only continue the target running if
4570         // no thread says we should stop.  Of course if some thread's PerformAction actually sets the target running,
4571         // then it doesn't matter what the other threads say...
4572 
4573         bool still_should_stop = false;
4574 
4575         // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a
4576         // valid stop reason.  In that case we should just stop, because we have no way of telling what the right
4577         // thing to do is, and it's better to let the user decide than continue behind their backs.
4578 
4579         bool does_anybody_have_an_opinion = false;
4580 
4581         for (idx = 0; idx < num_threads; ++idx)
4582         {
4583             curr_thread_list = process_sp->GetThreadList();
4584             if (curr_thread_list.GetSize() != num_threads)
4585             {
4586                 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
4587                 if (log)
4588                     log->Printf("Number of threads changed from %u to %u while processing event.", num_threads, curr_thread_list.GetSize());
4589                 break;
4590             }
4591 
4592             lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
4593 
4594             if (thread_sp->GetIndexID() != thread_index_array[idx])
4595             {
4596                 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
4597                 if (log)
4598                     log->Printf("The thread at position %u changed from %u to %u while processing event.",
4599                                 idx,
4600                                 thread_index_array[idx],
4601                                 thread_sp->GetIndexID());
4602                 break;
4603             }
4604 
4605             StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
4606             if (stop_info_sp && stop_info_sp->IsValid())
4607             {
4608                 does_anybody_have_an_opinion = true;
4609                 bool this_thread_wants_to_stop;
4610                 if (stop_info_sp->GetOverrideShouldStop())
4611                 {
4612                     this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue();
4613                 }
4614                 else
4615                 {
4616                     stop_info_sp->PerformAction(event_ptr);
4617                     // The stop action might restart the target.  If it does, then we want to mark that in the
4618                     // event so that whoever is receiving it will know to wait for the running event and reflect
4619                     // that state appropriately.
4620                     // We also need to stop processing actions, since they aren't expecting the target to be running.
4621 
4622                     // FIXME: we might have run.
4623                     if (stop_info_sp->HasTargetRunSinceMe())
4624                     {
4625                         SetRestarted (true);
4626                         break;
4627                     }
4628 
4629                     this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
4630                 }
4631 
4632                 if (still_should_stop == false)
4633                     still_should_stop = this_thread_wants_to_stop;
4634             }
4635         }
4636 
4637         if (!GetRestarted())
4638         {
4639             if (!still_should_stop && does_anybody_have_an_opinion)
4640             {
4641                 // We've been asked to continue, so do that here.
4642                 SetRestarted(true);
4643                 // Use the public resume method here, since this is just
4644                 // extending a public resume.
4645                 process_sp->PrivateResume();
4646             }
4647             else
4648             {
4649                 // If we didn't restart, run the Stop Hooks here:
4650                 // They might also restart the target, so watch for that.
4651                 process_sp->GetTarget().RunStopHooks();
4652                 if (process_sp->GetPrivateState() == eStateRunning)
4653                     SetRestarted(true);
4654             }
4655         }
4656     }
4657 }
4658 
4659 void
4660 Process::ProcessEventData::Dump (Stream *s) const
4661 {
4662     ProcessSP process_sp(m_process_wp.lock());
4663 
4664     if (process_sp)
4665         s->Printf(" process = %p (pid = %" PRIu64 "), ",
4666                   static_cast<void*>(process_sp.get()), process_sp->GetID());
4667     else
4668         s->PutCString(" process = NULL, ");
4669 
4670     s->Printf("state = %s", StateAsCString(GetState()));
4671 }
4672 
4673 const Process::ProcessEventData *
4674 Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
4675 {
4676     if (event_ptr)
4677     {
4678         const EventData *event_data = event_ptr->GetData();
4679         if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4680             return static_cast <const ProcessEventData *> (event_ptr->GetData());
4681     }
4682     return NULL;
4683 }
4684 
4685 ProcessSP
4686 Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4687 {
4688     ProcessSP process_sp;
4689     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4690     if (data)
4691         process_sp = data->GetProcessSP();
4692     return process_sp;
4693 }
4694 
4695 StateType
4696 Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4697 {
4698     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4699     if (data == NULL)
4700         return eStateInvalid;
4701     else
4702         return data->GetState();
4703 }
4704 
4705 bool
4706 Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4707 {
4708     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4709     if (data == NULL)
4710         return false;
4711     else
4712         return data->GetRestarted();
4713 }
4714 
4715 void
4716 Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4717 {
4718     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4719     if (data != NULL)
4720         data->SetRestarted(new_value);
4721 }
4722 
4723 size_t
4724 Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr)
4725 {
4726     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4727     if (data != NULL)
4728         return data->GetNumRestartedReasons();
4729     else
4730         return 0;
4731 }
4732 
4733 const char *
4734 Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx)
4735 {
4736     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4737     if (data != NULL)
4738         return data->GetRestartedReasonAtIndex(idx);
4739     else
4740         return NULL;
4741 }
4742 
4743 void
4744 Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason)
4745 {
4746     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4747     if (data != NULL)
4748         data->AddRestartedReason(reason);
4749 }
4750 
4751 bool
4752 Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4753 {
4754     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4755     if (data == NULL)
4756         return false;
4757     else
4758         return data->GetInterrupted ();
4759 }
4760 
4761 void
4762 Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4763 {
4764     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4765     if (data != NULL)
4766         data->SetInterrupted(new_value);
4767 }
4768 
4769 bool
4770 Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4771 {
4772     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4773     if (data)
4774     {
4775         data->SetUpdateStateOnRemoval();
4776         return true;
4777     }
4778     return false;
4779 }
4780 
4781 lldb::TargetSP
4782 Process::CalculateTarget ()
4783 {
4784     return m_target_sp.lock();
4785 }
4786 
4787 void
4788 Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
4789 {
4790     exe_ctx.SetTargetPtr (&GetTarget());
4791     exe_ctx.SetProcessPtr (this);
4792     exe_ctx.SetThreadPtr(NULL);
4793     exe_ctx.SetFramePtr (NULL);
4794 }
4795 
4796 //uint32_t
4797 //Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4798 //{
4799 //    return 0;
4800 //}
4801 //
4802 //ArchSpec
4803 //Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
4804 //{
4805 //    return Host::GetArchSpecForExistingProcess (pid);
4806 //}
4807 //
4808 //ArchSpec
4809 //Process::GetArchSpecForExistingProcess (const char *process_name)
4810 //{
4811 //    return Host::GetArchSpecForExistingProcess (process_name);
4812 //}
4813 //
4814 void
4815 Process::AppendSTDOUT (const char * s, size_t len)
4816 {
4817     Mutex::Locker locker (m_stdio_communication_mutex);
4818     m_stdout_data.append (s, len);
4819     BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
4820 }
4821 
4822 void
4823 Process::AppendSTDERR (const char * s, size_t len)
4824 {
4825     Mutex::Locker locker (m_stdio_communication_mutex);
4826     m_stderr_data.append (s, len);
4827     BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
4828 }
4829 
4830 void
4831 Process::BroadcastAsyncProfileData(const std::string &one_profile_data)
4832 {
4833     Mutex::Locker locker (m_profile_data_comm_mutex);
4834     m_profile_data.push_back(one_profile_data);
4835     BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
4836 }
4837 
4838 size_t
4839 Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
4840 {
4841     Mutex::Locker locker(m_profile_data_comm_mutex);
4842     if (m_profile_data.empty())
4843         return 0;
4844 
4845     std::string &one_profile_data = m_profile_data.front();
4846     size_t bytes_available = one_profile_data.size();
4847     if (bytes_available > 0)
4848     {
4849         Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4850         if (log)
4851             log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")",
4852                          static_cast<void*>(buf),
4853                          static_cast<uint64_t>(buf_size));
4854         if (bytes_available > buf_size)
4855         {
4856             memcpy(buf, one_profile_data.c_str(), buf_size);
4857             one_profile_data.erase(0, buf_size);
4858             bytes_available = buf_size;
4859         }
4860         else
4861         {
4862             memcpy(buf, one_profile_data.c_str(), bytes_available);
4863             m_profile_data.erase(m_profile_data.begin());
4864         }
4865     }
4866     return bytes_available;
4867 }
4868 
4869 //------------------------------------------------------------------
4870 // Process STDIO
4871 //------------------------------------------------------------------
4872 
4873 size_t
4874 Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
4875 {
4876     Mutex::Locker locker(m_stdio_communication_mutex);
4877     size_t bytes_available = m_stdout_data.size();
4878     if (bytes_available > 0)
4879     {
4880         Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4881         if (log)
4882             log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")",
4883                          static_cast<void*>(buf),
4884                          static_cast<uint64_t>(buf_size));
4885         if (bytes_available > buf_size)
4886         {
4887             memcpy(buf, m_stdout_data.c_str(), buf_size);
4888             m_stdout_data.erase(0, buf_size);
4889             bytes_available = buf_size;
4890         }
4891         else
4892         {
4893             memcpy(buf, m_stdout_data.c_str(), bytes_available);
4894             m_stdout_data.clear();
4895         }
4896     }
4897     return bytes_available;
4898 }
4899 
4900 size_t
4901 Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
4902 {
4903     Mutex::Locker locker(m_stdio_communication_mutex);
4904     size_t bytes_available = m_stderr_data.size();
4905     if (bytes_available > 0)
4906     {
4907         Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4908         if (log)
4909             log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")",
4910                          static_cast<void*>(buf),
4911                          static_cast<uint64_t>(buf_size));
4912         if (bytes_available > buf_size)
4913         {
4914             memcpy(buf, m_stderr_data.c_str(), buf_size);
4915             m_stderr_data.erase(0, buf_size);
4916             bytes_available = buf_size;
4917         }
4918         else
4919         {
4920             memcpy(buf, m_stderr_data.c_str(), bytes_available);
4921             m_stderr_data.clear();
4922         }
4923     }
4924     return bytes_available;
4925 }
4926 
4927 void
4928 Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
4929 {
4930     Process *process = (Process *) baton;
4931     process->AppendSTDOUT (static_cast<const char *>(src), src_len);
4932 }
4933 
4934 class IOHandlerProcessSTDIO :
4935     public IOHandler
4936 {
4937 public:
4938     IOHandlerProcessSTDIO (Process *process,
4939                            int write_fd) :
4940     IOHandler(process->GetTarget().GetDebugger(), IOHandler::Type::ProcessIO),
4941         m_process (process),
4942         m_read_file (),
4943         m_write_file (write_fd, false),
4944         m_pipe ()
4945     {
4946         m_pipe.CreateNew(false);
4947         m_read_file.SetDescriptor(GetInputFD(), false);
4948     }
4949 
4950     ~IOHandlerProcessSTDIO() override = default;
4951 
4952     // Each IOHandler gets to run until it is done. It should read data
4953     // from the "in" and place output into "out" and "err and return
4954     // when done.
4955     void
4956     Run () override
4957     {
4958         if (!m_read_file.IsValid() || !m_write_file.IsValid() || !m_pipe.CanRead() || !m_pipe.CanWrite())
4959         {
4960             SetIsDone(true);
4961             return;
4962         }
4963 
4964         SetIsDone(false);
4965         const int read_fd = m_read_file.GetDescriptor();
4966         TerminalState terminal_state;
4967         terminal_state.Save (read_fd, false);
4968         Terminal terminal(read_fd);
4969         terminal.SetCanonical(false);
4970         terminal.SetEcho(false);
4971 // FD_ZERO, FD_SET are not supported on windows
4972 #ifndef _WIN32
4973         const int pipe_read_fd = m_pipe.GetReadFileDescriptor();
4974         while (!GetIsDone())
4975         {
4976             fd_set read_fdset;
4977             FD_ZERO (&read_fdset);
4978             FD_SET (read_fd, &read_fdset);
4979             FD_SET (pipe_read_fd, &read_fdset);
4980             const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1;
4981             int num_set_fds = select (nfds, &read_fdset, NULL, NULL, NULL);
4982             if (num_set_fds < 0)
4983             {
4984                 const int select_errno = errno;
4985 
4986                 if (select_errno != EINTR)
4987                     SetIsDone(true);
4988             }
4989             else if (num_set_fds > 0)
4990             {
4991                 char ch = 0;
4992                 size_t n;
4993                 if (FD_ISSET (read_fd, &read_fdset))
4994                 {
4995                     n = 1;
4996                     if (m_read_file.Read(&ch, n).Success() && n == 1)
4997                     {
4998                         if (m_write_file.Write(&ch, n).Fail() || n != 1)
4999                             SetIsDone(true);
5000                     }
5001                     else
5002                         SetIsDone(true);
5003                 }
5004                 if (FD_ISSET (pipe_read_fd, &read_fdset))
5005                 {
5006                     size_t bytes_read;
5007                     // Consume the interrupt byte
5008                     Error error = m_pipe.Read(&ch, 1, bytes_read);
5009                     if (error.Success())
5010                     {
5011                         switch (ch)
5012                         {
5013                             case 'q':
5014                                 SetIsDone(true);
5015                                 break;
5016                             case 'i':
5017                                 if (StateIsRunningState(m_process->GetState()))
5018                                     m_process->SendAsyncInterrupt();
5019                                 break;
5020                         }
5021                     }
5022                 }
5023             }
5024         }
5025 #endif
5026         terminal_state.Restore();
5027     }
5028 
5029     void
5030     Cancel () override
5031     {
5032         char ch = 'q';  // Send 'q' for quit
5033         size_t bytes_written = 0;
5034         m_pipe.Write(&ch, 1, bytes_written);
5035     }
5036 
5037     bool
5038     Interrupt () override
5039     {
5040         // Do only things that are safe to do in an interrupt context (like in
5041         // a SIGINT handler), like write 1 byte to a file descriptor. This will
5042         // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte
5043         // that was written to the pipe and then call m_process->SendAsyncInterrupt()
5044         // from a much safer location in code.
5045         if (m_active)
5046         {
5047             char ch = 'i'; // Send 'i' for interrupt
5048             size_t bytes_written = 0;
5049             Error result = m_pipe.Write(&ch, 1, bytes_written);
5050             return result.Success();
5051         }
5052         else
5053         {
5054             // This IOHandler might be pushed on the stack, but not being run currently
5055             // so do the right thing if we aren't actively watching for STDIN by sending
5056             // the interrupt to the process. Otherwise the write to the pipe above would
5057             // do nothing. This can happen when the command interpreter is running and
5058             // gets a "expression ...". It will be on the IOHandler thread and sending
5059             // the input is complete to the delegate which will cause the expression to
5060             // run, which will push the process IO handler, but not run it.
5061 
5062             if (StateIsRunningState(m_process->GetState()))
5063             {
5064                 m_process->SendAsyncInterrupt();
5065                 return true;
5066             }
5067         }
5068         return false;
5069     }
5070 
5071     void
5072     GotEOF() override
5073     {
5074     }
5075 
5076 protected:
5077     Process *m_process;
5078     File m_read_file;   // Read from this file (usually actual STDIN for LLDB
5079     File m_write_file;  // Write to this file (usually the master pty for getting io to debuggee)
5080     Pipe m_pipe;
5081 };
5082 
5083 void
5084 Process::SetSTDIOFileDescriptor (int fd)
5085 {
5086     // First set up the Read Thread for reading/handling process I/O
5087 
5088     std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true));
5089 
5090     if (conn_ap.get())
5091     {
5092         m_stdio_communication.SetConnection (conn_ap.release());
5093         if (m_stdio_communication.IsConnected())
5094         {
5095             m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
5096             m_stdio_communication.StartReadThread();
5097 
5098             // Now read thread is set up, set up input reader.
5099 
5100             if (!m_process_input_reader.get())
5101                 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd));
5102         }
5103     }
5104 }
5105 
5106 bool
5107 Process::ProcessIOHandlerIsActive ()
5108 {
5109     IOHandlerSP io_handler_sp (m_process_input_reader);
5110     if (io_handler_sp)
5111         return GetTarget().GetDebugger().IsTopIOHandler (io_handler_sp);
5112     return false;
5113 }
5114 bool
5115 Process::PushProcessIOHandler ()
5116 {
5117     IOHandlerSP io_handler_sp (m_process_input_reader);
5118     if (io_handler_sp)
5119     {
5120         Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
5121         if (log)
5122             log->Printf("Process::%s pushing IO handler", __FUNCTION__);
5123 
5124         io_handler_sp->SetIsDone(false);
5125         GetTarget().GetDebugger().PushIOHandler (io_handler_sp);
5126         return true;
5127     }
5128     return false;
5129 }
5130 
5131 bool
5132 Process::PopProcessIOHandler ()
5133 {
5134     IOHandlerSP io_handler_sp (m_process_input_reader);
5135     if (io_handler_sp)
5136         return GetTarget().GetDebugger().PopIOHandler (io_handler_sp);
5137     return false;
5138 }
5139 
5140 // The process needs to know about installed plug-ins
5141 void
5142 Process::SettingsInitialize ()
5143 {
5144     Thread::SettingsInitialize ();
5145 }
5146 
5147 void
5148 Process::SettingsTerminate ()
5149 {
5150     Thread::SettingsTerminate ();
5151 }
5152 
5153 namespace
5154 {
5155     // RestorePlanState is used to record the "is private", "is master" and "okay to discard" fields of
5156     // the plan we are running, and reset it on Clean or on destruction.
5157     // It will only reset the state once, so you can call Clean and then monkey with the state and it
5158     // won't get reset on you again.
5159 
5160     class RestorePlanState
5161     {
5162     public:
5163         RestorePlanState (lldb::ThreadPlanSP thread_plan_sp) :
5164             m_thread_plan_sp(thread_plan_sp),
5165             m_already_reset(false)
5166         {
5167             if (m_thread_plan_sp)
5168             {
5169                 m_private = m_thread_plan_sp->GetPrivate();
5170                 m_is_master = m_thread_plan_sp->IsMasterPlan();
5171                 m_okay_to_discard = m_thread_plan_sp->OkayToDiscard();
5172             }
5173         }
5174 
5175         ~RestorePlanState()
5176         {
5177             Clean();
5178         }
5179 
5180         void
5181         Clean ()
5182         {
5183             if (!m_already_reset && m_thread_plan_sp)
5184             {
5185                 m_already_reset = true;
5186                 m_thread_plan_sp->SetPrivate(m_private);
5187                 m_thread_plan_sp->SetIsMasterPlan (m_is_master);
5188                 m_thread_plan_sp->SetOkayToDiscard(m_okay_to_discard);
5189             }
5190         }
5191 
5192     private:
5193         lldb::ThreadPlanSP m_thread_plan_sp;
5194         bool m_already_reset;
5195         bool m_private;
5196         bool m_is_master;
5197         bool m_okay_to_discard;
5198     };
5199 } // anonymous namespace
5200 
5201 ExpressionResults
5202 Process::RunThreadPlan (ExecutionContext &exe_ctx,
5203                         lldb::ThreadPlanSP &thread_plan_sp,
5204                         const EvaluateExpressionOptions &options,
5205                         Stream &errors)
5206 {
5207     ExpressionResults return_value = eExpressionSetupError;
5208 
5209     if (thread_plan_sp.get() == NULL)
5210     {
5211         errors.Printf("RunThreadPlan called with empty thread plan.");
5212         return eExpressionSetupError;
5213     }
5214 
5215     if (!thread_plan_sp->ValidatePlan(NULL))
5216     {
5217         errors.Printf ("RunThreadPlan called with an invalid thread plan.");
5218         return eExpressionSetupError;
5219     }
5220 
5221     if (exe_ctx.GetProcessPtr() != this)
5222     {
5223         errors.Printf("RunThreadPlan called on wrong process.");
5224         return eExpressionSetupError;
5225     }
5226 
5227     Thread *thread = exe_ctx.GetThreadPtr();
5228     if (thread == NULL)
5229     {
5230         errors.Printf("RunThreadPlan called with invalid thread.");
5231         return eExpressionSetupError;
5232     }
5233 
5234     // We need to change some of the thread plan attributes for the thread plan runner.  This will restore them
5235     // when we are done:
5236 
5237     RestorePlanState thread_plan_restorer(thread_plan_sp);
5238 
5239     // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
5240     // For that to be true the plan can't be private - since private plans suppress themselves in the
5241     // GetCompletedPlan call.
5242 
5243     thread_plan_sp->SetPrivate(false);
5244 
5245     // The plans run with RunThreadPlan also need to be terminal master plans or when they are done we will end
5246     // up asking the plan above us whether we should stop, which may give the wrong answer.
5247 
5248     thread_plan_sp->SetIsMasterPlan (true);
5249     thread_plan_sp->SetOkayToDiscard(false);
5250 
5251     if (m_private_state.GetValue() != eStateStopped)
5252     {
5253         errors.Printf ("RunThreadPlan called while the private state was not stopped.");
5254         return eExpressionSetupError;
5255     }
5256 
5257     // Save the thread & frame from the exe_ctx for restoration after we run
5258     const uint32_t thread_idx_id = thread->GetIndexID();
5259     StackFrameSP selected_frame_sp = thread->GetSelectedFrame();
5260     if (!selected_frame_sp)
5261     {
5262         thread->SetSelectedFrame(0);
5263         selected_frame_sp = thread->GetSelectedFrame();
5264         if (!selected_frame_sp)
5265         {
5266             errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id);
5267             return eExpressionSetupError;
5268         }
5269     }
5270 
5271     StackID ctx_frame_id = selected_frame_sp->GetStackID();
5272 
5273     // N.B. Running the target may unset the currently selected thread and frame.  We don't want to do that either,
5274     // so we should arrange to reset them as well.
5275 
5276     lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
5277 
5278     uint32_t selected_tid;
5279     StackID selected_stack_id;
5280     if (selected_thread_sp)
5281     {
5282         selected_tid = selected_thread_sp->GetIndexID();
5283         selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
5284     }
5285     else
5286     {
5287         selected_tid = LLDB_INVALID_THREAD_ID;
5288     }
5289 
5290     HostThread backup_private_state_thread;
5291     lldb::StateType old_state = eStateInvalid;
5292     lldb::ThreadPlanSP stopper_base_plan_sp;
5293 
5294     Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
5295     if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
5296     {
5297         // Yikes, we are running on the private state thread!  So we can't wait for public events on this thread, since
5298         // we are the thread that is generating public events.
5299         // The simplest thing to do is to spin up a temporary thread to handle private state thread events while
5300         // we are fielding public events here.
5301         if (log)
5302             log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events.");
5303 
5304         backup_private_state_thread = m_private_state_thread;
5305 
5306         // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
5307         // returning control here.
5308         // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
5309         // event before deciding to stop, and we don't want that.  So we insert a "stopper" base plan on the stack
5310         // before the plan we want to run.  Since base plans always stop and return control to the user, that will
5311         // do just what we want.
5312         stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
5313         thread->QueueThreadPlan (stopper_base_plan_sp, false);
5314         // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
5315         old_state = m_public_state.GetValue();
5316         m_public_state.SetValueNoLock(eStateStopped);
5317 
5318         // Now spin up the private state thread:
5319         StartPrivateStateThread(true);
5320     }
5321 
5322     thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
5323 
5324     if (options.GetDebug())
5325     {
5326         // In this case, we aren't actually going to run, we just want to stop right away.
5327         // Flush this thread so we will refetch the stacks and show the correct backtrace.
5328         // FIXME: To make this prettier we should invent some stop reason for this, but that
5329         // is only cosmetic, and this functionality is only of use to lldb developers who can
5330         // live with not pretty...
5331         thread->Flush();
5332         return eExpressionStoppedForDebug;
5333     }
5334 
5335     Listener listener("lldb.process.listener.run-thread-plan");
5336 
5337     lldb::EventSP event_to_broadcast_sp;
5338 
5339     {
5340         // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
5341         // restored on exit to the function.
5342         //
5343         // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
5344         // is put into event_to_broadcast_sp for rebroadcasting.
5345 
5346         ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
5347 
5348         if (log)
5349         {
5350             StreamString s;
5351             thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
5352             log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
5353                          thread->GetIndexID(),
5354                          thread->GetID(),
5355                          s.GetData());
5356         }
5357 
5358         bool got_event;
5359         lldb::EventSP event_sp;
5360         lldb::StateType stop_state = lldb::eStateInvalid;
5361 
5362         TimeValue* timeout_ptr = NULL;
5363         TimeValue real_timeout;
5364 
5365         bool before_first_timeout = true;  // This is set to false the first time that we have to halt the target.
5366         bool do_resume = true;
5367         bool handle_running_event = true;
5368         const uint64_t default_one_thread_timeout_usec = 250000;
5369 
5370         // This is just for accounting:
5371         uint32_t num_resumes = 0;
5372 
5373         uint32_t timeout_usec = options.GetTimeoutUsec();
5374         uint32_t one_thread_timeout_usec;
5375         uint32_t all_threads_timeout_usec = 0;
5376 
5377         // If we are going to run all threads the whole time, or if we are only going to run one thread,
5378         // then we don't need the first timeout.  So we set the final timeout, and pretend we are after the
5379         // first timeout already.
5380 
5381         if (!options.GetStopOthers() || !options.GetTryAllThreads())
5382         {
5383             before_first_timeout = false;
5384             one_thread_timeout_usec = 0;
5385             all_threads_timeout_usec = timeout_usec;
5386         }
5387         else
5388         {
5389             uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec();
5390 
5391             // If the overall wait is forever, then we only need to set the one thread timeout:
5392             if (timeout_usec == 0)
5393             {
5394                 if (option_one_thread_timeout != 0)
5395                     one_thread_timeout_usec = option_one_thread_timeout;
5396                 else
5397                     one_thread_timeout_usec = default_one_thread_timeout_usec;
5398             }
5399             else
5400             {
5401                 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout,
5402                 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec.
5403                 uint64_t computed_one_thread_timeout;
5404                 if (option_one_thread_timeout != 0)
5405                 {
5406                     if (timeout_usec < option_one_thread_timeout)
5407                     {
5408                         errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout");
5409                         return eExpressionSetupError;
5410                     }
5411                     computed_one_thread_timeout = option_one_thread_timeout;
5412                 }
5413                 else
5414                 {
5415                     computed_one_thread_timeout = timeout_usec / 2;
5416                     if (computed_one_thread_timeout > default_one_thread_timeout_usec)
5417                         computed_one_thread_timeout = default_one_thread_timeout_usec;
5418                 }
5419                 one_thread_timeout_usec = computed_one_thread_timeout;
5420                 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec;
5421             }
5422         }
5423 
5424         if (log)
5425             log->Printf ("Stop others: %u, try all: %u, before_first: %u, one thread: %" PRIu32 " - all threads: %" PRIu32 ".\n",
5426                          options.GetStopOthers(),
5427                          options.GetTryAllThreads(),
5428                          before_first_timeout,
5429                          one_thread_timeout_usec,
5430                          all_threads_timeout_usec);
5431 
5432         // This isn't going to work if there are unfetched events on the queue.
5433         // Are there cases where we might want to run the remaining events here, and then try to
5434         // call the function?  That's probably being too tricky for our own good.
5435 
5436         Event *other_events = listener.PeekAtNextEvent();
5437         if (other_events != NULL)
5438         {
5439             errors.Printf("Calling RunThreadPlan with pending events on the queue.");
5440             return eExpressionSetupError;
5441         }
5442 
5443         // We also need to make sure that the next event is delivered.  We might be calling a function as part of
5444         // a thread plan, in which case the last delivered event could be the running event, and we don't want
5445         // event coalescing to cause us to lose OUR running event...
5446         ForceNextEventDelivery();
5447 
5448         // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
5449         // So don't call return anywhere within it.
5450 
5451 #ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5452         // It's pretty much impossible to write test cases for things like:
5453         // One thread timeout expires, I go to halt, but the process already stopped
5454         // on the function call stop breakpoint.  Turning on this define will make us not
5455         // fetch the first event till after the halt.  So if you run a quick function, it will have
5456         // completed, and the completion event will be waiting, when you interrupt for halt.
5457         // The expression evaluation should still succeed.
5458         bool miss_first_event = true;
5459 #endif
5460         TimeValue one_thread_timeout;
5461         TimeValue final_timeout;
5462 
5463         while (1)
5464         {
5465             // We usually want to resume the process if we get to the top of the loop.
5466             // The only exception is if we get two running events with no intervening
5467             // stop, which can happen, we will just wait for then next stop event.
5468             if (log)
5469                 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.",
5470                              do_resume,
5471                              handle_running_event,
5472                              before_first_timeout);
5473 
5474             if (do_resume || handle_running_event)
5475             {
5476                 // Do the initial resume and wait for the running event before going further.
5477 
5478                 if (do_resume)
5479                 {
5480                     num_resumes++;
5481                     Error resume_error = PrivateResume ();
5482                     if (!resume_error.Success())
5483                     {
5484                         errors.Printf("Error resuming inferior the %d time: \"%s\".\n",
5485                                       num_resumes,
5486                                       resume_error.AsCString());
5487                         return_value = eExpressionSetupError;
5488                         break;
5489                     }
5490                 }
5491 
5492                 TimeValue resume_timeout = TimeValue::Now();
5493                 resume_timeout.OffsetWithMicroSeconds(500000);
5494 
5495                 got_event = listener.WaitForEvent(&resume_timeout, event_sp);
5496                 if (!got_event)
5497                 {
5498                     if (log)
5499                         log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.",
5500                                         num_resumes);
5501 
5502                     errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes);
5503                     return_value = eExpressionSetupError;
5504                     break;
5505                 }
5506 
5507                 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5508 
5509                 if (stop_state != eStateRunning)
5510                 {
5511                     bool restarted = false;
5512 
5513                     if (stop_state == eStateStopped)
5514                     {
5515                         restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get());
5516                         if (log)
5517                             log->Printf("Process::RunThreadPlan(): didn't get running event after "
5518                                         "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).",
5519                                         num_resumes,
5520                                         StateAsCString(stop_state),
5521                                         restarted,
5522                                         do_resume,
5523                                         handle_running_event);
5524                     }
5525 
5526                     if (restarted)
5527                     {
5528                         // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted
5529                         // event here.  But if I do, the best thing is to Halt and then get out of here.
5530                         Halt();
5531                     }
5532 
5533                     errors.Printf("Didn't get running event after initial resume, got %s instead.",
5534                                   StateAsCString(stop_state));
5535                     return_value = eExpressionSetupError;
5536                     break;
5537                 }
5538 
5539                 if (log)
5540                     log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
5541                 // We need to call the function synchronously, so spin waiting for it to return.
5542                 // If we get interrupted while executing, we're going to lose our context, and
5543                 // won't be able to gather the result at this point.
5544                 // We set the timeout AFTER the resume, since the resume takes some time and we
5545                 // don't want to charge that to the timeout.
5546             }
5547             else
5548             {
5549                 if (log)
5550                     log->PutCString ("Process::RunThreadPlan(): waiting for next event.");
5551             }
5552 
5553             if (before_first_timeout)
5554             {
5555                 if (options.GetTryAllThreads())
5556                 {
5557                     one_thread_timeout = TimeValue::Now();
5558                     one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec);
5559                     timeout_ptr = &one_thread_timeout;
5560                 }
5561                 else
5562                 {
5563                     if (timeout_usec == 0)
5564                         timeout_ptr = NULL;
5565                     else
5566                     {
5567                         final_timeout = TimeValue::Now();
5568                         final_timeout.OffsetWithMicroSeconds (timeout_usec);
5569                         timeout_ptr = &final_timeout;
5570                     }
5571                 }
5572             }
5573             else
5574             {
5575                 if (timeout_usec == 0)
5576                     timeout_ptr = NULL;
5577                 else
5578                 {
5579                     final_timeout = TimeValue::Now();
5580                     final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec);
5581                     timeout_ptr = &final_timeout;
5582                 }
5583             }
5584 
5585             do_resume = true;
5586             handle_running_event = true;
5587 
5588             // Now wait for the process to stop again:
5589             event_sp.reset();
5590 
5591             if (log)
5592             {
5593                 if (timeout_ptr)
5594                 {
5595                     log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64,
5596                                  TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(),
5597                                  timeout_ptr->GetAsMicroSecondsSinceJan1_1970());
5598                 }
5599                 else
5600                 {
5601                     log->Printf ("Process::RunThreadPlan(): about to wait forever.");
5602                 }
5603             }
5604 
5605 #ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5606             // See comment above...
5607             if (miss_first_event)
5608             {
5609                 usleep(1000);
5610                 miss_first_event = false;
5611                 got_event = false;
5612             }
5613             else
5614 #endif
5615             got_event = listener.WaitForEvent (timeout_ptr, event_sp);
5616 
5617             if (got_event)
5618             {
5619                 if (event_sp.get())
5620                 {
5621                     bool keep_going = false;
5622                     if (event_sp->GetType() == eBroadcastBitInterrupt)
5623                     {
5624                         Halt();
5625                         return_value = eExpressionInterrupted;
5626                         errors.Printf ("Execution halted by user interrupt.");
5627                         if (log)
5628                             log->Printf ("Process::RunThreadPlan(): Got  interrupted by eBroadcastBitInterrupted, exiting.");
5629                         break;
5630                     }
5631                     else
5632                     {
5633                         stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5634                         if (log)
5635                             log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
5636 
5637                         switch (stop_state)
5638                         {
5639                         case lldb::eStateStopped:
5640                             {
5641                                 // We stopped, figure out what we are going to do now.
5642                                 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
5643                                 if (!thread_sp)
5644                                 {
5645                                     // Ooh, our thread has vanished.  Unlikely that this was successful execution...
5646                                     if (log)
5647                                         log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
5648                                     return_value = eExpressionInterrupted;
5649                                 }
5650                                 else
5651                                 {
5652                                     // If we were restarted, we just need to go back up to fetch another event.
5653                                     if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5654                                     {
5655                                         if (log)
5656                                         {
5657                                             log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting.");
5658                                         }
5659                                        keep_going = true;
5660                                        do_resume = false;
5661                                        handle_running_event = true;
5662                                     }
5663                                     else
5664                                     {
5665                                         StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
5666                                         StopReason stop_reason = eStopReasonInvalid;
5667                                         if (stop_info_sp)
5668                                              stop_reason = stop_info_sp->GetStopReason();
5669 
5670                                         // FIXME: We only check if the stop reason is plan complete, should we make sure that
5671                                         // it is OUR plan that is complete?
5672                                         if (stop_reason == eStopReasonPlanComplete)
5673                                         {
5674                                             if (log)
5675                                                 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
5676 
5677                                             // Restore the plan state so it will get reported as intended when we are done.
5678                                             thread_plan_restorer.Clean();
5679 
5680                                             return_value = eExpressionCompleted;
5681                                         }
5682                                         else
5683                                         {
5684                                             // Something restarted the target, so just wait for it to stop for real.
5685                                             if (stop_reason == eStopReasonBreakpoint)
5686                                             {
5687                                                 if (log)
5688                                                     log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription());
5689                                                 return_value = eExpressionHitBreakpoint;
5690                                                 if (!options.DoesIgnoreBreakpoints())
5691                                                 {
5692                                                     // Restore the plan state and then force Private to false.  We are
5693                                                     // going to stop because of this plan so we need it to become a public
5694                                                     // plan or it won't report correctly when we continue to its termination
5695                                                     // later on.
5696                                                     thread_plan_restorer.Clean();
5697                                                     if (thread_plan_sp)
5698                                                         thread_plan_sp->SetPrivate(false);
5699                                                     event_to_broadcast_sp = event_sp;
5700                                                 }
5701                                             }
5702                                             else
5703                                             {
5704                                                 if (log)
5705                                                     log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
5706                                                 if (!options.DoesUnwindOnError())
5707                                                     event_to_broadcast_sp = event_sp;
5708                                                 return_value = eExpressionInterrupted;
5709                                             }
5710                                         }
5711                                     }
5712                                 }
5713                             }
5714                             break;
5715 
5716                         case lldb::eStateRunning:
5717                             // This shouldn't really happen, but sometimes we do get two running events without an
5718                             // intervening stop, and in that case we should just go back to waiting for the stop.
5719                             do_resume = false;
5720                             keep_going = true;
5721                             handle_running_event = false;
5722                             break;
5723 
5724                         default:
5725                             if (log)
5726                                 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
5727 
5728                             if (stop_state == eStateExited)
5729                                 event_to_broadcast_sp = event_sp;
5730 
5731                             errors.Printf ("Execution stopped with unexpected state.\n");
5732                             return_value = eExpressionInterrupted;
5733                             break;
5734                         }
5735                     }
5736 
5737                     if (keep_going)
5738                         continue;
5739                     else
5740                         break;
5741                 }
5742                 else
5743                 {
5744                     if (log)
5745                         log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null.  How odd...");
5746                     return_value = eExpressionInterrupted;
5747                     break;
5748                 }
5749             }
5750             else
5751             {
5752                 // If we didn't get an event that means we've timed out...
5753                 // We will interrupt the process here.  Depending on what we were asked to do we will
5754                 // either exit, or try with all threads running for the same timeout.
5755 
5756                 if (log) {
5757                     if (options.GetTryAllThreads())
5758                     {
5759                         if (before_first_timeout)
5760                         {
5761                             if (timeout_usec != 0)
5762                             {
5763                                 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
5764                                              "running for %" PRIu32 " usec with all threads enabled.",
5765                                              all_threads_timeout_usec);
5766                             }
5767                             else
5768                             {
5769                                 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
5770                                              "running forever with all threads enabled.");
5771                             }
5772                         }
5773                         else
5774                             log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
5775                                          "and timeout: %u timed out, abandoning execution.",
5776                                          timeout_usec);
5777                     }
5778                     else
5779                         log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, "
5780                                      "abandoning execution.",
5781                                      timeout_usec);
5782                 }
5783 
5784                 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target
5785                 // could have stopped.  That's fine, Halt will figure that out and send the appropriate Stopped event.
5786                 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.)  In
5787                 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's
5788                 // stopped event.  That's what this while loop does.
5789 
5790                 bool back_to_top = true;
5791                 uint32_t try_halt_again = 0;
5792                 bool do_halt = true;
5793                 const uint32_t num_retries = 5;
5794                 while (try_halt_again < num_retries)
5795                 {
5796                     Error halt_error;
5797                     if (do_halt)
5798                     {
5799                         if (log)
5800                             log->Printf ("Process::RunThreadPlan(): Running Halt.");
5801                         halt_error = Halt();
5802                     }
5803                     if (halt_error.Success())
5804                     {
5805                         if (log)
5806                             log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
5807 
5808                         real_timeout = TimeValue::Now();
5809                         real_timeout.OffsetWithMicroSeconds(500000);
5810 
5811                         got_event = listener.WaitForEvent(&real_timeout, event_sp);
5812 
5813                         if (got_event)
5814                         {
5815                             stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5816                             if (log)
5817                             {
5818                                 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
5819                                 if (stop_state == lldb::eStateStopped
5820                                     && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
5821                                     log->PutCString ("    Event was the Halt interruption event.");
5822                             }
5823 
5824                             if (stop_state == lldb::eStateStopped)
5825                             {
5826                                 // Between the time we initiated the Halt and the time we delivered it, the process could have
5827                                 // already finished its job.  Check that here:
5828 
5829                                 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
5830                                 {
5831                                     if (log)
5832                                         log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done.  "
5833                                                      "Exiting wait loop.");
5834                                     return_value = eExpressionCompleted;
5835                                     back_to_top = false;
5836                                     break;
5837                                 }
5838 
5839                                 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5840                                 {
5841                                     if (log)
5842                                         log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again...  "
5843                                                      "Exiting wait loop.");
5844                                     try_halt_again++;
5845                                     do_halt = false;
5846                                     continue;
5847                                 }
5848 
5849                                 if (!options.GetTryAllThreads())
5850                                 {
5851                                     if (log)
5852                                         log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
5853                                     return_value = eExpressionInterrupted;
5854                                     back_to_top = false;
5855                                     break;
5856                                 }
5857 
5858                                 if (before_first_timeout)
5859                                 {
5860                                     // Set all the other threads to run, and return to the top of the loop, which will continue;
5861                                     before_first_timeout = false;
5862                                     thread_plan_sp->SetStopOthers (false);
5863                                     if (log)
5864                                         log->PutCString ("Process::RunThreadPlan(): about to resume.");
5865 
5866                                     back_to_top = true;
5867                                     break;
5868                                 }
5869                                 else
5870                                 {
5871                                     // Running all threads failed, so return Interrupted.
5872                                     if (log)
5873                                         log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
5874                                     return_value = eExpressionInterrupted;
5875                                     back_to_top = false;
5876                                     break;
5877                                 }
5878                             }
5879                         }
5880                         else
5881                         {   if (log)
5882                                 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event.  "
5883                                         "I'm getting out of here passing Interrupted.");
5884                             return_value = eExpressionInterrupted;
5885                             back_to_top = false;
5886                             break;
5887                         }
5888                     }
5889                     else
5890                     {
5891                         try_halt_again++;
5892                         continue;
5893                     }
5894                 }
5895 
5896                 if (!back_to_top || try_halt_again > num_retries)
5897                     break;
5898                 else
5899                     continue;
5900             }
5901         }  // END WAIT LOOP
5902 
5903         // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
5904         if (backup_private_state_thread.IsJoinable())
5905         {
5906             StopPrivateStateThread();
5907             Error error;
5908             m_private_state_thread = backup_private_state_thread;
5909             if (stopper_base_plan_sp)
5910             {
5911                 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
5912             }
5913             if (old_state != eStateInvalid)
5914                 m_public_state.SetValueNoLock(old_state);
5915         }
5916 
5917         if (return_value != eExpressionCompleted && log)
5918         {
5919             // Print a backtrace into the log so we can figure out where we are:
5920             StreamString s;
5921             s.PutCString("Thread state after unsuccessful completion: \n");
5922             thread->GetStackFrameStatus (s,
5923                                          0,
5924                                          UINT32_MAX,
5925                                          true,
5926                                          UINT32_MAX);
5927             log->PutCString(s.GetData());
5928 
5929         }
5930         // Restore the thread state if we are going to discard the plan execution.  There are three cases where this
5931         // could happen:
5932         // 1) The execution successfully completed
5933         // 2) We hit a breakpoint, and ignore_breakpoints was true
5934         // 3) We got some other error, and discard_on_error was true
5935         bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError())
5936                              || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints());
5937 
5938         if (return_value == eExpressionCompleted
5939             || should_unwind)
5940         {
5941             thread_plan_sp->RestoreThreadState();
5942         }
5943 
5944         // Now do some processing on the results of the run:
5945         if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint)
5946         {
5947             if (log)
5948             {
5949                 StreamString s;
5950                 if (event_sp)
5951                     event_sp->Dump (&s);
5952                 else
5953                 {
5954                     log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
5955                 }
5956 
5957                 StreamString ts;
5958 
5959                 const char *event_explanation = NULL;
5960 
5961                 do
5962                 {
5963                     if (!event_sp)
5964                     {
5965                         event_explanation = "<no event>";
5966                         break;
5967                     }
5968                     else if (event_sp->GetType() == eBroadcastBitInterrupt)
5969                     {
5970                         event_explanation = "<user interrupt>";
5971                         break;
5972                     }
5973                     else
5974                     {
5975                         const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
5976 
5977                         if (!event_data)
5978                         {
5979                             event_explanation = "<no event data>";
5980                             break;
5981                         }
5982 
5983                         Process *process = event_data->GetProcessSP().get();
5984 
5985                         if (!process)
5986                         {
5987                             event_explanation = "<no process>";
5988                             break;
5989                         }
5990 
5991                         ThreadList &thread_list = process->GetThreadList();
5992 
5993                         uint32_t num_threads = thread_list.GetSize();
5994                         uint32_t thread_index;
5995 
5996                         ts.Printf("<%u threads> ", num_threads);
5997 
5998                         for (thread_index = 0;
5999                              thread_index < num_threads;
6000                              ++thread_index)
6001                         {
6002                             Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
6003 
6004                             if (!thread)
6005                             {
6006                                 ts.Printf("<?> ");
6007                                 continue;
6008                             }
6009 
6010                             ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
6011                             RegisterContext *register_context = thread->GetRegisterContext().get();
6012 
6013                             if (register_context)
6014                                 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
6015                             else
6016                                 ts.Printf("[ip unknown] ");
6017 
6018                             // Show the private stop info here, the public stop info will be from the last natural stop.
6019                             lldb::StopInfoSP stop_info_sp = thread->GetPrivateStopInfo();
6020                             if (stop_info_sp)
6021                             {
6022                                 const char *stop_desc = stop_info_sp->GetDescription();
6023                                 if (stop_desc)
6024                                     ts.PutCString (stop_desc);
6025                             }
6026                             ts.Printf(">");
6027                         }
6028 
6029                         event_explanation = ts.GetData();
6030                     }
6031                 } while (0);
6032 
6033                 if (event_explanation)
6034                     log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
6035                 else
6036                     log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
6037             }
6038 
6039             if (should_unwind)
6040             {
6041                 if (log)
6042                     log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.",
6043                                  static_cast<void*>(thread_plan_sp.get()));
6044                 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6045             }
6046             else
6047             {
6048                 if (log)
6049                     log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.",
6050                                  static_cast<void*>(thread_plan_sp.get()));
6051             }
6052         }
6053         else if (return_value == eExpressionSetupError)
6054         {
6055             if (log)
6056                 log->PutCString("Process::RunThreadPlan(): execution set up error.");
6057 
6058             if (options.DoesUnwindOnError())
6059             {
6060                 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6061             }
6062         }
6063         else
6064         {
6065             if (thread->IsThreadPlanDone (thread_plan_sp.get()))
6066             {
6067                 if (log)
6068                     log->PutCString("Process::RunThreadPlan(): thread plan is done");
6069                 return_value = eExpressionCompleted;
6070             }
6071             else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
6072             {
6073                 if (log)
6074                     log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
6075                 return_value = eExpressionDiscarded;
6076             }
6077             else
6078             {
6079                 if (log)
6080                     log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
6081                 if (options.DoesUnwindOnError() && thread_plan_sp)
6082                 {
6083                     if (log)
6084                         log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
6085                     thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6086                 }
6087             }
6088         }
6089 
6090         // Thread we ran the function in may have gone away because we ran the target
6091         // Check that it's still there, and if it is put it back in the context.  Also restore the
6092         // frame in the context if it is still present.
6093         thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
6094         if (thread)
6095         {
6096             exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
6097         }
6098 
6099         // Also restore the current process'es selected frame & thread, since this function calling may
6100         // be done behind the user's back.
6101 
6102         if (selected_tid != LLDB_INVALID_THREAD_ID)
6103         {
6104             if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
6105             {
6106                 // We were able to restore the selected thread, now restore the frame:
6107                 Mutex::Locker lock(GetThreadList().GetMutex());
6108                 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
6109                 if (old_frame_sp)
6110                     GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
6111             }
6112         }
6113     }
6114 
6115     // If the process exited during the run of the thread plan, notify everyone.
6116 
6117     if (event_to_broadcast_sp)
6118     {
6119         if (log)
6120             log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
6121         BroadcastEvent(event_to_broadcast_sp);
6122     }
6123 
6124     return return_value;
6125 }
6126 
6127 const char *
6128 Process::ExecutionResultAsCString (ExpressionResults result)
6129 {
6130     const char *result_name;
6131 
6132     switch (result)
6133     {
6134         case eExpressionCompleted:
6135             result_name = "eExpressionCompleted";
6136             break;
6137         case eExpressionDiscarded:
6138             result_name = "eExpressionDiscarded";
6139             break;
6140         case eExpressionInterrupted:
6141             result_name = "eExpressionInterrupted";
6142             break;
6143         case eExpressionHitBreakpoint:
6144             result_name = "eExpressionHitBreakpoint";
6145             break;
6146         case eExpressionSetupError:
6147             result_name = "eExpressionSetupError";
6148             break;
6149         case eExpressionParseError:
6150             result_name = "eExpressionParseError";
6151             break;
6152         case eExpressionResultUnavailable:
6153             result_name = "eExpressionResultUnavailable";
6154             break;
6155         case eExpressionTimedOut:
6156             result_name = "eExpressionTimedOut";
6157             break;
6158         case eExpressionStoppedForDebug:
6159             result_name = "eExpressionStoppedForDebug";
6160             break;
6161     }
6162     return result_name;
6163 }
6164 
6165 void
6166 Process::GetStatus (Stream &strm)
6167 {
6168     const StateType state = GetState();
6169     if (StateIsStoppedState(state, false))
6170     {
6171         if (state == eStateExited)
6172         {
6173             int exit_status = GetExitStatus();
6174             const char *exit_description = GetExitDescription();
6175             strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
6176                           GetID(),
6177                           exit_status,
6178                           exit_status,
6179                           exit_description ? exit_description : "");
6180         }
6181         else
6182         {
6183             if (state == eStateConnected)
6184                 strm.Printf ("Connected to remote target.\n");
6185             else
6186                 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
6187         }
6188     }
6189     else
6190     {
6191         strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
6192     }
6193 }
6194 
6195 size_t
6196 Process::GetThreadStatus (Stream &strm,
6197                           bool only_threads_with_stop_reason,
6198                           uint32_t start_frame,
6199                           uint32_t num_frames,
6200                           uint32_t num_frames_with_source)
6201 {
6202     size_t num_thread_infos_dumped = 0;
6203 
6204     // You can't hold the thread list lock while calling Thread::GetStatus.  That very well might run code (e.g. if we need it
6205     // to get return values or arguments.)  For that to work the process has to be able to acquire it.  So instead copy the thread
6206     // ID's, and look them up one by one:
6207 
6208     uint32_t num_threads;
6209     std::vector<lldb::tid_t> thread_id_array;
6210     //Scope for thread list locker;
6211     {
6212         Mutex::Locker locker (GetThreadList().GetMutex());
6213         ThreadList &curr_thread_list = GetThreadList();
6214         num_threads = curr_thread_list.GetSize();
6215         uint32_t idx;
6216         thread_id_array.resize(num_threads);
6217         for (idx = 0; idx < num_threads; ++idx)
6218             thread_id_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID();
6219     }
6220 
6221     for (uint32_t i = 0; i < num_threads; i++)
6222     {
6223         ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_id_array[i]));
6224         if (thread_sp)
6225         {
6226             if (only_threads_with_stop_reason)
6227             {
6228                 StopInfoSP stop_info_sp = thread_sp->GetStopInfo();
6229                 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
6230                     continue;
6231             }
6232             thread_sp->GetStatus (strm,
6233                                start_frame,
6234                                num_frames,
6235                                num_frames_with_source);
6236             ++num_thread_infos_dumped;
6237         }
6238         else
6239         {
6240             Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
6241             if (log)
6242                 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus.");
6243         }
6244     }
6245     return num_thread_infos_dumped;
6246 }
6247 
6248 void
6249 Process::AddInvalidMemoryRegion (const LoadRange &region)
6250 {
6251     m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
6252 }
6253 
6254 bool
6255 Process::RemoveInvalidMemoryRange (const LoadRange &region)
6256 {
6257     return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
6258 }
6259 
6260 void
6261 Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
6262 {
6263     m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
6264 }
6265 
6266 bool
6267 Process::RunPreResumeActions ()
6268 {
6269     bool result = true;
6270     while (!m_pre_resume_actions.empty())
6271     {
6272         struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
6273         m_pre_resume_actions.pop_back();
6274         bool this_result = action.callback (action.baton);
6275         if (result == true)
6276             result = this_result;
6277     }
6278     return result;
6279 }
6280 
6281 void
6282 Process::ClearPreResumeActions ()
6283 {
6284     m_pre_resume_actions.clear();
6285 }
6286 
6287 ProcessRunLock &
6288 Process::GetRunLock()
6289 {
6290     if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
6291         return m_private_run_lock;
6292     else
6293         return m_public_run_lock;
6294 }
6295 
6296 void
6297 Process::Flush ()
6298 {
6299     m_thread_list.Flush();
6300     m_extended_thread_list.Flush();
6301     m_extended_thread_stop_id =  0;
6302     m_queue_list.Clear();
6303     m_queue_list_stop_id = 0;
6304 }
6305 
6306 void
6307 Process::DidExec ()
6308 {
6309     Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
6310     if (log)
6311         log->Printf ("Process::%s()", __FUNCTION__);
6312 
6313     Target &target = GetTarget();
6314     target.CleanupProcess ();
6315     target.ClearModules(false);
6316     m_dynamic_checkers_ap.reset();
6317     m_abi_sp.reset();
6318     m_system_runtime_ap.reset();
6319     m_os_ap.reset();
6320     m_dyld_ap.reset();
6321     m_jit_loaders_ap.reset();
6322     m_image_tokens.clear();
6323     m_allocated_memory_cache.Clear();
6324     m_language_runtimes.clear();
6325     m_instrumentation_runtimes.clear();
6326     m_thread_list.DiscardThreadPlans();
6327     m_memory_cache.Clear(true);
6328     m_stop_info_override_callback = NULL;
6329     DoDidExec();
6330     CompleteAttach ();
6331     // Flush the process (threads and all stack frames) after running CompleteAttach()
6332     // in case the dynamic loader loaded things in new locations.
6333     Flush();
6334 
6335     // After we figure out what was loaded/unloaded in CompleteAttach,
6336     // we need to let the target know so it can do any cleanup it needs to.
6337     target.DidExec();
6338 }
6339 
6340 addr_t
6341 Process::ResolveIndirectFunction(const Address *address, Error &error)
6342 {
6343     if (address == nullptr)
6344     {
6345         error.SetErrorString("Invalid address argument");
6346         return LLDB_INVALID_ADDRESS;
6347     }
6348 
6349     addr_t function_addr = LLDB_INVALID_ADDRESS;
6350 
6351     addr_t addr = address->GetLoadAddress(&GetTarget());
6352     std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr);
6353     if (iter != m_resolved_indirect_addresses.end())
6354     {
6355         function_addr = (*iter).second;
6356     }
6357     else
6358     {
6359         if (!InferiorCall(this, address, function_addr))
6360         {
6361             Symbol *symbol = address->CalculateSymbolContextSymbol();
6362             error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s",
6363                                           symbol ? symbol->GetName().AsCString() : "<UNKNOWN>");
6364             function_addr = LLDB_INVALID_ADDRESS;
6365         }
6366         else
6367         {
6368             m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr));
6369         }
6370     }
6371     return function_addr;
6372 }
6373 
6374 void
6375 Process::ModulesDidLoad (ModuleList &module_list)
6376 {
6377     SystemRuntime *sys_runtime = GetSystemRuntime();
6378     if (sys_runtime)
6379     {
6380         sys_runtime->ModulesDidLoad (module_list);
6381     }
6382 
6383     GetJITLoaders().ModulesDidLoad (module_list);
6384 
6385     // Give runtimes a chance to be created.
6386     InstrumentationRuntime::ModulesDidLoad(module_list, this, m_instrumentation_runtimes);
6387 
6388     // Tell runtimes about new modules.
6389     for (auto pos = m_instrumentation_runtimes.begin(); pos != m_instrumentation_runtimes.end(); ++pos)
6390     {
6391         InstrumentationRuntimeSP runtime = pos->second;
6392         runtime->ModulesDidLoad(module_list);
6393     }
6394 
6395     // Let any language runtimes we have already created know
6396     // about the modules that loaded.
6397 
6398     // Iterate over a copy of this language runtime list in case
6399     // the language runtime ModulesDidLoad somehow causes the language
6400     // riuntime to be unloaded.
6401     LanguageRuntimeCollection language_runtimes(m_language_runtimes);
6402     for (const auto &pair: language_runtimes)
6403     {
6404         // We must check language_runtime_sp to make sure it is not
6405         // NULL as we might cache the fact that we didn't have a
6406         // language runtime for a language.
6407         LanguageRuntimeSP language_runtime_sp = pair.second;
6408         if (language_runtime_sp)
6409             language_runtime_sp->ModulesDidLoad(module_list);
6410     }
6411 
6412     LoadOperatingSystemPlugin(false);
6413 }
6414 
6415 void
6416 Process::PrintWarning (uint64_t warning_type, void *repeat_key, const char *fmt, ...)
6417 {
6418     bool print_warning = true;
6419 
6420     StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
6421     if (stream_sp.get() == nullptr)
6422         return;
6423     if (warning_type == eWarningsOptimization
6424         && GetWarningsOptimization() == false)
6425     {
6426         return;
6427     }
6428 
6429     if (repeat_key != nullptr)
6430     {
6431         WarningsCollection::iterator it = m_warnings_issued.find (warning_type);
6432         if (it == m_warnings_issued.end())
6433         {
6434             m_warnings_issued[warning_type] = WarningsPointerSet();
6435             m_warnings_issued[warning_type].insert (repeat_key);
6436         }
6437         else
6438         {
6439             if (it->second.find (repeat_key) != it->second.end())
6440             {
6441                 print_warning = false;
6442             }
6443             else
6444             {
6445                 it->second.insert (repeat_key);
6446             }
6447         }
6448     }
6449 
6450     if (print_warning)
6451     {
6452         va_list args;
6453         va_start (args, fmt);
6454         stream_sp->PrintfVarArg (fmt, args);
6455         va_end (args);
6456     }
6457 }
6458 
6459 void
6460 Process::PrintWarningOptimization (const SymbolContext &sc)
6461 {
6462     if (GetWarningsOptimization() == true
6463         && sc.module_sp.get()
6464         && sc.module_sp->GetFileSpec().GetFilename().IsEmpty() == false
6465         && sc.function
6466         && sc.function->GetIsOptimized() == true)
6467     {
6468         PrintWarning (Process::Warnings::eWarningsOptimization, sc.module_sp.get(), "%s was compiled with optimization - stepping may behave oddly; variables may not be available.\n", sc.module_sp->GetFileSpec().GetFilename().GetCString());
6469     }
6470 }
6471 
6472 ThreadCollectionSP
6473 Process::GetHistoryThreads(lldb::addr_t addr)
6474 {
6475     ThreadCollectionSP threads;
6476 
6477     const MemoryHistorySP &memory_history = MemoryHistory::FindPlugin(shared_from_this());
6478 
6479     if (! memory_history.get()) {
6480         return threads;
6481     }
6482 
6483     threads.reset(new ThreadCollection(memory_history->GetHistoryThreads(addr)));
6484 
6485     return threads;
6486 }
6487 
6488 InstrumentationRuntimeSP
6489 Process::GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type)
6490 {
6491     InstrumentationRuntimeCollection::iterator pos;
6492     pos = m_instrumentation_runtimes.find (type);
6493     if (pos == m_instrumentation_runtimes.end())
6494     {
6495         return InstrumentationRuntimeSP();
6496     }
6497     else
6498         return (*pos).second;
6499 }
6500 
6501 bool
6502 Process::GetModuleSpec(const FileSpec& module_file_spec,
6503                        const ArchSpec& arch,
6504                        ModuleSpec& module_spec)
6505 {
6506     module_spec.Clear();
6507     return false;
6508 }
6509 
6510 size_t
6511 Process::AddImageToken(lldb::addr_t image_ptr)
6512 {
6513     m_image_tokens.push_back(image_ptr);
6514     return m_image_tokens.size() - 1;
6515 }
6516 
6517 lldb::addr_t
6518 Process::GetImagePtrFromToken(size_t token) const
6519 {
6520     if (token < m_image_tokens.size())
6521         return m_image_tokens[token];
6522     return LLDB_INVALID_IMAGE_TOKEN;
6523 }
6524 
6525 void
6526 Process::ResetImageToken(size_t token)
6527 {
6528     if (token < m_image_tokens.size())
6529         m_image_tokens[token] = LLDB_INVALID_IMAGE_TOKEN;
6530 }
6531