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