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