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