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 #include "lldb/Target/Process.h"
11 
12 #include "lldb/lldb-private-log.h"
13 
14 #include "lldb/Breakpoint/StoppointCallbackContext.h"
15 #include "lldb/Breakpoint/BreakpointLocation.h"
16 #include "lldb/Core/Event.h"
17 #include "lldb/Core/ConnectionFileDescriptor.h"
18 #include "lldb/Core/Debugger.h"
19 #include "lldb/Core/InputReader.h"
20 #include "lldb/Core/Log.h"
21 #include "lldb/Core/Module.h"
22 #include "lldb/Core/PluginManager.h"
23 #include "lldb/Core/State.h"
24 #include "lldb/Expression/ClangUserExpression.h"
25 #include "lldb/Interpreter/CommandInterpreter.h"
26 #include "lldb/Host/Host.h"
27 #include "lldb/Target/ABI.h"
28 #include "lldb/Target/DynamicLoader.h"
29 #include "lldb/Target/OperatingSystem.h"
30 #include "lldb/Target/LanguageRuntime.h"
31 #include "lldb/Target/CPPLanguageRuntime.h"
32 #include "lldb/Target/ObjCLanguageRuntime.h"
33 #include "lldb/Target/Platform.h"
34 #include "lldb/Target/RegisterContext.h"
35 #include "lldb/Target/StopInfo.h"
36 #include "lldb/Target/Target.h"
37 #include "lldb/Target/TargetList.h"
38 #include "lldb/Target/Thread.h"
39 #include "lldb/Target/ThreadPlan.h"
40 #include "lldb/Target/ThreadPlanBase.h"
41 
42 using namespace lldb;
43 using namespace lldb_private;
44 
45 
46 // Comment out line below to disable memory caching, overriding the process setting
47 // target.process.disable-memory-cache
48 #define ENABLE_MEMORY_CACHING
49 
50 #ifdef ENABLE_MEMORY_CACHING
51 #define DISABLE_MEM_CACHE_DEFAULT false
52 #else
53 #define DISABLE_MEM_CACHE_DEFAULT true
54 #endif
55 
56 class ProcessOptionValueProperties : public OptionValueProperties
57 {
58 public:
59     ProcessOptionValueProperties (const ConstString &name) :
60         OptionValueProperties (name)
61     {
62     }
63 
64     // This constructor is used when creating ProcessOptionValueProperties when it
65     // is part of a new lldb_private::Process instance. It will copy all current
66     // global property values as needed
67     ProcessOptionValueProperties (ProcessProperties *global_properties) :
68         OptionValueProperties(*global_properties->GetValueProperties())
69     {
70     }
71 
72     virtual const Property *
73     GetPropertyAtIndex (const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const
74     {
75         // When gettings the value for a key from the process options, we will always
76         // try and grab the setting from the current process if there is one. Else we just
77         // use the one from this instance.
78         if (exe_ctx)
79         {
80             Process *process = exe_ctx->GetProcessPtr();
81             if (process)
82             {
83                 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
84                 if (this != instance_properties)
85                     return instance_properties->ProtectedGetPropertyAtIndex (idx);
86             }
87         }
88         return ProtectedGetPropertyAtIndex (idx);
89     }
90 };
91 
92 static PropertyDefinition
93 g_properties[] =
94 {
95     { "disable-memory-cache" , OptionValue::eTypeBoolean, false, DISABLE_MEM_CACHE_DEFAULT, NULL, NULL, "Disable reading and caching of memory in fixed-size units." },
96     { "extra-startup-command", OptionValue::eTypeArray  , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used." },
97     {  NULL                  , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL  }
98 };
99 
100 enum {
101     ePropertyDisableMemCache,
102     ePropertyExtraStartCommand
103 };
104 
105 ProcessProperties::ProcessProperties (bool is_global) :
106     Properties ()
107 {
108     if (is_global)
109     {
110         m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
111         m_collection_sp->Initialize(g_properties);
112         m_collection_sp->AppendProperty(ConstString("thread"),
113                                         ConstString("Settings specify to threads."),
114                                         true,
115                                         Thread::GetGlobalProperties()->GetValueProperties());
116     }
117     else
118         m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
119 }
120 
121 ProcessProperties::~ProcessProperties()
122 {
123 }
124 
125 bool
126 ProcessProperties::GetDisableMemoryCache() const
127 {
128     const uint32_t idx = ePropertyDisableMemCache;
129     return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
130 }
131 
132 Args
133 ProcessProperties::GetExtraStartupCommands () const
134 {
135     Args args;
136     const uint32_t idx = ePropertyExtraStartCommand;
137     m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
138     return args;
139 }
140 
141 void
142 ProcessProperties::SetExtraStartupCommands (const Args &args)
143 {
144     const uint32_t idx = ePropertyExtraStartCommand;
145     m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
146 }
147 
148 void
149 ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
150 {
151     const char *cstr;
152     if (m_pid != LLDB_INVALID_PROCESS_ID)
153         s.Printf ("    pid = %llu\n", m_pid);
154 
155     if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
156         s.Printf (" parent = %llu\n", m_parent_pid);
157 
158     if (m_executable)
159     {
160         s.Printf ("   name = %s\n", m_executable.GetFilename().GetCString());
161         s.PutCString ("   file = ");
162         m_executable.Dump(&s);
163         s.EOL();
164     }
165     const uint32_t argc = m_arguments.GetArgumentCount();
166     if (argc > 0)
167     {
168         for (uint32_t i=0; i<argc; i++)
169         {
170             const char *arg = m_arguments.GetArgumentAtIndex(i);
171             if (i < 10)
172                 s.Printf (" arg[%u] = %s\n", i, arg);
173             else
174                 s.Printf ("arg[%u] = %s\n", i, arg);
175         }
176     }
177 
178     const uint32_t envc = m_environment.GetArgumentCount();
179     if (envc > 0)
180     {
181         for (uint32_t i=0; i<envc; i++)
182         {
183             const char *env = m_environment.GetArgumentAtIndex(i);
184             if (i < 10)
185                 s.Printf (" env[%u] = %s\n", i, env);
186             else
187                 s.Printf ("env[%u] = %s\n", i, env);
188         }
189     }
190 
191     if (m_arch.IsValid())
192         s.Printf ("   arch = %s\n", m_arch.GetTriple().str().c_str());
193 
194     if (m_uid != UINT32_MAX)
195     {
196         cstr = platform->GetUserName (m_uid);
197         s.Printf ("    uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
198     }
199     if (m_gid != UINT32_MAX)
200     {
201         cstr = platform->GetGroupName (m_gid);
202         s.Printf ("    gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
203     }
204     if (m_euid != UINT32_MAX)
205     {
206         cstr = platform->GetUserName (m_euid);
207         s.Printf ("   euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
208     }
209     if (m_egid != UINT32_MAX)
210     {
211         cstr = platform->GetGroupName (m_egid);
212         s.Printf ("   egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
213     }
214 }
215 
216 void
217 ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
218 {
219     const char *label;
220     if (show_args || verbose)
221         label = "ARGUMENTS";
222     else
223         label = "NAME";
224 
225     if (verbose)
226     {
227         s.Printf     ("PID    PARENT USER       GROUP      EFF USER   EFF GROUP  TRIPLE                   %s\n", label);
228         s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
229     }
230     else
231     {
232         s.Printf     ("PID    PARENT USER       ARCH    %s\n", label);
233         s.PutCString ("====== ====== ========== ======= ============================\n");
234     }
235 }
236 
237 void
238 ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
239 {
240     if (m_pid != LLDB_INVALID_PROCESS_ID)
241     {
242         const char *cstr;
243         s.Printf ("%-6llu %-6llu ", m_pid, m_parent_pid);
244 
245 
246         if (verbose)
247         {
248             cstr = platform->GetUserName (m_uid);
249             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
250                 s.Printf ("%-10s ", cstr);
251             else
252                 s.Printf ("%-10u ", m_uid);
253 
254             cstr = platform->GetGroupName (m_gid);
255             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
256                 s.Printf ("%-10s ", cstr);
257             else
258                 s.Printf ("%-10u ", m_gid);
259 
260             cstr = platform->GetUserName (m_euid);
261             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
262                 s.Printf ("%-10s ", cstr);
263             else
264                 s.Printf ("%-10u ", m_euid);
265 
266             cstr = platform->GetGroupName (m_egid);
267             if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
268                 s.Printf ("%-10s ", cstr);
269             else
270                 s.Printf ("%-10u ", m_egid);
271             s.Printf ("%-24s ", m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
272         }
273         else
274         {
275             s.Printf ("%-10s %-7d %s ",
276                       platform->GetUserName (m_euid),
277                       (int)m_arch.GetTriple().getArchName().size(),
278                       m_arch.GetTriple().getArchName().data());
279         }
280 
281         if (verbose || show_args)
282         {
283             const uint32_t argc = m_arguments.GetArgumentCount();
284             if (argc > 0)
285             {
286                 for (uint32_t i=0; i<argc; i++)
287                 {
288                     if (i > 0)
289                         s.PutChar (' ');
290                     s.PutCString (m_arguments.GetArgumentAtIndex(i));
291                 }
292             }
293         }
294         else
295         {
296             s.PutCString (GetName());
297         }
298 
299         s.EOL();
300     }
301 }
302 
303 
304 void
305 ProcessInfo::SetArguments (char const **argv,
306                            bool first_arg_is_executable,
307                            bool first_arg_is_executable_and_argument)
308 {
309     m_arguments.SetArguments (argv);
310 
311     // Is the first argument the executable?
312     if (first_arg_is_executable)
313     {
314         const char *first_arg = m_arguments.GetArgumentAtIndex (0);
315         if (first_arg)
316         {
317             // Yes the first argument is an executable, set it as the executable
318             // in the launch options. Don't resolve the file path as the path
319             // could be a remote platform path
320             const bool resolve = false;
321             m_executable.SetFile(first_arg, resolve);
322 
323             // If argument zero is an executable and shouldn't be included
324             // in the arguments, remove it from the front of the arguments
325             if (first_arg_is_executable_and_argument == false)
326                 m_arguments.DeleteArgumentAtIndex (0);
327         }
328     }
329 }
330 void
331 ProcessInfo::SetArguments (const Args& args,
332                            bool first_arg_is_executable,
333                            bool first_arg_is_executable_and_argument)
334 {
335     // Copy all arguments
336     m_arguments = args;
337 
338     // Is the first argument the executable?
339     if (first_arg_is_executable)
340     {
341         const char *first_arg = m_arguments.GetArgumentAtIndex (0);
342         if (first_arg)
343         {
344             // Yes the first argument is an executable, set it as the executable
345             // in the launch options. Don't resolve the file path as the path
346             // could be a remote platform path
347             const bool resolve = false;
348             m_executable.SetFile(first_arg, resolve);
349 
350             // If argument zero is an executable and shouldn't be included
351             // in the arguments, remove it from the front of the arguments
352             if (first_arg_is_executable_and_argument == false)
353                 m_arguments.DeleteArgumentAtIndex (0);
354         }
355     }
356 }
357 
358 void
359 ProcessLaunchInfo::FinalizeFileActions (Target *target, bool default_to_use_pty)
360 {
361     // If notthing was specified, then check the process for any default
362     // settings that were set with "settings set"
363     if (m_file_actions.empty())
364     {
365         if (m_flags.Test(eLaunchFlagDisableSTDIO))
366         {
367             AppendSuppressFileAction (STDIN_FILENO , true, false);
368             AppendSuppressFileAction (STDOUT_FILENO, false, true);
369             AppendSuppressFileAction (STDERR_FILENO, false, true);
370         }
371         else
372         {
373             // Check for any values that might have gotten set with any of:
374             // (lldb) settings set target.input-path
375             // (lldb) settings set target.output-path
376             // (lldb) settings set target.error-path
377             FileSpec in_path;
378             FileSpec out_path;
379             FileSpec err_path;
380             if (target)
381             {
382                 in_path = target->GetStandardInputPath();
383                 out_path = target->GetStandardOutputPath();
384                 err_path = target->GetStandardErrorPath();
385             }
386 
387             if (in_path || out_path || err_path)
388             {
389                 char path[PATH_MAX];
390                 if (in_path && in_path.GetPath(path, sizeof(path)))
391                     AppendOpenFileAction(STDIN_FILENO, path, true, false);
392 
393                 if (out_path && out_path.GetPath(path, sizeof(path)))
394                     AppendOpenFileAction(STDOUT_FILENO, path, false, true);
395 
396                 if (err_path && err_path.GetPath(path, sizeof(path)))
397                     AppendOpenFileAction(STDERR_FILENO, path, false, true);
398             }
399             else if (default_to_use_pty)
400             {
401                 if (m_pty.OpenFirstAvailableMaster (O_RDWR|O_NOCTTY, NULL, 0))
402                 {
403                     const char *slave_path = m_pty.GetSlaveName (NULL, 0);
404                     AppendOpenFileAction(STDIN_FILENO, slave_path, true, false);
405                     AppendOpenFileAction(STDOUT_FILENO, slave_path, false, true);
406                     AppendOpenFileAction(STDERR_FILENO, slave_path, false, true);
407                 }
408             }
409         }
410     }
411 }
412 
413 
414 bool
415 ProcessLaunchInfo::ConvertArgumentsForLaunchingInShell (Error &error,
416                                                         bool localhost,
417                                                         bool will_debug,
418                                                         bool first_arg_is_full_shell_command)
419 {
420     error.Clear();
421 
422     if (GetFlags().Test (eLaunchFlagLaunchInShell))
423     {
424         const char *shell_executable = GetShell();
425         if (shell_executable)
426         {
427             char shell_resolved_path[PATH_MAX];
428 
429             if (localhost)
430             {
431                 FileSpec shell_filespec (shell_executable, true);
432 
433                 if (!shell_filespec.Exists())
434                 {
435                     // Resolve the path in case we just got "bash", "sh" or "tcsh"
436                     if (!shell_filespec.ResolveExecutableLocation ())
437                     {
438                         error.SetErrorStringWithFormat("invalid shell path '%s'", shell_executable);
439                         return false;
440                     }
441                 }
442                 shell_filespec.GetPath (shell_resolved_path, sizeof(shell_resolved_path));
443                 shell_executable = shell_resolved_path;
444             }
445 
446             Args shell_arguments;
447             std::string safe_arg;
448             shell_arguments.AppendArgument (shell_executable);
449             shell_arguments.AppendArgument ("-c");
450 
451             StreamString shell_command;
452             if (will_debug)
453             {
454                 shell_command.PutCString ("exec");
455                 if (GetArchitecture().IsValid())
456                 {
457                     shell_command.Printf(" /usr/bin/arch -arch %s", GetArchitecture().GetArchitectureName());
458                     // Set the resume count to 2:
459                     // 1 - stop in shell
460                     // 2 - stop in /usr/bin/arch
461                     // 3 - then we will stop in our program
462                     SetResumeCount(2);
463                 }
464                 else
465                 {
466                     // Set the resume count to 1:
467                     // 1 - stop in shell
468                     // 2 - then we will stop in our program
469                     SetResumeCount(1);
470                 }
471             }
472 
473             const char **argv = GetArguments().GetConstArgumentVector ();
474             if (argv)
475             {
476                 if (first_arg_is_full_shell_command)
477                 {
478                     // There should only be one argument that is the shell command itself to be used as is
479                     if (argv[0] && !argv[1])
480                         shell_command.Printf("%s", argv[0]);
481                     else
482                         return false;
483                 }
484                 else
485                 {
486                     for (size_t i=0; argv[i] != NULL; ++i)
487                     {
488                         const char *arg = Args::GetShellSafeArgument (argv[i], safe_arg);
489                         shell_command.Printf(" %s", arg);
490                     }
491                 }
492                 shell_arguments.AppendArgument (shell_command.GetString().c_str());
493             }
494             else
495             {
496                 return false;
497             }
498 
499             m_executable.SetFile(shell_executable, false);
500             m_arguments = shell_arguments;
501             return true;
502         }
503         else
504         {
505             error.SetErrorString ("invalid shell path");
506         }
507     }
508     else
509     {
510         error.SetErrorString ("not launching in shell");
511     }
512     return false;
513 }
514 
515 
516 bool
517 ProcessLaunchInfo::FileAction::Open (int fd, const char *path, bool read, bool write)
518 {
519     if ((read || write) && fd >= 0 && path && path[0])
520     {
521         m_action = eFileActionOpen;
522         m_fd = fd;
523         if (read && write)
524             m_arg = O_NOCTTY | O_CREAT | O_RDWR;
525         else if (read)
526             m_arg = O_NOCTTY | O_RDONLY;
527         else
528             m_arg = O_NOCTTY | O_CREAT | O_WRONLY;
529         m_path.assign (path);
530         return true;
531     }
532     else
533     {
534         Clear();
535     }
536     return false;
537 }
538 
539 bool
540 ProcessLaunchInfo::FileAction::Close (int fd)
541 {
542     Clear();
543     if (fd >= 0)
544     {
545         m_action = eFileActionClose;
546         m_fd = fd;
547     }
548     return m_fd >= 0;
549 }
550 
551 
552 bool
553 ProcessLaunchInfo::FileAction::Duplicate (int fd, int dup_fd)
554 {
555     Clear();
556     if (fd >= 0 && dup_fd >= 0)
557     {
558         m_action = eFileActionDuplicate;
559         m_fd = fd;
560         m_arg = dup_fd;
561     }
562     return m_fd >= 0;
563 }
564 
565 
566 
567 bool
568 ProcessLaunchInfo::FileAction::AddPosixSpawnFileAction (posix_spawn_file_actions_t *file_actions,
569                                                         const FileAction *info,
570                                                         Log *log,
571                                                         Error& error)
572 {
573     if (info == NULL)
574         return false;
575 
576     switch (info->m_action)
577     {
578         case eFileActionNone:
579             error.Clear();
580             break;
581 
582         case eFileActionClose:
583             if (info->m_fd == -1)
584                 error.SetErrorString ("invalid fd for posix_spawn_file_actions_addclose(...)");
585             else
586             {
587                 error.SetError (::posix_spawn_file_actions_addclose (file_actions, info->m_fd),
588                                 eErrorTypePOSIX);
589                 if (log && (error.Fail() || log))
590                     error.PutToLog(log, "posix_spawn_file_actions_addclose (action=%p, fd=%i)",
591                                    file_actions, info->m_fd);
592             }
593             break;
594 
595         case eFileActionDuplicate:
596             if (info->m_fd == -1)
597                 error.SetErrorString ("invalid fd for posix_spawn_file_actions_adddup2(...)");
598             else if (info->m_arg == -1)
599                 error.SetErrorString ("invalid duplicate fd for posix_spawn_file_actions_adddup2(...)");
600             else
601             {
602                 error.SetError (::posix_spawn_file_actions_adddup2 (file_actions, info->m_fd, info->m_arg),
603                                 eErrorTypePOSIX);
604                 if (log && (error.Fail() || log))
605                     error.PutToLog(log, "posix_spawn_file_actions_adddup2 (action=%p, fd=%i, dup_fd=%i)",
606                                    file_actions, info->m_fd, info->m_arg);
607             }
608             break;
609 
610         case eFileActionOpen:
611             if (info->m_fd == -1)
612                 error.SetErrorString ("invalid fd in posix_spawn_file_actions_addopen(...)");
613             else
614             {
615                 int oflag = info->m_arg;
616 
617                 mode_t mode = 0;
618 
619                 if (oflag & O_CREAT)
620                     mode = 0640;
621 
622                 error.SetError (::posix_spawn_file_actions_addopen (file_actions,
623                                                                     info->m_fd,
624                                                                     info->m_path.c_str(),
625                                                                     oflag,
626                                                                     mode),
627                                 eErrorTypePOSIX);
628                 if (error.Fail() || log)
629                     error.PutToLog(log,
630                                    "posix_spawn_file_actions_addopen (action=%p, fd=%i, path='%s', oflag=%i, mode=%i)",
631                                    file_actions, info->m_fd, info->m_path.c_str(), oflag, mode);
632             }
633             break;
634 
635         default:
636             error.SetErrorStringWithFormat ("invalid file action: %i", info->m_action);
637             break;
638     }
639     return error.Success();
640 }
641 
642 Error
643 ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
644 {
645     Error error;
646     char short_option = (char) m_getopt_table[option_idx].val;
647 
648     switch (short_option)
649     {
650         case 's':   // Stop at program entry point
651             launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
652             break;
653 
654         case 'i':   // STDIN for read only
655             {
656                 ProcessLaunchInfo::FileAction action;
657                 if (action.Open (STDIN_FILENO, option_arg, true, false))
658                     launch_info.AppendFileAction (action);
659             }
660             break;
661 
662         case 'o':   // Open STDOUT for write only
663             {
664                 ProcessLaunchInfo::FileAction action;
665                 if (action.Open (STDOUT_FILENO, option_arg, false, true))
666                     launch_info.AppendFileAction (action);
667             }
668             break;
669 
670         case 'e':   // STDERR for write only
671             {
672                 ProcessLaunchInfo::FileAction action;
673                 if (action.Open (STDERR_FILENO, option_arg, false, true))
674                     launch_info.AppendFileAction (action);
675             }
676             break;
677 
678 
679         case 'p':   // Process plug-in name
680             launch_info.SetProcessPluginName (option_arg);
681             break;
682 
683         case 'n':   // Disable STDIO
684             {
685                 ProcessLaunchInfo::FileAction action;
686                 if (action.Open (STDIN_FILENO, "/dev/null", true, false))
687                     launch_info.AppendFileAction (action);
688                 if (action.Open (STDOUT_FILENO, "/dev/null", false, true))
689                     launch_info.AppendFileAction (action);
690                 if (action.Open (STDERR_FILENO, "/dev/null", false, true))
691                     launch_info.AppendFileAction (action);
692             }
693             break;
694 
695         case 'w':
696             launch_info.SetWorkingDirectory (option_arg);
697             break;
698 
699         case 't':   // Open process in new terminal window
700             launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
701             break;
702 
703         case 'a':
704             if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
705                 launch_info.GetArchitecture().SetTriple (option_arg);
706             break;
707 
708         case 'A':
709             launch_info.GetFlags().Set (eLaunchFlagDisableASLR);
710             break;
711 
712         case 'c':
713             if (option_arg && option_arg[0])
714                 launch_info.SetShell (option_arg);
715             else
716                 launch_info.SetShell ("/bin/bash");
717             break;
718 
719         case 'v':
720             launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
721             break;
722 
723         default:
724             error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
725             break;
726 
727     }
728     return error;
729 }
730 
731 OptionDefinition
732 ProcessLaunchCommandOptions::g_option_table[] =
733 {
734 { LLDB_OPT_SET_ALL, false, "stop-at-entry", 's', no_argument,       NULL, 0, eArgTypeNone,          "Stop at the entry point of the program when launching a process."},
735 { LLDB_OPT_SET_ALL, false, "disable-aslr",  'A', no_argument,       NULL, 0, eArgTypeNone,          "Disable address space layout randomization when launching a process."},
736 { LLDB_OPT_SET_ALL, false, "plugin",        'p', required_argument, NULL, 0, eArgTypePlugin,        "Name of the process plugin you want to use."},
737 { LLDB_OPT_SET_ALL, false, "working-dir",   'w', required_argument, NULL, 0, eArgTypePath,          "Set the current working directory to <path> when running the inferior."},
738 { LLDB_OPT_SET_ALL, false, "arch",          'a', required_argument, NULL, 0, eArgTypeArchitecture,  "Set the architecture for the process to launch when ambiguous."},
739 { LLDB_OPT_SET_ALL, false, "environment",   'v', required_argument, NULL, 0, eArgTypeNone,          "Specify an environment variable name/value stirng (--environement NAME=VALUE). Can be specified multiple times for subsequent environment entries."},
740 { LLDB_OPT_SET_ALL, false, "shell",         'c', optional_argument, NULL, 0, eArgTypePath,          "Run the process in a shell (not supported on all platforms)."},
741 
742 { LLDB_OPT_SET_1  , false, "stdin",         'i', required_argument, NULL, 0, eArgTypePath,    "Redirect stdin for the process to <path>."},
743 { LLDB_OPT_SET_1  , false, "stdout",        'o', required_argument, NULL, 0, eArgTypePath,    "Redirect stdout for the process to <path>."},
744 { LLDB_OPT_SET_1  , false, "stderr",        'e', required_argument, NULL, 0, eArgTypePath,    "Redirect stderr for the process to <path>."},
745 
746 { LLDB_OPT_SET_2  , false, "tty",           't', no_argument,       NULL, 0, eArgTypeNone,    "Start the process in a terminal (not supported on all platforms)."},
747 
748 { LLDB_OPT_SET_3  , false, "no-stdio",      'n', no_argument,       NULL, 0, eArgTypeNone,    "Do not set up for terminal I/O to go to running process."},
749 
750 { 0               , false, NULL,             0,  0,                 NULL, 0, eArgTypeNone,    NULL }
751 };
752 
753 
754 
755 bool
756 ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
757 {
758     if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
759         return true;
760     const char *match_name = m_match_info.GetName();
761     if (!match_name)
762         return true;
763 
764     return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
765 }
766 
767 bool
768 ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
769 {
770     if (!NameMatches (proc_info.GetName()))
771         return false;
772 
773     if (m_match_info.ProcessIDIsValid() &&
774         m_match_info.GetProcessID() != proc_info.GetProcessID())
775         return false;
776 
777     if (m_match_info.ParentProcessIDIsValid() &&
778         m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
779         return false;
780 
781     if (m_match_info.UserIDIsValid () &&
782         m_match_info.GetUserID() != proc_info.GetUserID())
783         return false;
784 
785     if (m_match_info.GroupIDIsValid () &&
786         m_match_info.GetGroupID() != proc_info.GetGroupID())
787         return false;
788 
789     if (m_match_info.EffectiveUserIDIsValid () &&
790         m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
791         return false;
792 
793     if (m_match_info.EffectiveGroupIDIsValid () &&
794         m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
795         return false;
796 
797     if (m_match_info.GetArchitecture().IsValid() &&
798         m_match_info.GetArchitecture() != proc_info.GetArchitecture())
799         return false;
800     return true;
801 }
802 
803 bool
804 ProcessInstanceInfoMatch::MatchAllProcesses () const
805 {
806     if (m_name_match_type != eNameMatchIgnore)
807         return false;
808 
809     if (m_match_info.ProcessIDIsValid())
810         return false;
811 
812     if (m_match_info.ParentProcessIDIsValid())
813         return false;
814 
815     if (m_match_info.UserIDIsValid ())
816         return false;
817 
818     if (m_match_info.GroupIDIsValid ())
819         return false;
820 
821     if (m_match_info.EffectiveUserIDIsValid ())
822         return false;
823 
824     if (m_match_info.EffectiveGroupIDIsValid ())
825         return false;
826 
827     if (m_match_info.GetArchitecture().IsValid())
828         return false;
829 
830     if (m_match_all_users)
831         return false;
832 
833     return true;
834 
835 }
836 
837 void
838 ProcessInstanceInfoMatch::Clear()
839 {
840     m_match_info.Clear();
841     m_name_match_type = eNameMatchIgnore;
842     m_match_all_users = false;
843 }
844 
845 ProcessSP
846 Process::FindPlugin (Target &target, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
847 {
848     ProcessSP process_sp;
849     ProcessCreateInstance create_callback = NULL;
850     if (plugin_name)
851     {
852         create_callback  = PluginManager::GetProcessCreateCallbackForPluginName (plugin_name);
853         if (create_callback)
854         {
855             process_sp = create_callback(target, listener, crash_file_path);
856             if (process_sp)
857             {
858                 if (!process_sp->CanDebug(target, true))
859                     process_sp.reset();
860             }
861         }
862     }
863     else
864     {
865         for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
866         {
867             process_sp = create_callback(target, listener, crash_file_path);
868             if (process_sp)
869             {
870                 if (!process_sp->CanDebug(target, false))
871                     process_sp.reset();
872                 else
873                     break;
874             }
875         }
876     }
877     return process_sp;
878 }
879 
880 ConstString &
881 Process::GetStaticBroadcasterClass ()
882 {
883     static ConstString class_name ("lldb.process");
884     return class_name;
885 }
886 
887 //----------------------------------------------------------------------
888 // Process constructor
889 //----------------------------------------------------------------------
890 Process::Process(Target &target, Listener &listener) :
891     ProcessProperties (false),
892     UserID (LLDB_INVALID_PROCESS_ID),
893     Broadcaster (&(target.GetDebugger()), "lldb.process"),
894     m_target (target),
895     m_public_state (eStateUnloaded),
896     m_private_state (eStateUnloaded),
897     m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
898     m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
899     m_private_state_listener ("lldb.process.internal_state_listener"),
900     m_private_state_control_wait(),
901     m_private_state_thread (LLDB_INVALID_HOST_THREAD),
902     m_mod_id (),
903     m_thread_index_id (0),
904     m_exit_status (-1),
905     m_exit_string (),
906     m_thread_list (this),
907     m_notifications (),
908     m_image_tokens (),
909     m_listener (listener),
910     m_breakpoint_site_list (),
911     m_dynamic_checkers_ap (),
912     m_unix_signals (),
913     m_abi_sp (),
914     m_process_input_reader (),
915     m_stdio_communication ("process.stdio"),
916     m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
917     m_stdout_data (),
918     m_stderr_data (),
919     m_memory_cache (*this),
920     m_allocated_memory_cache (*this),
921     m_should_detach (false),
922     m_next_event_action_ap(),
923     m_run_lock (),
924     m_currently_handling_event(false),
925     m_finalize_called(false),
926     m_can_jit(eCanJITDontKnow)
927 {
928     CheckInWithManager ();
929 
930     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
931     if (log)
932         log->Printf ("%p Process::Process()", this);
933 
934     SetEventName (eBroadcastBitStateChanged, "state-changed");
935     SetEventName (eBroadcastBitInterrupt, "interrupt");
936     SetEventName (eBroadcastBitSTDOUT, "stdout-available");
937     SetEventName (eBroadcastBitSTDERR, "stderr-available");
938 
939     listener.StartListeningForEvents (this,
940                                       eBroadcastBitStateChanged |
941                                       eBroadcastBitInterrupt |
942                                       eBroadcastBitSTDOUT |
943                                       eBroadcastBitSTDERR);
944 
945     m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
946                                                      eBroadcastBitStateChanged |
947                                                      eBroadcastBitInterrupt);
948 
949     m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
950                                                      eBroadcastInternalStateControlStop |
951                                                      eBroadcastInternalStateControlPause |
952                                                      eBroadcastInternalStateControlResume);
953 }
954 
955 //----------------------------------------------------------------------
956 // Destructor
957 //----------------------------------------------------------------------
958 Process::~Process()
959 {
960     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
961     if (log)
962         log->Printf ("%p Process::~Process()", this);
963     StopPrivateStateThread();
964 }
965 
966 const ProcessPropertiesSP &
967 Process::GetGlobalProperties()
968 {
969     static ProcessPropertiesSP g_settings_sp;
970     if (!g_settings_sp)
971         g_settings_sp.reset (new ProcessProperties (true));
972     return g_settings_sp;
973 }
974 
975 void
976 Process::Finalize()
977 {
978     switch (GetPrivateState())
979     {
980         case eStateConnected:
981         case eStateAttaching:
982         case eStateLaunching:
983         case eStateStopped:
984         case eStateRunning:
985         case eStateStepping:
986         case eStateCrashed:
987         case eStateSuspended:
988             if (GetShouldDetach())
989                 Detach();
990             else
991                 Destroy();
992             break;
993 
994         case eStateInvalid:
995         case eStateUnloaded:
996         case eStateDetached:
997         case eStateExited:
998             break;
999     }
1000 
1001     // Clear our broadcaster before we proceed with destroying
1002     Broadcaster::Clear();
1003 
1004     // Do any cleanup needed prior to being destructed... Subclasses
1005     // that override this method should call this superclass method as well.
1006 
1007     // We need to destroy the loader before the derived Process class gets destroyed
1008     // since it is very likely that undoing the loader will require access to the real process.
1009     m_dynamic_checkers_ap.reset();
1010     m_abi_sp.reset();
1011     m_os_ap.reset();
1012     m_dyld_ap.reset();
1013     m_thread_list.Destroy();
1014     std::vector<Notifications> empty_notifications;
1015     m_notifications.swap(empty_notifications);
1016     m_image_tokens.clear();
1017     m_memory_cache.Clear();
1018     m_allocated_memory_cache.Clear();
1019     m_language_runtimes.clear();
1020     m_next_event_action_ap.reset();
1021     m_finalize_called = true;
1022 }
1023 
1024 void
1025 Process::RegisterNotificationCallbacks (const Notifications& callbacks)
1026 {
1027     m_notifications.push_back(callbacks);
1028     if (callbacks.initialize != NULL)
1029         callbacks.initialize (callbacks.baton, this);
1030 }
1031 
1032 bool
1033 Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
1034 {
1035     std::vector<Notifications>::iterator pos, end = m_notifications.end();
1036     for (pos = m_notifications.begin(); pos != end; ++pos)
1037     {
1038         if (pos->baton == callbacks.baton &&
1039             pos->initialize == callbacks.initialize &&
1040             pos->process_state_changed == callbacks.process_state_changed)
1041         {
1042             m_notifications.erase(pos);
1043             return true;
1044         }
1045     }
1046     return false;
1047 }
1048 
1049 void
1050 Process::SynchronouslyNotifyStateChanged (StateType state)
1051 {
1052     std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
1053     for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
1054     {
1055         if (notification_pos->process_state_changed)
1056             notification_pos->process_state_changed (notification_pos->baton, this, state);
1057     }
1058 }
1059 
1060 // FIXME: We need to do some work on events before the general Listener sees them.
1061 // For instance if we are continuing from a breakpoint, we need to ensure that we do
1062 // the little "insert real insn, step & stop" trick.  But we can't do that when the
1063 // event is delivered by the broadcaster - since that is done on the thread that is
1064 // waiting for new events, so if we needed more than one event for our handling, we would
1065 // stall.  So instead we do it when we fetch the event off of the queue.
1066 //
1067 
1068 StateType
1069 Process::GetNextEvent (EventSP &event_sp)
1070 {
1071     StateType state = eStateInvalid;
1072 
1073     if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
1074         state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
1075 
1076     return state;
1077 }
1078 
1079 
1080 StateType
1081 Process::WaitForProcessToStop (const TimeValue *timeout, lldb::EventSP *event_sp_ptr)
1082 {
1083     // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
1084     // We have to actually check each event, and in the case of a stopped event check the restarted flag
1085     // on the event.
1086     if (event_sp_ptr)
1087         event_sp_ptr->reset();
1088     StateType state = GetState();
1089     // If we are exited or detached, we won't ever get back to any
1090     // other valid state...
1091     if (state == eStateDetached || state == eStateExited)
1092         return state;
1093 
1094     while (state != eStateInvalid)
1095     {
1096         EventSP event_sp;
1097         state = WaitForStateChangedEvents (timeout, event_sp);
1098         if (event_sp_ptr && event_sp)
1099             *event_sp_ptr = event_sp;
1100 
1101         switch (state)
1102         {
1103         case eStateCrashed:
1104         case eStateDetached:
1105         case eStateExited:
1106         case eStateUnloaded:
1107             return state;
1108         case eStateStopped:
1109             if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1110                 continue;
1111             else
1112                 return state;
1113         default:
1114             continue;
1115         }
1116     }
1117     return state;
1118 }
1119 
1120 
1121 StateType
1122 Process::WaitForState
1123 (
1124     const TimeValue *timeout,
1125     const StateType *match_states, const uint32_t num_match_states
1126 )
1127 {
1128     EventSP event_sp;
1129     uint32_t i;
1130     StateType state = GetState();
1131     while (state != eStateInvalid)
1132     {
1133         // If we are exited or detached, we won't ever get back to any
1134         // other valid state...
1135         if (state == eStateDetached || state == eStateExited)
1136             return state;
1137 
1138         state = WaitForStateChangedEvents (timeout, event_sp);
1139 
1140         for (i=0; i<num_match_states; ++i)
1141         {
1142             if (match_states[i] == state)
1143                 return state;
1144         }
1145     }
1146     return state;
1147 }
1148 
1149 bool
1150 Process::HijackProcessEvents (Listener *listener)
1151 {
1152     if (listener != NULL)
1153     {
1154         return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
1155     }
1156     else
1157         return false;
1158 }
1159 
1160 void
1161 Process::RestoreProcessEvents ()
1162 {
1163     RestoreBroadcaster();
1164 }
1165 
1166 bool
1167 Process::HijackPrivateProcessEvents (Listener *listener)
1168 {
1169     if (listener != NULL)
1170     {
1171         return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
1172     }
1173     else
1174         return false;
1175 }
1176 
1177 void
1178 Process::RestorePrivateProcessEvents ()
1179 {
1180     m_private_state_broadcaster.RestoreBroadcaster();
1181 }
1182 
1183 StateType
1184 Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp)
1185 {
1186     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1187 
1188     if (log)
1189         log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1190 
1191     StateType state = eStateInvalid;
1192     if (m_listener.WaitForEventForBroadcasterWithType (timeout,
1193                                                        this,
1194                                                        eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1195                                                        event_sp))
1196     {
1197         if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1198             state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1199         else if (log)
1200             log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1201     }
1202 
1203     if (log)
1204         log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1205                      __FUNCTION__,
1206                      timeout,
1207                      StateAsCString(state));
1208     return state;
1209 }
1210 
1211 Event *
1212 Process::PeekAtStateChangedEvents ()
1213 {
1214     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1215 
1216     if (log)
1217         log->Printf ("Process::%s...", __FUNCTION__);
1218 
1219     Event *event_ptr;
1220     event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1221                                                                   eBroadcastBitStateChanged);
1222     if (log)
1223     {
1224         if (event_ptr)
1225         {
1226             log->Printf ("Process::%s (event_ptr) => %s",
1227                          __FUNCTION__,
1228                          StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1229         }
1230         else
1231         {
1232             log->Printf ("Process::%s no events found",
1233                          __FUNCTION__);
1234         }
1235     }
1236     return event_ptr;
1237 }
1238 
1239 StateType
1240 Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1241 {
1242     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1243 
1244     if (log)
1245         log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1246 
1247     StateType state = eStateInvalid;
1248     if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1249                                                                      &m_private_state_broadcaster,
1250                                                                      eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1251                                                                      event_sp))
1252         if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1253             state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1254 
1255     // This is a bit of a hack, but when we wait here we could very well return
1256     // to the command-line, and that could disable the log, which would render the
1257     // log we got above invalid.
1258     if (log)
1259     {
1260         if (state == eStateInvalid)
1261             log->Printf ("Process::%s (timeout = %p, event_sp) => TIMEOUT", __FUNCTION__, timeout);
1262         else
1263             log->Printf ("Process::%s (timeout = %p, event_sp) => %s", __FUNCTION__, timeout, StateAsCString(state));
1264     }
1265     return state;
1266 }
1267 
1268 bool
1269 Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1270 {
1271     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1272 
1273     if (log)
1274         log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1275 
1276     if (control_only)
1277         return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1278     else
1279         return m_private_state_listener.WaitForEvent(timeout, event_sp);
1280 }
1281 
1282 bool
1283 Process::IsRunning () const
1284 {
1285     return StateIsRunningState (m_public_state.GetValue());
1286 }
1287 
1288 int
1289 Process::GetExitStatus ()
1290 {
1291     if (m_public_state.GetValue() == eStateExited)
1292         return m_exit_status;
1293     return -1;
1294 }
1295 
1296 
1297 const char *
1298 Process::GetExitDescription ()
1299 {
1300     if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1301         return m_exit_string.c_str();
1302     return NULL;
1303 }
1304 
1305 bool
1306 Process::SetExitStatus (int status, const char *cstr)
1307 {
1308     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1309     if (log)
1310         log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1311                     status, status,
1312                     cstr ? "\"" : "",
1313                     cstr ? cstr : "NULL",
1314                     cstr ? "\"" : "");
1315 
1316     // We were already in the exited state
1317     if (m_private_state.GetValue() == eStateExited)
1318     {
1319         if (log)
1320             log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
1321         return false;
1322     }
1323 
1324     m_exit_status = status;
1325     if (cstr)
1326         m_exit_string = cstr;
1327     else
1328         m_exit_string.clear();
1329 
1330     DidExit ();
1331 
1332     SetPrivateState (eStateExited);
1333     return true;
1334 }
1335 
1336 // This static callback can be used to watch for local child processes on
1337 // the current host. The the child process exits, the process will be
1338 // found in the global target list (we want to be completely sure that the
1339 // lldb_private::Process doesn't go away before we can deliver the signal.
1340 bool
1341 Process::SetProcessExitStatus (void *callback_baton,
1342                                lldb::pid_t pid,
1343                                bool exited,
1344                                int signo,          // Zero for no signal
1345                                int exit_status     // Exit value of process if signal is zero
1346 )
1347 {
1348     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
1349     if (log)
1350         log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%llu, exited=%i, signal=%i, exit_status=%i)\n",
1351                      callback_baton,
1352                      pid,
1353                      exited,
1354                      signo,
1355                      exit_status);
1356 
1357     if (exited)
1358     {
1359         TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
1360         if (target_sp)
1361         {
1362             ProcessSP process_sp (target_sp->GetProcessSP());
1363             if (process_sp)
1364             {
1365                 const char *signal_cstr = NULL;
1366                 if (signo)
1367                     signal_cstr = process_sp->GetUnixSignals().GetSignalAsCString (signo);
1368 
1369                 process_sp->SetExitStatus (exit_status, signal_cstr);
1370             }
1371         }
1372         return true;
1373     }
1374     return false;
1375 }
1376 
1377 
1378 void
1379 Process::UpdateThreadListIfNeeded ()
1380 {
1381     const uint32_t stop_id = GetStopID();
1382     if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1383     {
1384         const StateType state = GetPrivateState();
1385         if (StateIsStoppedState (state, true))
1386         {
1387             Mutex::Locker locker (m_thread_list.GetMutex ());
1388             // m_thread_list does have its own mutex, but we need to
1389             // hold onto the mutex between the call to UpdateThreadList(...)
1390             // and the os->UpdateThreadList(...) so it doesn't change on us
1391             ThreadList new_thread_list(this);
1392             // Always update the thread list with the protocol specific
1393             // thread list, but only update if "true" is returned
1394             if (UpdateThreadList (m_thread_list, new_thread_list))
1395             {
1396                 OperatingSystem *os = GetOperatingSystem ();
1397                 if (os)
1398                     os->UpdateThreadList (m_thread_list, new_thread_list);
1399                 m_thread_list.Update (new_thread_list);
1400                 m_thread_list.SetStopID (stop_id);
1401             }
1402         }
1403     }
1404 }
1405 
1406 uint32_t
1407 Process::GetNextThreadIndexID ()
1408 {
1409     return ++m_thread_index_id;
1410 }
1411 
1412 StateType
1413 Process::GetState()
1414 {
1415     // If any other threads access this we will need a mutex for it
1416     return m_public_state.GetValue ();
1417 }
1418 
1419 void
1420 Process::SetPublicState (StateType new_state)
1421 {
1422     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1423     if (log)
1424         log->Printf("Process::SetPublicState (%s)", StateAsCString(new_state));
1425     const StateType old_state = m_public_state.GetValue();
1426     m_public_state.SetValue (new_state);
1427 
1428     // On the transition from Run to Stopped, we unlock the writer end of the
1429     // run lock.  The lock gets locked in Resume, which is the public API
1430     // to tell the program to run.
1431     if (!IsHijackedForEvent(eBroadcastBitStateChanged))
1432     {
1433         if (new_state == eStateDetached)
1434         {
1435             if (log)
1436                 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
1437             m_run_lock.WriteUnlock();
1438         }
1439         else
1440         {
1441             const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1442             const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1443             if (old_state_is_stopped != new_state_is_stopped)
1444             {
1445                 if (new_state_is_stopped)
1446                 {
1447                     if (log)
1448                         log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
1449                     m_run_lock.WriteUnlock();
1450                 }
1451             }
1452         }
1453     }
1454 }
1455 
1456 Error
1457 Process::Resume ()
1458 {
1459     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1460     if (log)
1461         log->Printf("Process::Resume -- locking run lock");
1462     if (!m_run_lock.WriteTryLock())
1463     {
1464         Error error("Resume request failed - process still running.");
1465         if (log)
1466             log->Printf ("Process::Resume: -- WriteTryLock failed, not resuming.");
1467         return error;
1468     }
1469     return PrivateResume();
1470 }
1471 
1472 StateType
1473 Process::GetPrivateState ()
1474 {
1475     return m_private_state.GetValue();
1476 }
1477 
1478 void
1479 Process::SetPrivateState (StateType new_state)
1480 {
1481     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1482     bool state_changed = false;
1483 
1484     if (log)
1485         log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1486 
1487     Mutex::Locker locker(m_private_state.GetMutex());
1488 
1489     const StateType old_state = m_private_state.GetValueNoLock ();
1490     state_changed = old_state != new_state;
1491     // This code is left commented out in case we ever need to control
1492     // the private process state with another run lock. Right now it doesn't
1493     // seem like we need to do this, but if we ever do, we can uncomment and
1494     // use this code.
1495 //    const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1496 //    const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1497 //    if (old_state_is_stopped != new_state_is_stopped)
1498 //    {
1499 //        if (new_state_is_stopped)
1500 //            m_private_run_lock.WriteUnlock();
1501 //        else
1502 //            m_private_run_lock.WriteLock();
1503 //    }
1504 
1505     if (state_changed)
1506     {
1507         m_private_state.SetValueNoLock (new_state);
1508         if (StateIsStoppedState(new_state, false))
1509         {
1510             m_mod_id.BumpStopID();
1511             m_memory_cache.Clear();
1512             if (log)
1513                 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
1514         }
1515         // Use our target to get a shared pointer to ourselves...
1516         m_private_state_broadcaster.BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (GetTarget().GetProcessSP(), new_state));
1517     }
1518     else
1519     {
1520         if (log)
1521             log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
1522     }
1523 }
1524 
1525 void
1526 Process::SetRunningUserExpression (bool on)
1527 {
1528     m_mod_id.SetRunningUserExpression (on);
1529 }
1530 
1531 addr_t
1532 Process::GetImageInfoAddress()
1533 {
1534     return LLDB_INVALID_ADDRESS;
1535 }
1536 
1537 //----------------------------------------------------------------------
1538 // LoadImage
1539 //
1540 // This function provides a default implementation that works for most
1541 // unix variants. Any Process subclasses that need to do shared library
1542 // loading differently should override LoadImage and UnloadImage and
1543 // do what is needed.
1544 //----------------------------------------------------------------------
1545 uint32_t
1546 Process::LoadImage (const FileSpec &image_spec, Error &error)
1547 {
1548     char path[PATH_MAX];
1549     image_spec.GetPath(path, sizeof(path));
1550 
1551     DynamicLoader *loader = GetDynamicLoader();
1552     if (loader)
1553     {
1554         error = loader->CanLoadImage();
1555         if (error.Fail())
1556             return LLDB_INVALID_IMAGE_TOKEN;
1557     }
1558 
1559     if (error.Success())
1560     {
1561         ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
1562 
1563         if (thread_sp)
1564         {
1565             StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1566 
1567             if (frame_sp)
1568             {
1569                 ExecutionContext exe_ctx;
1570                 frame_sp->CalculateExecutionContext (exe_ctx);
1571                 bool unwind_on_error = true;
1572                 StreamString expr;
1573                 expr.Printf("dlopen (\"%s\", 2)", path);
1574                 const char *prefix = "extern \"C\" void* dlopen (const char *path, int mode);\n";
1575                 lldb::ValueObjectSP result_valobj_sp;
1576                 ClangUserExpression::Evaluate (exe_ctx, eExecutionPolicyAlways, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny, unwind_on_error, expr.GetData(), prefix, result_valobj_sp);
1577                 error = result_valobj_sp->GetError();
1578                 if (error.Success())
1579                 {
1580                     Scalar scalar;
1581                     if (result_valobj_sp->ResolveValue (scalar))
1582                     {
1583                         addr_t image_ptr = scalar.ULongLong(LLDB_INVALID_ADDRESS);
1584                         if (image_ptr != 0 && image_ptr != LLDB_INVALID_ADDRESS)
1585                         {
1586                             uint32_t image_token = m_image_tokens.size();
1587                             m_image_tokens.push_back (image_ptr);
1588                             return image_token;
1589                         }
1590                     }
1591                 }
1592             }
1593         }
1594     }
1595     if (!error.AsCString())
1596         error.SetErrorStringWithFormat("unable to load '%s'", path);
1597     return LLDB_INVALID_IMAGE_TOKEN;
1598 }
1599 
1600 //----------------------------------------------------------------------
1601 // UnloadImage
1602 //
1603 // This function provides a default implementation that works for most
1604 // unix variants. Any Process subclasses that need to do shared library
1605 // loading differently should override LoadImage and UnloadImage and
1606 // do what is needed.
1607 //----------------------------------------------------------------------
1608 Error
1609 Process::UnloadImage (uint32_t image_token)
1610 {
1611     Error error;
1612     if (image_token < m_image_tokens.size())
1613     {
1614         const addr_t image_addr = m_image_tokens[image_token];
1615         if (image_addr == LLDB_INVALID_ADDRESS)
1616         {
1617             error.SetErrorString("image already unloaded");
1618         }
1619         else
1620         {
1621             DynamicLoader *loader = GetDynamicLoader();
1622             if (loader)
1623                 error = loader->CanLoadImage();
1624 
1625             if (error.Success())
1626             {
1627                 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
1628 
1629                 if (thread_sp)
1630                 {
1631                     StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1632 
1633                     if (frame_sp)
1634                     {
1635                         ExecutionContext exe_ctx;
1636                         frame_sp->CalculateExecutionContext (exe_ctx);
1637                         bool unwind_on_error = true;
1638                         StreamString expr;
1639                         expr.Printf("dlclose ((void *)0x%llx)", image_addr);
1640                         const char *prefix = "extern \"C\" int dlclose(void* handle);\n";
1641                         lldb::ValueObjectSP result_valobj_sp;
1642                         ClangUserExpression::Evaluate (exe_ctx, eExecutionPolicyAlways, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny, unwind_on_error, expr.GetData(), prefix, result_valobj_sp);
1643                         if (result_valobj_sp->GetError().Success())
1644                         {
1645                             Scalar scalar;
1646                             if (result_valobj_sp->ResolveValue (scalar))
1647                             {
1648                                 if (scalar.UInt(1))
1649                                 {
1650                                     error.SetErrorStringWithFormat("expression failed: \"%s\"", expr.GetData());
1651                                 }
1652                                 else
1653                                 {
1654                                     m_image_tokens[image_token] = LLDB_INVALID_ADDRESS;
1655                                 }
1656                             }
1657                         }
1658                         else
1659                         {
1660                             error = result_valobj_sp->GetError();
1661                         }
1662                     }
1663                 }
1664             }
1665         }
1666     }
1667     else
1668     {
1669         error.SetErrorString("invalid image token");
1670     }
1671     return error;
1672 }
1673 
1674 const lldb::ABISP &
1675 Process::GetABI()
1676 {
1677     if (!m_abi_sp)
1678         m_abi_sp = ABI::FindPlugin(m_target.GetArchitecture());
1679     return m_abi_sp;
1680 }
1681 
1682 LanguageRuntime *
1683 Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
1684 {
1685     LanguageRuntimeCollection::iterator pos;
1686     pos = m_language_runtimes.find (language);
1687     if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
1688     {
1689         lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
1690 
1691         m_language_runtimes[language] = runtime_sp;
1692         return runtime_sp.get();
1693     }
1694     else
1695         return (*pos).second.get();
1696 }
1697 
1698 CPPLanguageRuntime *
1699 Process::GetCPPLanguageRuntime (bool retry_if_null)
1700 {
1701     LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
1702     if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1703         return static_cast<CPPLanguageRuntime *> (runtime);
1704     return NULL;
1705 }
1706 
1707 ObjCLanguageRuntime *
1708 Process::GetObjCLanguageRuntime (bool retry_if_null)
1709 {
1710     LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
1711     if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1712         return static_cast<ObjCLanguageRuntime *> (runtime);
1713     return NULL;
1714 }
1715 
1716 bool
1717 Process::IsPossibleDynamicValue (ValueObject& in_value)
1718 {
1719     if (in_value.IsDynamic())
1720         return false;
1721     LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1722 
1723     if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1724     {
1725         LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1726         return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1727     }
1728 
1729     LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1730     if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1731         return true;
1732 
1733     LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1734     return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1735 }
1736 
1737 BreakpointSiteList &
1738 Process::GetBreakpointSiteList()
1739 {
1740     return m_breakpoint_site_list;
1741 }
1742 
1743 const BreakpointSiteList &
1744 Process::GetBreakpointSiteList() const
1745 {
1746     return m_breakpoint_site_list;
1747 }
1748 
1749 
1750 void
1751 Process::DisableAllBreakpointSites ()
1752 {
1753     m_breakpoint_site_list.SetEnabledForAll (false);
1754     size_t num_sites = m_breakpoint_site_list.GetSize();
1755     for (size_t i = 0; i < num_sites; i++)
1756     {
1757         DisableBreakpoint (m_breakpoint_site_list.GetByIndex(i).get());
1758     }
1759 }
1760 
1761 Error
1762 Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1763 {
1764     Error error (DisableBreakpointSiteByID (break_id));
1765 
1766     if (error.Success())
1767         m_breakpoint_site_list.Remove(break_id);
1768 
1769     return error;
1770 }
1771 
1772 Error
1773 Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1774 {
1775     Error error;
1776     BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1777     if (bp_site_sp)
1778     {
1779         if (bp_site_sp->IsEnabled())
1780             error = DisableBreakpoint (bp_site_sp.get());
1781     }
1782     else
1783     {
1784         error.SetErrorStringWithFormat("invalid breakpoint site ID: %llu", break_id);
1785     }
1786 
1787     return error;
1788 }
1789 
1790 Error
1791 Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
1792 {
1793     Error error;
1794     BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1795     if (bp_site_sp)
1796     {
1797         if (!bp_site_sp->IsEnabled())
1798             error = EnableBreakpoint (bp_site_sp.get());
1799     }
1800     else
1801     {
1802         error.SetErrorStringWithFormat("invalid breakpoint site ID: %llu", break_id);
1803     }
1804     return error;
1805 }
1806 
1807 lldb::break_id_t
1808 Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
1809 {
1810     const addr_t load_addr = owner->GetAddress().GetOpcodeLoadAddress (&m_target);
1811     if (load_addr != LLDB_INVALID_ADDRESS)
1812     {
1813         BreakpointSiteSP bp_site_sp;
1814 
1815         // Look up this breakpoint site.  If it exists, then add this new owner, otherwise
1816         // create a new breakpoint site and add it.
1817 
1818         bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
1819 
1820         if (bp_site_sp)
1821         {
1822             bp_site_sp->AddOwner (owner);
1823             owner->SetBreakpointSite (bp_site_sp);
1824             return bp_site_sp->GetID();
1825         }
1826         else
1827         {
1828             bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, LLDB_INVALID_THREAD_ID, use_hardware));
1829             if (bp_site_sp)
1830             {
1831                 if (EnableBreakpoint (bp_site_sp.get()).Success())
1832                 {
1833                     owner->SetBreakpointSite (bp_site_sp);
1834                     return m_breakpoint_site_list.Add (bp_site_sp);
1835                 }
1836             }
1837         }
1838     }
1839     // We failed to enable the breakpoint
1840     return LLDB_INVALID_BREAK_ID;
1841 
1842 }
1843 
1844 void
1845 Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
1846 {
1847     uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
1848     if (num_owners == 0)
1849     {
1850         DisableBreakpoint(bp_site_sp.get());
1851         m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
1852     }
1853 }
1854 
1855 
1856 size_t
1857 Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
1858 {
1859     size_t bytes_removed = 0;
1860     addr_t intersect_addr;
1861     size_t intersect_size;
1862     size_t opcode_offset;
1863     size_t idx;
1864     BreakpointSiteSP bp_sp;
1865     BreakpointSiteList bp_sites_in_range;
1866 
1867     if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
1868     {
1869         for (idx = 0; (bp_sp = bp_sites_in_range.GetByIndex(idx)); ++idx)
1870         {
1871             if (bp_sp->GetType() == BreakpointSite::eSoftware)
1872             {
1873                 if (bp_sp->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
1874                 {
1875                     assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
1876                     assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
1877                     assert(opcode_offset + intersect_size <= bp_sp->GetByteSize());
1878                     size_t buf_offset = intersect_addr - bp_addr;
1879                     ::memcpy(buf + buf_offset, bp_sp->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
1880                 }
1881             }
1882         }
1883     }
1884     return bytes_removed;
1885 }
1886 
1887 
1888 
1889 size_t
1890 Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
1891 {
1892     PlatformSP platform_sp (m_target.GetPlatform());
1893     if (platform_sp)
1894         return platform_sp->GetSoftwareBreakpointTrapOpcode (m_target, bp_site);
1895     return 0;
1896 }
1897 
1898 Error
1899 Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
1900 {
1901     Error error;
1902     assert (bp_site != NULL);
1903     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
1904     const addr_t bp_addr = bp_site->GetLoadAddress();
1905     if (log)
1906         log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx", bp_site->GetID(), (uint64_t)bp_addr);
1907     if (bp_site->IsEnabled())
1908     {
1909         if (log)
1910             log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
1911         return error;
1912     }
1913 
1914     if (bp_addr == LLDB_INVALID_ADDRESS)
1915     {
1916         error.SetErrorString("BreakpointSite contains an invalid load address.");
1917         return error;
1918     }
1919     // Ask the lldb::Process subclass to fill in the correct software breakpoint
1920     // trap for the breakpoint site
1921     const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
1922 
1923     if (bp_opcode_size == 0)
1924     {
1925         error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%llx", bp_addr);
1926     }
1927     else
1928     {
1929         const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
1930 
1931         if (bp_opcode_bytes == NULL)
1932         {
1933             error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
1934             return error;
1935         }
1936 
1937         // Save the original opcode by reading it
1938         if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
1939         {
1940             // Write a software breakpoint in place of the original opcode
1941             if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1942             {
1943                 uint8_t verify_bp_opcode_bytes[64];
1944                 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1945                 {
1946                     if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
1947                     {
1948                         bp_site->SetEnabled(true);
1949                         bp_site->SetType (BreakpointSite::eSoftware);
1950                         if (log)
1951                             log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- SUCCESS",
1952                                          bp_site->GetID(),
1953                                          (uint64_t)bp_addr);
1954                     }
1955                     else
1956                         error.SetErrorString("failed to verify the breakpoint trap in memory.");
1957                 }
1958                 else
1959                     error.SetErrorString("Unable to read memory to verify breakpoint trap.");
1960             }
1961             else
1962                 error.SetErrorString("Unable to write breakpoint trap to memory.");
1963         }
1964         else
1965             error.SetErrorString("Unable to read memory at breakpoint address.");
1966     }
1967     if (log && error.Fail())
1968         log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- FAILED: %s",
1969                      bp_site->GetID(),
1970                      (uint64_t)bp_addr,
1971                      error.AsCString());
1972     return error;
1973 }
1974 
1975 Error
1976 Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
1977 {
1978     Error error;
1979     assert (bp_site != NULL);
1980     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
1981     addr_t bp_addr = bp_site->GetLoadAddress();
1982     lldb::user_id_t breakID = bp_site->GetID();
1983     if (log)
1984         log->Printf ("Process::DisableBreakpoint (breakID = %llu) addr = 0x%llx", breakID, (uint64_t)bp_addr);
1985 
1986     if (bp_site->IsHardware())
1987     {
1988         error.SetErrorString("Breakpoint site is a hardware breakpoint.");
1989     }
1990     else if (bp_site->IsEnabled())
1991     {
1992         const size_t break_op_size = bp_site->GetByteSize();
1993         const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
1994         if (break_op_size > 0)
1995         {
1996             // Clear a software breakoint instruction
1997             uint8_t curr_break_op[8];
1998             assert (break_op_size <= sizeof(curr_break_op));
1999             bool break_op_found = false;
2000 
2001             // Read the breakpoint opcode
2002             if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2003             {
2004                 bool verify = false;
2005                 // Make sure we have the a breakpoint opcode exists at this address
2006                 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2007                 {
2008                     break_op_found = true;
2009                     // We found a valid breakpoint opcode at this address, now restore
2010                     // the saved opcode.
2011                     if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2012                     {
2013                         verify = true;
2014                     }
2015                     else
2016                         error.SetErrorString("Memory write failed when restoring original opcode.");
2017                 }
2018                 else
2019                 {
2020                     error.SetErrorString("Original breakpoint trap is no longer in memory.");
2021                     // Set verify to true and so we can check if the original opcode has already been restored
2022                     verify = true;
2023                 }
2024 
2025                 if (verify)
2026                 {
2027                     uint8_t verify_opcode[8];
2028                     assert (break_op_size < sizeof(verify_opcode));
2029                     // Verify that our original opcode made it back to the inferior
2030                     if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2031                     {
2032                         // compare the memory we just read with the original opcode
2033                         if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2034                         {
2035                             // SUCCESS
2036                             bp_site->SetEnabled(false);
2037                             if (log)
2038                                 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
2039                             return error;
2040                         }
2041                         else
2042                         {
2043                             if (break_op_found)
2044                                 error.SetErrorString("Failed to restore original opcode.");
2045                         }
2046                     }
2047                     else
2048                         error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2049                 }
2050             }
2051             else
2052                 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2053         }
2054     }
2055     else
2056     {
2057         if (log)
2058             log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
2059         return error;
2060     }
2061 
2062     if (log)
2063         log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- FAILED: %s",
2064                      bp_site->GetID(),
2065                      (uint64_t)bp_addr,
2066                      error.AsCString());
2067     return error;
2068 
2069 }
2070 
2071 // Uncomment to verify memory caching works after making changes to caching code
2072 //#define VERIFY_MEMORY_READS
2073 
2074 size_t
2075 Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2076 {
2077     if (!GetDisableMemoryCache())
2078     {
2079 #if defined (VERIFY_MEMORY_READS)
2080         // Memory caching is enabled, with debug verification
2081 
2082         if (buf && size)
2083         {
2084             // Uncomment the line below to make sure memory caching is working.
2085             // I ran this through the test suite and got no assertions, so I am
2086             // pretty confident this is working well. If any changes are made to
2087             // memory caching, uncomment the line below and test your changes!
2088 
2089             // Verify all memory reads by using the cache first, then redundantly
2090             // reading the same memory from the inferior and comparing to make sure
2091             // everything is exactly the same.
2092             std::string verify_buf (size, '\0');
2093             assert (verify_buf.size() == size);
2094             const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2095             Error verify_error;
2096             const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2097             assert (cache_bytes_read == verify_bytes_read);
2098             assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2099             assert (verify_error.Success() == error.Success());
2100             return cache_bytes_read;
2101         }
2102         return 0;
2103 #else // !defined(VERIFY_MEMORY_READS)
2104         // Memory caching is enabled, without debug verification
2105 
2106         return m_memory_cache.Read (addr, buf, size, error);
2107 #endif // defined (VERIFY_MEMORY_READS)
2108     }
2109     else
2110     {
2111         // Memory caching is disabled
2112 
2113         return ReadMemoryFromInferior (addr, buf, size, error);
2114     }
2115 }
2116 
2117 size_t
2118 Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2119 {
2120     char buf[256];
2121     out_str.clear();
2122     addr_t curr_addr = addr;
2123     while (1)
2124     {
2125         size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2126         if (length == 0)
2127             break;
2128         out_str.append(buf, length);
2129         // If we got "length - 1" bytes, we didn't get the whole C string, we
2130         // need to read some more characters
2131         if (length == sizeof(buf) - 1)
2132             curr_addr += length;
2133         else
2134             break;
2135     }
2136     return out_str.size();
2137 }
2138 
2139 
2140 size_t
2141 Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
2142 {
2143     size_t total_cstr_len = 0;
2144     if (dst && dst_max_len)
2145     {
2146         result_error.Clear();
2147         // NULL out everything just to be safe
2148         memset (dst, 0, dst_max_len);
2149         Error error;
2150         addr_t curr_addr = addr;
2151         const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2152         size_t bytes_left = dst_max_len - 1;
2153         char *curr_dst = dst;
2154 
2155         while (bytes_left > 0)
2156         {
2157             addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2158             addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2159             size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2160 
2161             if (bytes_read == 0)
2162             {
2163                 result_error = error;
2164                 dst[total_cstr_len] = '\0';
2165                 break;
2166             }
2167             const size_t len = strlen(curr_dst);
2168 
2169             total_cstr_len += len;
2170 
2171             if (len < bytes_to_read)
2172                 break;
2173 
2174             curr_dst += bytes_read;
2175             curr_addr += bytes_read;
2176             bytes_left -= bytes_read;
2177         }
2178     }
2179     else
2180     {
2181         if (dst == NULL)
2182             result_error.SetErrorString("invalid arguments");
2183         else
2184             result_error.Clear();
2185     }
2186     return total_cstr_len;
2187 }
2188 
2189 size_t
2190 Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2191 {
2192     if (buf == NULL || size == 0)
2193         return 0;
2194 
2195     size_t bytes_read = 0;
2196     uint8_t *bytes = (uint8_t *)buf;
2197 
2198     while (bytes_read < size)
2199     {
2200         const size_t curr_size = size - bytes_read;
2201         const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2202                                                      bytes + bytes_read,
2203                                                      curr_size,
2204                                                      error);
2205         bytes_read += curr_bytes_read;
2206         if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2207             break;
2208     }
2209 
2210     // Replace any software breakpoint opcodes that fall into this range back
2211     // into "buf" before we return
2212     if (bytes_read > 0)
2213         RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2214     return bytes_read;
2215 }
2216 
2217 uint64_t
2218 Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
2219 {
2220     Scalar scalar;
2221     if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2222         return scalar.ULongLong(fail_value);
2223     return fail_value;
2224 }
2225 
2226 addr_t
2227 Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2228 {
2229     Scalar scalar;
2230     if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2231         return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2232     return LLDB_INVALID_ADDRESS;
2233 }
2234 
2235 
2236 bool
2237 Process::WritePointerToMemory (lldb::addr_t vm_addr,
2238                                lldb::addr_t ptr_value,
2239                                Error &error)
2240 {
2241     Scalar scalar;
2242     const uint32_t addr_byte_size = GetAddressByteSize();
2243     if (addr_byte_size <= 4)
2244         scalar = (uint32_t)ptr_value;
2245     else
2246         scalar = ptr_value;
2247     return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
2248 }
2249 
2250 size_t
2251 Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2252 {
2253     size_t bytes_written = 0;
2254     const uint8_t *bytes = (const uint8_t *)buf;
2255 
2256     while (bytes_written < size)
2257     {
2258         const size_t curr_size = size - bytes_written;
2259         const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2260                                                          bytes + bytes_written,
2261                                                          curr_size,
2262                                                          error);
2263         bytes_written += curr_bytes_written;
2264         if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2265             break;
2266     }
2267     return bytes_written;
2268 }
2269 
2270 size_t
2271 Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2272 {
2273 #if defined (ENABLE_MEMORY_CACHING)
2274     m_memory_cache.Flush (addr, size);
2275 #endif
2276 
2277     if (buf == NULL || size == 0)
2278         return 0;
2279 
2280     m_mod_id.BumpMemoryID();
2281 
2282     // We need to write any data that would go where any current software traps
2283     // (enabled software breakpoints) any software traps (breakpoints) that we
2284     // may have placed in our tasks memory.
2285 
2286     BreakpointSiteList::collection::const_iterator iter = m_breakpoint_site_list.GetMap()->lower_bound (addr);
2287     BreakpointSiteList::collection::const_iterator end =  m_breakpoint_site_list.GetMap()->end();
2288 
2289     if (iter == end || iter->second->GetLoadAddress() > addr + size)
2290         return WriteMemoryPrivate (addr, buf, size, error);
2291 
2292     BreakpointSiteList::collection::const_iterator pos;
2293     size_t bytes_written = 0;
2294     addr_t intersect_addr = 0;
2295     size_t intersect_size = 0;
2296     size_t opcode_offset = 0;
2297     const uint8_t *ubuf = (const uint8_t *)buf;
2298 
2299     for (pos = iter; pos != end; ++pos)
2300     {
2301         BreakpointSiteSP bp;
2302         bp = pos->second;
2303 
2304         assert(bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset));
2305         assert(addr <= intersect_addr && intersect_addr < addr + size);
2306         assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2307         assert(opcode_offset + intersect_size <= bp->GetByteSize());
2308 
2309         // Check for bytes before this breakpoint
2310         const addr_t curr_addr = addr + bytes_written;
2311         if (intersect_addr > curr_addr)
2312         {
2313             // There are some bytes before this breakpoint that we need to
2314             // just write to memory
2315             size_t curr_size = intersect_addr - curr_addr;
2316             size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2317                                                             ubuf + bytes_written,
2318                                                             curr_size,
2319                                                             error);
2320             bytes_written += curr_bytes_written;
2321             if (curr_bytes_written != curr_size)
2322             {
2323                 // We weren't able to write all of the requested bytes, we
2324                 // are done looping and will return the number of bytes that
2325                 // we have written so far.
2326                 break;
2327             }
2328         }
2329 
2330         // Now write any bytes that would cover up any software breakpoints
2331         // directly into the breakpoint opcode buffer
2332         ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2333         bytes_written += intersect_size;
2334     }
2335 
2336     // Write any remaining bytes after the last breakpoint if we have any left
2337     if (bytes_written < size)
2338         bytes_written += WriteMemoryPrivate (addr + bytes_written,
2339                                              ubuf + bytes_written,
2340                                              size - bytes_written,
2341                                              error);
2342 
2343     return bytes_written;
2344 }
2345 
2346 size_t
2347 Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, uint32_t byte_size, Error &error)
2348 {
2349     if (byte_size == UINT32_MAX)
2350         byte_size = scalar.GetByteSize();
2351     if (byte_size > 0)
2352     {
2353         uint8_t buf[32];
2354         const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2355         if (mem_size > 0)
2356             return WriteMemory(addr, buf, mem_size, error);
2357         else
2358             error.SetErrorString ("failed to get scalar as memory data");
2359     }
2360     else
2361     {
2362         error.SetErrorString ("invalid scalar value");
2363     }
2364     return 0;
2365 }
2366 
2367 size_t
2368 Process::ReadScalarIntegerFromMemory (addr_t addr,
2369                                       uint32_t byte_size,
2370                                       bool is_signed,
2371                                       Scalar &scalar,
2372                                       Error &error)
2373 {
2374     uint64_t uval;
2375 
2376     if (byte_size <= sizeof(uval))
2377     {
2378         size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
2379         if (bytes_read == byte_size)
2380         {
2381             DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
2382             uint32_t offset = 0;
2383             if (byte_size <= 4)
2384                 scalar = data.GetMaxU32 (&offset, byte_size);
2385             else
2386                 scalar = data.GetMaxU64 (&offset, byte_size);
2387 
2388             if (is_signed)
2389                 scalar.SignExtend(byte_size * 8);
2390             return bytes_read;
2391         }
2392     }
2393     else
2394     {
2395         error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2396     }
2397     return 0;
2398 }
2399 
2400 #define USE_ALLOCATE_MEMORY_CACHE 1
2401 addr_t
2402 Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2403 {
2404     if (GetPrivateState() != eStateStopped)
2405         return LLDB_INVALID_ADDRESS;
2406 
2407 #if defined (USE_ALLOCATE_MEMORY_CACHE)
2408     return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2409 #else
2410     addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
2411     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2412     if (log)
2413         log->Printf("Process::AllocateMemory(size=%4zu, permissions=%s) => 0x%16.16llx (m_stop_id = %u m_memory_id = %u)",
2414                     size,
2415                     GetPermissionsAsCString (permissions),
2416                     (uint64_t)allocated_addr,
2417                     m_mod_id.GetStopID(),
2418                     m_mod_id.GetMemoryID());
2419     return allocated_addr;
2420 #endif
2421 }
2422 
2423 bool
2424 Process::CanJIT ()
2425 {
2426     if (m_can_jit == eCanJITDontKnow)
2427     {
2428         Error err;
2429 
2430         uint64_t allocated_memory = AllocateMemory(8,
2431                                                    ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2432                                                    err);
2433 
2434         if (err.Success())
2435             m_can_jit = eCanJITYes;
2436         else
2437             m_can_jit = eCanJITNo;
2438 
2439         DeallocateMemory (allocated_memory);
2440     }
2441 
2442     return m_can_jit == eCanJITYes;
2443 }
2444 
2445 void
2446 Process::SetCanJIT (bool can_jit)
2447 {
2448     m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2449 }
2450 
2451 Error
2452 Process::DeallocateMemory (addr_t ptr)
2453 {
2454     Error error;
2455 #if defined (USE_ALLOCATE_MEMORY_CACHE)
2456     if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2457     {
2458         error.SetErrorStringWithFormat ("deallocation of memory at 0x%llx failed.", (uint64_t)ptr);
2459     }
2460 #else
2461     error = DoDeallocateMemory (ptr);
2462 
2463     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2464     if (log)
2465         log->Printf("Process::DeallocateMemory(addr=0x%16.16llx) => err = %s (m_stop_id = %u, m_memory_id = %u)",
2466                     ptr,
2467                     error.AsCString("SUCCESS"),
2468                     m_mod_id.GetStopID(),
2469                     m_mod_id.GetMemoryID());
2470 #endif
2471     return error;
2472 }
2473 
2474 ModuleSP
2475 Process::ReadModuleFromMemory (const FileSpec& file_spec,
2476                                lldb::addr_t header_addr,
2477                                bool add_image_to_target,
2478                                bool load_sections_in_target)
2479 {
2480     ModuleSP module_sp (new Module (file_spec, ArchSpec()));
2481     if (module_sp)
2482     {
2483         Error error;
2484         ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error);
2485         if (objfile)
2486         {
2487             if (add_image_to_target)
2488             {
2489                 m_target.GetImages().Append(module_sp);
2490                 if (load_sections_in_target)
2491                 {
2492                     bool changed = false;
2493                     module_sp->SetLoadAddress (m_target, 0, changed);
2494                 }
2495             }
2496             return module_sp;
2497         }
2498     }
2499     return ModuleSP();
2500 }
2501 
2502 Error
2503 Process::EnableWatchpoint (Watchpoint *watchpoint)
2504 {
2505     Error error;
2506     error.SetErrorString("watchpoints are not supported");
2507     return error;
2508 }
2509 
2510 Error
2511 Process::DisableWatchpoint (Watchpoint *watchpoint)
2512 {
2513     Error error;
2514     error.SetErrorString("watchpoints are not supported");
2515     return error;
2516 }
2517 
2518 StateType
2519 Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2520 {
2521     StateType state;
2522     // Now wait for the process to launch and return control to us, and then
2523     // call DidLaunch:
2524     while (1)
2525     {
2526         event_sp.reset();
2527         state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2528 
2529         if (StateIsStoppedState(state, false))
2530             break;
2531 
2532         // If state is invalid, then we timed out
2533         if (state == eStateInvalid)
2534             break;
2535 
2536         if (event_sp)
2537             HandlePrivateEvent (event_sp);
2538     }
2539     return state;
2540 }
2541 
2542 Error
2543 Process::Launch (const ProcessLaunchInfo &launch_info)
2544 {
2545     Error error;
2546     m_abi_sp.reset();
2547     m_dyld_ap.reset();
2548     m_os_ap.reset();
2549     m_process_input_reader.reset();
2550 
2551     Module *exe_module = m_target.GetExecutableModulePointer();
2552     if (exe_module)
2553     {
2554         char local_exec_file_path[PATH_MAX];
2555         char platform_exec_file_path[PATH_MAX];
2556         exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2557         exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
2558         if (exe_module->GetFileSpec().Exists())
2559         {
2560             if (PrivateStateThreadIsValid ())
2561                 PausePrivateStateThread ();
2562 
2563             error = WillLaunch (exe_module);
2564             if (error.Success())
2565             {
2566                 SetPublicState (eStateLaunching);
2567                 m_should_detach = false;
2568 
2569                 if (m_run_lock.WriteTryLock())
2570                 {
2571                     // Now launch using these arguments.
2572                     error = DoLaunch (exe_module, launch_info);
2573                 }
2574                 else
2575                 {
2576                     // This shouldn't happen
2577                     error.SetErrorString("failed to acquire process run lock");
2578                 }
2579 
2580                 if (error.Fail())
2581                 {
2582                     if (GetID() != LLDB_INVALID_PROCESS_ID)
2583                     {
2584                         SetID (LLDB_INVALID_PROCESS_ID);
2585                         const char *error_string = error.AsCString();
2586                         if (error_string == NULL)
2587                             error_string = "launch failed";
2588                         SetExitStatus (-1, error_string);
2589                     }
2590                 }
2591                 else
2592                 {
2593                     EventSP event_sp;
2594                     TimeValue timeout_time;
2595                     timeout_time = TimeValue::Now();
2596                     timeout_time.OffsetWithSeconds(10);
2597                     StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
2598 
2599                     if (state == eStateInvalid || event_sp.get() == NULL)
2600                     {
2601                         // We were able to launch the process, but we failed to
2602                         // catch the initial stop.
2603                         SetExitStatus (0, "failed to catch stop after launch");
2604                         Destroy();
2605                     }
2606                     else if (state == eStateStopped || state == eStateCrashed)
2607                     {
2608 
2609                         DidLaunch ();
2610 
2611                         DynamicLoader *dyld = GetDynamicLoader ();
2612                         if (dyld)
2613                             dyld->DidLaunch();
2614 
2615                         m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2616                         // This delays passing the stopped event to listeners till DidLaunch gets
2617                         // a chance to complete...
2618                         HandlePrivateEvent (event_sp);
2619 
2620                         if (PrivateStateThreadIsValid ())
2621                             ResumePrivateStateThread ();
2622                         else
2623                             StartPrivateStateThread ();
2624                     }
2625                     else if (state == eStateExited)
2626                     {
2627                         // We exited while trying to launch somehow.  Don't call DidLaunch as that's
2628                         // not likely to work, and return an invalid pid.
2629                         HandlePrivateEvent (event_sp);
2630                     }
2631                 }
2632             }
2633         }
2634         else
2635         {
2636             error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
2637         }
2638     }
2639     return error;
2640 }
2641 
2642 
2643 Error
2644 Process::LoadCore ()
2645 {
2646     Error error = DoLoadCore();
2647     if (error.Success())
2648     {
2649         if (PrivateStateThreadIsValid ())
2650             ResumePrivateStateThread ();
2651         else
2652             StartPrivateStateThread ();
2653 
2654         DynamicLoader *dyld = GetDynamicLoader ();
2655         if (dyld)
2656             dyld->DidAttach();
2657 
2658         m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2659         // We successfully loaded a core file, now pretend we stopped so we can
2660         // show all of the threads in the core file and explore the crashed
2661         // state.
2662         SetPrivateState (eStateStopped);
2663 
2664     }
2665     return error;
2666 }
2667 
2668 DynamicLoader *
2669 Process::GetDynamicLoader ()
2670 {
2671     if (m_dyld_ap.get() == NULL)
2672         m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
2673     return m_dyld_ap.get();
2674 }
2675 
2676 
2677 Process::NextEventAction::EventActionResult
2678 Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
2679 {
2680     StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
2681     switch (state)
2682     {
2683         case eStateRunning:
2684         case eStateConnected:
2685             return eEventActionRetry;
2686 
2687         case eStateStopped:
2688         case eStateCrashed:
2689             {
2690                 // During attach, prior to sending the eStateStopped event,
2691                 // lldb_private::Process subclasses must set the new process ID.
2692                 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
2693                 if (m_exec_count > 0)
2694                 {
2695                     --m_exec_count;
2696                     m_process->PrivateResume ();
2697                     Process::ProcessEventData::SetRestartedInEvent (event_sp.get(), true);
2698                     return eEventActionRetry;
2699                 }
2700                 else
2701                 {
2702                     m_process->CompleteAttach ();
2703                     return eEventActionSuccess;
2704                 }
2705             }
2706             break;
2707 
2708         default:
2709         case eStateExited:
2710         case eStateInvalid:
2711             break;
2712     }
2713 
2714     m_exit_string.assign ("No valid Process");
2715     return eEventActionExit;
2716 }
2717 
2718 Process::NextEventAction::EventActionResult
2719 Process::AttachCompletionHandler::HandleBeingInterrupted()
2720 {
2721     return eEventActionSuccess;
2722 }
2723 
2724 const char *
2725 Process::AttachCompletionHandler::GetExitString ()
2726 {
2727     return m_exit_string.c_str();
2728 }
2729 
2730 Error
2731 Process::Attach (ProcessAttachInfo &attach_info)
2732 {
2733     m_abi_sp.reset();
2734     m_process_input_reader.reset();
2735     m_dyld_ap.reset();
2736     m_os_ap.reset();
2737 
2738     lldb::pid_t attach_pid = attach_info.GetProcessID();
2739     Error error;
2740     if (attach_pid == LLDB_INVALID_PROCESS_ID)
2741     {
2742         char process_name[PATH_MAX];
2743 
2744         if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
2745         {
2746             const bool wait_for_launch = attach_info.GetWaitForLaunch();
2747 
2748             if (wait_for_launch)
2749             {
2750                 error = WillAttachToProcessWithName(process_name, wait_for_launch);
2751                 if (error.Success())
2752                 {
2753                     m_should_detach = true;
2754 
2755                     SetPublicState (eStateAttaching);
2756                     error = DoAttachToProcessWithName (process_name, wait_for_launch, attach_info);
2757                     if (error.Fail())
2758                     {
2759                         if (GetID() != LLDB_INVALID_PROCESS_ID)
2760                         {
2761                             SetID (LLDB_INVALID_PROCESS_ID);
2762                             if (error.AsCString() == NULL)
2763                                 error.SetErrorString("attach failed");
2764 
2765                             SetExitStatus(-1, error.AsCString());
2766                         }
2767                     }
2768                     else
2769                     {
2770                         SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
2771                         StartPrivateStateThread();
2772                     }
2773                     return error;
2774                 }
2775             }
2776             else
2777             {
2778                 ProcessInstanceInfoList process_infos;
2779                 PlatformSP platform_sp (m_target.GetPlatform ());
2780 
2781                 if (platform_sp)
2782                 {
2783                     ProcessInstanceInfoMatch match_info;
2784                     match_info.GetProcessInfo() = attach_info;
2785                     match_info.SetNameMatchType (eNameMatchEquals);
2786                     platform_sp->FindProcesses (match_info, process_infos);
2787                     const uint32_t num_matches = process_infos.GetSize();
2788                     if (num_matches == 1)
2789                     {
2790                         attach_pid = process_infos.GetProcessIDAtIndex(0);
2791                         // Fall through and attach using the above process ID
2792                     }
2793                     else
2794                     {
2795                         match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
2796                         if (num_matches > 1)
2797                             error.SetErrorStringWithFormat ("more than one process named %s", process_name);
2798                         else
2799                             error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
2800                     }
2801                 }
2802                 else
2803                 {
2804                     error.SetErrorString ("invalid platform, can't find processes by name");
2805                     return error;
2806                 }
2807             }
2808         }
2809         else
2810         {
2811             error.SetErrorString ("invalid process name");
2812         }
2813     }
2814 
2815     if (attach_pid != LLDB_INVALID_PROCESS_ID)
2816     {
2817         error = WillAttachToProcessWithID(attach_pid);
2818         if (error.Success())
2819         {
2820             m_should_detach = true;
2821             SetPublicState (eStateAttaching);
2822 
2823             error = DoAttachToProcessWithID (attach_pid, attach_info);
2824             if (error.Success())
2825             {
2826 
2827                 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
2828                 StartPrivateStateThread();
2829             }
2830             else
2831             {
2832                 if (GetID() != LLDB_INVALID_PROCESS_ID)
2833                 {
2834                     SetID (LLDB_INVALID_PROCESS_ID);
2835                     const char *error_string = error.AsCString();
2836                     if (error_string == NULL)
2837                         error_string = "attach failed";
2838 
2839                     SetExitStatus(-1, error_string);
2840                 }
2841             }
2842         }
2843     }
2844     return error;
2845 }
2846 
2847 void
2848 Process::CompleteAttach ()
2849 {
2850     // Let the process subclass figure out at much as it can about the process
2851     // before we go looking for a dynamic loader plug-in.
2852     DidAttach();
2853 
2854     // We just attached.  If we have a platform, ask it for the process architecture, and if it isn't
2855     // the same as the one we've already set, switch architectures.
2856     PlatformSP platform_sp (m_target.GetPlatform ());
2857     assert (platform_sp.get());
2858     if (platform_sp)
2859     {
2860         const ArchSpec &target_arch = m_target.GetArchitecture();
2861         if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch))
2862         {
2863             ArchSpec platform_arch;
2864             platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
2865             if (platform_sp)
2866             {
2867                 m_target.SetPlatform (platform_sp);
2868                 m_target.SetArchitecture(platform_arch);
2869             }
2870         }
2871         else
2872         {
2873             ProcessInstanceInfo process_info;
2874             platform_sp->GetProcessInfo (GetID(), process_info);
2875             const ArchSpec &process_arch = process_info.GetArchitecture();
2876             if (process_arch.IsValid() && m_target.GetArchitecture() != process_arch)
2877                 m_target.SetArchitecture (process_arch);
2878         }
2879     }
2880 
2881     // We have completed the attach, now it is time to find the dynamic loader
2882     // plug-in
2883     DynamicLoader *dyld = GetDynamicLoader ();
2884     if (dyld)
2885         dyld->DidAttach();
2886 
2887     m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2888     // Figure out which one is the executable, and set that in our target:
2889     ModuleList &target_modules = m_target.GetImages();
2890     Mutex::Locker modules_locker(target_modules.GetMutex());
2891     size_t num_modules = target_modules.GetSize();
2892     ModuleSP new_executable_module_sp;
2893 
2894     for (int i = 0; i < num_modules; i++)
2895     {
2896         ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
2897         if (module_sp && module_sp->IsExecutable())
2898         {
2899             if (m_target.GetExecutableModulePointer() != module_sp.get())
2900                 new_executable_module_sp = module_sp;
2901             break;
2902         }
2903     }
2904     if (new_executable_module_sp)
2905         m_target.SetExecutableModule (new_executable_module_sp, false);
2906 }
2907 
2908 Error
2909 Process::ConnectRemote (const char *remote_url)
2910 {
2911     m_abi_sp.reset();
2912     m_process_input_reader.reset();
2913 
2914     // Find the process and its architecture.  Make sure it matches the architecture
2915     // of the current Target, and if not adjust it.
2916 
2917     Error error (DoConnectRemote (remote_url));
2918     if (error.Success())
2919     {
2920         if (GetID() != LLDB_INVALID_PROCESS_ID)
2921         {
2922             EventSP event_sp;
2923             StateType state = WaitForProcessStopPrivate(NULL, event_sp);
2924 
2925             if (state == eStateStopped || state == eStateCrashed)
2926             {
2927                 // If we attached and actually have a process on the other end, then
2928                 // this ended up being the equivalent of an attach.
2929                 CompleteAttach ();
2930 
2931                 // This delays passing the stopped event to listeners till
2932                 // CompleteAttach gets a chance to complete...
2933                 HandlePrivateEvent (event_sp);
2934 
2935             }
2936         }
2937 
2938         if (PrivateStateThreadIsValid ())
2939             ResumePrivateStateThread ();
2940         else
2941             StartPrivateStateThread ();
2942     }
2943     return error;
2944 }
2945 
2946 
2947 Error
2948 Process::PrivateResume ()
2949 {
2950     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
2951     if (log)
2952         log->Printf("Process::Resume() m_stop_id = %u, public state: %s private state: %s",
2953                     m_mod_id.GetStopID(),
2954                     StateAsCString(m_public_state.GetValue()),
2955                     StateAsCString(m_private_state.GetValue()));
2956 
2957     Error error (WillResume());
2958     // Tell the process it is about to resume before the thread list
2959     if (error.Success())
2960     {
2961         // Now let the thread list know we are about to resume so it
2962         // can let all of our threads know that they are about to be
2963         // resumed. Threads will each be called with
2964         // Thread::WillResume(StateType) where StateType contains the state
2965         // that they are supposed to have when the process is resumed
2966         // (suspended/running/stepping). Threads should also check
2967         // their resume signal in lldb::Thread::GetResumeSignal()
2968         // to see if they are suppoed to start back up with a signal.
2969         if (m_thread_list.WillResume())
2970         {
2971             // Last thing, do the PreResumeActions.
2972             if (!RunPreResumeActions())
2973             {
2974                 error.SetErrorStringWithFormat ("Process::Resume PreResumeActions failed, not resuming.");
2975             }
2976             else
2977             {
2978                 m_mod_id.BumpResumeID();
2979                 error = DoResume();
2980                 if (error.Success())
2981                 {
2982                     DidResume();
2983                     m_thread_list.DidResume();
2984                     if (log)
2985                         log->Printf ("Process thinks the process has resumed.");
2986                 }
2987             }
2988         }
2989         else
2990         {
2991             // Somebody wanted to run without running.  So generate a continue & a stopped event,
2992             // and let the world handle them.
2993             if (log)
2994                 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
2995 
2996             SetPrivateState(eStateRunning);
2997             SetPrivateState(eStateStopped);
2998         }
2999     }
3000     else if (log)
3001         log->Printf ("Process::WillResume() got an error \"%s\".", error.AsCString("<unknown error>"));
3002     return error;
3003 }
3004 
3005 Error
3006 Process::Halt ()
3007 {
3008     // First make sure we aren't in the middle of handling an event, or we might restart.  This is pretty weak, since
3009     // we could just straightaway get another event.  It just narrows the window...
3010     m_currently_handling_event.WaitForValueEqualTo(false);
3011 
3012 
3013     // Pause our private state thread so we can ensure no one else eats
3014     // the stop event out from under us.
3015     Listener halt_listener ("lldb.process.halt_listener");
3016     HijackPrivateProcessEvents(&halt_listener);
3017 
3018     EventSP event_sp;
3019     Error error (WillHalt());
3020 
3021     if (error.Success())
3022     {
3023 
3024         bool caused_stop = false;
3025 
3026         // Ask the process subclass to actually halt our process
3027         error = DoHalt(caused_stop);
3028         if (error.Success())
3029         {
3030             if (m_public_state.GetValue() == eStateAttaching)
3031             {
3032                 SetExitStatus(SIGKILL, "Cancelled async attach.");
3033                 Destroy ();
3034             }
3035             else
3036             {
3037                 // If "caused_stop" is true, then DoHalt stopped the process. If
3038                 // "caused_stop" is false, the process was already stopped.
3039                 // If the DoHalt caused the process to stop, then we want to catch
3040                 // this event and set the interrupted bool to true before we pass
3041                 // this along so clients know that the process was interrupted by
3042                 // a halt command.
3043                 if (caused_stop)
3044                 {
3045                     // Wait for 1 second for the process to stop.
3046                     TimeValue timeout_time;
3047                     timeout_time = TimeValue::Now();
3048                     timeout_time.OffsetWithSeconds(1);
3049                     bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3050                     StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3051 
3052                     if (!got_event || state == eStateInvalid)
3053                     {
3054                         // We timeout out and didn't get a stop event...
3055                         error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
3056                     }
3057                     else
3058                     {
3059                         if (StateIsStoppedState (state, false))
3060                         {
3061                             // We caused the process to interrupt itself, so mark this
3062                             // as such in the stop event so clients can tell an interrupted
3063                             // process from a natural stop
3064                             ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3065                         }
3066                         else
3067                         {
3068                             LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3069                             if (log)
3070                                 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3071                             error.SetErrorString ("Did not get stopped event after halt.");
3072                         }
3073                     }
3074                 }
3075                 DidHalt();
3076             }
3077         }
3078     }
3079     // Resume our private state thread before we post the event (if any)
3080     RestorePrivateProcessEvents();
3081 
3082     // Post any event we might have consumed. If all goes well, we will have
3083     // stopped the process, intercepted the event and set the interrupted
3084     // bool in the event.  Post it to the private event queue and that will end up
3085     // correctly setting the state.
3086     if (event_sp)
3087         m_private_state_broadcaster.BroadcastEvent(event_sp);
3088 
3089     return error;
3090 }
3091 
3092 Error
3093 Process::Detach ()
3094 {
3095     Error error (WillDetach());
3096 
3097     if (error.Success())
3098     {
3099         DisableAllBreakpointSites();
3100         error = DoDetach();
3101         if (error.Success())
3102         {
3103             DidDetach();
3104             StopPrivateStateThread();
3105         }
3106     }
3107     return error;
3108 }
3109 
3110 Error
3111 Process::Destroy ()
3112 {
3113     Error error (WillDestroy());
3114     if (error.Success())
3115     {
3116         EventSP exit_event_sp;
3117         if (m_public_state.GetValue() == eStateRunning)
3118         {
3119             LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3120             if (log)
3121                 log->Printf("Process::Destroy() About to halt.");
3122             error = Halt();
3123             if (error.Success())
3124             {
3125                 // Consume the halt event.
3126                 TimeValue timeout (TimeValue::Now());
3127                 timeout.OffsetWithSeconds(1);
3128                 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp);
3129                 if (state != eStateExited)
3130                     exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3131 
3132                 if (state != eStateStopped)
3133                 {
3134                     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3135                     if (log)
3136                         log->Printf("Process::Destroy() Halt failed to stop, state is: %s", StateAsCString(state));
3137                     // If we really couldn't stop the process then we should just error out here, but if the
3138                     // lower levels just bobbled sending the event and we really are stopped, then continue on.
3139                     StateType private_state = m_private_state.GetValue();
3140                     if (private_state != eStateStopped && private_state != eStateExited)
3141                     {
3142                         // If we exited when we were waiting for a process to stop, then
3143                         // forward the event here so we don't lose the event
3144                         return error;
3145                     }
3146                 }
3147             }
3148             else
3149             {
3150                 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3151                 if (log)
3152                     log->Printf("Process::Destroy() Halt got error: %s", error.AsCString());
3153                 return error;
3154             }
3155         }
3156 
3157         if (m_public_state.GetValue() != eStateRunning)
3158         {
3159             // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3160             // kill it, we don't want it hitting a breakpoint...
3161             // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3162             // we're not going to have much luck doing this now.
3163             m_thread_list.DiscardThreadPlans();
3164             DisableAllBreakpointSites();
3165         }
3166 
3167         error = DoDestroy();
3168         if (error.Success())
3169         {
3170             DidDestroy();
3171             StopPrivateStateThread();
3172         }
3173         m_stdio_communication.StopReadThread();
3174         m_stdio_communication.Disconnect();
3175         if (m_process_input_reader && m_process_input_reader->IsActive())
3176             m_target.GetDebugger().PopInputReader (m_process_input_reader);
3177         if (m_process_input_reader)
3178             m_process_input_reader.reset();
3179 
3180         // If we exited when we were waiting for a process to stop, then
3181         // forward the event here so we don't lose the event
3182         if (exit_event_sp)
3183         {
3184             // Directly broadcast our exited event because we shut down our
3185             // private state thread above
3186             BroadcastEvent(exit_event_sp);
3187         }
3188 
3189         // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3190         // the last events through the event system, in which case we might strand the write lock.  Unlock
3191         // it here so when we do to tear down the process we don't get an error destroying the lock.
3192         m_run_lock.WriteUnlock();
3193     }
3194     return error;
3195 }
3196 
3197 Error
3198 Process::Signal (int signal)
3199 {
3200     Error error (WillSignal());
3201     if (error.Success())
3202     {
3203         error = DoSignal(signal);
3204         if (error.Success())
3205             DidSignal();
3206     }
3207     return error;
3208 }
3209 
3210 lldb::ByteOrder
3211 Process::GetByteOrder () const
3212 {
3213     return m_target.GetArchitecture().GetByteOrder();
3214 }
3215 
3216 uint32_t
3217 Process::GetAddressByteSize () const
3218 {
3219     return m_target.GetArchitecture().GetAddressByteSize();
3220 }
3221 
3222 
3223 bool
3224 Process::ShouldBroadcastEvent (Event *event_ptr)
3225 {
3226     const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3227     bool return_value = true;
3228     LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
3229 
3230     switch (state)
3231     {
3232         case eStateConnected:
3233         case eStateAttaching:
3234         case eStateLaunching:
3235         case eStateDetached:
3236         case eStateExited:
3237         case eStateUnloaded:
3238             // These events indicate changes in the state of the debugging session, always report them.
3239             return_value = true;
3240             break;
3241         case eStateInvalid:
3242             // We stopped for no apparent reason, don't report it.
3243             return_value = false;
3244             break;
3245         case eStateRunning:
3246         case eStateStepping:
3247             // If we've started the target running, we handle the cases where we
3248             // are already running and where there is a transition from stopped to
3249             // running differently.
3250             // running -> running: Automatically suppress extra running events
3251             // stopped -> running: Report except when there is one or more no votes
3252             //     and no yes votes.
3253             SynchronouslyNotifyStateChanged (state);
3254             switch (m_public_state.GetValue())
3255             {
3256                 case eStateRunning:
3257                 case eStateStepping:
3258                     // We always suppress multiple runnings with no PUBLIC stop in between.
3259                     return_value = false;
3260                     break;
3261                 default:
3262                     // TODO: make this work correctly. For now always report
3263                     // run if we aren't running so we don't miss any runnning
3264                     // events. If I run the lldb/test/thread/a.out file and
3265                     // break at main.cpp:58, run and hit the breakpoints on
3266                     // multiple threads, then somehow during the stepping over
3267                     // of all breakpoints no run gets reported.
3268 
3269                     // This is a transition from stop to run.
3270                     switch (m_thread_list.ShouldReportRun (event_ptr))
3271                     {
3272                         default:
3273                         case eVoteYes:
3274                         case eVoteNoOpinion:
3275                             return_value = true;
3276                             break;
3277                         case eVoteNo:
3278                             return_value = false;
3279                             break;
3280                     }
3281                     break;
3282             }
3283             break;
3284         case eStateStopped:
3285         case eStateCrashed:
3286         case eStateSuspended:
3287         {
3288             // We've stopped.  First see if we're going to restart the target.
3289             // If we are going to stop, then we always broadcast the event.
3290             // If we aren't going to stop, let the thread plans decide if we're going to report this event.
3291             // If no thread has an opinion, we don't report it.
3292 
3293             RefreshStateAfterStop ();
3294             if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
3295             {
3296                 if (log)
3297                     log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s", event_ptr, StateAsCString(state));
3298                 return true;
3299             }
3300             else
3301             {
3302 
3303                 if (m_thread_list.ShouldStop (event_ptr) == false)
3304                 {
3305                     // ShouldStop may have restarted the target already.  If so, don't
3306                     // resume it twice.
3307                     bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
3308                     switch (m_thread_list.ShouldReportStop (event_ptr))
3309                     {
3310                         case eVoteYes:
3311                             Process::ProcessEventData::SetRestartedInEvent (event_ptr, true);
3312                             // Intentional fall-through here.
3313                         case eVoteNoOpinion:
3314                         case eVoteNo:
3315                             return_value = false;
3316                             break;
3317                     }
3318 
3319                     if (log)
3320                         log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s", event_ptr, StateAsCString(state));
3321                     if (!was_restarted)
3322                         PrivateResume ();
3323                 }
3324                 else
3325                 {
3326                     return_value = true;
3327                     SynchronouslyNotifyStateChanged (state);
3328                 }
3329             }
3330         }
3331     }
3332 
3333     if (log)
3334         log->Printf ("Process::ShouldBroadcastEvent (%p) => %s - %s", event_ptr, StateAsCString(state), return_value ? "YES" : "NO");
3335     return return_value;
3336 }
3337 
3338 
3339 bool
3340 Process::StartPrivateStateThread (bool force)
3341 {
3342     LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
3343 
3344     bool already_running = PrivateStateThreadIsValid ();
3345     if (log)
3346         log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
3347 
3348     if (!force && already_running)
3349         return true;
3350 
3351     // Create a thread that watches our internal state and controls which
3352     // events make it to clients (into the DCProcess event queue).
3353     char thread_name[1024];
3354     if (already_running)
3355         snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%llu)>", GetID());
3356     else
3357         snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%llu)>", GetID());
3358 
3359     // Create the private state thread, and start it running.
3360     m_private_state_thread = Host::ThreadCreate (thread_name, Process::PrivateStateThread, this, NULL);
3361     bool success = IS_VALID_LLDB_HOST_THREAD(m_private_state_thread);
3362     if (success)
3363     {
3364         ResumePrivateStateThread();
3365         return true;
3366     }
3367     else
3368         return false;
3369 }
3370 
3371 void
3372 Process::PausePrivateStateThread ()
3373 {
3374     ControlPrivateStateThread (eBroadcastInternalStateControlPause);
3375 }
3376 
3377 void
3378 Process::ResumePrivateStateThread ()
3379 {
3380     ControlPrivateStateThread (eBroadcastInternalStateControlResume);
3381 }
3382 
3383 void
3384 Process::StopPrivateStateThread ()
3385 {
3386     if (PrivateStateThreadIsValid ())
3387         ControlPrivateStateThread (eBroadcastInternalStateControlStop);
3388     else
3389     {
3390         LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
3391         if (log)
3392             printf ("Went to stop the private state thread, but it was already invalid.");
3393     }
3394 }
3395 
3396 void
3397 Process::ControlPrivateStateThread (uint32_t signal)
3398 {
3399     LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
3400 
3401     assert (signal == eBroadcastInternalStateControlStop ||
3402             signal == eBroadcastInternalStateControlPause ||
3403             signal == eBroadcastInternalStateControlResume);
3404 
3405     if (log)
3406         log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
3407 
3408     // Signal the private state thread. First we should copy this is case the
3409     // thread starts exiting since the private state thread will NULL this out
3410     // when it exits
3411     const lldb::thread_t private_state_thread = m_private_state_thread;
3412     if (IS_VALID_LLDB_HOST_THREAD(private_state_thread))
3413     {
3414         TimeValue timeout_time;
3415         bool timed_out;
3416 
3417         m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
3418 
3419         timeout_time = TimeValue::Now();
3420         timeout_time.OffsetWithSeconds(2);
3421         if (log)
3422             log->Printf ("Sending control event of type: %d.", signal);
3423         m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
3424         m_private_state_control_wait.SetValue (false, eBroadcastNever);
3425 
3426         if (signal == eBroadcastInternalStateControlStop)
3427         {
3428             if (timed_out)
3429             {
3430                 Error error;
3431                 Host::ThreadCancel (private_state_thread, &error);
3432                 if (log)
3433                     log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
3434             }
3435             else
3436             {
3437                 if (log)
3438                     log->Printf ("The control event killed the private state thread without having to cancel.");
3439             }
3440 
3441             thread_result_t result = NULL;
3442             Host::ThreadJoin (private_state_thread, &result, NULL);
3443             m_private_state_thread = LLDB_INVALID_HOST_THREAD;
3444         }
3445     }
3446     else
3447     {
3448         if (log)
3449             log->Printf ("Private state thread already dead, no need to signal it to stop.");
3450     }
3451 }
3452 
3453 void
3454 Process::SendAsyncInterrupt ()
3455 {
3456     if (PrivateStateThreadIsValid())
3457         m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3458     else
3459         BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3460 }
3461 
3462 void
3463 Process::HandlePrivateEvent (EventSP &event_sp)
3464 {
3465     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3466     m_currently_handling_event.SetValue(true, eBroadcastNever);
3467 
3468     const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3469 
3470     // First check to see if anybody wants a shot at this event:
3471     if (m_next_event_action_ap.get() != NULL)
3472     {
3473         NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
3474         switch (action_result)
3475         {
3476             case NextEventAction::eEventActionSuccess:
3477                 SetNextEventAction(NULL);
3478                 break;
3479 
3480             case NextEventAction::eEventActionRetry:
3481                 break;
3482 
3483             case NextEventAction::eEventActionExit:
3484                 // Handle Exiting Here.  If we already got an exited event,
3485                 // we should just propagate it.  Otherwise, swallow this event,
3486                 // and set our state to exit so the next event will kill us.
3487                 if (new_state != eStateExited)
3488                 {
3489                     // FIXME: should cons up an exited event, and discard this one.
3490                     SetExitStatus(0, m_next_event_action_ap->GetExitString());
3491                     SetNextEventAction(NULL);
3492                     return;
3493                 }
3494                 SetNextEventAction(NULL);
3495                 break;
3496         }
3497     }
3498 
3499     // See if we should broadcast this state to external clients?
3500     const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
3501 
3502     if (should_broadcast)
3503     {
3504         if (log)
3505         {
3506             log->Printf ("Process::%s (pid = %llu) broadcasting new state %s (old state %s) to %s",
3507                          __FUNCTION__,
3508                          GetID(),
3509                          StateAsCString(new_state),
3510                          StateAsCString (GetState ()),
3511                          IsHijackedForEvent(eBroadcastBitStateChanged) ? "hijacked" : "public");
3512         }
3513         Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
3514         if (StateIsRunningState (new_state))
3515             PushProcessInputReader ();
3516         else
3517             PopProcessInputReader ();
3518 
3519         BroadcastEvent (event_sp);
3520     }
3521     else
3522     {
3523         if (log)
3524         {
3525             log->Printf ("Process::%s (pid = %llu) suppressing state %s (old state %s): should_broadcast == false",
3526                          __FUNCTION__,
3527                          GetID(),
3528                          StateAsCString(new_state),
3529                          StateAsCString (GetState ()));
3530         }
3531     }
3532     m_currently_handling_event.SetValue(false, eBroadcastAlways);
3533 }
3534 
3535 void *
3536 Process::PrivateStateThread (void *arg)
3537 {
3538     Process *proc = static_cast<Process*> (arg);
3539     void *result = proc->RunPrivateStateThread ();
3540     return result;
3541 }
3542 
3543 void *
3544 Process::RunPrivateStateThread ()
3545 {
3546     bool control_only = true;
3547     m_private_state_control_wait.SetValue (false, eBroadcastNever);
3548 
3549     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3550     if (log)
3551         log->Printf ("Process::%s (arg = %p, pid = %llu) thread starting...", __FUNCTION__, this, GetID());
3552 
3553     bool exit_now = false;
3554     while (!exit_now)
3555     {
3556         EventSP event_sp;
3557         WaitForEventsPrivate (NULL, event_sp, control_only);
3558         if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
3559         {
3560             if (log)
3561                 log->Printf ("Process::%s (arg = %p, pid = %llu) got a control event: %d", __FUNCTION__, this, GetID(), event_sp->GetType());
3562 
3563             switch (event_sp->GetType())
3564             {
3565             case eBroadcastInternalStateControlStop:
3566                 exit_now = true;
3567                 break;      // doing any internal state managment below
3568 
3569             case eBroadcastInternalStateControlPause:
3570                 control_only = true;
3571                 break;
3572 
3573             case eBroadcastInternalStateControlResume:
3574                 control_only = false;
3575                 break;
3576             }
3577 
3578             m_private_state_control_wait.SetValue (true, eBroadcastAlways);
3579             continue;
3580         }
3581         else if (event_sp->GetType() == eBroadcastBitInterrupt)
3582         {
3583             if (m_public_state.GetValue() == eStateAttaching)
3584             {
3585                 if (log)
3586                     log->Printf ("Process::%s (arg = %p, pid = %llu) woke up with an interrupt while attaching - forwarding interrupt.", __FUNCTION__, this, GetID());
3587                 BroadcastEvent (eBroadcastBitInterrupt, NULL);
3588             }
3589             else
3590             {
3591                 if (log)
3592                     log->Printf ("Process::%s (arg = %p, pid = %llu) woke up with an interrupt - Halting.", __FUNCTION__, this, GetID());
3593                 Halt();
3594             }
3595             continue;
3596         }
3597 
3598         const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3599 
3600         if (internal_state != eStateInvalid)
3601         {
3602             HandlePrivateEvent (event_sp);
3603         }
3604 
3605         if (internal_state == eStateInvalid ||
3606             internal_state == eStateExited  ||
3607             internal_state == eStateDetached )
3608         {
3609             if (log)
3610                 log->Printf ("Process::%s (arg = %p, pid = %llu) about to exit with internal state %s...", __FUNCTION__, this, GetID(), StateAsCString(internal_state));
3611 
3612             break;
3613         }
3614     }
3615 
3616     // Verify log is still enabled before attempting to write to it...
3617     if (log)
3618         log->Printf ("Process::%s (arg = %p, pid = %llu) thread exiting...", __FUNCTION__, this, GetID());
3619 
3620     m_private_state_control_wait.SetValue (true, eBroadcastAlways);
3621     m_private_state_thread = LLDB_INVALID_HOST_THREAD;
3622     return NULL;
3623 }
3624 
3625 //------------------------------------------------------------------
3626 // Process Event Data
3627 //------------------------------------------------------------------
3628 
3629 Process::ProcessEventData::ProcessEventData () :
3630     EventData (),
3631     m_process_sp (),
3632     m_state (eStateInvalid),
3633     m_restarted (false),
3634     m_update_state (0),
3635     m_interrupted (false)
3636 {
3637 }
3638 
3639 Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
3640     EventData (),
3641     m_process_sp (process_sp),
3642     m_state (state),
3643     m_restarted (false),
3644     m_update_state (0),
3645     m_interrupted (false)
3646 {
3647 }
3648 
3649 Process::ProcessEventData::~ProcessEventData()
3650 {
3651 }
3652 
3653 const ConstString &
3654 Process::ProcessEventData::GetFlavorString ()
3655 {
3656     static ConstString g_flavor ("Process::ProcessEventData");
3657     return g_flavor;
3658 }
3659 
3660 const ConstString &
3661 Process::ProcessEventData::GetFlavor () const
3662 {
3663     return ProcessEventData::GetFlavorString ();
3664 }
3665 
3666 void
3667 Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
3668 {
3669     // This function gets called twice for each event, once when the event gets pulled
3670     // off of the private process event queue, and then any number of times, first when it gets pulled off of
3671     // the public event queue, then other times when we're pretending that this is where we stopped at the
3672     // end of expression evaluation.  m_update_state is used to distinguish these
3673     // three cases; it is 0 when we're just pulling it off for private handling,
3674     // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
3675 
3676     if (m_update_state != 1)
3677         return;
3678 
3679     m_process_sp->SetPublicState (m_state);
3680 
3681     // If we're stopped and haven't restarted, then do the breakpoint commands here:
3682     if (m_state == eStateStopped && ! m_restarted)
3683     {
3684         ThreadList &curr_thread_list = m_process_sp->GetThreadList();
3685         uint32_t num_threads = curr_thread_list.GetSize();
3686         uint32_t idx;
3687 
3688         // The actions might change one of the thread's stop_info's opinions about whether we should
3689         // stop the process, so we need to query that as we go.
3690 
3691         // One other complication here, is that we try to catch any case where the target has run (except for expressions)
3692         // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
3693         // that would cause our iteration here to crash.  We could make a copy of the thread list, but we'd really like
3694         // 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
3695         // against this list & bag out if anything differs.
3696         std::vector<uint32_t> thread_index_array(num_threads);
3697         for (idx = 0; idx < num_threads; ++idx)
3698             thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
3699 
3700         bool still_should_stop = true;
3701 
3702         for (idx = 0; idx < num_threads; ++idx)
3703         {
3704             curr_thread_list = m_process_sp->GetThreadList();
3705             if (curr_thread_list.GetSize() != num_threads)
3706             {
3707                 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
3708                 if (log)
3709                     log->Printf("Number of threads changed from %u to %u while processing event.", num_threads, curr_thread_list.GetSize());
3710                 break;
3711             }
3712 
3713             lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
3714 
3715             if (thread_sp->GetIndexID() != thread_index_array[idx])
3716             {
3717                 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
3718                 if (log)
3719                     log->Printf("The thread at position %u changed from %u to %u while processing event.",
3720                                 idx,
3721                                 thread_index_array[idx],
3722                                 thread_sp->GetIndexID());
3723                 break;
3724             }
3725 
3726             StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
3727             if (stop_info_sp)
3728             {
3729                 stop_info_sp->PerformAction(event_ptr);
3730                 // The stop action might restart the target.  If it does, then we want to mark that in the
3731                 // event so that whoever is receiving it will know to wait for the running event and reflect
3732                 // that state appropriately.
3733                 // We also need to stop processing actions, since they aren't expecting the target to be running.
3734 
3735                 // FIXME: we might have run.
3736                 if (stop_info_sp->HasTargetRunSinceMe())
3737                 {
3738                     SetRestarted (true);
3739                     break;
3740                 }
3741                 else if (!stop_info_sp->ShouldStop(event_ptr))
3742                 {
3743                     still_should_stop = false;
3744                 }
3745             }
3746         }
3747 
3748 
3749         if (m_process_sp->GetPrivateState() != eStateRunning)
3750         {
3751             if (!still_should_stop)
3752             {
3753                 // We've been asked to continue, so do that here.
3754                 SetRestarted(true);
3755                 // Use the public resume method here, since this is just
3756                 // extending a public resume.
3757                 m_process_sp->Resume();
3758             }
3759             else
3760             {
3761                 // If we didn't restart, run the Stop Hooks here:
3762                 // They might also restart the target, so watch for that.
3763                 m_process_sp->GetTarget().RunStopHooks();
3764                 if (m_process_sp->GetPrivateState() == eStateRunning)
3765                     SetRestarted(true);
3766             }
3767         }
3768 
3769     }
3770 }
3771 
3772 void
3773 Process::ProcessEventData::Dump (Stream *s) const
3774 {
3775     if (m_process_sp)
3776         s->Printf(" process = %p (pid = %llu), ", m_process_sp.get(), m_process_sp->GetID());
3777 
3778     s->Printf("state = %s", StateAsCString(GetState()));
3779 }
3780 
3781 const Process::ProcessEventData *
3782 Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
3783 {
3784     if (event_ptr)
3785     {
3786         const EventData *event_data = event_ptr->GetData();
3787         if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
3788             return static_cast <const ProcessEventData *> (event_ptr->GetData());
3789     }
3790     return NULL;
3791 }
3792 
3793 ProcessSP
3794 Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
3795 {
3796     ProcessSP process_sp;
3797     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3798     if (data)
3799         process_sp = data->GetProcessSP();
3800     return process_sp;
3801 }
3802 
3803 StateType
3804 Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
3805 {
3806     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3807     if (data == NULL)
3808         return eStateInvalid;
3809     else
3810         return data->GetState();
3811 }
3812 
3813 bool
3814 Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
3815 {
3816     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3817     if (data == NULL)
3818         return false;
3819     else
3820         return data->GetRestarted();
3821 }
3822 
3823 void
3824 Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
3825 {
3826     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
3827     if (data != NULL)
3828         data->SetRestarted(new_value);
3829 }
3830 
3831 bool
3832 Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
3833 {
3834     const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3835     if (data == NULL)
3836         return false;
3837     else
3838         return data->GetInterrupted ();
3839 }
3840 
3841 void
3842 Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
3843 {
3844     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
3845     if (data != NULL)
3846         data->SetInterrupted(new_value);
3847 }
3848 
3849 bool
3850 Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
3851 {
3852     ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
3853     if (data)
3854     {
3855         data->SetUpdateStateOnRemoval();
3856         return true;
3857     }
3858     return false;
3859 }
3860 
3861 lldb::TargetSP
3862 Process::CalculateTarget ()
3863 {
3864     return m_target.shared_from_this();
3865 }
3866 
3867 void
3868 Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
3869 {
3870     exe_ctx.SetTargetPtr (&m_target);
3871     exe_ctx.SetProcessPtr (this);
3872     exe_ctx.SetThreadPtr(NULL);
3873     exe_ctx.SetFramePtr (NULL);
3874 }
3875 
3876 //uint32_t
3877 //Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
3878 //{
3879 //    return 0;
3880 //}
3881 //
3882 //ArchSpec
3883 //Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
3884 //{
3885 //    return Host::GetArchSpecForExistingProcess (pid);
3886 //}
3887 //
3888 //ArchSpec
3889 //Process::GetArchSpecForExistingProcess (const char *process_name)
3890 //{
3891 //    return Host::GetArchSpecForExistingProcess (process_name);
3892 //}
3893 //
3894 void
3895 Process::AppendSTDOUT (const char * s, size_t len)
3896 {
3897     Mutex::Locker locker (m_stdio_communication_mutex);
3898     m_stdout_data.append (s, len);
3899     BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (GetTarget().GetProcessSP(), GetState()));
3900 }
3901 
3902 void
3903 Process::AppendSTDERR (const char * s, size_t len)
3904 {
3905     Mutex::Locker locker (m_stdio_communication_mutex);
3906     m_stderr_data.append (s, len);
3907     BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (GetTarget().GetProcessSP(), GetState()));
3908 }
3909 
3910 //------------------------------------------------------------------
3911 // Process STDIO
3912 //------------------------------------------------------------------
3913 
3914 size_t
3915 Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
3916 {
3917     Mutex::Locker locker(m_stdio_communication_mutex);
3918     size_t bytes_available = m_stdout_data.size();
3919     if (bytes_available > 0)
3920     {
3921         LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3922         if (log)
3923             log->Printf ("Process::GetSTDOUT (buf = %p, size = %llu)", buf, (uint64_t)buf_size);
3924         if (bytes_available > buf_size)
3925         {
3926             memcpy(buf, m_stdout_data.c_str(), buf_size);
3927             m_stdout_data.erase(0, buf_size);
3928             bytes_available = buf_size;
3929         }
3930         else
3931         {
3932             memcpy(buf, m_stdout_data.c_str(), bytes_available);
3933             m_stdout_data.clear();
3934         }
3935     }
3936     return bytes_available;
3937 }
3938 
3939 
3940 size_t
3941 Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
3942 {
3943     Mutex::Locker locker(m_stdio_communication_mutex);
3944     size_t bytes_available = m_stderr_data.size();
3945     if (bytes_available > 0)
3946     {
3947         LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3948         if (log)
3949             log->Printf ("Process::GetSTDERR (buf = %p, size = %llu)", buf, (uint64_t)buf_size);
3950         if (bytes_available > buf_size)
3951         {
3952             memcpy(buf, m_stderr_data.c_str(), buf_size);
3953             m_stderr_data.erase(0, buf_size);
3954             bytes_available = buf_size;
3955         }
3956         else
3957         {
3958             memcpy(buf, m_stderr_data.c_str(), bytes_available);
3959             m_stderr_data.clear();
3960         }
3961     }
3962     return bytes_available;
3963 }
3964 
3965 void
3966 Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
3967 {
3968     Process *process = (Process *) baton;
3969     process->AppendSTDOUT (static_cast<const char *>(src), src_len);
3970 }
3971 
3972 size_t
3973 Process::ProcessInputReaderCallback (void *baton,
3974                                      InputReader &reader,
3975                                      lldb::InputReaderAction notification,
3976                                      const char *bytes,
3977                                      size_t bytes_len)
3978 {
3979     Process *process = (Process *) baton;
3980 
3981     switch (notification)
3982     {
3983     case eInputReaderActivate:
3984         break;
3985 
3986     case eInputReaderDeactivate:
3987         break;
3988 
3989     case eInputReaderReactivate:
3990         break;
3991 
3992     case eInputReaderAsynchronousOutputWritten:
3993         break;
3994 
3995     case eInputReaderGotToken:
3996         {
3997             Error error;
3998             process->PutSTDIN (bytes, bytes_len, error);
3999         }
4000         break;
4001 
4002     case eInputReaderInterrupt:
4003         process->Halt ();
4004         break;
4005 
4006     case eInputReaderEndOfFile:
4007         process->AppendSTDOUT ("^D", 2);
4008         break;
4009 
4010     case eInputReaderDone:
4011         break;
4012 
4013     }
4014 
4015     return bytes_len;
4016 }
4017 
4018 void
4019 Process::ResetProcessInputReader ()
4020 {
4021     m_process_input_reader.reset();
4022 }
4023 
4024 void
4025 Process::SetSTDIOFileDescriptor (int file_descriptor)
4026 {
4027     // First set up the Read Thread for reading/handling process I/O
4028 
4029     std::auto_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (file_descriptor, true));
4030 
4031     if (conn_ap.get())
4032     {
4033         m_stdio_communication.SetConnection (conn_ap.release());
4034         if (m_stdio_communication.IsConnected())
4035         {
4036             m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
4037             m_stdio_communication.StartReadThread();
4038 
4039             // Now read thread is set up, set up input reader.
4040 
4041             if (!m_process_input_reader.get())
4042             {
4043                 m_process_input_reader.reset (new InputReader(m_target.GetDebugger()));
4044                 Error err (m_process_input_reader->Initialize (Process::ProcessInputReaderCallback,
4045                                                                this,
4046                                                                eInputReaderGranularityByte,
4047                                                                NULL,
4048                                                                NULL,
4049                                                                false));
4050 
4051                 if  (err.Fail())
4052                     m_process_input_reader.reset();
4053             }
4054         }
4055     }
4056 }
4057 
4058 void
4059 Process::PushProcessInputReader ()
4060 {
4061     if (m_process_input_reader && !m_process_input_reader->IsActive())
4062         m_target.GetDebugger().PushInputReader (m_process_input_reader);
4063 }
4064 
4065 void
4066 Process::PopProcessInputReader ()
4067 {
4068     if (m_process_input_reader && m_process_input_reader->IsActive())
4069         m_target.GetDebugger().PopInputReader (m_process_input_reader);
4070 }
4071 
4072 // The process needs to know about installed plug-ins
4073 void
4074 Process::SettingsInitialize ()
4075 {
4076 //    static std::vector<OptionEnumValueElement> g_plugins;
4077 //
4078 //    int i=0;
4079 //    const char *name;
4080 //    OptionEnumValueElement option_enum;
4081 //    while ((name = PluginManager::GetProcessPluginNameAtIndex (i)) != NULL)
4082 //    {
4083 //        if (name)
4084 //        {
4085 //            option_enum.value = i;
4086 //            option_enum.string_value = name;
4087 //            option_enum.usage = PluginManager::GetProcessPluginDescriptionAtIndex (i);
4088 //            g_plugins.push_back (option_enum);
4089 //        }
4090 //        ++i;
4091 //    }
4092 //    option_enum.value = 0;
4093 //    option_enum.string_value = NULL;
4094 //    option_enum.usage = NULL;
4095 //    g_plugins.push_back (option_enum);
4096 //
4097 //    for (i=0; (name = SettingsController::instance_settings_table[i].var_name); ++i)
4098 //    {
4099 //        if (::strcmp (name, "plugin") == 0)
4100 //        {
4101 //            SettingsController::instance_settings_table[i].enum_values = &g_plugins[0];
4102 //            break;
4103 //        }
4104 //    }
4105 //
4106     Thread::SettingsInitialize ();
4107 }
4108 
4109 void
4110 Process::SettingsTerminate ()
4111 {
4112     Thread::SettingsTerminate ();
4113 }
4114 
4115 ExecutionResults
4116 Process::RunThreadPlan (ExecutionContext &exe_ctx,
4117                         lldb::ThreadPlanSP &thread_plan_sp,
4118                         bool stop_others,
4119                         bool try_all_threads,
4120                         bool discard_on_error,
4121                         uint32_t single_thread_timeout_usec,
4122                         Stream &errors)
4123 {
4124     ExecutionResults return_value = eExecutionSetupError;
4125 
4126     if (thread_plan_sp.get() == NULL)
4127     {
4128         errors.Printf("RunThreadPlan called with empty thread plan.");
4129         return eExecutionSetupError;
4130     }
4131 
4132     if (exe_ctx.GetProcessPtr() != this)
4133     {
4134         errors.Printf("RunThreadPlan called on wrong process.");
4135         return eExecutionSetupError;
4136     }
4137 
4138     Thread *thread = exe_ctx.GetThreadPtr();
4139     if (thread == NULL)
4140     {
4141         errors.Printf("RunThreadPlan called with invalid thread.");
4142         return eExecutionSetupError;
4143     }
4144 
4145     // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
4146     // For that to be true the plan can't be private - since private plans suppress themselves in the
4147     // GetCompletedPlan call.
4148 
4149     bool orig_plan_private = thread_plan_sp->GetPrivate();
4150     thread_plan_sp->SetPrivate(false);
4151 
4152     if (m_private_state.GetValue() != eStateStopped)
4153     {
4154         errors.Printf ("RunThreadPlan called while the private state was not stopped.");
4155         return eExecutionSetupError;
4156     }
4157 
4158     // Save the thread & frame from the exe_ctx for restoration after we run
4159     const uint32_t thread_idx_id = thread->GetIndexID();
4160     StackID ctx_frame_id = thread->GetSelectedFrame()->GetStackID();
4161 
4162     // N.B. Running the target may unset the currently selected thread and frame.  We don't want to do that either,
4163     // so we should arrange to reset them as well.
4164 
4165     lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
4166 
4167     uint32_t selected_tid;
4168     StackID selected_stack_id;
4169     if (selected_thread_sp)
4170     {
4171         selected_tid = selected_thread_sp->GetIndexID();
4172         selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
4173     }
4174     else
4175     {
4176         selected_tid = LLDB_INVALID_THREAD_ID;
4177     }
4178 
4179     lldb::thread_t backup_private_state_thread = LLDB_INVALID_HOST_THREAD;
4180     lldb::StateType old_state;
4181     lldb::ThreadPlanSP stopper_base_plan_sp;
4182 
4183     lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
4184     if (Host::GetCurrentThread() == m_private_state_thread)
4185     {
4186         // Yikes, we are running on the private state thread!  So we can't wait for public events on this thread, since
4187         // we are the thread that is generating public events.
4188         // The simplest thing to do is to spin up a temporary thread to handle private state thread events while
4189         // we are fielding public events here.
4190         if (log)
4191 			log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events.");
4192 
4193 
4194         backup_private_state_thread = m_private_state_thread;
4195 
4196         // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
4197         // returning control here.
4198         // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
4199         // event before deciding to stop, and we don't want that.  So we insert a "stopper" base plan on the stack
4200         // before the plan we want to run.  Since base plans always stop and return control to the user, that will
4201         // do just what we want.
4202         stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
4203         thread->QueueThreadPlan (stopper_base_plan_sp, false);
4204         // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
4205         old_state = m_public_state.GetValue();
4206         m_public_state.SetValueNoLock(eStateStopped);
4207 
4208         // Now spin up the private state thread:
4209         StartPrivateStateThread(true);
4210     }
4211 
4212     thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
4213 
4214     Listener listener("lldb.process.listener.run-thread-plan");
4215 
4216     lldb::EventSP event_to_broadcast_sp;
4217 
4218     {
4219         // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
4220         // restored on exit to the function.
4221         //
4222         // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
4223         // is put into event_to_broadcast_sp for rebroadcasting.
4224 
4225         ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
4226 
4227         if (log)
4228         {
4229             StreamString s;
4230             thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
4231             log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4llx to run thread plan \"%s\".",
4232                          thread->GetIndexID(),
4233                          thread->GetID(),
4234                          s.GetData());
4235         }
4236 
4237         bool got_event;
4238         lldb::EventSP event_sp;
4239         lldb::StateType stop_state = lldb::eStateInvalid;
4240 
4241         TimeValue* timeout_ptr = NULL;
4242         TimeValue real_timeout;
4243 
4244         bool first_timeout = true;
4245         bool do_resume = true;
4246 
4247         while (1)
4248         {
4249             // We usually want to resume the process if we get to the top of the loop.
4250             // The only exception is if we get two running events with no intervening
4251             // stop, which can happen, we will just wait for then next stop event.
4252 
4253             if (do_resume)
4254             {
4255                 // Do the initial resume and wait for the running event before going further.
4256 
4257                 Error resume_error = PrivateResume ();
4258                 if (!resume_error.Success())
4259                 {
4260                     errors.Printf("Error resuming inferior: \"%s\".\n", resume_error.AsCString());
4261                     return_value = eExecutionSetupError;
4262                     break;
4263                 }
4264 
4265                 real_timeout = TimeValue::Now();
4266                 real_timeout.OffsetWithMicroSeconds(500000);
4267                 timeout_ptr = &real_timeout;
4268 
4269                 got_event = listener.WaitForEvent(timeout_ptr, event_sp);
4270                 if (!got_event)
4271                 {
4272                     if (log)
4273                         log->PutCString("Process::RunThreadPlan(): didn't get any event after initial resume, exiting.");
4274 
4275                     errors.Printf("Didn't get any event after initial resume, exiting.");
4276                     return_value = eExecutionSetupError;
4277                     break;
4278                 }
4279 
4280                 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4281                 if (stop_state != eStateRunning)
4282                 {
4283                     if (log)
4284                         log->Printf("Process::RunThreadPlan(): didn't get running event after initial resume, got %s instead.", StateAsCString(stop_state));
4285 
4286                     errors.Printf("Didn't get running event after initial resume, got %s instead.", StateAsCString(stop_state));
4287                     return_value = eExecutionSetupError;
4288                     break;
4289                 }
4290 
4291                 if (log)
4292                     log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
4293                 // We need to call the function synchronously, so spin waiting for it to return.
4294                 // If we get interrupted while executing, we're going to lose our context, and
4295                 // won't be able to gather the result at this point.
4296                 // We set the timeout AFTER the resume, since the resume takes some time and we
4297                 // don't want to charge that to the timeout.
4298 
4299                 if (single_thread_timeout_usec != 0)
4300                 {
4301                     // we have a > 0 timeout, let us set it so that we stop after the deadline
4302                     real_timeout = TimeValue::Now();
4303                     real_timeout.OffsetWithMicroSeconds(single_thread_timeout_usec);
4304 
4305                     timeout_ptr = &real_timeout;
4306                 }
4307                 else if (first_timeout)
4308                 {
4309                     // if we are willing to wait "forever" we still need to have an initial timeout
4310                     // this timeout is going to induce all threads to run when hit. we do this so that
4311                     // we can avoid ending locked up because of multithreaded contention issues
4312                     real_timeout = TimeValue::Now();
4313                     real_timeout.OffsetWithNanoSeconds(500000000UL);
4314                     timeout_ptr = &real_timeout;
4315                 }
4316                 else
4317                 {
4318                     timeout_ptr = NULL; // if we are in a no-timeout scenario, then we only need a fake timeout the first time through
4319                     // at this point in the code, all threads will be running so we are willing to wait forever, and do not
4320                     // need a timeout
4321                 }
4322             }
4323             else
4324             {
4325                 if (log)
4326                     log->PutCString ("Process::RunThreadPlan(): handled an extra running event.");
4327                 do_resume = true;
4328             }
4329 
4330             // Now wait for the process to stop again:
4331             event_sp.reset();
4332 
4333             if (log)
4334             {
4335                 if (timeout_ptr)
4336                 {
4337                     StreamString s;
4338                     s.Printf ("about to wait - timeout is:\n   ");
4339                     timeout_ptr->Dump (&s, 120);
4340                     s.Printf ("\nNow is:\n    ");
4341                     TimeValue::Now().Dump (&s, 120);
4342                     log->Printf ("Process::RunThreadPlan(): %s", s.GetData());
4343                 }
4344                 else
4345                 {
4346                     log->Printf ("Process::RunThreadPlan(): about to wait forever.");
4347                 }
4348             }
4349 
4350             got_event = listener.WaitForEvent (timeout_ptr, event_sp);
4351 
4352             if (got_event)
4353             {
4354                 if (event_sp.get())
4355                 {
4356                     bool keep_going = false;
4357                     if (event_sp->GetType() == eBroadcastBitInterrupt)
4358                     {
4359                         Halt();
4360                         keep_going = false;
4361                         return_value = eExecutionInterrupted;
4362                         errors.Printf ("Execution halted by user interrupt.");
4363                         if (log)
4364                             log->Printf ("Process::RunThreadPlan(): Got  interrupted by eBroadcastBitInterrupted, exiting.");
4365                     }
4366                     else
4367                     {
4368                         stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4369                         if (log)
4370                             log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
4371 
4372                         switch (stop_state)
4373                         {
4374                         case lldb::eStateStopped:
4375                             {
4376                                 // Yay, we're done.  Now make sure that our thread plan actually completed.
4377                                 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
4378                                 if (!thread_sp)
4379                                 {
4380                                     // Ooh, our thread has vanished.  Unlikely that this was successful execution...
4381                                     if (log)
4382                                         log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
4383                                     return_value = eExecutionInterrupted;
4384                                 }
4385                                 else
4386                                 {
4387                                     StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
4388                                     StopReason stop_reason = eStopReasonInvalid;
4389                                     if (stop_info_sp)
4390                                          stop_reason = stop_info_sp->GetStopReason();
4391                                     if (stop_reason == eStopReasonPlanComplete)
4392                                     {
4393                                         if (log)
4394                                             log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
4395                                         // Now mark this plan as private so it doesn't get reported as the stop reason
4396                                         // after this point.
4397                                         if (thread_plan_sp)
4398                                             thread_plan_sp->SetPrivate (orig_plan_private);
4399                                         return_value = eExecutionCompleted;
4400                                     }
4401                                     else
4402                                     {
4403                                         if (log)
4404                                             log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
4405 
4406                                         return_value = eExecutionInterrupted;
4407                                     }
4408                                 }
4409                             }
4410                             break;
4411 
4412                         case lldb::eStateCrashed:
4413                             if (log)
4414                                 log->PutCString ("Process::RunThreadPlan(): execution crashed.");
4415                             return_value = eExecutionInterrupted;
4416                             break;
4417 
4418                         case lldb::eStateRunning:
4419                             do_resume = false;
4420                             keep_going = true;
4421                             break;
4422 
4423                         default:
4424                             if (log)
4425                                 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
4426 
4427                             if (stop_state == eStateExited)
4428                                 event_to_broadcast_sp = event_sp;
4429 
4430                             errors.Printf ("Execution stopped with unexpected state.\n");
4431                             return_value = eExecutionInterrupted;
4432                             break;
4433                         }
4434                     }
4435 
4436                     if (keep_going)
4437                         continue;
4438                     else
4439                         break;
4440                 }
4441                 else
4442                 {
4443                     if (log)
4444                         log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null.  How odd...");
4445                     return_value = eExecutionInterrupted;
4446                     break;
4447                 }
4448             }
4449             else
4450             {
4451                 // If we didn't get an event that means we've timed out...
4452                 // We will interrupt the process here.  Depending on what we were asked to do we will
4453                 // either exit, or try with all threads running for the same timeout.
4454                 // Not really sure what to do if Halt fails here...
4455 
4456                 if (log) {
4457                     if (try_all_threads)
4458                     {
4459                         if (first_timeout)
4460                             log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
4461                                          "trying with all threads enabled.",
4462                                          single_thread_timeout_usec);
4463                         else
4464                             log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
4465                                          "and timeout: %d timed out.",
4466                                          single_thread_timeout_usec);
4467                     }
4468                     else
4469                         log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
4470                                      "halt and abandoning execution.",
4471                                      single_thread_timeout_usec);
4472                 }
4473 
4474                 Error halt_error = Halt();
4475                 if (halt_error.Success())
4476                 {
4477                     if (log)
4478                         log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
4479 
4480                     // If halt succeeds, it always produces a stopped event.  Wait for that:
4481 
4482                     real_timeout = TimeValue::Now();
4483                     real_timeout.OffsetWithMicroSeconds(500000);
4484 
4485                     got_event = listener.WaitForEvent(&real_timeout, event_sp);
4486 
4487                     if (got_event)
4488                     {
4489                         stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4490                         if (log)
4491                         {
4492                             log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
4493                             if (stop_state == lldb::eStateStopped
4494                                 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
4495                                 log->PutCString ("    Event was the Halt interruption event.");
4496                         }
4497 
4498                         if (stop_state == lldb::eStateStopped)
4499                         {
4500                             // Between the time we initiated the Halt and the time we delivered it, the process could have
4501                             // already finished its job.  Check that here:
4502 
4503                             if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4504                             {
4505                                 if (log)
4506                                     log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done.  "
4507                                                  "Exiting wait loop.");
4508                                 return_value = eExecutionCompleted;
4509                                 break;
4510                             }
4511 
4512                             if (!try_all_threads)
4513                             {
4514                                 if (log)
4515                                     log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
4516                                 return_value = eExecutionInterrupted;
4517                                 break;
4518                             }
4519 
4520                             if (first_timeout)
4521                             {
4522                                 // Set all the other threads to run, and return to the top of the loop, which will continue;
4523                                 first_timeout = false;
4524                                 thread_plan_sp->SetStopOthers (false);
4525                                 if (log)
4526                                     log->PutCString ("Process::RunThreadPlan(): about to resume.");
4527 
4528                                 continue;
4529                             }
4530                             else
4531                             {
4532                                 // Running all threads failed, so return Interrupted.
4533                                 if (log)
4534                                     log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
4535                                 return_value = eExecutionInterrupted;
4536                                 break;
4537                             }
4538                         }
4539                     }
4540                     else
4541                     {   if (log)
4542                             log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event.  "
4543                                     "I'm getting out of here passing Interrupted.");
4544                         return_value = eExecutionInterrupted;
4545                         break;
4546                     }
4547                 }
4548                 else
4549                 {
4550                     // This branch is to work around some problems with gdb-remote's Halt.  It is a little racy, and can return
4551                     // an error from halt, but if you wait a bit you'll get a stopped event anyway.
4552                     if (log)
4553                         log->Printf ("Process::RunThreadPlan(): halt failed: error = \"%s\", I'm just going to wait a little longer and see if I get a stopped event.",
4554                                      halt_error.AsCString());
4555                     real_timeout = TimeValue::Now();
4556                     real_timeout.OffsetWithMicroSeconds(500000);
4557                     timeout_ptr = &real_timeout;
4558                     got_event = listener.WaitForEvent(&real_timeout, event_sp);
4559                     if (!got_event || event_sp.get() == NULL)
4560                     {
4561                         // This is not going anywhere, bag out.
4562                         if (log)
4563                             log->PutCString ("Process::RunThreadPlan(): halt failed: and waiting for the stopped event failed.");
4564                         return_value = eExecutionInterrupted;
4565                         break;
4566                     }
4567                     else
4568                     {
4569                         stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4570                         if (log)
4571                             log->PutCString ("Process::RunThreadPlan(): halt failed: but then I got a stopped event.  Whatever...");
4572                         if (stop_state == lldb::eStateStopped)
4573                         {
4574                             // Between the time we initiated the Halt and the time we delivered it, the process could have
4575                             // already finished its job.  Check that here:
4576 
4577                             if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4578                             {
4579                                 if (log)
4580                                     log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done.  "
4581                                                  "Exiting wait loop.");
4582                                 return_value = eExecutionCompleted;
4583                                 break;
4584                             }
4585 
4586                             if (first_timeout)
4587                             {
4588                                 // Set all the other threads to run, and return to the top of the loop, which will continue;
4589                                 first_timeout = false;
4590                                 thread_plan_sp->SetStopOthers (false);
4591                                 if (log)
4592                                     log->PutCString ("Process::RunThreadPlan(): About to resume.");
4593 
4594                                 continue;
4595                             }
4596                             else
4597                             {
4598                                 // Running all threads failed, so return Interrupted.
4599                                 if (log)
4600                                     log->PutCString ("Process::RunThreadPlan(): running all threads timed out.");
4601                                 return_value = eExecutionInterrupted;
4602                                 break;
4603                             }
4604                         }
4605                         else
4606                         {
4607                             if (log)
4608                                 log->Printf ("Process::RunThreadPlan(): halt failed, I waited and didn't get"
4609                                              " a stopped event, instead got %s.", StateAsCString(stop_state));
4610                             return_value = eExecutionInterrupted;
4611                             break;
4612                         }
4613                     }
4614                 }
4615 
4616             }
4617 
4618         }  // END WAIT LOOP
4619 
4620         // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
4621         if (IS_VALID_LLDB_HOST_THREAD(backup_private_state_thread))
4622         {
4623             StopPrivateStateThread();
4624             Error error;
4625             m_private_state_thread = backup_private_state_thread;
4626             if (stopper_base_plan_sp)
4627             {
4628                 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
4629             }
4630             m_public_state.SetValueNoLock(old_state);
4631 
4632         }
4633 
4634 
4635         // Now do some processing on the results of the run:
4636         if (return_value == eExecutionInterrupted)
4637         {
4638             if (log)
4639             {
4640                 StreamString s;
4641                 if (event_sp)
4642                     event_sp->Dump (&s);
4643                 else
4644                 {
4645                     log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
4646                 }
4647 
4648                 StreamString ts;
4649 
4650                 const char *event_explanation = NULL;
4651 
4652                 do
4653                 {
4654                     if (!event_sp)
4655                     {
4656                         event_explanation = "<no event>";
4657                         break;
4658                     }
4659                     else if (event_sp->GetType() == eBroadcastBitInterrupt)
4660                     {
4661                         event_explanation = "<user interrupt>";
4662                         break;
4663                     }
4664                     else
4665                     {
4666                         const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
4667 
4668                         if (!event_data)
4669                         {
4670                             event_explanation = "<no event data>";
4671                             break;
4672                         }
4673 
4674                         Process *process = event_data->GetProcessSP().get();
4675 
4676                         if (!process)
4677                         {
4678                             event_explanation = "<no process>";
4679                             break;
4680                         }
4681 
4682                         ThreadList &thread_list = process->GetThreadList();
4683 
4684                         uint32_t num_threads = thread_list.GetSize();
4685                         uint32_t thread_index;
4686 
4687                         ts.Printf("<%u threads> ", num_threads);
4688 
4689                         for (thread_index = 0;
4690                              thread_index < num_threads;
4691                              ++thread_index)
4692                         {
4693                             Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
4694 
4695                             if (!thread)
4696                             {
4697                                 ts.Printf("<?> ");
4698                                 continue;
4699                             }
4700 
4701                             ts.Printf("<0x%4.4llx ", thread->GetID());
4702                             RegisterContext *register_context = thread->GetRegisterContext().get();
4703 
4704                             if (register_context)
4705                                 ts.Printf("[ip 0x%llx] ", register_context->GetPC());
4706                             else
4707                                 ts.Printf("[ip unknown] ");
4708 
4709                             lldb::StopInfoSP stop_info_sp = thread->GetStopInfo();
4710                             if (stop_info_sp)
4711                             {
4712                                 const char *stop_desc = stop_info_sp->GetDescription();
4713                                 if (stop_desc)
4714                                     ts.PutCString (stop_desc);
4715                             }
4716                             ts.Printf(">");
4717                         }
4718 
4719                         event_explanation = ts.GetData();
4720                     }
4721                 } while (0);
4722 
4723                 if (event_explanation)
4724                     log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
4725                 else
4726                     log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
4727             }
4728 
4729             if (discard_on_error && thread_plan_sp)
4730             {
4731                 if (log)
4732                     log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.", thread_plan_sp.get());
4733                 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
4734                 thread_plan_sp->SetPrivate (orig_plan_private);
4735             }
4736             else
4737             {
4738                 if (log)
4739                     log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.", thread_plan_sp.get());
4740             }
4741         }
4742         else if (return_value == eExecutionSetupError)
4743         {
4744             if (log)
4745                 log->PutCString("Process::RunThreadPlan(): execution set up error.");
4746 
4747             if (discard_on_error && thread_plan_sp)
4748             {
4749                 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
4750                 thread_plan_sp->SetPrivate (orig_plan_private);
4751             }
4752         }
4753         else
4754         {
4755             if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4756             {
4757                 if (log)
4758                     log->PutCString("Process::RunThreadPlan(): thread plan is done");
4759                 return_value = eExecutionCompleted;
4760             }
4761             else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
4762             {
4763                 if (log)
4764                     log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
4765                 return_value = eExecutionDiscarded;
4766             }
4767             else
4768             {
4769                 if (log)
4770                     log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
4771                 if (discard_on_error && thread_plan_sp)
4772                 {
4773                     if (log)
4774                         log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause discard_on_error is set.");
4775                     thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
4776                     thread_plan_sp->SetPrivate (orig_plan_private);
4777                 }
4778             }
4779         }
4780 
4781         // Thread we ran the function in may have gone away because we ran the target
4782         // Check that it's still there, and if it is put it back in the context.  Also restore the
4783         // frame in the context if it is still present.
4784         thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
4785         if (thread)
4786         {
4787             exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
4788         }
4789 
4790         // Also restore the current process'es selected frame & thread, since this function calling may
4791         // be done behind the user's back.
4792 
4793         if (selected_tid != LLDB_INVALID_THREAD_ID)
4794         {
4795             if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
4796             {
4797                 // We were able to restore the selected thread, now restore the frame:
4798                 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
4799                 if (old_frame_sp)
4800                     GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
4801             }
4802         }
4803     }
4804 
4805     // If the process exited during the run of the thread plan, notify everyone.
4806 
4807     if (event_to_broadcast_sp)
4808     {
4809         if (log)
4810             log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
4811         BroadcastEvent(event_to_broadcast_sp);
4812     }
4813 
4814     return return_value;
4815 }
4816 
4817 const char *
4818 Process::ExecutionResultAsCString (ExecutionResults result)
4819 {
4820     const char *result_name;
4821 
4822     switch (result)
4823     {
4824         case eExecutionCompleted:
4825             result_name = "eExecutionCompleted";
4826             break;
4827         case eExecutionDiscarded:
4828             result_name = "eExecutionDiscarded";
4829             break;
4830         case eExecutionInterrupted:
4831             result_name = "eExecutionInterrupted";
4832             break;
4833         case eExecutionSetupError:
4834             result_name = "eExecutionSetupError";
4835             break;
4836         case eExecutionTimedOut:
4837             result_name = "eExecutionTimedOut";
4838             break;
4839     }
4840     return result_name;
4841 }
4842 
4843 void
4844 Process::GetStatus (Stream &strm)
4845 {
4846     const StateType state = GetState();
4847     if (StateIsStoppedState(state, false))
4848     {
4849         if (state == eStateExited)
4850         {
4851             int exit_status = GetExitStatus();
4852             const char *exit_description = GetExitDescription();
4853             strm.Printf ("Process %llu exited with status = %i (0x%8.8x) %s\n",
4854                           GetID(),
4855                           exit_status,
4856                           exit_status,
4857                           exit_description ? exit_description : "");
4858         }
4859         else
4860         {
4861             if (state == eStateConnected)
4862                 strm.Printf ("Connected to remote target.\n");
4863             else
4864                 strm.Printf ("Process %llu %s\n", GetID(), StateAsCString (state));
4865         }
4866     }
4867     else
4868     {
4869         strm.Printf ("Process %llu is running.\n", GetID());
4870     }
4871 }
4872 
4873 size_t
4874 Process::GetThreadStatus (Stream &strm,
4875                           bool only_threads_with_stop_reason,
4876                           uint32_t start_frame,
4877                           uint32_t num_frames,
4878                           uint32_t num_frames_with_source)
4879 {
4880     size_t num_thread_infos_dumped = 0;
4881 
4882     Mutex::Locker locker (GetThreadList().GetMutex());
4883     const size_t num_threads = GetThreadList().GetSize();
4884     for (uint32_t i = 0; i < num_threads; i++)
4885     {
4886         Thread *thread = GetThreadList().GetThreadAtIndex(i).get();
4887         if (thread)
4888         {
4889             if (only_threads_with_stop_reason)
4890             {
4891                 if (thread->GetStopInfo().get() == NULL)
4892                     continue;
4893             }
4894             thread->GetStatus (strm,
4895                                start_frame,
4896                                num_frames,
4897                                num_frames_with_source);
4898             ++num_thread_infos_dumped;
4899         }
4900     }
4901     return num_thread_infos_dumped;
4902 }
4903 
4904 void
4905 Process::AddInvalidMemoryRegion (const LoadRange &region)
4906 {
4907     m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
4908 }
4909 
4910 bool
4911 Process::RemoveInvalidMemoryRange (const LoadRange &region)
4912 {
4913     return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
4914 }
4915 
4916 void
4917 Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
4918 {
4919     m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
4920 }
4921 
4922 bool
4923 Process::RunPreResumeActions ()
4924 {
4925     bool result = true;
4926     while (!m_pre_resume_actions.empty())
4927     {
4928         struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
4929         m_pre_resume_actions.pop_back();
4930         bool this_result = action.callback (action.baton);
4931         if (result == true) result = this_result;
4932     }
4933     return result;
4934 }
4935 
4936 void
4937 Process::ClearPreResumeActions ()
4938 {
4939     m_pre_resume_actions.clear();
4940 }
4941 
4942 void
4943 Process::Flush ()
4944 {
4945     m_thread_list.Flush();
4946 }
4947