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