xref: /llvm-project/lldb/source/Commands/CommandObjectProcess.cpp (revision d37221dc5d819d63dbe35ab9a2d60e73cbd52dbd)
1 //===-- CommandObjectProcess.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/lldb-python.h"
11 
12 #include "CommandObjectProcess.h"
13 
14 // C Includes
15 // C++ Includes
16 // Other libraries and framework includes
17 // Project includes
18 #include "lldb/Breakpoint/Breakpoint.h"
19 #include "lldb/Breakpoint/BreakpointLocation.h"
20 #include "lldb/Breakpoint/BreakpointSite.h"
21 #include "lldb/Core/State.h"
22 #include "lldb/Core/Module.h"
23 #include "lldb/Core/PluginManager.h"
24 #include "lldb/Host/Host.h"
25 #include "lldb/Interpreter/Args.h"
26 #include "lldb/Interpreter/Options.h"
27 #include "lldb/Interpreter/CommandInterpreter.h"
28 #include "lldb/Interpreter/CommandReturnObject.h"
29 #include "lldb/Target/Platform.h"
30 #include "lldb/Target/Process.h"
31 #include "lldb/Target/StopInfo.h"
32 #include "lldb/Target/Target.h"
33 #include "lldb/Target/Thread.h"
34 
35 using namespace lldb;
36 using namespace lldb_private;
37 
38 class CommandObjectProcessLaunchOrAttach : public CommandObjectParsed
39 {
40 public:
41     CommandObjectProcessLaunchOrAttach (CommandInterpreter &interpreter,
42                                        const char *name,
43                                        const char *help,
44                                        const char *syntax,
45                                        uint32_t flags,
46                                        const char *new_process_action) :
47         CommandObjectParsed (interpreter, name, help, syntax, flags),
48         m_new_process_action (new_process_action) {}
49 
50     virtual ~CommandObjectProcessLaunchOrAttach () {}
51 protected:
52     bool
53     StopProcessIfNecessary (Process *process, StateType &state, CommandReturnObject &result)
54     {
55         state = eStateInvalid;
56         if (process)
57         {
58             state = process->GetState();
59 
60             if (process->IsAlive() && state != eStateConnected)
61             {
62                 char message[1024];
63                 if (process->GetState() == eStateAttaching)
64                     ::snprintf (message, sizeof(message), "There is a pending attach, abort it and %s?", m_new_process_action.c_str());
65                 else if (process->GetShouldDetach())
66                     ::snprintf (message, sizeof(message), "There is a running process, detach from it and %s?", m_new_process_action.c_str());
67                 else
68                     ::snprintf (message, sizeof(message), "There is a running process, kill it and %s?", m_new_process_action.c_str());
69 
70                 if (!m_interpreter.Confirm (message, true))
71                 {
72                     result.SetStatus (eReturnStatusFailed);
73                     return false;
74                 }
75                 else
76                 {
77                     if (process->GetShouldDetach())
78                     {
79                         bool keep_stopped = false;
80                         Error detach_error (process->Detach(keep_stopped));
81                         if (detach_error.Success())
82                         {
83                             result.SetStatus (eReturnStatusSuccessFinishResult);
84                             process = NULL;
85                         }
86                         else
87                         {
88                             result.AppendErrorWithFormat ("Failed to detach from process: %s\n", detach_error.AsCString());
89                             result.SetStatus (eReturnStatusFailed);
90                         }
91                     }
92                     else
93                     {
94                         Error destroy_error (process->Destroy());
95                         if (destroy_error.Success())
96                         {
97                             result.SetStatus (eReturnStatusSuccessFinishResult);
98                             process = NULL;
99                         }
100                         else
101                         {
102                             result.AppendErrorWithFormat ("Failed to kill process: %s\n", destroy_error.AsCString());
103                             result.SetStatus (eReturnStatusFailed);
104                         }
105                     }
106                 }
107             }
108         }
109         return result.Succeeded();
110     }
111     std::string m_new_process_action;
112 };
113 //-------------------------------------------------------------------------
114 // CommandObjectProcessLaunch
115 //-------------------------------------------------------------------------
116 #pragma mark CommandObjectProcessLaunch
117 class CommandObjectProcessLaunch : public CommandObjectProcessLaunchOrAttach
118 {
119 public:
120 
121     CommandObjectProcessLaunch (CommandInterpreter &interpreter) :
122         CommandObjectProcessLaunchOrAttach (interpreter,
123                                             "process launch",
124                                             "Launch the executable in the debugger.",
125                                             NULL,
126                                             eFlagRequiresTarget,
127                                             "restart"),
128         m_options (interpreter)
129     {
130         CommandArgumentEntry arg;
131         CommandArgumentData run_args_arg;
132 
133         // Define the first (and only) variant of this arg.
134         run_args_arg.arg_type = eArgTypeRunArgs;
135         run_args_arg.arg_repetition = eArgRepeatOptional;
136 
137         // There is only one variant this argument could be; put it into the argument entry.
138         arg.push_back (run_args_arg);
139 
140         // Push the data for the first argument into the m_arguments vector.
141         m_arguments.push_back (arg);
142     }
143 
144 
145     ~CommandObjectProcessLaunch ()
146     {
147     }
148 
149     virtual int
150     HandleArgumentCompletion (Args &input,
151                               int &cursor_index,
152                               int &cursor_char_position,
153                               OptionElementVector &opt_element_vector,
154                               int match_start_point,
155                               int max_return_elements,
156                               bool &word_complete,
157                               StringList &matches)
158     {
159         std::string completion_str (input.GetArgumentAtIndex(cursor_index));
160         completion_str.erase (cursor_char_position);
161 
162         CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
163                                                              CommandCompletions::eDiskFileCompletion,
164                                                              completion_str.c_str(),
165                                                              match_start_point,
166                                                              max_return_elements,
167                                                              NULL,
168                                                              word_complete,
169                                                              matches);
170         return matches.GetSize();
171     }
172 
173     Options *
174     GetOptions ()
175     {
176         return &m_options;
177     }
178 
179     virtual const char *GetRepeatCommand (Args &current_command_args, uint32_t index)
180     {
181         // No repeat for "process launch"...
182         return "";
183     }
184 
185 protected:
186     bool
187     DoExecute (Args& launch_args, CommandReturnObject &result)
188     {
189         Debugger &debugger = m_interpreter.GetDebugger();
190         Target *target = debugger.GetSelectedTarget().get();
191         // If our listener is NULL, users aren't allows to launch
192         ModuleSP exe_module_sp = target->GetExecutableModule();
193 
194         if (exe_module_sp == NULL)
195         {
196             result.AppendError ("no file in target, create a debug target using the 'target create' command");
197             result.SetStatus (eReturnStatusFailed);
198             return false;
199         }
200 
201         StateType state = eStateInvalid;
202 
203         if (!StopProcessIfNecessary(m_exe_ctx.GetProcessPtr(), state, result))
204             return false;
205 
206         const char *target_settings_argv0 = target->GetArg0();
207 
208         if (target->GetDisableASLR())
209             m_options.launch_info.GetFlags().Set (eLaunchFlagDisableASLR);
210 
211         if (target->GetDetachOnError())
212             m_options.launch_info.GetFlags().Set (eLaunchFlagDetachOnError);
213 
214         if (target->GetDisableSTDIO())
215             m_options.launch_info.GetFlags().Set (eLaunchFlagDisableSTDIO);
216 
217         Args environment;
218         target->GetEnvironmentAsArgs (environment);
219         if (environment.GetArgumentCount() > 0)
220             m_options.launch_info.GetEnvironmentEntries ().AppendArguments (environment);
221 
222         if (target_settings_argv0)
223         {
224             m_options.launch_info.GetArguments().AppendArgument (target_settings_argv0);
225             m_options.launch_info.SetExecutableFile(exe_module_sp->GetPlatformFileSpec(), false);
226         }
227         else
228         {
229             m_options.launch_info.SetExecutableFile(exe_module_sp->GetPlatformFileSpec(), true);
230         }
231 
232         if (launch_args.GetArgumentCount() == 0)
233         {
234             Args target_setting_args;
235             if (target->GetRunArguments(target_setting_args))
236                 m_options.launch_info.GetArguments().AppendArguments (target_setting_args);
237         }
238         else
239         {
240             m_options.launch_info.GetArguments().AppendArguments (launch_args);
241             // Save the arguments for subsequent runs in the current target.
242             target->SetRunArguments (launch_args);
243         }
244 
245         Error error = target->Launch(debugger.GetListener(), m_options.launch_info);
246 
247         if (error.Success())
248         {
249             const char *archname = exe_module_sp->GetArchitecture().GetArchitectureName();
250             ProcessSP process_sp (target->GetProcessSP());
251             if (process_sp)
252             {
253                 result.AppendMessageWithFormat ("Process %" PRIu64 " launched: '%s' (%s)\n", process_sp->GetID(), exe_module_sp->GetFileSpec().GetPath().c_str(), archname);
254                 result.SetStatus (eReturnStatusSuccessFinishResult);
255                 result.SetDidChangeProcessState (true);
256             }
257             else
258             {
259                 result.AppendError("no error returned from Target::Launch, and target has no process");
260                 result.SetStatus (eReturnStatusFailed);
261             }
262         }
263         else
264         {
265             result.AppendError(error.AsCString());
266             result.SetStatus (eReturnStatusFailed);
267         }
268         return result.Succeeded();
269     }
270 
271 protected:
272     ProcessLaunchCommandOptions m_options;
273 };
274 
275 
276 //#define SET1 LLDB_OPT_SET_1
277 //#define SET2 LLDB_OPT_SET_2
278 //#define SET3 LLDB_OPT_SET_3
279 //
280 //OptionDefinition
281 //CommandObjectProcessLaunch::CommandOptions::g_option_table[] =
282 //{
283 //{ SET1 | SET2 | SET3, false, "stop-at-entry", 's', OptionParser::eNoArgument,       NULL, 0, eArgTypeNone,    "Stop at the entry point of the program when launching a process."},
284 //{ SET1              , false, "stdin",         'i', OptionParser::eRequiredArgument, NULL, 0, eArgTypeDirectoryName,    "Redirect stdin for the process to <path>."},
285 //{ SET1              , false, "stdout",        'o', OptionParser::eRequiredArgument, NULL, 0, eArgTypeDirectoryName,    "Redirect stdout for the process to <path>."},
286 //{ SET1              , false, "stderr",        'e', OptionParser::eRequiredArgument, NULL, 0, eArgTypeDirectoryName,    "Redirect stderr for the process to <path>."},
287 //{ SET1 | SET2 | SET3, false, "plugin",        'p', OptionParser::eRequiredArgument, NULL, 0, eArgTypePlugin,  "Name of the process plugin you want to use."},
288 //{        SET2       , false, "tty",           't', OptionParser::eOptionalArgument, NULL, 0, eArgTypeDirectoryName,    "Start the process in a terminal. If <path> is specified, look for a terminal whose name contains <path>, else start the process in a new terminal."},
289 //{               SET3, false, "no-stdio",      'n', OptionParser::eNoArgument,       NULL, 0, eArgTypeNone,    "Do not set up for terminal I/O to go to running process."},
290 //{ SET1 | SET2 | SET3, false, "working-dir",   'w', OptionParser::eRequiredArgument, NULL, 0, eArgTypeDirectoryName,    "Set the current working directory to <path> when running the inferior."},
291 //{ 0,                  false, NULL,             0,  0,                 NULL, 0, eArgTypeNone,    NULL }
292 //};
293 //
294 //#undef SET1
295 //#undef SET2
296 //#undef SET3
297 
298 //-------------------------------------------------------------------------
299 // CommandObjectProcessAttach
300 //-------------------------------------------------------------------------
301 #pragma mark CommandObjectProcessAttach
302 class CommandObjectProcessAttach : public CommandObjectProcessLaunchOrAttach
303 {
304 public:
305 
306     class CommandOptions : public Options
307     {
308     public:
309 
310         CommandOptions (CommandInterpreter &interpreter) :
311             Options(interpreter)
312         {
313             // Keep default values of all options in one place: OptionParsingStarting ()
314             OptionParsingStarting ();
315         }
316 
317         ~CommandOptions ()
318         {
319         }
320 
321         Error
322         SetOptionValue (uint32_t option_idx, const char *option_arg)
323         {
324             Error error;
325             const int short_option = m_getopt_table[option_idx].val;
326             bool success = false;
327             switch (short_option)
328             {
329                 case 'c':
330                     attach_info.SetContinueOnceAttached(true);
331                     break;
332 
333                 case 'p':
334                     {
335                         lldb::pid_t pid = Args::StringToUInt32 (option_arg, LLDB_INVALID_PROCESS_ID, 0, &success);
336                         if (!success || pid == LLDB_INVALID_PROCESS_ID)
337                         {
338                             error.SetErrorStringWithFormat("invalid process ID '%s'", option_arg);
339                         }
340                         else
341                         {
342                             attach_info.SetProcessID (pid);
343                         }
344                     }
345                     break;
346 
347                 case 'P':
348                     attach_info.SetProcessPluginName (option_arg);
349                     break;
350 
351                 case 'n':
352                     attach_info.GetExecutableFile().SetFile(option_arg, false);
353                     break;
354 
355                 case 'w':
356                     attach_info.SetWaitForLaunch(true);
357                     break;
358 
359                 case 'i':
360                     attach_info.SetIgnoreExisting(false);
361                     break;
362 
363                 default:
364                     error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
365                     break;
366             }
367             return error;
368         }
369 
370         void
371         OptionParsingStarting ()
372         {
373             attach_info.Clear();
374         }
375 
376         const OptionDefinition*
377         GetDefinitions ()
378         {
379             return g_option_table;
380         }
381 
382         virtual bool
383         HandleOptionArgumentCompletion (Args &input,
384                                         int cursor_index,
385                                         int char_pos,
386                                         OptionElementVector &opt_element_vector,
387                                         int opt_element_index,
388                                         int match_start_point,
389                                         int max_return_elements,
390                                         bool &word_complete,
391                                         StringList &matches)
392         {
393             int opt_arg_pos = opt_element_vector[opt_element_index].opt_arg_pos;
394             int opt_defs_index = opt_element_vector[opt_element_index].opt_defs_index;
395 
396             // We are only completing the name option for now...
397 
398             const OptionDefinition *opt_defs = GetDefinitions();
399             if (opt_defs[opt_defs_index].short_option == 'n')
400             {
401                 // Are we in the name?
402 
403                 // Look to see if there is a -P argument provided, and if so use that plugin, otherwise
404                 // use the default plugin.
405 
406                 const char *partial_name = NULL;
407                 partial_name = input.GetArgumentAtIndex(opt_arg_pos);
408 
409                 PlatformSP platform_sp (m_interpreter.GetPlatform (true));
410                 if (platform_sp)
411                 {
412                     ProcessInstanceInfoList process_infos;
413                     ProcessInstanceInfoMatch match_info;
414                     if (partial_name)
415                     {
416                         match_info.GetProcessInfo().GetExecutableFile().SetFile(partial_name, false);
417                         match_info.SetNameMatchType(eNameMatchStartsWith);
418                     }
419                     platform_sp->FindProcesses (match_info, process_infos);
420                     const size_t num_matches = process_infos.GetSize();
421                     if (num_matches > 0)
422                     {
423                         for (size_t i=0; i<num_matches; ++i)
424                         {
425                             matches.AppendString (process_infos.GetProcessNameAtIndex(i),
426                                                   process_infos.GetProcessNameLengthAtIndex(i));
427                         }
428                     }
429                 }
430             }
431 
432             return false;
433         }
434 
435         // Options table: Required for subclasses of Options.
436 
437         static OptionDefinition g_option_table[];
438 
439         // Instance variables to hold the values for command options.
440 
441         ProcessAttachInfo attach_info;
442     };
443 
444     CommandObjectProcessAttach (CommandInterpreter &interpreter) :
445         CommandObjectProcessLaunchOrAttach (interpreter,
446                                             "process attach",
447                                             "Attach to a process.",
448                                             "process attach <cmd-options>",
449                                             0,
450                                             "attach"),
451         m_options (interpreter)
452     {
453     }
454 
455     ~CommandObjectProcessAttach ()
456     {
457     }
458 
459     Options *
460     GetOptions ()
461     {
462         return &m_options;
463     }
464 
465 protected:
466     bool
467     DoExecute (Args& command,
468              CommandReturnObject &result)
469     {
470         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
471         // N.B. The attach should be synchronous.  It doesn't help much to get the prompt back between initiating the attach
472         // and the target actually stopping.  So even if the interpreter is set to be asynchronous, we wait for the stop
473         // ourselves here.
474 
475         StateType state = eStateInvalid;
476         Process *process = m_exe_ctx.GetProcessPtr();
477 
478         if (!StopProcessIfNecessary (process, state, result))
479             return false;
480 
481         if (target == NULL)
482         {
483             // If there isn't a current target create one.
484             TargetSP new_target_sp;
485             Error error;
486 
487             error = m_interpreter.GetDebugger().GetTargetList().CreateTarget (m_interpreter.GetDebugger(),
488                                                                               NULL,
489                                                                               NULL,
490                                                                               false,
491                                                                               NULL, // No platform options
492                                                                               new_target_sp);
493             target = new_target_sp.get();
494             if (target == NULL || error.Fail())
495             {
496                 result.AppendError(error.AsCString("Error creating target"));
497                 return false;
498             }
499             m_interpreter.GetDebugger().GetTargetList().SetSelectedTarget(target);
500         }
501 
502         // Record the old executable module, we want to issue a warning if the process of attaching changed the
503         // current executable (like somebody said "file foo" then attached to a PID whose executable was bar.)
504 
505         ModuleSP old_exec_module_sp = target->GetExecutableModule();
506         ArchSpec old_arch_spec = target->GetArchitecture();
507 
508         if (command.GetArgumentCount())
509         {
510             result.AppendErrorWithFormat("Invalid arguments for '%s'.\nUsage: %s\n", m_cmd_name.c_str(), m_cmd_syntax.c_str());
511             result.SetStatus (eReturnStatusFailed);
512         }
513         else
514         {
515             if (state != eStateConnected)
516             {
517                 const char *plugin_name = m_options.attach_info.GetProcessPluginName();
518                 process = target->CreateProcess (m_interpreter.GetDebugger().GetListener(), plugin_name, NULL).get();
519             }
520 
521             if (process)
522             {
523                 Error error;
524                 // If no process info was specified, then use the target executable
525                 // name as the process to attach to by default
526                 if (!m_options.attach_info.ProcessInfoSpecified ())
527                 {
528                     if (old_exec_module_sp)
529                         m_options.attach_info.GetExecutableFile().GetFilename() = old_exec_module_sp->GetPlatformFileSpec().GetFilename();
530 
531                     if (!m_options.attach_info.ProcessInfoSpecified ())
532                     {
533                         error.SetErrorString ("no process specified, create a target with a file, or specify the --pid or --name command option");
534                     }
535                 }
536 
537                 if (error.Success())
538                 {
539                     ListenerSP listener_sp (new Listener("lldb.CommandObjectProcessAttach.DoExecute.attach.hijack"));
540                     m_options.attach_info.SetHijackListener(listener_sp);
541                     process->HijackProcessEvents(listener_sp.get());
542                     error = process->Attach (m_options.attach_info);
543 
544                     if (error.Success())
545                     {
546                         result.SetStatus (eReturnStatusSuccessContinuingNoResult);
547                         StateType state = process->WaitForProcessToStop (NULL, NULL, false, listener_sp.get());
548 
549                         process->RestoreProcessEvents();
550 
551                         result.SetDidChangeProcessState (true);
552 
553                         if (state == eStateStopped)
554                         {
555                             result.AppendMessageWithFormat ("Process %" PRIu64 " %s\n", process->GetID(), StateAsCString (state));
556                             result.SetStatus (eReturnStatusSuccessFinishNoResult);
557                         }
558                         else
559                         {
560                             result.AppendError ("attach failed: process did not stop (no such process or permission problem?)");
561                             process->Destroy();
562                             result.SetStatus (eReturnStatusFailed);
563                         }
564                     }
565                     else
566                     {
567                         result.AppendErrorWithFormat ("attach failed: %s\n", error.AsCString());
568                         result.SetStatus (eReturnStatusFailed);
569                     }
570                 }
571             }
572         }
573 
574         if (result.Succeeded())
575         {
576             // Okay, we're done.  Last step is to warn if the executable module has changed:
577             char new_path[PATH_MAX];
578             ModuleSP new_exec_module_sp (target->GetExecutableModule());
579             if (!old_exec_module_sp)
580             {
581                 // We might not have a module if we attached to a raw pid...
582                 if (new_exec_module_sp)
583                 {
584                     new_exec_module_sp->GetFileSpec().GetPath(new_path, PATH_MAX);
585                     result.AppendMessageWithFormat("Executable module set to \"%s\".\n", new_path);
586                 }
587             }
588             else if (old_exec_module_sp->GetFileSpec() != new_exec_module_sp->GetFileSpec())
589             {
590                 char old_path[PATH_MAX];
591 
592                 old_exec_module_sp->GetFileSpec().GetPath (old_path, PATH_MAX);
593                 new_exec_module_sp->GetFileSpec().GetPath (new_path, PATH_MAX);
594 
595                 result.AppendWarningWithFormat("Executable module changed from \"%s\" to \"%s\".\n",
596                                                     old_path, new_path);
597             }
598 
599             if (!old_arch_spec.IsValid())
600             {
601                 result.AppendMessageWithFormat ("Architecture set to: %s.\n", target->GetArchitecture().GetTriple().getTriple().c_str());
602             }
603             else if (!old_arch_spec.IsExactMatch(target->GetArchitecture()))
604             {
605                 result.AppendWarningWithFormat("Architecture changed from %s to %s.\n",
606                                                old_arch_spec.GetTriple().getTriple().c_str(),
607                                                target->GetArchitecture().GetTriple().getTriple().c_str());
608             }
609 
610             // This supports the use-case scenario of immediately continuing the process once attached.
611             if (m_options.attach_info.GetContinueOnceAttached())
612                 m_interpreter.HandleCommand("process continue", eLazyBoolNo, result);
613         }
614         return result.Succeeded();
615     }
616 
617     CommandOptions m_options;
618 };
619 
620 
621 OptionDefinition
622 CommandObjectProcessAttach::CommandOptions::g_option_table[] =
623 {
624 { LLDB_OPT_SET_ALL, false, "continue",'c', OptionParser::eNoArgument,         NULL, NULL, 0, eArgTypeNone,         "Immediately continue the process once attached."},
625 { LLDB_OPT_SET_ALL, false, "plugin",  'P', OptionParser::eRequiredArgument,   NULL, NULL, 0, eArgTypePlugin,       "Name of the process plugin you want to use."},
626 { LLDB_OPT_SET_1,   false, "pid",     'p', OptionParser::eRequiredArgument,   NULL, NULL, 0, eArgTypePid,          "The process ID of an existing process to attach to."},
627 { LLDB_OPT_SET_2,   false, "name",    'n', OptionParser::eRequiredArgument,   NULL, NULL, 0, eArgTypeProcessName,  "The name of the process to attach to."},
628 { LLDB_OPT_SET_2,   false, "include-existing", 'i', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone,         "Include existing processes when doing attach -w."},
629 { LLDB_OPT_SET_2,   false, "waitfor", 'w', OptionParser::eNoArgument,         NULL, NULL, 0, eArgTypeNone,         "Wait for the process with <process-name> to launch."},
630 { 0, false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
631 };
632 
633 //-------------------------------------------------------------------------
634 // CommandObjectProcessContinue
635 //-------------------------------------------------------------------------
636 #pragma mark CommandObjectProcessContinue
637 
638 class CommandObjectProcessContinue : public CommandObjectParsed
639 {
640 public:
641 
642     CommandObjectProcessContinue (CommandInterpreter &interpreter) :
643         CommandObjectParsed (interpreter,
644                              "process continue",
645                              "Continue execution of all threads in the current process.",
646                              "process continue",
647                              eFlagRequiresProcess       |
648                              eFlagTryTargetAPILock      |
649                              eFlagProcessMustBeLaunched |
650                              eFlagProcessMustBePaused   ),
651         m_options(interpreter)
652     {
653     }
654 
655 
656     ~CommandObjectProcessContinue ()
657     {
658     }
659 
660 protected:
661 
662     class CommandOptions : public Options
663     {
664     public:
665 
666         CommandOptions (CommandInterpreter &interpreter) :
667             Options(interpreter)
668         {
669             // Keep default values of all options in one place: OptionParsingStarting ()
670             OptionParsingStarting ();
671         }
672 
673         ~CommandOptions ()
674         {
675         }
676 
677         Error
678         SetOptionValue (uint32_t option_idx, const char *option_arg)
679         {
680             Error error;
681             const int short_option = m_getopt_table[option_idx].val;
682             bool success = false;
683             switch (short_option)
684             {
685                 case 'i':
686                     m_ignore = Args::StringToUInt32 (option_arg, 0, 0, &success);
687                     if (!success)
688                         error.SetErrorStringWithFormat ("invalid value for ignore option: \"%s\", should be a number.", option_arg);
689                     break;
690 
691                 default:
692                     error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
693                     break;
694             }
695             return error;
696         }
697 
698         void
699         OptionParsingStarting ()
700         {
701             m_ignore = 0;
702         }
703 
704         const OptionDefinition*
705         GetDefinitions ()
706         {
707             return g_option_table;
708         }
709 
710         // Options table: Required for subclasses of Options.
711 
712         static OptionDefinition g_option_table[];
713 
714         uint32_t m_ignore;
715     };
716 
717     bool
718     DoExecute (Args& command, CommandReturnObject &result)
719     {
720         Process *process = m_exe_ctx.GetProcessPtr();
721         bool synchronous_execution = m_interpreter.GetSynchronous ();
722         StateType state = process->GetState();
723         if (state == eStateStopped)
724         {
725             if (command.GetArgumentCount() != 0)
726             {
727                 result.AppendErrorWithFormat ("The '%s' command does not take any arguments.\n", m_cmd_name.c_str());
728                 result.SetStatus (eReturnStatusFailed);
729                 return false;
730             }
731 
732             if (m_options.m_ignore > 0)
733             {
734                 ThreadSP sel_thread_sp(process->GetThreadList().GetSelectedThread());
735                 if (sel_thread_sp)
736                 {
737                     StopInfoSP stop_info_sp = sel_thread_sp->GetStopInfo();
738                     if (stop_info_sp && stop_info_sp->GetStopReason() == eStopReasonBreakpoint)
739                     {
740                         lldb::break_id_t bp_site_id = (lldb::break_id_t)stop_info_sp->GetValue();
741                         BreakpointSiteSP bp_site_sp(process->GetBreakpointSiteList().FindByID(bp_site_id));
742                         if (bp_site_sp)
743                         {
744                             const size_t num_owners = bp_site_sp->GetNumberOfOwners();
745                             for (size_t i = 0; i < num_owners; i++)
746                             {
747                                 Breakpoint &bp_ref = bp_site_sp->GetOwnerAtIndex(i)->GetBreakpoint();
748                                 if (!bp_ref.IsInternal())
749                                 {
750                                     bp_ref.SetIgnoreCount(m_options.m_ignore);
751                                 }
752                             }
753                         }
754                     }
755                 }
756             }
757 
758             {  // Scope for thread list mutex:
759                 Mutex::Locker locker (process->GetThreadList().GetMutex());
760                 const uint32_t num_threads = process->GetThreadList().GetSize();
761 
762                 // Set the actions that the threads should each take when resuming
763                 for (uint32_t idx=0; idx<num_threads; ++idx)
764                 {
765                     const bool override_suspend = false;
766                     process->GetThreadList().GetThreadAtIndex(idx)->SetResumeState (eStateRunning, override_suspend);
767                 }
768             }
769 
770             Error error(process->Resume());
771             if (error.Success())
772             {
773                 result.AppendMessageWithFormat ("Process %" PRIu64 " resuming\n", process->GetID());
774                 if (synchronous_execution)
775                 {
776                     state = process->WaitForProcessToStop (NULL);
777 
778                     result.SetDidChangeProcessState (true);
779                     result.AppendMessageWithFormat ("Process %" PRIu64 " %s\n", process->GetID(), StateAsCString (state));
780                     result.SetStatus (eReturnStatusSuccessFinishNoResult);
781                 }
782                 else
783                 {
784                     result.SetStatus (eReturnStatusSuccessContinuingNoResult);
785                 }
786             }
787             else
788             {
789                 result.AppendErrorWithFormat("Failed to resume process: %s.\n", error.AsCString());
790                 result.SetStatus (eReturnStatusFailed);
791             }
792         }
793         else
794         {
795             result.AppendErrorWithFormat ("Process cannot be continued from its current state (%s).\n",
796                                          StateAsCString(state));
797             result.SetStatus (eReturnStatusFailed);
798         }
799         return result.Succeeded();
800     }
801 
802     Options *
803     GetOptions ()
804     {
805         return &m_options;
806     }
807 
808     CommandOptions m_options;
809 
810 };
811 
812 OptionDefinition
813 CommandObjectProcessContinue::CommandOptions::g_option_table[] =
814 {
815 { LLDB_OPT_SET_ALL, false, "ignore-count",'i', OptionParser::eRequiredArgument,         NULL, NULL, 0, eArgTypeUnsignedInteger,
816                            "Ignore <N> crossings of the breakpoint (if it exists) for the currently selected thread."},
817 { 0, false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
818 };
819 
820 //-------------------------------------------------------------------------
821 // CommandObjectProcessDetach
822 //-------------------------------------------------------------------------
823 #pragma mark CommandObjectProcessDetach
824 
825 class CommandObjectProcessDetach : public CommandObjectParsed
826 {
827 public:
828     class CommandOptions : public Options
829     {
830     public:
831 
832         CommandOptions (CommandInterpreter &interpreter) :
833             Options (interpreter)
834         {
835             OptionParsingStarting ();
836         }
837 
838         ~CommandOptions ()
839         {
840         }
841 
842         Error
843         SetOptionValue (uint32_t option_idx, const char *option_arg)
844         {
845             Error error;
846             const int short_option = m_getopt_table[option_idx].val;
847 
848             switch (short_option)
849             {
850                 case 's':
851                     bool tmp_result;
852                     bool success;
853                     tmp_result = Args::StringToBoolean(option_arg, false, &success);
854                     if (!success)
855                         error.SetErrorStringWithFormat("invalid boolean option: \"%s\"", option_arg);
856                     else
857                     {
858                         if (tmp_result)
859                             m_keep_stopped = eLazyBoolYes;
860                         else
861                             m_keep_stopped = eLazyBoolNo;
862                     }
863                     break;
864                 default:
865                     error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
866                     break;
867             }
868             return error;
869         }
870 
871         void
872         OptionParsingStarting ()
873         {
874             m_keep_stopped = eLazyBoolCalculate;
875         }
876 
877         const OptionDefinition*
878         GetDefinitions ()
879         {
880             return g_option_table;
881         }
882 
883         // Options table: Required for subclasses of Options.
884 
885         static OptionDefinition g_option_table[];
886 
887         // Instance variables to hold the values for command options.
888         LazyBool m_keep_stopped;
889     };
890 
891     CommandObjectProcessDetach (CommandInterpreter &interpreter) :
892         CommandObjectParsed (interpreter,
893                              "process detach",
894                              "Detach from the current process being debugged.",
895                              "process detach",
896                              eFlagRequiresProcess      |
897                              eFlagTryTargetAPILock     |
898                              eFlagProcessMustBeLaunched),
899         m_options(interpreter)
900     {
901     }
902 
903     ~CommandObjectProcessDetach ()
904     {
905     }
906 
907     Options *
908     GetOptions ()
909     {
910         return &m_options;
911     }
912 
913 
914 protected:
915     bool
916     DoExecute (Args& command, CommandReturnObject &result)
917     {
918         Process *process = m_exe_ctx.GetProcessPtr();
919         // FIXME: This will be a Command Option:
920         bool keep_stopped;
921         if (m_options.m_keep_stopped == eLazyBoolCalculate)
922         {
923             // Check the process default:
924             if (process->GetDetachKeepsStopped())
925                 keep_stopped = true;
926             else
927                 keep_stopped = false;
928         }
929         else if (m_options.m_keep_stopped == eLazyBoolYes)
930             keep_stopped = true;
931         else
932             keep_stopped = false;
933 
934         Error error (process->Detach(keep_stopped));
935         if (error.Success())
936         {
937             result.SetStatus (eReturnStatusSuccessFinishResult);
938         }
939         else
940         {
941             result.AppendErrorWithFormat ("Detach failed: %s\n", error.AsCString());
942             result.SetStatus (eReturnStatusFailed);
943             return false;
944         }
945         return result.Succeeded();
946     }
947 
948     CommandOptions m_options;
949 };
950 
951 OptionDefinition
952 CommandObjectProcessDetach::CommandOptions::g_option_table[] =
953 {
954 { LLDB_OPT_SET_1, false, "keep-stopped",   's', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Whether or not the process should be kept stopped on detach (if possible)." },
955 { 0, false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
956 };
957 
958 //-------------------------------------------------------------------------
959 // CommandObjectProcessConnect
960 //-------------------------------------------------------------------------
961 #pragma mark CommandObjectProcessConnect
962 
963 class CommandObjectProcessConnect : public CommandObjectParsed
964 {
965 public:
966 
967     class CommandOptions : public Options
968     {
969     public:
970 
971         CommandOptions (CommandInterpreter &interpreter) :
972             Options(interpreter)
973         {
974             // Keep default values of all options in one place: OptionParsingStarting ()
975             OptionParsingStarting ();
976         }
977 
978         ~CommandOptions ()
979         {
980         }
981 
982         Error
983         SetOptionValue (uint32_t option_idx, const char *option_arg)
984         {
985             Error error;
986             const int short_option = m_getopt_table[option_idx].val;
987 
988             switch (short_option)
989             {
990             case 'p':
991                 plugin_name.assign (option_arg);
992                 break;
993 
994             default:
995                 error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
996                 break;
997             }
998             return error;
999         }
1000 
1001         void
1002         OptionParsingStarting ()
1003         {
1004             plugin_name.clear();
1005         }
1006 
1007         const OptionDefinition*
1008         GetDefinitions ()
1009         {
1010             return g_option_table;
1011         }
1012 
1013         // Options table: Required for subclasses of Options.
1014 
1015         static OptionDefinition g_option_table[];
1016 
1017         // Instance variables to hold the values for command options.
1018 
1019         std::string plugin_name;
1020     };
1021 
1022     CommandObjectProcessConnect (CommandInterpreter &interpreter) :
1023         CommandObjectParsed (interpreter,
1024                              "process connect",
1025                              "Connect to a remote debug service.",
1026                              "process connect <remote-url>",
1027                              0),
1028         m_options (interpreter)
1029     {
1030     }
1031 
1032     ~CommandObjectProcessConnect ()
1033     {
1034     }
1035 
1036 
1037     Options *
1038     GetOptions ()
1039     {
1040         return &m_options;
1041     }
1042 
1043 protected:
1044     bool
1045     DoExecute (Args& command,
1046              CommandReturnObject &result)
1047     {
1048 
1049         TargetSP target_sp (m_interpreter.GetDebugger().GetSelectedTarget());
1050         Error error;
1051         Process *process = m_exe_ctx.GetProcessPtr();
1052         if (process)
1053         {
1054             if (process->IsAlive())
1055             {
1056                 result.AppendErrorWithFormat ("Process %" PRIu64 " is currently being debugged, kill the process before connecting.\n",
1057                                               process->GetID());
1058                 result.SetStatus (eReturnStatusFailed);
1059                 return false;
1060             }
1061         }
1062 
1063         if (!target_sp)
1064         {
1065             // If there isn't a current target create one.
1066 
1067             error = m_interpreter.GetDebugger().GetTargetList().CreateTarget (m_interpreter.GetDebugger(),
1068                                                                               NULL,
1069                                                                               NULL,
1070                                                                               false,
1071                                                                               NULL, // No platform options
1072                                                                               target_sp);
1073             if (!target_sp || error.Fail())
1074             {
1075                 result.AppendError(error.AsCString("Error creating target"));
1076                 result.SetStatus (eReturnStatusFailed);
1077                 return false;
1078             }
1079             m_interpreter.GetDebugger().GetTargetList().SetSelectedTarget(target_sp.get());
1080         }
1081 
1082         if (command.GetArgumentCount() == 1)
1083         {
1084             const char *plugin_name = NULL;
1085             if (!m_options.plugin_name.empty())
1086                 plugin_name = m_options.plugin_name.c_str();
1087 
1088             const char *remote_url = command.GetArgumentAtIndex(0);
1089             process = target_sp->CreateProcess (m_interpreter.GetDebugger().GetListener(), plugin_name, NULL).get();
1090 
1091             if (process)
1092             {
1093                 error = process->ConnectRemote (process->GetTarget().GetDebugger().GetOutputFile().get(), remote_url);
1094 
1095                 if (error.Fail())
1096                 {
1097                     result.AppendError(error.AsCString("Remote connect failed"));
1098                     result.SetStatus (eReturnStatusFailed);
1099                     target_sp->DeleteCurrentProcess();
1100                     return false;
1101                 }
1102             }
1103             else
1104             {
1105                 result.AppendErrorWithFormat ("Unable to find process plug-in for remote URL '%s'.\nPlease specify a process plug-in name with the --plugin option, or specify an object file using the \"file\" command.\n",
1106                                               remote_url);
1107                 result.SetStatus (eReturnStatusFailed);
1108             }
1109         }
1110         else
1111         {
1112             result.AppendErrorWithFormat ("'%s' takes exactly one argument:\nUsage: %s\n",
1113                                           m_cmd_name.c_str(),
1114                                           m_cmd_syntax.c_str());
1115             result.SetStatus (eReturnStatusFailed);
1116         }
1117         return result.Succeeded();
1118     }
1119 
1120     CommandOptions m_options;
1121 };
1122 
1123 OptionDefinition
1124 CommandObjectProcessConnect::CommandOptions::g_option_table[] =
1125 {
1126     { LLDB_OPT_SET_ALL, false, "plugin", 'p', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
1127     { 0,                false, NULL,      0 , 0,                 NULL, NULL, 0, eArgTypeNone,   NULL }
1128 };
1129 
1130 //-------------------------------------------------------------------------
1131 // CommandObjectProcessPlugin
1132 //-------------------------------------------------------------------------
1133 #pragma mark CommandObjectProcessPlugin
1134 
1135 class CommandObjectProcessPlugin : public CommandObjectProxy
1136 {
1137 public:
1138 
1139     CommandObjectProcessPlugin (CommandInterpreter &interpreter) :
1140         CommandObjectProxy (interpreter,
1141                             "process plugin",
1142                             "Send a custom command to the current process plug-in.",
1143                             "process plugin <args>",
1144                             0)
1145     {
1146     }
1147 
1148     ~CommandObjectProcessPlugin ()
1149     {
1150     }
1151 
1152     virtual CommandObject *
1153     GetProxyCommandObject()
1154     {
1155         Process *process = m_interpreter.GetExecutionContext().GetProcessPtr();
1156         if (process)
1157             return process->GetPluginCommandObject();
1158         return NULL;
1159     }
1160 };
1161 
1162 
1163 //-------------------------------------------------------------------------
1164 // CommandObjectProcessLoad
1165 //-------------------------------------------------------------------------
1166 #pragma mark CommandObjectProcessLoad
1167 
1168 class CommandObjectProcessLoad : public CommandObjectParsed
1169 {
1170 public:
1171 
1172     CommandObjectProcessLoad (CommandInterpreter &interpreter) :
1173         CommandObjectParsed (interpreter,
1174                              "process load",
1175                              "Load a shared library into the current process.",
1176                              "process load <filename> [<filename> ...]",
1177                              eFlagRequiresProcess       |
1178                              eFlagTryTargetAPILock      |
1179                              eFlagProcessMustBeLaunched |
1180                              eFlagProcessMustBePaused   )
1181     {
1182     }
1183 
1184     ~CommandObjectProcessLoad ()
1185     {
1186     }
1187 
1188 protected:
1189     bool
1190     DoExecute (Args& command,
1191              CommandReturnObject &result)
1192     {
1193         Process *process = m_exe_ctx.GetProcessPtr();
1194 
1195         const size_t argc = command.GetArgumentCount();
1196 
1197         for (uint32_t i=0; i<argc; ++i)
1198         {
1199             Error error;
1200             const char *image_path = command.GetArgumentAtIndex(i);
1201             FileSpec image_spec (image_path, false);
1202             process->GetTarget().GetPlatform()->ResolveRemotePath(image_spec, image_spec);
1203             uint32_t image_token = process->LoadImage(image_spec, error);
1204             if (image_token != LLDB_INVALID_IMAGE_TOKEN)
1205             {
1206                 result.AppendMessageWithFormat ("Loading \"%s\"...ok\nImage %u loaded.\n", image_path, image_token);
1207                 result.SetStatus (eReturnStatusSuccessFinishResult);
1208             }
1209             else
1210             {
1211                 result.AppendErrorWithFormat ("failed to load '%s': %s", image_path, error.AsCString());
1212                 result.SetStatus (eReturnStatusFailed);
1213             }
1214         }
1215         return result.Succeeded();
1216     }
1217 };
1218 
1219 
1220 //-------------------------------------------------------------------------
1221 // CommandObjectProcessUnload
1222 //-------------------------------------------------------------------------
1223 #pragma mark CommandObjectProcessUnload
1224 
1225 class CommandObjectProcessUnload : public CommandObjectParsed
1226 {
1227 public:
1228 
1229     CommandObjectProcessUnload (CommandInterpreter &interpreter) :
1230         CommandObjectParsed (interpreter,
1231                              "process unload",
1232                              "Unload a shared library from the current process using the index returned by a previous call to \"process load\".",
1233                              "process unload <index>",
1234                              eFlagRequiresProcess       |
1235                              eFlagTryTargetAPILock      |
1236                              eFlagProcessMustBeLaunched |
1237                              eFlagProcessMustBePaused   )
1238     {
1239     }
1240 
1241     ~CommandObjectProcessUnload ()
1242     {
1243     }
1244 
1245 protected:
1246     bool
1247     DoExecute (Args& command,
1248              CommandReturnObject &result)
1249     {
1250         Process *process = m_exe_ctx.GetProcessPtr();
1251 
1252         const size_t argc = command.GetArgumentCount();
1253 
1254         for (uint32_t i=0; i<argc; ++i)
1255         {
1256             const char *image_token_cstr = command.GetArgumentAtIndex(i);
1257             uint32_t image_token = Args::StringToUInt32(image_token_cstr, LLDB_INVALID_IMAGE_TOKEN, 0);
1258             if (image_token == LLDB_INVALID_IMAGE_TOKEN)
1259             {
1260                 result.AppendErrorWithFormat ("invalid image index argument '%s'", image_token_cstr);
1261                 result.SetStatus (eReturnStatusFailed);
1262                 break;
1263             }
1264             else
1265             {
1266                 Error error (process->UnloadImage(image_token));
1267                 if (error.Success())
1268                 {
1269                     result.AppendMessageWithFormat ("Unloading shared library with index %u...ok\n", image_token);
1270                     result.SetStatus (eReturnStatusSuccessFinishResult);
1271                 }
1272                 else
1273                 {
1274                     result.AppendErrorWithFormat ("failed to unload image: %s", error.AsCString());
1275                     result.SetStatus (eReturnStatusFailed);
1276                     break;
1277                 }
1278             }
1279         }
1280         return result.Succeeded();
1281     }
1282 };
1283 
1284 //-------------------------------------------------------------------------
1285 // CommandObjectProcessSignal
1286 //-------------------------------------------------------------------------
1287 #pragma mark CommandObjectProcessSignal
1288 
1289 class CommandObjectProcessSignal : public CommandObjectParsed
1290 {
1291 public:
1292 
1293     CommandObjectProcessSignal (CommandInterpreter &interpreter) :
1294         CommandObjectParsed (interpreter,
1295                              "process signal",
1296                              "Send a UNIX signal to the current process being debugged.",
1297                              NULL,
1298                              eFlagRequiresProcess | eFlagTryTargetAPILock)
1299     {
1300         CommandArgumentEntry arg;
1301         CommandArgumentData signal_arg;
1302 
1303         // Define the first (and only) variant of this arg.
1304         signal_arg.arg_type = eArgTypeUnixSignal;
1305         signal_arg.arg_repetition = eArgRepeatPlain;
1306 
1307         // There is only one variant this argument could be; put it into the argument entry.
1308         arg.push_back (signal_arg);
1309 
1310         // Push the data for the first argument into the m_arguments vector.
1311         m_arguments.push_back (arg);
1312     }
1313 
1314     ~CommandObjectProcessSignal ()
1315     {
1316     }
1317 
1318 protected:
1319     bool
1320     DoExecute (Args& command,
1321              CommandReturnObject &result)
1322     {
1323         Process *process = m_exe_ctx.GetProcessPtr();
1324 
1325         if (command.GetArgumentCount() == 1)
1326         {
1327             int signo = LLDB_INVALID_SIGNAL_NUMBER;
1328 
1329             const char *signal_name = command.GetArgumentAtIndex(0);
1330             if (::isxdigit (signal_name[0]))
1331                 signo = Args::StringToSInt32(signal_name, LLDB_INVALID_SIGNAL_NUMBER, 0);
1332             else
1333                 signo = process->GetUnixSignals().GetSignalNumberFromName (signal_name);
1334 
1335             if (signo == LLDB_INVALID_SIGNAL_NUMBER)
1336             {
1337                 result.AppendErrorWithFormat ("Invalid signal argument '%s'.\n", command.GetArgumentAtIndex(0));
1338                 result.SetStatus (eReturnStatusFailed);
1339             }
1340             else
1341             {
1342                 Error error (process->Signal (signo));
1343                 if (error.Success())
1344                 {
1345                     result.SetStatus (eReturnStatusSuccessFinishResult);
1346                 }
1347                 else
1348                 {
1349                     result.AppendErrorWithFormat ("Failed to send signal %i: %s\n", signo, error.AsCString());
1350                     result.SetStatus (eReturnStatusFailed);
1351                 }
1352             }
1353         }
1354         else
1355         {
1356             result.AppendErrorWithFormat("'%s' takes exactly one signal number argument:\nUsage: %s\n", m_cmd_name.c_str(),
1357                                         m_cmd_syntax.c_str());
1358             result.SetStatus (eReturnStatusFailed);
1359         }
1360         return result.Succeeded();
1361     }
1362 };
1363 
1364 
1365 //-------------------------------------------------------------------------
1366 // CommandObjectProcessInterrupt
1367 //-------------------------------------------------------------------------
1368 #pragma mark CommandObjectProcessInterrupt
1369 
1370 class CommandObjectProcessInterrupt : public CommandObjectParsed
1371 {
1372 public:
1373 
1374 
1375     CommandObjectProcessInterrupt (CommandInterpreter &interpreter) :
1376         CommandObjectParsed (interpreter,
1377                              "process interrupt",
1378                              "Interrupt the current process being debugged.",
1379                              "process interrupt",
1380                              eFlagRequiresProcess      |
1381                              eFlagTryTargetAPILock     |
1382                              eFlagProcessMustBeLaunched)
1383     {
1384     }
1385 
1386     ~CommandObjectProcessInterrupt ()
1387     {
1388     }
1389 
1390 protected:
1391     bool
1392     DoExecute (Args& command,
1393                CommandReturnObject &result)
1394     {
1395         Process *process = m_exe_ctx.GetProcessPtr();
1396         if (process == NULL)
1397         {
1398             result.AppendError ("no process to halt");
1399             result.SetStatus (eReturnStatusFailed);
1400             return false;
1401         }
1402 
1403         if (command.GetArgumentCount() == 0)
1404         {
1405             bool clear_thread_plans = true;
1406             Error error(process->Halt (clear_thread_plans));
1407             if (error.Success())
1408             {
1409                 result.SetStatus (eReturnStatusSuccessFinishResult);
1410             }
1411             else
1412             {
1413                 result.AppendErrorWithFormat ("Failed to halt process: %s\n", error.AsCString());
1414                 result.SetStatus (eReturnStatusFailed);
1415             }
1416         }
1417         else
1418         {
1419             result.AppendErrorWithFormat("'%s' takes no arguments:\nUsage: %s\n",
1420                                         m_cmd_name.c_str(),
1421                                         m_cmd_syntax.c_str());
1422             result.SetStatus (eReturnStatusFailed);
1423         }
1424         return result.Succeeded();
1425     }
1426 };
1427 
1428 //-------------------------------------------------------------------------
1429 // CommandObjectProcessKill
1430 //-------------------------------------------------------------------------
1431 #pragma mark CommandObjectProcessKill
1432 
1433 class CommandObjectProcessKill : public CommandObjectParsed
1434 {
1435 public:
1436 
1437     CommandObjectProcessKill (CommandInterpreter &interpreter) :
1438         CommandObjectParsed (interpreter,
1439                              "process kill",
1440                              "Terminate the current process being debugged.",
1441                              "process kill",
1442                              eFlagRequiresProcess      |
1443                              eFlagTryTargetAPILock     |
1444                              eFlagProcessMustBeLaunched)
1445     {
1446     }
1447 
1448     ~CommandObjectProcessKill ()
1449     {
1450     }
1451 
1452 protected:
1453     bool
1454     DoExecute (Args& command,
1455              CommandReturnObject &result)
1456     {
1457         Process *process = m_exe_ctx.GetProcessPtr();
1458         if (process == NULL)
1459         {
1460             result.AppendError ("no process to kill");
1461             result.SetStatus (eReturnStatusFailed);
1462             return false;
1463         }
1464 
1465         if (command.GetArgumentCount() == 0)
1466         {
1467             Error error (process->Destroy());
1468             if (error.Success())
1469             {
1470                 result.SetStatus (eReturnStatusSuccessFinishResult);
1471             }
1472             else
1473             {
1474                 result.AppendErrorWithFormat ("Failed to kill process: %s\n", error.AsCString());
1475                 result.SetStatus (eReturnStatusFailed);
1476             }
1477         }
1478         else
1479         {
1480             result.AppendErrorWithFormat("'%s' takes no arguments:\nUsage: %s\n",
1481                                         m_cmd_name.c_str(),
1482                                         m_cmd_syntax.c_str());
1483             result.SetStatus (eReturnStatusFailed);
1484         }
1485         return result.Succeeded();
1486     }
1487 };
1488 
1489 //-------------------------------------------------------------------------
1490 // CommandObjectProcessSaveCore
1491 //-------------------------------------------------------------------------
1492 #pragma mark CommandObjectProcessSaveCore
1493 
1494 class CommandObjectProcessSaveCore : public CommandObjectParsed
1495 {
1496 public:
1497 
1498     CommandObjectProcessSaveCore (CommandInterpreter &interpreter) :
1499     CommandObjectParsed (interpreter,
1500                          "process save-core",
1501                          "Save the current process as a core file using an appropriate file type.",
1502                          "process save-core FILE",
1503                          eFlagRequiresProcess      |
1504                          eFlagTryTargetAPILock     |
1505                          eFlagProcessMustBeLaunched)
1506     {
1507     }
1508 
1509     ~CommandObjectProcessSaveCore ()
1510     {
1511     }
1512 
1513 protected:
1514     bool
1515     DoExecute (Args& command,
1516                CommandReturnObject &result)
1517     {
1518         ProcessSP process_sp = m_exe_ctx.GetProcessSP();
1519         if (process_sp)
1520         {
1521             if (command.GetArgumentCount() == 1)
1522             {
1523                 FileSpec output_file(command.GetArgumentAtIndex(0), false);
1524                 Error error = PluginManager::SaveCore(process_sp, output_file);
1525                 if (error.Success())
1526                 {
1527                     result.SetStatus (eReturnStatusSuccessFinishResult);
1528                 }
1529                 else
1530                 {
1531                     result.AppendErrorWithFormat ("Failed to save core file for process: %s\n", error.AsCString());
1532                     result.SetStatus (eReturnStatusFailed);
1533                 }
1534             }
1535             else
1536             {
1537                 result.AppendErrorWithFormat ("'%s' takes one arguments:\nUsage: %s\n",
1538                                               m_cmd_name.c_str(),
1539                                               m_cmd_syntax.c_str());
1540                 result.SetStatus (eReturnStatusFailed);
1541             }
1542         }
1543         else
1544         {
1545             result.AppendError ("invalid process");
1546             result.SetStatus (eReturnStatusFailed);
1547             return false;
1548         }
1549 
1550         return result.Succeeded();
1551     }
1552 };
1553 
1554 //-------------------------------------------------------------------------
1555 // CommandObjectProcessStatus
1556 //-------------------------------------------------------------------------
1557 #pragma mark CommandObjectProcessStatus
1558 
1559 class CommandObjectProcessStatus : public CommandObjectParsed
1560 {
1561 public:
1562     CommandObjectProcessStatus (CommandInterpreter &interpreter) :
1563         CommandObjectParsed (interpreter,
1564                              "process status",
1565                              "Show the current status and location of executing process.",
1566                              "process status",
1567                              eFlagRequiresProcess | eFlagTryTargetAPILock)
1568     {
1569     }
1570 
1571     ~CommandObjectProcessStatus()
1572     {
1573     }
1574 
1575 
1576     bool
1577     DoExecute (Args& command, CommandReturnObject &result)
1578     {
1579         Stream &strm = result.GetOutputStream();
1580         result.SetStatus (eReturnStatusSuccessFinishNoResult);
1581         // No need to check "process" for validity as eFlagRequiresProcess ensures it is valid
1582         Process *process = m_exe_ctx.GetProcessPtr();
1583         const bool only_threads_with_stop_reason = true;
1584         const uint32_t start_frame = 0;
1585         const uint32_t num_frames = 1;
1586         const uint32_t num_frames_with_source = 1;
1587         process->GetStatus(strm);
1588         process->GetThreadStatus (strm,
1589                                   only_threads_with_stop_reason,
1590                                   start_frame,
1591                                   num_frames,
1592                                   num_frames_with_source);
1593         return result.Succeeded();
1594     }
1595 };
1596 
1597 //-------------------------------------------------------------------------
1598 // CommandObjectProcessHandle
1599 //-------------------------------------------------------------------------
1600 #pragma mark CommandObjectProcessHandle
1601 
1602 class CommandObjectProcessHandle : public CommandObjectParsed
1603 {
1604 public:
1605 
1606     class CommandOptions : public Options
1607     {
1608     public:
1609 
1610         CommandOptions (CommandInterpreter &interpreter) :
1611             Options (interpreter)
1612         {
1613             OptionParsingStarting ();
1614         }
1615 
1616         ~CommandOptions ()
1617         {
1618         }
1619 
1620         Error
1621         SetOptionValue (uint32_t option_idx, const char *option_arg)
1622         {
1623             Error error;
1624             const int short_option = m_getopt_table[option_idx].val;
1625 
1626             switch (short_option)
1627             {
1628                 case 's':
1629                     stop = option_arg;
1630                     break;
1631                 case 'n':
1632                     notify = option_arg;
1633                     break;
1634                 case 'p':
1635                     pass = option_arg;
1636                     break;
1637                 default:
1638                     error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
1639                     break;
1640             }
1641             return error;
1642         }
1643 
1644         void
1645         OptionParsingStarting ()
1646         {
1647             stop.clear();
1648             notify.clear();
1649             pass.clear();
1650         }
1651 
1652         const OptionDefinition*
1653         GetDefinitions ()
1654         {
1655             return g_option_table;
1656         }
1657 
1658         // Options table: Required for subclasses of Options.
1659 
1660         static OptionDefinition g_option_table[];
1661 
1662         // Instance variables to hold the values for command options.
1663 
1664         std::string stop;
1665         std::string notify;
1666         std::string pass;
1667     };
1668 
1669 
1670     CommandObjectProcessHandle (CommandInterpreter &interpreter) :
1671         CommandObjectParsed (interpreter,
1672                              "process handle",
1673                              "Show or update what the process and debugger should do with various signals received from the OS.",
1674                              NULL),
1675         m_options (interpreter)
1676     {
1677         SetHelpLong ("If no signals are specified, update them all.  If no update option is specified, list the current values.\n");
1678         CommandArgumentEntry arg;
1679         CommandArgumentData signal_arg;
1680 
1681         signal_arg.arg_type = eArgTypeUnixSignal;
1682         signal_arg.arg_repetition = eArgRepeatStar;
1683 
1684         arg.push_back (signal_arg);
1685 
1686         m_arguments.push_back (arg);
1687     }
1688 
1689     ~CommandObjectProcessHandle ()
1690     {
1691     }
1692 
1693     Options *
1694     GetOptions ()
1695     {
1696         return &m_options;
1697     }
1698 
1699     bool
1700     VerifyCommandOptionValue (const std::string &option, int &real_value)
1701     {
1702         bool okay = true;
1703 
1704         bool success = false;
1705         bool tmp_value = Args::StringToBoolean (option.c_str(), false, &success);
1706 
1707         if (success && tmp_value)
1708             real_value = 1;
1709         else if (success && !tmp_value)
1710             real_value = 0;
1711         else
1712         {
1713             // If the value isn't 'true' or 'false', it had better be 0 or 1.
1714             real_value = Args::StringToUInt32 (option.c_str(), 3);
1715             if (real_value != 0 && real_value != 1)
1716                 okay = false;
1717         }
1718 
1719         return okay;
1720     }
1721 
1722     void
1723     PrintSignalHeader (Stream &str)
1724     {
1725         str.Printf ("NAME        PASS   STOP   NOTIFY\n");
1726         str.Printf ("==========  =====  =====  ======\n");
1727     }
1728 
1729     void
1730     PrintSignal (Stream &str, int32_t signo, const char *sig_name, UnixSignals &signals)
1731     {
1732         bool stop;
1733         bool suppress;
1734         bool notify;
1735 
1736         str.Printf ("%-10s  ", sig_name);
1737         if (signals.GetSignalInfo (signo, suppress, stop, notify))
1738         {
1739             bool pass = !suppress;
1740             str.Printf ("%s  %s  %s",
1741                         (pass ? "true " : "false"),
1742                         (stop ? "true " : "false"),
1743                         (notify ? "true " : "false"));
1744         }
1745         str.Printf ("\n");
1746     }
1747 
1748     void
1749     PrintSignalInformation (Stream &str, Args &signal_args, int num_valid_signals, UnixSignals &signals)
1750     {
1751         PrintSignalHeader (str);
1752 
1753         if (num_valid_signals > 0)
1754         {
1755             size_t num_args = signal_args.GetArgumentCount();
1756             for (size_t i = 0; i < num_args; ++i)
1757             {
1758                 int32_t signo = signals.GetSignalNumberFromName (signal_args.GetArgumentAtIndex (i));
1759                 if (signo != LLDB_INVALID_SIGNAL_NUMBER)
1760                     PrintSignal (str, signo, signal_args.GetArgumentAtIndex (i), signals);
1761             }
1762         }
1763         else // Print info for ALL signals
1764         {
1765             int32_t signo = signals.GetFirstSignalNumber();
1766             while (signo != LLDB_INVALID_SIGNAL_NUMBER)
1767             {
1768                 PrintSignal (str, signo, signals.GetSignalAsCString (signo), signals);
1769                 signo = signals.GetNextSignalNumber (signo);
1770             }
1771         }
1772     }
1773 
1774 protected:
1775     bool
1776     DoExecute (Args &signal_args, CommandReturnObject &result)
1777     {
1778         TargetSP target_sp = m_interpreter.GetDebugger().GetSelectedTarget();
1779 
1780         if (!target_sp)
1781         {
1782             result.AppendError ("No current target;"
1783                                 " cannot handle signals until you have a valid target and process.\n");
1784             result.SetStatus (eReturnStatusFailed);
1785             return false;
1786         }
1787 
1788         ProcessSP process_sp = target_sp->GetProcessSP();
1789 
1790         if (!process_sp)
1791         {
1792             result.AppendError ("No current process; cannot handle signals until you have a valid process.\n");
1793             result.SetStatus (eReturnStatusFailed);
1794             return false;
1795         }
1796 
1797         int stop_action = -1;   // -1 means leave the current setting alone
1798         int pass_action = -1;   // -1 means leave the current setting alone
1799         int notify_action = -1; // -1 means leave the current setting alone
1800 
1801         if (! m_options.stop.empty()
1802             && ! VerifyCommandOptionValue (m_options.stop, stop_action))
1803         {
1804             result.AppendError ("Invalid argument for command option --stop; must be true or false.\n");
1805             result.SetStatus (eReturnStatusFailed);
1806             return false;
1807         }
1808 
1809         if (! m_options.notify.empty()
1810             && ! VerifyCommandOptionValue (m_options.notify, notify_action))
1811         {
1812             result.AppendError ("Invalid argument for command option --notify; must be true or false.\n");
1813             result.SetStatus (eReturnStatusFailed);
1814             return false;
1815         }
1816 
1817         if (! m_options.pass.empty()
1818             && ! VerifyCommandOptionValue (m_options.pass, pass_action))
1819         {
1820             result.AppendError ("Invalid argument for command option --pass; must be true or false.\n");
1821             result.SetStatus (eReturnStatusFailed);
1822             return false;
1823         }
1824 
1825         size_t num_args = signal_args.GetArgumentCount();
1826         UnixSignals &signals = process_sp->GetUnixSignals();
1827         int num_signals_set = 0;
1828 
1829         if (num_args > 0)
1830         {
1831             for (size_t i = 0; i < num_args; ++i)
1832             {
1833                 int32_t signo = signals.GetSignalNumberFromName (signal_args.GetArgumentAtIndex (i));
1834                 if (signo != LLDB_INVALID_SIGNAL_NUMBER)
1835                 {
1836                     // Casting the actions as bools here should be okay, because VerifyCommandOptionValue guarantees
1837                     // the value is either 0 or 1.
1838                     if (stop_action != -1)
1839                         signals.SetShouldStop (signo, (bool) stop_action);
1840                     if (pass_action != -1)
1841                     {
1842                         bool suppress = ! ((bool) pass_action);
1843                         signals.SetShouldSuppress (signo, suppress);
1844                     }
1845                     if (notify_action != -1)
1846                         signals.SetShouldNotify (signo, (bool) notify_action);
1847                     ++num_signals_set;
1848                 }
1849                 else
1850                 {
1851                     result.AppendErrorWithFormat ("Invalid signal name '%s'\n", signal_args.GetArgumentAtIndex (i));
1852                 }
1853             }
1854         }
1855         else
1856         {
1857             // No signal specified, if any command options were specified, update ALL signals.
1858             if ((notify_action != -1) || (stop_action != -1) || (pass_action != -1))
1859             {
1860                 if (m_interpreter.Confirm ("Do you really want to update all the signals?", false))
1861                 {
1862                     int32_t signo = signals.GetFirstSignalNumber();
1863                     while (signo != LLDB_INVALID_SIGNAL_NUMBER)
1864                     {
1865                         if (notify_action != -1)
1866                             signals.SetShouldNotify (signo, (bool) notify_action);
1867                         if (stop_action != -1)
1868                             signals.SetShouldStop (signo, (bool) stop_action);
1869                         if (pass_action != -1)
1870                         {
1871                             bool suppress = ! ((bool) pass_action);
1872                             signals.SetShouldSuppress (signo, suppress);
1873                         }
1874                         signo = signals.GetNextSignalNumber (signo);
1875                     }
1876                 }
1877             }
1878         }
1879 
1880         PrintSignalInformation (result.GetOutputStream(), signal_args, num_signals_set, signals);
1881 
1882         if (num_signals_set > 0)
1883             result.SetStatus (eReturnStatusSuccessFinishNoResult);
1884         else
1885             result.SetStatus (eReturnStatusFailed);
1886 
1887         return result.Succeeded();
1888     }
1889 
1890     CommandOptions m_options;
1891 };
1892 
1893 OptionDefinition
1894 CommandObjectProcessHandle::CommandOptions::g_option_table[] =
1895 {
1896 { LLDB_OPT_SET_1, false, "stop",   's', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Whether or not the process should be stopped if the signal is received." },
1897 { LLDB_OPT_SET_1, false, "notify", 'n', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Whether or not the debugger should notify the user if the signal is received." },
1898 { LLDB_OPT_SET_1, false, "pass",  'p', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Whether or not the signal should be passed to the process." },
1899 { 0, false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
1900 };
1901 
1902 //-------------------------------------------------------------------------
1903 // CommandObjectMultiwordProcess
1904 //-------------------------------------------------------------------------
1905 
1906 CommandObjectMultiwordProcess::CommandObjectMultiwordProcess (CommandInterpreter &interpreter) :
1907     CommandObjectMultiword (interpreter,
1908                             "process",
1909                             "A set of commands for operating on a process.",
1910                             "process <subcommand> [<subcommand-options>]")
1911 {
1912     LoadSubCommand ("attach",      CommandObjectSP (new CommandObjectProcessAttach    (interpreter)));
1913     LoadSubCommand ("launch",      CommandObjectSP (new CommandObjectProcessLaunch    (interpreter)));
1914     LoadSubCommand ("continue",    CommandObjectSP (new CommandObjectProcessContinue  (interpreter)));
1915     LoadSubCommand ("connect",     CommandObjectSP (new CommandObjectProcessConnect   (interpreter)));
1916     LoadSubCommand ("detach",      CommandObjectSP (new CommandObjectProcessDetach    (interpreter)));
1917     LoadSubCommand ("load",        CommandObjectSP (new CommandObjectProcessLoad      (interpreter)));
1918     LoadSubCommand ("unload",      CommandObjectSP (new CommandObjectProcessUnload    (interpreter)));
1919     LoadSubCommand ("signal",      CommandObjectSP (new CommandObjectProcessSignal    (interpreter)));
1920     LoadSubCommand ("handle",      CommandObjectSP (new CommandObjectProcessHandle    (interpreter)));
1921     LoadSubCommand ("status",      CommandObjectSP (new CommandObjectProcessStatus    (interpreter)));
1922     LoadSubCommand ("interrupt",   CommandObjectSP (new CommandObjectProcessInterrupt (interpreter)));
1923     LoadSubCommand ("kill",        CommandObjectSP (new CommandObjectProcessKill      (interpreter)));
1924     LoadSubCommand ("plugin",      CommandObjectSP (new CommandObjectProcessPlugin    (interpreter)));
1925     LoadSubCommand ("save-core",   CommandObjectSP (new CommandObjectProcessSaveCore  (interpreter)));
1926 }
1927 
1928 CommandObjectMultiwordProcess::~CommandObjectMultiwordProcess ()
1929 {
1930 }
1931 
1932