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