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