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