1 //===-- CommandObjectTarget.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 "CommandObjectTarget.h"
11 
12 // C Includes
13 #include <errno.h>
14 
15 // C++ Includes
16 // Other libraries and framework includes
17 // Project includes
18 #include "lldb/Interpreter/Args.h"
19 #include "lldb/Core/Debugger.h"
20 #include "lldb/Core/InputReader.h"
21 #include "lldb/Core/Section.h"
22 #include "lldb/Core/State.h"
23 #include "lldb/Core/Timer.h"
24 #include "lldb/Core/ValueObjectVariable.h"
25 #include "lldb/Interpreter/CommandInterpreter.h"
26 #include "lldb/Interpreter/CommandReturnObject.h"
27 #include "lldb/Interpreter/Options.h"
28 #include "lldb/Interpreter/OptionGroupArchitecture.h"
29 #include "lldb/Interpreter/OptionGroupBoolean.h"
30 #include "lldb/Interpreter/OptionGroupFile.h"
31 #include "lldb/Interpreter/OptionGroupFormat.h"
32 #include "lldb/Interpreter/OptionGroupVariable.h"
33 #include "lldb/Interpreter/OptionGroupPlatform.h"
34 #include "lldb/Interpreter/OptionGroupUInt64.h"
35 #include "lldb/Interpreter/OptionGroupUUID.h"
36 #include "lldb/Interpreter/OptionGroupValueObjectDisplay.h"
37 #include "lldb/Symbol/LineTable.h"
38 #include "lldb/Symbol/ObjectFile.h"
39 #include "lldb/Symbol/SymbolFile.h"
40 #include "lldb/Symbol/SymbolVendor.h"
41 #include "lldb/Symbol/VariableList.h"
42 #include "lldb/Target/Process.h"
43 #include "lldb/Target/StackFrame.h"
44 #include "lldb/Target/Thread.h"
45 #include "lldb/Target/ThreadSpec.h"
46 
47 using namespace lldb;
48 using namespace lldb_private;
49 
50 
51 
52 static void
53 DumpTargetInfo (uint32_t target_idx, Target *target, const char *prefix_cstr, bool show_stopped_process_status, Stream &strm)
54 {
55     const ArchSpec &target_arch = target->GetArchitecture();
56 
57     Module *exe_module = target->GetExecutableModulePointer();
58     char exe_path[PATH_MAX];
59     bool exe_valid = false;
60     if (exe_module)
61         exe_valid = exe_module->GetFileSpec().GetPath (exe_path, sizeof(exe_path));
62 
63     if (!exe_valid)
64         ::strcpy (exe_path, "<none>");
65 
66     strm.Printf ("%starget #%u: %s", prefix_cstr ? prefix_cstr : "", target_idx, exe_path);
67 
68     uint32_t properties = 0;
69     if (target_arch.IsValid())
70     {
71         strm.Printf ("%sarch=%s", properties++ > 0 ? ", " : " ( ", target_arch.GetTriple().str().c_str());
72         properties++;
73     }
74     PlatformSP platform_sp (target->GetPlatform());
75     if (platform_sp)
76         strm.Printf ("%splatform=%s", properties++ > 0 ? ", " : " ( ", platform_sp->GetName());
77 
78     ProcessSP process_sp (target->GetProcessSP());
79     bool show_process_status = false;
80     if (process_sp)
81     {
82         lldb::pid_t pid = process_sp->GetID();
83         StateType state = process_sp->GetState();
84         if (show_stopped_process_status)
85             show_process_status = StateIsStoppedState(state, true);
86         const char *state_cstr = StateAsCString (state);
87         if (pid != LLDB_INVALID_PROCESS_ID)
88             strm.Printf ("%spid=%llu", properties++ > 0 ? ", " : " ( ", pid);
89         strm.Printf ("%sstate=%s", properties++ > 0 ? ", " : " ( ", state_cstr);
90     }
91     if (properties > 0)
92         strm.PutCString (" )\n");
93     else
94         strm.EOL();
95     if (show_process_status)
96     {
97         const bool only_threads_with_stop_reason = true;
98         const uint32_t start_frame = 0;
99         const uint32_t num_frames = 1;
100         const uint32_t num_frames_with_source = 1;
101         process_sp->GetStatus (strm);
102         process_sp->GetThreadStatus (strm,
103                                      only_threads_with_stop_reason,
104                                      start_frame,
105                                      num_frames,
106                                      num_frames_with_source);
107 
108     }
109 }
110 
111 static uint32_t
112 DumpTargetList (TargetList &target_list, bool show_stopped_process_status, Stream &strm)
113 {
114     const uint32_t num_targets = target_list.GetNumTargets();
115     if (num_targets)
116     {
117         TargetSP selected_target_sp (target_list.GetSelectedTarget());
118         strm.PutCString ("Current targets:\n");
119         for (uint32_t i=0; i<num_targets; ++i)
120         {
121             TargetSP target_sp (target_list.GetTargetAtIndex (i));
122             if (target_sp)
123             {
124                 bool is_selected = target_sp.get() == selected_target_sp.get();
125                 DumpTargetInfo (i,
126                                 target_sp.get(),
127                                 is_selected ? "* " : "  ",
128                                 show_stopped_process_status,
129                                 strm);
130             }
131         }
132     }
133     return num_targets;
134 }
135 #pragma mark CommandObjectTargetCreate
136 
137 //-------------------------------------------------------------------------
138 // "target create"
139 //-------------------------------------------------------------------------
140 
141 class CommandObjectTargetCreate : public CommandObject
142 {
143 public:
144     CommandObjectTargetCreate(CommandInterpreter &interpreter) :
145         CommandObject (interpreter,
146                        "target create",
147                        "Create a target using the argument as the main executable.",
148                        NULL),
149         m_option_group (interpreter),
150         m_arch_option (),
151         m_platform_options(true), // Do include the "--platform" option in the platform settings by passing true
152         m_core_file (LLDB_OPT_SET_1, false, "core-file", 'c', 0, eArgTypePath, "Fullpath to a core file to use for this target.")
153     {
154         CommandArgumentEntry arg;
155         CommandArgumentData file_arg;
156 
157         // Define the first (and only) variant of this arg.
158             file_arg.arg_type = eArgTypeFilename;
159         file_arg.arg_repetition = eArgRepeatPlain;
160 
161         // There is only one variant this argument could be; put it into the argument entry.
162         arg.push_back (file_arg);
163 
164         // Push the data for the first argument into the m_arguments vector.
165         m_arguments.push_back (arg);
166 
167         m_option_group.Append (&m_arch_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
168         m_option_group.Append (&m_platform_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
169         m_option_group.Append (&m_core_file, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
170         m_option_group.Finalize();
171     }
172 
173     ~CommandObjectTargetCreate ()
174     {
175     }
176 
177     Options *
178     GetOptions ()
179     {
180         return &m_option_group;
181     }
182 
183     bool
184     Execute (Args& command, CommandReturnObject &result)
185     {
186         const int argc = command.GetArgumentCount();
187         FileSpec core_file (m_core_file.GetOptionValue().GetCurrentValue());
188 
189         if (argc == 1 || core_file)
190         {
191             const char *file_path = command.GetArgumentAtIndex(0);
192             Timer scoped_timer(__PRETTY_FUNCTION__, "(lldb) target create '%s'", file_path);
193             FileSpec file_spec;
194 
195             if (file_path)
196                 file_spec.SetFile (file_path, true);
197 
198             TargetSP target_sp;
199             Debugger &debugger = m_interpreter.GetDebugger();
200             const char *arch_cstr = m_arch_option.GetArchitectureName();
201             const bool get_dependent_files = true;
202             Error error (debugger.GetTargetList().CreateTarget (debugger,
203                                                                 file_spec,
204                                                                 arch_cstr,
205                                                                 get_dependent_files,
206                                                                 &m_platform_options,
207                                                                 target_sp));
208 
209             if (target_sp)
210             {
211                 debugger.GetTargetList().SetSelectedTarget(target_sp.get());
212                 if (core_file)
213                 {
214                     char core_path[PATH_MAX];
215                     core_file.GetPath(core_path, sizeof(core_path));
216                     if (core_file.Exists())
217                     {
218                         FileSpec core_file_dir;
219                         core_file_dir.GetDirectory() = core_file.GetDirectory();
220                         target_sp->GetExecutableSearchPaths ().Append (core_file_dir);
221 
222                         ProcessSP process_sp (target_sp->CreateProcess (m_interpreter.GetDebugger().GetListener(), NULL, &core_file));
223 
224                         if (process_sp)
225                         {
226                             // Seems wierd that we Launch a core file, but that is
227                             // what we do!
228                             error = process_sp->LoadCore();
229 
230                             if (error.Fail())
231                             {
232                                 result.AppendError(error.AsCString("can't find plug-in for core file"));
233                                 result.SetStatus (eReturnStatusFailed);
234                                 return false;
235                             }
236                             else
237                             {
238                                 result.AppendMessageWithFormat ("Core file '%s' (%s) was loaded.\n", core_path, target_sp->GetArchitecture().GetArchitectureName());
239                                 result.SetStatus (eReturnStatusSuccessFinishNoResult);
240                             }
241                         }
242                         else
243                         {
244                             result.AppendErrorWithFormat ("Unable to find process plug-in for core file '%s'\n", core_path);
245                             result.SetStatus (eReturnStatusFailed);
246                         }
247                     }
248                     else
249                     {
250                         result.AppendErrorWithFormat ("Core file '%s' does not exist\n", core_path);
251                         result.SetStatus (eReturnStatusFailed);
252                     }
253                 }
254                 else
255                 {
256                     result.AppendMessageWithFormat ("Current executable set to '%s' (%s).\n", file_path, target_sp->GetArchitecture().GetArchitectureName());
257                     result.SetStatus (eReturnStatusSuccessFinishNoResult);
258                 }
259             }
260             else
261             {
262                 result.AppendError(error.AsCString());
263                 result.SetStatus (eReturnStatusFailed);
264             }
265         }
266         else
267         {
268             result.AppendErrorWithFormat("'%s' takes exactly one executable path argument, or use the --core-file option.\n", m_cmd_name.c_str());
269             result.SetStatus (eReturnStatusFailed);
270         }
271         return result.Succeeded();
272 
273     }
274 
275     int
276     HandleArgumentCompletion (Args &input,
277                               int &cursor_index,
278                               int &cursor_char_position,
279                               OptionElementVector &opt_element_vector,
280                               int match_start_point,
281                               int max_return_elements,
282                               bool &word_complete,
283                               StringList &matches)
284     {
285         std::string completion_str (input.GetArgumentAtIndex(cursor_index));
286         completion_str.erase (cursor_char_position);
287 
288         CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
289                                                              CommandCompletions::eDiskFileCompletion,
290                                                              completion_str.c_str(),
291                                                              match_start_point,
292                                                              max_return_elements,
293                                                              NULL,
294                                                              word_complete,
295                                                              matches);
296         return matches.GetSize();
297     }
298 private:
299     OptionGroupOptions m_option_group;
300     OptionGroupArchitecture m_arch_option;
301     OptionGroupPlatform m_platform_options;
302     OptionGroupFile m_core_file;
303 
304 };
305 
306 #pragma mark CommandObjectTargetList
307 
308 //----------------------------------------------------------------------
309 // "target list"
310 //----------------------------------------------------------------------
311 
312 class CommandObjectTargetList : public CommandObject
313 {
314 public:
315     CommandObjectTargetList (CommandInterpreter &interpreter) :
316         CommandObject (interpreter,
317                        "target list",
318                        "List all current targets in the current debug session.",
319                        NULL,
320                        0)
321     {
322     }
323 
324     virtual
325     ~CommandObjectTargetList ()
326     {
327     }
328 
329     virtual bool
330     Execute (Args& args, CommandReturnObject &result)
331     {
332         if (args.GetArgumentCount() == 0)
333         {
334             Stream &strm = result.GetOutputStream();
335 
336             bool show_stopped_process_status = false;
337             if (DumpTargetList (m_interpreter.GetDebugger().GetTargetList(), show_stopped_process_status, strm) == 0)
338             {
339                 strm.PutCString ("No targets.\n");
340             }
341             result.SetStatus (eReturnStatusSuccessFinishResult);
342         }
343         else
344         {
345             result.AppendError ("the 'target list' command takes no arguments\n");
346             result.SetStatus (eReturnStatusFailed);
347         }
348         return result.Succeeded();
349     }
350 };
351 
352 
353 #pragma mark CommandObjectTargetSelect
354 
355 //----------------------------------------------------------------------
356 // "target select"
357 //----------------------------------------------------------------------
358 
359 class CommandObjectTargetSelect : public CommandObject
360 {
361 public:
362     CommandObjectTargetSelect (CommandInterpreter &interpreter) :
363         CommandObject (interpreter,
364                        "target select",
365                        "Select a target as the current target by target index.",
366                        NULL,
367                        0)
368     {
369     }
370 
371     virtual
372     ~CommandObjectTargetSelect ()
373     {
374     }
375 
376     virtual bool
377     Execute (Args& args, CommandReturnObject &result)
378     {
379         if (args.GetArgumentCount() == 1)
380         {
381             bool success = false;
382             const char *target_idx_arg = args.GetArgumentAtIndex(0);
383             uint32_t target_idx = Args::StringToUInt32 (target_idx_arg, UINT32_MAX, 0, &success);
384             if (success)
385             {
386                 TargetList &target_list = m_interpreter.GetDebugger().GetTargetList();
387                 const uint32_t num_targets = target_list.GetNumTargets();
388                 if (target_idx < num_targets)
389                 {
390                     TargetSP target_sp (target_list.GetTargetAtIndex (target_idx));
391                     if (target_sp)
392                     {
393                         Stream &strm = result.GetOutputStream();
394                         target_list.SetSelectedTarget (target_sp.get());
395                         bool show_stopped_process_status = false;
396                         DumpTargetList (target_list, show_stopped_process_status, strm);
397                         result.SetStatus (eReturnStatusSuccessFinishResult);
398                     }
399                     else
400                     {
401                         result.AppendErrorWithFormat ("target #%u is NULL in target list\n", target_idx);
402                         result.SetStatus (eReturnStatusFailed);
403                     }
404                 }
405                 else
406                 {
407                     result.AppendErrorWithFormat ("index %u is out of range, valid target indexes are 0 - %u\n",
408                                                   target_idx,
409                                                   num_targets - 1);
410                     result.SetStatus (eReturnStatusFailed);
411                 }
412             }
413             else
414             {
415                 result.AppendErrorWithFormat("invalid index string value '%s'\n", target_idx_arg);
416                 result.SetStatus (eReturnStatusFailed);
417             }
418         }
419         else
420         {
421             result.AppendError ("'target select' takes a single argument: a target index\n");
422             result.SetStatus (eReturnStatusFailed);
423         }
424         return result.Succeeded();
425     }
426 };
427 
428 #pragma mark CommandObjectTargetSelect
429 
430 //----------------------------------------------------------------------
431 // "target delete"
432 //----------------------------------------------------------------------
433 
434 class CommandObjectTargetDelete : public CommandObject
435 {
436 public:
437     CommandObjectTargetDelete (CommandInterpreter &interpreter) :
438         CommandObject (interpreter,
439                        "target delete",
440                        "Delete one or more targets by target index.",
441                        NULL,
442                        0),
443         m_option_group (interpreter),
444         m_cleanup_option (LLDB_OPT_SET_1, false, "clean", 'c', 0, eArgTypeNone, "Perform extra cleanup to minimize memory consumption after deleting the target.", false)
445     {
446         m_option_group.Append (&m_cleanup_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
447         m_option_group.Finalize();
448     }
449 
450     virtual
451     ~CommandObjectTargetDelete ()
452     {
453     }
454 
455     virtual bool
456     Execute (Args& args, CommandReturnObject &result)
457     {
458         const size_t argc = args.GetArgumentCount();
459         std::vector<TargetSP> delete_target_list;
460         TargetList &target_list = m_interpreter.GetDebugger().GetTargetList();
461         bool success = true;
462         TargetSP target_sp;
463         if (argc > 0)
464         {
465             const uint32_t num_targets = target_list.GetNumTargets();
466             for (uint32_t arg_idx = 0; success && arg_idx < argc; ++arg_idx)
467             {
468                 const char *target_idx_arg = args.GetArgumentAtIndex(arg_idx);
469                 uint32_t target_idx = Args::StringToUInt32 (target_idx_arg, UINT32_MAX, 0, &success);
470                 if (success)
471                 {
472                     if (target_idx < num_targets)
473                     {
474                         target_sp = target_list.GetTargetAtIndex (target_idx);
475                         if (target_sp)
476                         {
477                             delete_target_list.push_back (target_sp);
478                             continue;
479                         }
480                     }
481                     result.AppendErrorWithFormat ("target index %u is out of range, valid target indexes are 0 - %u\n",
482                                                   target_idx,
483                                                   num_targets - 1);
484                     result.SetStatus (eReturnStatusFailed);
485                     success = false;
486                 }
487                 else
488                 {
489                     result.AppendErrorWithFormat("invalid target index '%s'\n", target_idx_arg);
490                     result.SetStatus (eReturnStatusFailed);
491                     success = false;
492                 }
493             }
494 
495         }
496         else
497         {
498             target_sp = target_list.GetSelectedTarget();
499             if (target_sp)
500             {
501                 delete_target_list.push_back (target_sp);
502             }
503             else
504             {
505                 result.AppendErrorWithFormat("no target is currently selected\n");
506                 result.SetStatus (eReturnStatusFailed);
507                 success = false;
508             }
509         }
510         if (success)
511         {
512             const size_t num_targets_to_delete = delete_target_list.size();
513             for (size_t idx = 0; idx < num_targets_to_delete; ++idx)
514             {
515                 target_sp = delete_target_list[idx];
516                 target_list.DeleteTarget(target_sp);
517                 target_sp->Destroy();
518             }
519             // If "--clean" was specified, prune any orphaned shared modules from
520             // the global shared module list
521             if (m_cleanup_option.GetOptionValue ())
522             {
523                 ModuleList::RemoveOrphanSharedModules();
524             }
525             result.GetOutputStream().Printf("%u targets deleted.\n", (uint32_t)num_targets_to_delete);
526             result.SetStatus(eReturnStatusSuccessFinishResult);
527         }
528 
529         return result.Succeeded();
530     }
531 
532     Options *
533     GetOptions ()
534     {
535         return &m_option_group;
536     }
537 
538 protected:
539     OptionGroupOptions m_option_group;
540     OptionGroupBoolean m_cleanup_option;
541 };
542 
543 
544 #pragma mark CommandObjectTargetVariable
545 
546 //----------------------------------------------------------------------
547 // "target variable"
548 //----------------------------------------------------------------------
549 
550 class CommandObjectTargetVariable : public CommandObject
551 {
552 public:
553     CommandObjectTargetVariable (CommandInterpreter &interpreter) :
554         CommandObject (interpreter,
555                        "target variable",
556                        "Read global variable(s) prior to running your binary.",
557                        NULL,
558                        0),
559         m_option_group (interpreter),
560         m_option_variable (false), // Don't include frame options
561         m_option_format (eFormatDefault),
562         m_option_compile_units    (LLDB_OPT_SET_1, false, "file", 'f', 0, eArgTypePath, "A basename or fullpath to a file that contains global variables. This option can be specified multiple times."),
563         m_option_shared_libraries (LLDB_OPT_SET_1, false, "shlib",'s', 0, eArgTypePath, "A basename or fullpath to a shared library to use in the search for global variables. This option can be specified multiple times."),
564         m_varobj_options()
565     {
566         CommandArgumentEntry arg;
567         CommandArgumentData var_name_arg;
568 
569         // Define the first (and only) variant of this arg.
570         var_name_arg.arg_type = eArgTypeVarName;
571         var_name_arg.arg_repetition = eArgRepeatPlus;
572 
573         // There is only one variant this argument could be; put it into the argument entry.
574         arg.push_back (var_name_arg);
575 
576         // Push the data for the first argument into the m_arguments vector.
577         m_arguments.push_back (arg);
578 
579         m_option_group.Append (&m_varobj_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
580         m_option_group.Append (&m_option_variable, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
581         m_option_group.Append (&m_option_format, OptionGroupFormat::OPTION_GROUP_FORMAT | OptionGroupFormat::OPTION_GROUP_GDB_FMT, LLDB_OPT_SET_1);
582         m_option_group.Append (&m_option_compile_units, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
583         m_option_group.Append (&m_option_shared_libraries, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
584         m_option_group.Finalize();
585     }
586 
587     virtual
588     ~CommandObjectTargetVariable ()
589     {
590     }
591 
592     void
593     DumpValueObject (Stream &s, VariableSP &var_sp, ValueObjectSP &valobj_sp, const char *root_name)
594     {
595         ValueObject::DumpValueObjectOptions options;
596 
597         options.SetMaximumPointerDepth(m_varobj_options.ptr_depth)
598                .SetMaximumDepth(m_varobj_options.max_depth)
599                .SetShowTypes(m_varobj_options.show_types)
600                .SetShowLocation(m_varobj_options.show_location)
601                .SetUseObjectiveC(m_varobj_options.use_objc)
602                .SetUseDynamicType(m_varobj_options.use_dynamic)
603                .SetUseSyntheticValue((lldb::SyntheticValueType)m_varobj_options.use_synth)
604                .SetFlatOutput(m_varobj_options.flat_output)
605                .SetOmitSummaryDepth(m_varobj_options.no_summary_depth)
606                .SetIgnoreCap(m_varobj_options.ignore_cap);
607 
608         switch (var_sp->GetScope())
609         {
610             case eValueTypeVariableGlobal:
611                 if (m_option_variable.show_scope)
612                     s.PutCString("GLOBAL: ");
613                 break;
614 
615             case eValueTypeVariableStatic:
616                 if (m_option_variable.show_scope)
617                     s.PutCString("STATIC: ");
618                 break;
619 
620             case eValueTypeVariableArgument:
621                 if (m_option_variable.show_scope)
622                     s.PutCString("   ARG: ");
623                 break;
624 
625             case eValueTypeVariableLocal:
626                 if (m_option_variable.show_scope)
627                     s.PutCString(" LOCAL: ");
628                 break;
629 
630             default:
631                 break;
632         }
633 
634         if (m_option_variable.show_decl)
635         {
636             bool show_fullpaths = false;
637             bool show_module = true;
638             if (var_sp->DumpDeclaration(&s, show_fullpaths, show_module))
639                 s.PutCString (": ");
640         }
641 
642         const Format format = m_option_format.GetFormat();
643         if (format != eFormatDefault)
644             options.SetFormat(format);
645 
646         options.SetRootValueObjectName(root_name);
647 
648         ValueObject::DumpValueObject (s,
649                                       valobj_sp.get(),
650                                       options);
651 
652     }
653 
654 
655     static uint32_t GetVariableCallback (void *baton,
656                                          const char *name,
657                                          VariableList &variable_list)
658     {
659         Target *target = static_cast<Target *>(baton);
660         if (target)
661         {
662             return target->GetImages().FindGlobalVariables (ConstString(name),
663                                                             true,
664                                                             UINT32_MAX,
665                                                             variable_list);
666         }
667         return 0;
668     }
669 
670 
671 
672     virtual bool
673     Execute (Args& args, CommandReturnObject &result)
674     {
675         ExecutionContext exe_ctx (m_interpreter.GetExecutionContext());
676         Target *target = exe_ctx.GetTargetPtr();
677         if (target)
678         {
679             const size_t argc = args.GetArgumentCount();
680             Stream &s = result.GetOutputStream();
681             if (argc > 0)
682             {
683 
684                 for (size_t idx = 0; idx < argc; ++idx)
685                 {
686                     VariableList variable_list;
687                     ValueObjectList valobj_list;
688 
689                     const char *arg = args.GetArgumentAtIndex(idx);
690                     uint32_t matches = 0;
691                     bool use_var_name = false;
692                     if (m_option_variable.use_regex)
693                     {
694                         RegularExpression regex(arg);
695                         if (!regex.IsValid ())
696                         {
697                             result.GetErrorStream().Printf ("error: invalid regular expression: '%s'\n", arg);
698                             result.SetStatus (eReturnStatusFailed);
699                             return false;
700                         }
701                         use_var_name = true;
702                         matches = target->GetImages().FindGlobalVariables (regex,
703                                                                            true,
704                                                                            UINT32_MAX,
705                                                                            variable_list);
706                     }
707                     else
708                     {
709                         Error error (Variable::GetValuesForVariableExpressionPath (arg,
710                                                                                    exe_ctx.GetBestExecutionContextScope(),
711                                                                                    GetVariableCallback,
712                                                                                    target,
713                                                                                    variable_list,
714                                                                                    valobj_list));
715                         matches = variable_list.GetSize();
716                     }
717 
718                     if (matches == 0)
719                     {
720                         result.GetErrorStream().Printf ("error: can't find global variable '%s'\n", arg);
721                         result.SetStatus (eReturnStatusFailed);
722                         return false;
723                     }
724                     else
725                     {
726                         for (uint32_t global_idx=0; global_idx<matches; ++global_idx)
727                         {
728                             VariableSP var_sp (variable_list.GetVariableAtIndex(global_idx));
729                             if (var_sp)
730                             {
731                                 ValueObjectSP valobj_sp (valobj_list.GetValueObjectAtIndex(global_idx));
732                                 if (!valobj_sp)
733                                     valobj_sp = ValueObjectVariable::Create (exe_ctx.GetBestExecutionContextScope(), var_sp);
734 
735                                 if (valobj_sp)
736                                     DumpValueObject (s, var_sp, valobj_sp, use_var_name ? var_sp->GetName().GetCString() : arg);
737                             }
738                         }
739                     }
740                 }
741             }
742             else
743             {
744                 bool success = false;
745                 StackFrame *frame = exe_ctx.GetFramePtr();
746                 CompileUnit *comp_unit = NULL;
747                 if (frame)
748                 {
749                     comp_unit = frame->GetSymbolContext (eSymbolContextCompUnit).comp_unit;
750                     if (comp_unit)
751                     {
752                         const bool can_create = true;
753                         VariableListSP comp_unit_varlist_sp (comp_unit->GetVariableList(can_create));
754                         if (comp_unit_varlist_sp)
755                         {
756                             size_t count = comp_unit_varlist_sp->GetSize();
757                             if (count > 0)
758                             {
759                                 s.Printf ("Global variables for %s/%s:\n",
760                                           comp_unit->GetDirectory().GetCString(),
761                                           comp_unit->GetFilename().GetCString());
762 
763                                 success = true;
764                                 for (uint32_t i=0; i<count; ++i)
765                                 {
766                                     VariableSP var_sp (comp_unit_varlist_sp->GetVariableAtIndex(i));
767                                     if (var_sp)
768                                     {
769                                         ValueObjectSP valobj_sp (ValueObjectVariable::Create (exe_ctx.GetBestExecutionContextScope(), var_sp));
770 
771                                         if (valobj_sp)
772                                             DumpValueObject (s, var_sp, valobj_sp, var_sp->GetName().GetCString());
773                                     }
774                                 }
775                             }
776                         }
777                     }
778                 }
779                 if (!success)
780                 {
781                     if (frame)
782                     {
783                         if (comp_unit)
784                             result.AppendErrorWithFormat ("no global variables in current compile unit: %s/%s\n",
785                                                           comp_unit->GetDirectory().GetCString(),
786                                                           comp_unit->GetFilename().GetCString());
787                         else
788                             result.AppendError ("no debug information for frame %u\n", frame->GetFrameIndex());
789                     }
790                     else
791                         result.AppendError ("'target variable' takes one or more global variable names as arguments\n");
792                     result.SetStatus (eReturnStatusFailed);
793                 }
794             }
795         }
796         else
797         {
798             result.AppendError ("invalid target, create a debug target using the 'target create' command");
799             result.SetStatus (eReturnStatusFailed);
800             return false;
801         }
802 
803         if (m_interpreter.TruncationWarningNecessary())
804         {
805             result.GetOutputStream().Printf(m_interpreter.TruncationWarningText(),
806                                             m_cmd_name.c_str());
807             m_interpreter.TruncationWarningGiven();
808         }
809 
810         return result.Succeeded();
811     }
812 
813     Options *
814     GetOptions ()
815     {
816         return &m_option_group;
817     }
818 
819 protected:
820     OptionGroupOptions m_option_group;
821     OptionGroupVariable m_option_variable;
822     OptionGroupFormat m_option_format;
823     OptionGroupFileList m_option_compile_units;
824     OptionGroupFileList m_option_shared_libraries;
825     OptionGroupValueObjectDisplay m_varobj_options;
826 
827 };
828 
829 
830 #pragma mark CommandObjectTargetModulesSearchPathsAdd
831 
832 class CommandObjectTargetModulesSearchPathsAdd : public CommandObject
833 {
834 public:
835 
836     CommandObjectTargetModulesSearchPathsAdd (CommandInterpreter &interpreter) :
837         CommandObject (interpreter,
838                        "target modules search-paths add",
839                        "Add new image search paths substitution pairs to the current target.",
840                        NULL)
841     {
842         CommandArgumentEntry arg;
843         CommandArgumentData old_prefix_arg;
844         CommandArgumentData new_prefix_arg;
845 
846         // Define the first variant of this arg pair.
847         old_prefix_arg.arg_type = eArgTypeOldPathPrefix;
848         old_prefix_arg.arg_repetition = eArgRepeatPairPlus;
849 
850         // Define the first variant of this arg pair.
851         new_prefix_arg.arg_type = eArgTypeNewPathPrefix;
852         new_prefix_arg.arg_repetition = eArgRepeatPairPlus;
853 
854         // There are two required arguments that must always occur together, i.e. an argument "pair".  Because they
855         // must always occur together, they are treated as two variants of one argument rather than two independent
856         // arguments.  Push them both into the first argument position for m_arguments...
857 
858         arg.push_back (old_prefix_arg);
859         arg.push_back (new_prefix_arg);
860 
861         m_arguments.push_back (arg);
862     }
863 
864     ~CommandObjectTargetModulesSearchPathsAdd ()
865     {
866     }
867 
868     bool
869     Execute (Args& command,
870              CommandReturnObject &result)
871     {
872         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
873         if (target)
874         {
875             uint32_t argc = command.GetArgumentCount();
876             if (argc & 1)
877             {
878                 result.AppendError ("add requires an even number of arguments\n");
879                 result.SetStatus (eReturnStatusFailed);
880             }
881             else
882             {
883                 for (uint32_t i=0; i<argc; i+=2)
884                 {
885                     const char *from = command.GetArgumentAtIndex(i);
886                     const char *to = command.GetArgumentAtIndex(i+1);
887 
888                     if (from[0] && to[0])
889                     {
890                         bool last_pair = ((argc - i) == 2);
891                         target->GetImageSearchPathList().Append (ConstString(from),
892                                                                  ConstString(to),
893                                                                  last_pair); // Notify if this is the last pair
894                         result.SetStatus (eReturnStatusSuccessFinishNoResult);
895                     }
896                     else
897                     {
898                         if (from[0])
899                             result.AppendError ("<path-prefix> can't be empty\n");
900                         else
901                             result.AppendError ("<new-path-prefix> can't be empty\n");
902                         result.SetStatus (eReturnStatusFailed);
903                     }
904                 }
905             }
906         }
907         else
908         {
909             result.AppendError ("invalid target\n");
910             result.SetStatus (eReturnStatusFailed);
911         }
912         return result.Succeeded();
913     }
914 };
915 
916 #pragma mark CommandObjectTargetModulesSearchPathsClear
917 
918 class CommandObjectTargetModulesSearchPathsClear : public CommandObject
919 {
920 public:
921 
922     CommandObjectTargetModulesSearchPathsClear (CommandInterpreter &interpreter) :
923         CommandObject (interpreter,
924                        "target modules search-paths clear",
925                        "Clear all current image search path substitution pairs from the current target.",
926                        "target modules search-paths clear")
927     {
928     }
929 
930     ~CommandObjectTargetModulesSearchPathsClear ()
931     {
932     }
933 
934     bool
935     Execute (Args& command,
936              CommandReturnObject &result)
937     {
938         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
939         if (target)
940         {
941             bool notify = true;
942             target->GetImageSearchPathList().Clear(notify);
943             result.SetStatus (eReturnStatusSuccessFinishNoResult);
944         }
945         else
946         {
947             result.AppendError ("invalid target\n");
948             result.SetStatus (eReturnStatusFailed);
949         }
950         return result.Succeeded();
951     }
952 };
953 
954 #pragma mark CommandObjectTargetModulesSearchPathsInsert
955 
956 class CommandObjectTargetModulesSearchPathsInsert : public CommandObject
957 {
958 public:
959 
960     CommandObjectTargetModulesSearchPathsInsert (CommandInterpreter &interpreter) :
961         CommandObject (interpreter,
962                        "target modules search-paths insert",
963                        "Insert a new image search path substitution pair into the current target at the specified index.",
964                        NULL)
965     {
966         CommandArgumentEntry arg1;
967         CommandArgumentEntry arg2;
968         CommandArgumentData index_arg;
969         CommandArgumentData old_prefix_arg;
970         CommandArgumentData new_prefix_arg;
971 
972         // Define the first and only variant of this arg.
973         index_arg.arg_type = eArgTypeIndex;
974         index_arg.arg_repetition = eArgRepeatPlain;
975 
976         // Put the one and only variant into the first arg for m_arguments:
977         arg1.push_back (index_arg);
978 
979         // Define the first variant of this arg pair.
980         old_prefix_arg.arg_type = eArgTypeOldPathPrefix;
981         old_prefix_arg.arg_repetition = eArgRepeatPairPlus;
982 
983         // Define the first variant of this arg pair.
984         new_prefix_arg.arg_type = eArgTypeNewPathPrefix;
985         new_prefix_arg.arg_repetition = eArgRepeatPairPlus;
986 
987         // There are two required arguments that must always occur together, i.e. an argument "pair".  Because they
988         // must always occur together, they are treated as two variants of one argument rather than two independent
989         // arguments.  Push them both into the same argument position for m_arguments...
990 
991         arg2.push_back (old_prefix_arg);
992         arg2.push_back (new_prefix_arg);
993 
994         // Add arguments to m_arguments.
995         m_arguments.push_back (arg1);
996         m_arguments.push_back (arg2);
997     }
998 
999     ~CommandObjectTargetModulesSearchPathsInsert ()
1000     {
1001     }
1002 
1003     bool
1004     Execute (Args& command,
1005              CommandReturnObject &result)
1006     {
1007         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
1008         if (target)
1009         {
1010             uint32_t argc = command.GetArgumentCount();
1011             // check for at least 3 arguments and an odd nubmer of parameters
1012             if (argc >= 3 && argc & 1)
1013             {
1014                 bool success = false;
1015 
1016                 uint32_t insert_idx = Args::StringToUInt32(command.GetArgumentAtIndex(0), UINT32_MAX, 0, &success);
1017 
1018                 if (!success)
1019                 {
1020                     result.AppendErrorWithFormat("<index> parameter is not an integer: '%s'.\n", command.GetArgumentAtIndex(0));
1021                     result.SetStatus (eReturnStatusFailed);
1022                     return result.Succeeded();
1023                 }
1024 
1025                 // shift off the index
1026                 command.Shift();
1027                 argc = command.GetArgumentCount();
1028 
1029                 for (uint32_t i=0; i<argc; i+=2, ++insert_idx)
1030                 {
1031                     const char *from = command.GetArgumentAtIndex(i);
1032                     const char *to = command.GetArgumentAtIndex(i+1);
1033 
1034                     if (from[0] && to[0])
1035                     {
1036                         bool last_pair = ((argc - i) == 2);
1037                         target->GetImageSearchPathList().Insert (ConstString(from),
1038                                                                  ConstString(to),
1039                                                                  insert_idx,
1040                                                                  last_pair);
1041                         result.SetStatus (eReturnStatusSuccessFinishNoResult);
1042                     }
1043                     else
1044                     {
1045                         if (from[0])
1046                             result.AppendError ("<path-prefix> can't be empty\n");
1047                         else
1048                             result.AppendError ("<new-path-prefix> can't be empty\n");
1049                         result.SetStatus (eReturnStatusFailed);
1050                         return false;
1051                     }
1052                 }
1053             }
1054             else
1055             {
1056                 result.AppendError ("insert requires at least three arguments\n");
1057                 result.SetStatus (eReturnStatusFailed);
1058                 return result.Succeeded();
1059             }
1060 
1061         }
1062         else
1063         {
1064             result.AppendError ("invalid target\n");
1065             result.SetStatus (eReturnStatusFailed);
1066         }
1067         return result.Succeeded();
1068     }
1069 };
1070 
1071 
1072 #pragma mark CommandObjectTargetModulesSearchPathsList
1073 
1074 
1075 class CommandObjectTargetModulesSearchPathsList : public CommandObject
1076 {
1077 public:
1078 
1079     CommandObjectTargetModulesSearchPathsList (CommandInterpreter &interpreter) :
1080         CommandObject (interpreter,
1081                        "target modules search-paths list",
1082                        "List all current image search path substitution pairs in the current target.",
1083                        "target modules search-paths list")
1084     {
1085     }
1086 
1087     ~CommandObjectTargetModulesSearchPathsList ()
1088     {
1089     }
1090 
1091     bool
1092     Execute (Args& command,
1093              CommandReturnObject &result)
1094     {
1095         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
1096         if (target)
1097         {
1098             if (command.GetArgumentCount() != 0)
1099             {
1100                 result.AppendError ("list takes no arguments\n");
1101                 result.SetStatus (eReturnStatusFailed);
1102                 return result.Succeeded();
1103             }
1104 
1105             target->GetImageSearchPathList().Dump(&result.GetOutputStream());
1106             result.SetStatus (eReturnStatusSuccessFinishResult);
1107         }
1108         else
1109         {
1110             result.AppendError ("invalid target\n");
1111             result.SetStatus (eReturnStatusFailed);
1112         }
1113         return result.Succeeded();
1114     }
1115 };
1116 
1117 #pragma mark CommandObjectTargetModulesSearchPathsQuery
1118 
1119 class CommandObjectTargetModulesSearchPathsQuery : public CommandObject
1120 {
1121 public:
1122 
1123     CommandObjectTargetModulesSearchPathsQuery (CommandInterpreter &interpreter) :
1124     CommandObject (interpreter,
1125                    "target modules search-paths query",
1126                    "Transform a path using the first applicable image search path.",
1127                    NULL)
1128     {
1129         CommandArgumentEntry arg;
1130         CommandArgumentData path_arg;
1131 
1132         // Define the first (and only) variant of this arg.
1133         path_arg.arg_type = eArgTypePath;
1134         path_arg.arg_repetition = eArgRepeatPlain;
1135 
1136         // There is only one variant this argument could be; put it into the argument entry.
1137         arg.push_back (path_arg);
1138 
1139         // Push the data for the first argument into the m_arguments vector.
1140         m_arguments.push_back (arg);
1141     }
1142 
1143     ~CommandObjectTargetModulesSearchPathsQuery ()
1144     {
1145     }
1146 
1147     bool
1148     Execute (Args& command,
1149              CommandReturnObject &result)
1150     {
1151         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
1152         if (target)
1153         {
1154             if (command.GetArgumentCount() != 1)
1155             {
1156                 result.AppendError ("query requires one argument\n");
1157                 result.SetStatus (eReturnStatusFailed);
1158                 return result.Succeeded();
1159             }
1160 
1161             ConstString orig(command.GetArgumentAtIndex(0));
1162             ConstString transformed;
1163             if (target->GetImageSearchPathList().RemapPath(orig, transformed))
1164                 result.GetOutputStream().Printf("%s\n", transformed.GetCString());
1165             else
1166                 result.GetOutputStream().Printf("%s\n", orig.GetCString());
1167 
1168             result.SetStatus (eReturnStatusSuccessFinishResult);
1169         }
1170         else
1171         {
1172             result.AppendError ("invalid target\n");
1173             result.SetStatus (eReturnStatusFailed);
1174         }
1175         return result.Succeeded();
1176     }
1177 };
1178 
1179 //----------------------------------------------------------------------
1180 // Static Helper functions
1181 //----------------------------------------------------------------------
1182 static void
1183 DumpModuleArchitecture (Stream &strm, Module *module, bool full_triple, uint32_t width)
1184 {
1185     if (module)
1186     {
1187         const char *arch_cstr;
1188         if (full_triple)
1189             arch_cstr = module->GetArchitecture().GetTriple().str().c_str();
1190         else
1191             arch_cstr = module->GetArchitecture().GetArchitectureName();
1192         if (width)
1193             strm.Printf("%-*s", width, arch_cstr);
1194         else
1195             strm.PutCString(arch_cstr);
1196     }
1197 }
1198 
1199 static void
1200 DumpModuleUUID (Stream &strm, Module *module)
1201 {
1202     if (module->GetUUID().IsValid())
1203         module->GetUUID().Dump (&strm);
1204     else
1205         strm.PutCString("                                    ");
1206 }
1207 
1208 static uint32_t
1209 DumpCompileUnitLineTable
1210 (
1211  CommandInterpreter &interpreter,
1212  Stream &strm,
1213  Module *module,
1214  const FileSpec &file_spec,
1215  bool load_addresses
1216  )
1217 {
1218     uint32_t num_matches = 0;
1219     if (module)
1220     {
1221         SymbolContextList sc_list;
1222         num_matches = module->ResolveSymbolContextsForFileSpec (file_spec,
1223                                                                 0,
1224                                                                 false,
1225                                                                 eSymbolContextCompUnit,
1226                                                                 sc_list);
1227 
1228         for (uint32_t i=0; i<num_matches; ++i)
1229         {
1230             SymbolContext sc;
1231             if (sc_list.GetContextAtIndex(i, sc))
1232             {
1233                 if (i > 0)
1234                     strm << "\n\n";
1235 
1236                 strm << "Line table for " << *static_cast<FileSpec*> (sc.comp_unit) << " in `"
1237                 << module->GetFileSpec().GetFilename() << "\n";
1238                 LineTable *line_table = sc.comp_unit->GetLineTable();
1239                 if (line_table)
1240                     line_table->GetDescription (&strm,
1241                                                 interpreter.GetExecutionContext().GetTargetPtr(),
1242                                                 lldb::eDescriptionLevelBrief);
1243                 else
1244                     strm << "No line table";
1245             }
1246         }
1247     }
1248     return num_matches;
1249 }
1250 
1251 static void
1252 DumpFullpath (Stream &strm, const FileSpec *file_spec_ptr, uint32_t width)
1253 {
1254     if (file_spec_ptr)
1255     {
1256         if (width > 0)
1257         {
1258             char fullpath[PATH_MAX];
1259             if (file_spec_ptr->GetPath(fullpath, sizeof(fullpath)))
1260             {
1261                 strm.Printf("%-*s", width, fullpath);
1262                 return;
1263             }
1264         }
1265         else
1266         {
1267             file_spec_ptr->Dump(&strm);
1268             return;
1269         }
1270     }
1271     // Keep the width spacing correct if things go wrong...
1272     if (width > 0)
1273         strm.Printf("%-*s", width, "");
1274 }
1275 
1276 static void
1277 DumpDirectory (Stream &strm, const FileSpec *file_spec_ptr, uint32_t width)
1278 {
1279     if (file_spec_ptr)
1280     {
1281         if (width > 0)
1282             strm.Printf("%-*s", width, file_spec_ptr->GetDirectory().AsCString(""));
1283         else
1284             file_spec_ptr->GetDirectory().Dump(&strm);
1285         return;
1286     }
1287     // Keep the width spacing correct if things go wrong...
1288     if (width > 0)
1289         strm.Printf("%-*s", width, "");
1290 }
1291 
1292 static void
1293 DumpBasename (Stream &strm, const FileSpec *file_spec_ptr, uint32_t width)
1294 {
1295     if (file_spec_ptr)
1296     {
1297         if (width > 0)
1298             strm.Printf("%-*s", width, file_spec_ptr->GetFilename().AsCString(""));
1299         else
1300             file_spec_ptr->GetFilename().Dump(&strm);
1301         return;
1302     }
1303     // Keep the width spacing correct if things go wrong...
1304     if (width > 0)
1305         strm.Printf("%-*s", width, "");
1306 }
1307 
1308 
1309 static void
1310 DumpModuleSymtab (CommandInterpreter &interpreter, Stream &strm, Module *module, SortOrder sort_order)
1311 {
1312     if (module)
1313     {
1314         ObjectFile *objfile = module->GetObjectFile ();
1315         if (objfile)
1316         {
1317             Symtab *symtab = objfile->GetSymtab();
1318             if (symtab)
1319                 symtab->Dump(&strm, interpreter.GetExecutionContext().GetTargetPtr(), sort_order);
1320         }
1321     }
1322 }
1323 
1324 static void
1325 DumpModuleSections (CommandInterpreter &interpreter, Stream &strm, Module *module)
1326 {
1327     if (module)
1328     {
1329         ObjectFile *objfile = module->GetObjectFile ();
1330         if (objfile)
1331         {
1332             SectionList *section_list = objfile->GetSectionList();
1333             if (section_list)
1334             {
1335                 strm.PutCString ("Sections for '");
1336                 strm << module->GetFileSpec();
1337                 if (module->GetObjectName())
1338                     strm << '(' << module->GetObjectName() << ')';
1339                 strm.Printf ("' (%s):\n", module->GetArchitecture().GetArchitectureName());
1340                 strm.IndentMore();
1341                 section_list->Dump(&strm, interpreter.GetExecutionContext().GetTargetPtr(), true, UINT32_MAX);
1342                 strm.IndentLess();
1343             }
1344         }
1345     }
1346 }
1347 
1348 static bool
1349 DumpModuleSymbolVendor (Stream &strm, Module *module)
1350 {
1351     if (module)
1352     {
1353         SymbolVendor *symbol_vendor = module->GetSymbolVendor(true);
1354         if (symbol_vendor)
1355         {
1356             symbol_vendor->Dump(&strm);
1357             return true;
1358         }
1359     }
1360     return false;
1361 }
1362 
1363 static bool
1364 LookupAddressInModule (CommandInterpreter &interpreter,
1365                        Stream &strm,
1366                        Module *module,
1367                        uint32_t resolve_mask,
1368                        lldb::addr_t raw_addr,
1369                        lldb::addr_t offset,
1370                        bool verbose)
1371 {
1372     if (module)
1373     {
1374         lldb::addr_t addr = raw_addr - offset;
1375         Address so_addr;
1376         SymbolContext sc;
1377         Target *target = interpreter.GetExecutionContext().GetTargetPtr();
1378         if (target && !target->GetSectionLoadList().IsEmpty())
1379         {
1380             if (!target->GetSectionLoadList().ResolveLoadAddress (addr, so_addr))
1381                 return false;
1382             else if (so_addr.GetModule().get() != module)
1383                 return false;
1384         }
1385         else
1386         {
1387             if (!module->ResolveFileAddress (addr, so_addr))
1388                 return false;
1389         }
1390 
1391         ExecutionContextScope *exe_scope = interpreter.GetExecutionContext().GetBestExecutionContextScope();
1392         strm.IndentMore();
1393         strm.Indent ("    Address: ");
1394         so_addr.Dump (&strm, exe_scope, Address::DumpStyleModuleWithFileAddress);
1395         strm.PutCString (" (");
1396         so_addr.Dump (&strm, exe_scope, Address::DumpStyleSectionNameOffset);
1397         strm.PutCString (")\n");
1398         strm.Indent ("    Summary: ");
1399         const uint32_t save_indent = strm.GetIndentLevel ();
1400         strm.SetIndentLevel (save_indent + 13);
1401         so_addr.Dump (&strm, exe_scope, Address::DumpStyleResolvedDescription);
1402         strm.SetIndentLevel (save_indent);
1403         // Print out detailed address information when verbose is enabled
1404         if (verbose)
1405         {
1406             strm.EOL();
1407             so_addr.Dump (&strm, exe_scope, Address::DumpStyleDetailedSymbolContext);
1408         }
1409         strm.IndentLess();
1410         return true;
1411     }
1412 
1413     return false;
1414 }
1415 
1416 static uint32_t
1417 LookupSymbolInModule (CommandInterpreter &interpreter, Stream &strm, Module *module, const char *name, bool name_is_regex)
1418 {
1419     if (module)
1420     {
1421         SymbolContext sc;
1422 
1423         ObjectFile *objfile = module->GetObjectFile ();
1424         if (objfile)
1425         {
1426             Symtab *symtab = objfile->GetSymtab();
1427             if (symtab)
1428             {
1429                 uint32_t i;
1430                 std::vector<uint32_t> match_indexes;
1431                 ConstString symbol_name (name);
1432                 uint32_t num_matches = 0;
1433                 if (name_is_regex)
1434                 {
1435                     RegularExpression name_regexp(name);
1436                     num_matches = symtab->AppendSymbolIndexesMatchingRegExAndType (name_regexp,
1437                                                                                    eSymbolTypeAny,
1438                                                                                    match_indexes);
1439                 }
1440                 else
1441                 {
1442                     num_matches = symtab->AppendSymbolIndexesWithName (symbol_name, match_indexes);
1443                 }
1444 
1445 
1446                 if (num_matches > 0)
1447                 {
1448                     strm.Indent ();
1449                     strm.Printf("%u symbols match %s'%s' in ", num_matches,
1450                                 name_is_regex ? "the regular expression " : "", name);
1451                     DumpFullpath (strm, &module->GetFileSpec(), 0);
1452                     strm.PutCString(":\n");
1453                     strm.IndentMore ();
1454                     Symtab::DumpSymbolHeader (&strm);
1455                     for (i=0; i < num_matches; ++i)
1456                     {
1457                         Symbol *symbol = symtab->SymbolAtIndex(match_indexes[i]);
1458                         strm.Indent ();
1459                         symbol->Dump (&strm, interpreter.GetExecutionContext().GetTargetPtr(), i);
1460                     }
1461                     strm.IndentLess ();
1462                     return num_matches;
1463                 }
1464             }
1465         }
1466     }
1467     return 0;
1468 }
1469 
1470 
1471 static void
1472 DumpSymbolContextList (CommandInterpreter &interpreter, Stream &strm, SymbolContextList &sc_list, bool prepend_addr, bool verbose)
1473 {
1474     strm.IndentMore ();
1475     uint32_t i;
1476     const uint32_t num_matches = sc_list.GetSize();
1477 
1478     for (i=0; i<num_matches; ++i)
1479     {
1480         SymbolContext sc;
1481         if (sc_list.GetContextAtIndex(i, sc))
1482         {
1483             strm.Indent();
1484             ExecutionContextScope *exe_scope = interpreter.GetExecutionContext().GetBestExecutionContextScope ();
1485 
1486             if (prepend_addr)
1487             {
1488                 if (sc.line_entry.range.GetBaseAddress().IsValid())
1489                 {
1490                     sc.line_entry.range.GetBaseAddress().Dump (&strm,
1491                                                                exe_scope,
1492                                                                Address::DumpStyleLoadAddress,
1493                                                                Address::DumpStyleModuleWithFileAddress);
1494                     strm.PutCString(" in ");
1495                 }
1496             }
1497 
1498             AddressRange range;
1499 
1500             sc.GetAddressRange(eSymbolContextEverything,
1501                                0,
1502                                true,
1503                                range);
1504 
1505             sc.DumpStopContext(&strm,
1506                                exe_scope,
1507                                range.GetBaseAddress(),
1508                                true,
1509                                true,
1510                                false);
1511 
1512             strm.EOL();
1513             if (verbose)
1514             {
1515                 if (sc.line_entry.range.GetBaseAddress().IsValid())
1516                 {
1517                     if (sc.line_entry.range.GetBaseAddress().Dump (&strm,
1518                                                                    exe_scope,
1519                                                                    Address::DumpStyleDetailedSymbolContext))
1520                         strm.PutCString("\n\n");
1521                 }
1522                 else if (sc.function->GetAddressRange().GetBaseAddress().IsValid())
1523                 {
1524                     if (sc.function->GetAddressRange().GetBaseAddress().Dump (&strm,
1525                                                                               exe_scope,
1526                                                                               Address::DumpStyleDetailedSymbolContext))
1527                         strm.PutCString("\n\n");
1528                 }
1529             }
1530         }
1531     }
1532     strm.IndentLess ();
1533 }
1534 
1535 static uint32_t
1536 LookupFunctionInModule (CommandInterpreter &interpreter, Stream &strm, Module *module, const char *name, bool name_is_regex, bool include_inlines, bool verbose)
1537 {
1538     if (module && name && name[0])
1539     {
1540         SymbolContextList sc_list;
1541         const bool include_symbols = false;
1542         const bool append = true;
1543         uint32_t num_matches = 0;
1544         if (name_is_regex)
1545         {
1546             RegularExpression function_name_regex (name);
1547             num_matches = module->FindFunctions (function_name_regex,
1548                                                  include_symbols,
1549                                                  include_inlines,
1550                                                  append,
1551                                                  sc_list);
1552         }
1553         else
1554         {
1555             ConstString function_name (name);
1556             num_matches = module->FindFunctions (function_name,
1557                                                  NULL,
1558                                                  eFunctionNameTypeBase | eFunctionNameTypeFull | eFunctionNameTypeMethod | eFunctionNameTypeSelector,
1559                                                  include_symbols,
1560                                                  include_inlines,
1561                                                  append,
1562                                                  sc_list);
1563         }
1564 
1565         if (num_matches)
1566         {
1567             strm.Indent ();
1568             strm.Printf("%u match%s found in ", num_matches, num_matches > 1 ? "es" : "");
1569             DumpFullpath (strm, &module->GetFileSpec(), 0);
1570             strm.PutCString(":\n");
1571             DumpSymbolContextList (interpreter, strm, sc_list, true, verbose);
1572         }
1573         return num_matches;
1574     }
1575     return 0;
1576 }
1577 
1578 static uint32_t
1579 LookupTypeInModule (CommandInterpreter &interpreter,
1580                     Stream &strm,
1581                     Module *module,
1582                     const char *name_cstr,
1583                     bool name_is_regex)
1584 {
1585     if (module && name_cstr && name_cstr[0])
1586     {
1587         TypeList type_list;
1588         const uint32_t max_num_matches = 1;
1589         uint32_t num_matches = 0;
1590         SymbolContext sc;
1591 
1592         ConstString name(name_cstr);
1593         num_matches = module->FindTypes(sc, name, NULL, true, max_num_matches, type_list);
1594 
1595         if (num_matches)
1596         {
1597             strm.Indent ();
1598             strm.Printf("%u match%s found in ", num_matches, num_matches > 1 ? "es" : "");
1599             DumpFullpath (strm, &module->GetFileSpec(), 0);
1600             strm.PutCString(":\n");
1601             const uint32_t num_types = type_list.GetSize();
1602             for (uint32_t i=0; i<num_types; ++i)
1603             {
1604                 TypeSP type_sp (type_list.GetTypeAtIndex(i));
1605                 if (type_sp)
1606                 {
1607                     // Resolve the clang type so that any forward references
1608                     // to types that haven't yet been parsed will get parsed.
1609                     type_sp->GetClangFullType ();
1610                     type_sp->GetDescription (&strm, eDescriptionLevelFull, true);
1611                 }
1612                 strm.EOL();
1613             }
1614         }
1615         return num_matches;
1616     }
1617     return 0;
1618 }
1619 
1620 static uint32_t
1621 LookupFileAndLineInModule (CommandInterpreter &interpreter,
1622                            Stream &strm,
1623                            Module *module,
1624                            const FileSpec &file_spec,
1625                            uint32_t line,
1626                            bool check_inlines,
1627                            bool verbose)
1628 {
1629     if (module && file_spec)
1630     {
1631         SymbolContextList sc_list;
1632         const uint32_t num_matches = module->ResolveSymbolContextsForFileSpec(file_spec, line, check_inlines,
1633                                                                               eSymbolContextEverything, sc_list);
1634         if (num_matches > 0)
1635         {
1636             strm.Indent ();
1637             strm.Printf("%u match%s found in ", num_matches, num_matches > 1 ? "es" : "");
1638             strm << file_spec;
1639             if (line > 0)
1640                 strm.Printf (":%u", line);
1641             strm << " in ";
1642             DumpFullpath (strm, &module->GetFileSpec(), 0);
1643             strm.PutCString(":\n");
1644             DumpSymbolContextList (interpreter, strm, sc_list, true, verbose);
1645             return num_matches;
1646         }
1647     }
1648     return 0;
1649 
1650 }
1651 
1652 
1653 static size_t
1654 FindModulesByName (Target *target,
1655                    const char *module_name,
1656                    ModuleList &module_list,
1657                    bool check_global_list)
1658 {
1659 // Dump specified images (by basename or fullpath)
1660     FileSpec module_file_spec(module_name, false);
1661     ModuleSpec module_spec (module_file_spec);
1662 
1663     const size_t initial_size = module_list.GetSize ();
1664 
1665     size_t num_matches = 0;
1666 
1667     if (target)
1668     {
1669         num_matches = target->GetImages().FindModules (module_spec, module_list);
1670 
1671         // Not found in our module list for our target, check the main
1672         // shared module list in case it is a extra file used somewhere
1673         // else
1674         if (num_matches == 0)
1675         {
1676             module_spec.GetArchitecture() = target->GetArchitecture();
1677             num_matches = ModuleList::FindSharedModules (module_spec, module_list);
1678         }
1679     }
1680     else
1681     {
1682         num_matches = ModuleList::FindSharedModules (module_spec,module_list);
1683     }
1684 
1685     if (check_global_list && num_matches == 0)
1686     {
1687         // Check the global list
1688         Mutex::Locker locker(Module::GetAllocationModuleCollectionMutex());
1689         const uint32_t num_modules = Module::GetNumberAllocatedModules();
1690         ModuleSP module_sp;
1691         for (uint32_t image_idx = 0; image_idx<num_modules; ++image_idx)
1692         {
1693             Module *module = Module::GetAllocatedModuleAtIndex(image_idx);
1694 
1695             if (module)
1696             {
1697                 if (module->MatchesModuleSpec (module_spec))
1698                 {
1699                     module_sp = module->shared_from_this();
1700                     module_list.AppendIfNeeded(module_sp);
1701                 }
1702             }
1703         }
1704     }
1705     return module_list.GetSize () - initial_size;
1706 }
1707 
1708 #pragma mark CommandObjectTargetModulesModuleAutoComplete
1709 
1710 //----------------------------------------------------------------------
1711 // A base command object class that can auto complete with module file
1712 // paths
1713 //----------------------------------------------------------------------
1714 
1715 class CommandObjectTargetModulesModuleAutoComplete : public CommandObject
1716 {
1717 public:
1718 
1719     CommandObjectTargetModulesModuleAutoComplete (CommandInterpreter &interpreter,
1720                                       const char *name,
1721                                       const char *help,
1722                                       const char *syntax) :
1723     CommandObject (interpreter, name, help, syntax)
1724     {
1725         CommandArgumentEntry arg;
1726         CommandArgumentData file_arg;
1727 
1728         // Define the first (and only) variant of this arg.
1729         file_arg.arg_type = eArgTypeFilename;
1730         file_arg.arg_repetition = eArgRepeatStar;
1731 
1732         // There is only one variant this argument could be; put it into the argument entry.
1733         arg.push_back (file_arg);
1734 
1735         // Push the data for the first argument into the m_arguments vector.
1736         m_arguments.push_back (arg);
1737     }
1738 
1739     virtual
1740     ~CommandObjectTargetModulesModuleAutoComplete ()
1741     {
1742     }
1743 
1744     virtual int
1745     HandleArgumentCompletion (Args &input,
1746                               int &cursor_index,
1747                               int &cursor_char_position,
1748                               OptionElementVector &opt_element_vector,
1749                               int match_start_point,
1750                               int max_return_elements,
1751                               bool &word_complete,
1752                               StringList &matches)
1753     {
1754         // Arguments are the standard module completer.
1755         std::string completion_str (input.GetArgumentAtIndex(cursor_index));
1756         completion_str.erase (cursor_char_position);
1757 
1758         CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
1759                                                              CommandCompletions::eModuleCompletion,
1760                                                              completion_str.c_str(),
1761                                                              match_start_point,
1762                                                              max_return_elements,
1763                                                              NULL,
1764                                                              word_complete,
1765                                                              matches);
1766         return matches.GetSize();
1767     }
1768 };
1769 
1770 #pragma mark CommandObjectTargetModulesSourceFileAutoComplete
1771 
1772 //----------------------------------------------------------------------
1773 // A base command object class that can auto complete with module source
1774 // file paths
1775 //----------------------------------------------------------------------
1776 
1777 class CommandObjectTargetModulesSourceFileAutoComplete : public CommandObject
1778 {
1779 public:
1780 
1781     CommandObjectTargetModulesSourceFileAutoComplete (CommandInterpreter &interpreter,
1782                                           const char *name,
1783                                           const char *help,
1784                                           const char *syntax) :
1785     CommandObject (interpreter, name, help, syntax)
1786     {
1787         CommandArgumentEntry arg;
1788         CommandArgumentData source_file_arg;
1789 
1790         // Define the first (and only) variant of this arg.
1791         source_file_arg.arg_type = eArgTypeSourceFile;
1792         source_file_arg.arg_repetition = eArgRepeatPlus;
1793 
1794         // There is only one variant this argument could be; put it into the argument entry.
1795         arg.push_back (source_file_arg);
1796 
1797         // Push the data for the first argument into the m_arguments vector.
1798         m_arguments.push_back (arg);
1799     }
1800 
1801     virtual
1802     ~CommandObjectTargetModulesSourceFileAutoComplete ()
1803     {
1804     }
1805 
1806     virtual int
1807     HandleArgumentCompletion (Args &input,
1808                               int &cursor_index,
1809                               int &cursor_char_position,
1810                               OptionElementVector &opt_element_vector,
1811                               int match_start_point,
1812                               int max_return_elements,
1813                               bool &word_complete,
1814                               StringList &matches)
1815     {
1816         // Arguments are the standard source file completer.
1817         std::string completion_str (input.GetArgumentAtIndex(cursor_index));
1818         completion_str.erase (cursor_char_position);
1819 
1820         CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
1821                                                              CommandCompletions::eSourceFileCompletion,
1822                                                              completion_str.c_str(),
1823                                                              match_start_point,
1824                                                              max_return_elements,
1825                                                              NULL,
1826                                                              word_complete,
1827                                                              matches);
1828         return matches.GetSize();
1829     }
1830 };
1831 
1832 
1833 #pragma mark CommandObjectTargetModulesDumpSymtab
1834 
1835 
1836 class CommandObjectTargetModulesDumpSymtab : public CommandObjectTargetModulesModuleAutoComplete
1837 {
1838 public:
1839     CommandObjectTargetModulesDumpSymtab (CommandInterpreter &interpreter) :
1840     CommandObjectTargetModulesModuleAutoComplete (interpreter,
1841                                       "target modules dump symtab",
1842                                       "Dump the symbol table from one or more target modules.",
1843                                       NULL),
1844     m_options (interpreter)
1845     {
1846     }
1847 
1848     virtual
1849     ~CommandObjectTargetModulesDumpSymtab ()
1850     {
1851     }
1852 
1853     virtual bool
1854     Execute (Args& command,
1855              CommandReturnObject &result)
1856     {
1857         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
1858         if (target == NULL)
1859         {
1860             result.AppendError ("invalid target, create a debug target using the 'target create' command");
1861             result.SetStatus (eReturnStatusFailed);
1862             return false;
1863         }
1864         else
1865         {
1866             uint32_t num_dumped = 0;
1867 
1868             uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize();
1869             result.GetOutputStream().SetAddressByteSize(addr_byte_size);
1870             result.GetErrorStream().SetAddressByteSize(addr_byte_size);
1871 
1872             if (command.GetArgumentCount() == 0)
1873             {
1874                 // Dump all sections for all modules images
1875                 const uint32_t num_modules = target->GetImages().GetSize();
1876                 if (num_modules > 0)
1877                 {
1878                     result.GetOutputStream().Printf("Dumping symbol table for %u modules.\n", num_modules);
1879                     for (uint32_t image_idx = 0;  image_idx<num_modules; ++image_idx)
1880                     {
1881                         if (num_dumped > 0)
1882                         {
1883                             result.GetOutputStream().EOL();
1884                             result.GetOutputStream().EOL();
1885                         }
1886                         num_dumped++;
1887                         DumpModuleSymtab (m_interpreter, result.GetOutputStream(), target->GetImages().GetModulePointerAtIndex(image_idx), m_options.m_sort_order);
1888                     }
1889                 }
1890                 else
1891                 {
1892                     result.AppendError ("the target has no associated executable images");
1893                     result.SetStatus (eReturnStatusFailed);
1894                     return false;
1895                 }
1896             }
1897             else
1898             {
1899                 // Dump specified images (by basename or fullpath)
1900                 const char *arg_cstr;
1901                 for (int arg_idx = 0; (arg_cstr = command.GetArgumentAtIndex(arg_idx)) != NULL; ++arg_idx)
1902                 {
1903                     ModuleList module_list;
1904                     const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, true);
1905                     if (num_matches > 0)
1906                     {
1907                         for (size_t i=0; i<num_matches; ++i)
1908                         {
1909                             Module *module = module_list.GetModulePointerAtIndex(i);
1910                             if (module)
1911                             {
1912                                 if (num_dumped > 0)
1913                                 {
1914                                     result.GetOutputStream().EOL();
1915                                     result.GetOutputStream().EOL();
1916                                 }
1917                                 num_dumped++;
1918                                 DumpModuleSymtab (m_interpreter, result.GetOutputStream(), module, m_options.m_sort_order);
1919                             }
1920                         }
1921                     }
1922                     else
1923                         result.AppendWarningWithFormat("Unable to find an image that matches '%s'.\n", arg_cstr);
1924                 }
1925             }
1926 
1927             if (num_dumped > 0)
1928                 result.SetStatus (eReturnStatusSuccessFinishResult);
1929             else
1930             {
1931                 result.AppendError ("no matching executable images found");
1932                 result.SetStatus (eReturnStatusFailed);
1933             }
1934         }
1935         return result.Succeeded();
1936     }
1937 
1938     virtual Options *
1939     GetOptions ()
1940     {
1941         return &m_options;
1942     }
1943 
1944     class CommandOptions : public Options
1945     {
1946     public:
1947 
1948         CommandOptions (CommandInterpreter &interpreter) :
1949         Options(interpreter),
1950         m_sort_order (eSortOrderNone)
1951         {
1952         }
1953 
1954         virtual
1955         ~CommandOptions ()
1956         {
1957         }
1958 
1959         virtual Error
1960         SetOptionValue (uint32_t option_idx, const char *option_arg)
1961         {
1962             Error error;
1963             char short_option = (char) m_getopt_table[option_idx].val;
1964 
1965             switch (short_option)
1966             {
1967                 case 's':
1968                     m_sort_order = (SortOrder) Args::StringToOptionEnum (option_arg,
1969                                                                          g_option_table[option_idx].enum_values,
1970                                                                          eSortOrderNone,
1971                                                                          error);
1972                     break;
1973 
1974                 default:
1975                     error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
1976                     break;
1977 
1978             }
1979             return error;
1980         }
1981 
1982         void
1983         OptionParsingStarting ()
1984         {
1985             m_sort_order = eSortOrderNone;
1986         }
1987 
1988         const OptionDefinition*
1989         GetDefinitions ()
1990         {
1991             return g_option_table;
1992         }
1993 
1994         // Options table: Required for subclasses of Options.
1995         static OptionDefinition g_option_table[];
1996 
1997         SortOrder m_sort_order;
1998     };
1999 
2000 protected:
2001 
2002     CommandOptions m_options;
2003 };
2004 
2005 static OptionEnumValueElement
2006 g_sort_option_enumeration[4] =
2007 {
2008     { eSortOrderNone,       "none",     "No sorting, use the original symbol table order."},
2009     { eSortOrderByAddress,  "address",  "Sort output by symbol address."},
2010     { eSortOrderByName,     "name",     "Sort output by symbol name."},
2011     { 0,                    NULL,       NULL }
2012 };
2013 
2014 
2015 OptionDefinition
2016 CommandObjectTargetModulesDumpSymtab::CommandOptions::g_option_table[] =
2017 {
2018     { LLDB_OPT_SET_1, false, "sort", 's', required_argument, g_sort_option_enumeration, 0, eArgTypeSortOrder, "Supply a sort order when dumping the symbol table."},
2019     { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
2020 };
2021 
2022 #pragma mark CommandObjectTargetModulesDumpSections
2023 
2024 //----------------------------------------------------------------------
2025 // Image section dumping command
2026 //----------------------------------------------------------------------
2027 
2028 class CommandObjectTargetModulesDumpSections : public CommandObjectTargetModulesModuleAutoComplete
2029 {
2030 public:
2031     CommandObjectTargetModulesDumpSections (CommandInterpreter &interpreter) :
2032     CommandObjectTargetModulesModuleAutoComplete (interpreter,
2033                                       "target modules dump sections",
2034                                       "Dump the sections from one or more target modules.",
2035                                       //"target modules dump sections [<file1> ...]")
2036                                       NULL)
2037     {
2038     }
2039 
2040     virtual
2041     ~CommandObjectTargetModulesDumpSections ()
2042     {
2043     }
2044 
2045     virtual bool
2046     Execute (Args& command,
2047              CommandReturnObject &result)
2048     {
2049         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
2050         if (target == NULL)
2051         {
2052             result.AppendError ("invalid target, create a debug target using the 'target create' command");
2053             result.SetStatus (eReturnStatusFailed);
2054             return false;
2055         }
2056         else
2057         {
2058             uint32_t num_dumped = 0;
2059 
2060             uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize();
2061             result.GetOutputStream().SetAddressByteSize(addr_byte_size);
2062             result.GetErrorStream().SetAddressByteSize(addr_byte_size);
2063 
2064             if (command.GetArgumentCount() == 0)
2065             {
2066                 // Dump all sections for all modules images
2067                 const uint32_t num_modules = target->GetImages().GetSize();
2068                 if (num_modules > 0)
2069                 {
2070                     result.GetOutputStream().Printf("Dumping sections for %u modules.\n", num_modules);
2071                     for (uint32_t image_idx = 0;  image_idx<num_modules; ++image_idx)
2072                     {
2073                         num_dumped++;
2074                         DumpModuleSections (m_interpreter, result.GetOutputStream(), target->GetImages().GetModulePointerAtIndex(image_idx));
2075                     }
2076                 }
2077                 else
2078                 {
2079                     result.AppendError ("the target has no associated executable images");
2080                     result.SetStatus (eReturnStatusFailed);
2081                     return false;
2082                 }
2083             }
2084             else
2085             {
2086                 // Dump specified images (by basename or fullpath)
2087                 const char *arg_cstr;
2088                 for (int arg_idx = 0; (arg_cstr = command.GetArgumentAtIndex(arg_idx)) != NULL; ++arg_idx)
2089                 {
2090                     ModuleList module_list;
2091                     const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, true);
2092                     if (num_matches > 0)
2093                     {
2094                         for (size_t i=0; i<num_matches; ++i)
2095                         {
2096                             Module *module = module_list.GetModulePointerAtIndex(i);
2097                             if (module)
2098                             {
2099                                 num_dumped++;
2100                                 DumpModuleSections (m_interpreter, result.GetOutputStream(), module);
2101                             }
2102                         }
2103                     }
2104                     else
2105                     {
2106                         // Check the global list
2107                         Mutex::Locker locker(Module::GetAllocationModuleCollectionMutex());
2108 
2109                         result.AppendWarningWithFormat("Unable to find an image that matches '%s'.\n", arg_cstr);
2110                     }
2111                 }
2112             }
2113 
2114             if (num_dumped > 0)
2115                 result.SetStatus (eReturnStatusSuccessFinishResult);
2116             else
2117             {
2118                 result.AppendError ("no matching executable images found");
2119                 result.SetStatus (eReturnStatusFailed);
2120             }
2121         }
2122         return result.Succeeded();
2123     }
2124 };
2125 
2126 
2127 #pragma mark CommandObjectTargetModulesDumpSymfile
2128 
2129 //----------------------------------------------------------------------
2130 // Image debug symbol dumping command
2131 //----------------------------------------------------------------------
2132 
2133 class CommandObjectTargetModulesDumpSymfile : public CommandObjectTargetModulesModuleAutoComplete
2134 {
2135 public:
2136     CommandObjectTargetModulesDumpSymfile (CommandInterpreter &interpreter) :
2137     CommandObjectTargetModulesModuleAutoComplete (interpreter,
2138                                       "target modules dump symfile",
2139                                       "Dump the debug symbol file for one or more target modules.",
2140                                       //"target modules dump symfile [<file1> ...]")
2141                                       NULL)
2142     {
2143     }
2144 
2145     virtual
2146     ~CommandObjectTargetModulesDumpSymfile ()
2147     {
2148     }
2149 
2150     virtual bool
2151     Execute (Args& command,
2152              CommandReturnObject &result)
2153     {
2154         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
2155         if (target == NULL)
2156         {
2157             result.AppendError ("invalid target, create a debug target using the 'target create' command");
2158             result.SetStatus (eReturnStatusFailed);
2159             return false;
2160         }
2161         else
2162         {
2163             uint32_t num_dumped = 0;
2164 
2165             uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize();
2166             result.GetOutputStream().SetAddressByteSize(addr_byte_size);
2167             result.GetErrorStream().SetAddressByteSize(addr_byte_size);
2168 
2169             if (command.GetArgumentCount() == 0)
2170             {
2171                 // Dump all sections for all modules images
2172                 const uint32_t num_modules = target->GetImages().GetSize();
2173                 if (num_modules > 0)
2174                 {
2175                     result.GetOutputStream().Printf("Dumping debug symbols for %u modules.\n", num_modules);
2176                     for (uint32_t image_idx = 0;  image_idx<num_modules; ++image_idx)
2177                     {
2178                         if (DumpModuleSymbolVendor (result.GetOutputStream(), target->GetImages().GetModulePointerAtIndex(image_idx)))
2179                             num_dumped++;
2180                     }
2181                 }
2182                 else
2183                 {
2184                     result.AppendError ("the target has no associated executable images");
2185                     result.SetStatus (eReturnStatusFailed);
2186                     return false;
2187                 }
2188             }
2189             else
2190             {
2191                 // Dump specified images (by basename or fullpath)
2192                 const char *arg_cstr;
2193                 for (int arg_idx = 0; (arg_cstr = command.GetArgumentAtIndex(arg_idx)) != NULL; ++arg_idx)
2194                 {
2195                     ModuleList module_list;
2196                     const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, true);
2197                     if (num_matches > 0)
2198                     {
2199                         for (size_t i=0; i<num_matches; ++i)
2200                         {
2201                             Module *module = module_list.GetModulePointerAtIndex(i);
2202                             if (module)
2203                             {
2204                                 if (DumpModuleSymbolVendor (result.GetOutputStream(), module))
2205                                     num_dumped++;
2206                             }
2207                         }
2208                     }
2209                     else
2210                         result.AppendWarningWithFormat("Unable to find an image that matches '%s'.\n", arg_cstr);
2211                 }
2212             }
2213 
2214             if (num_dumped > 0)
2215                 result.SetStatus (eReturnStatusSuccessFinishResult);
2216             else
2217             {
2218                 result.AppendError ("no matching executable images found");
2219                 result.SetStatus (eReturnStatusFailed);
2220             }
2221         }
2222         return result.Succeeded();
2223     }
2224 };
2225 
2226 
2227 #pragma mark CommandObjectTargetModulesDumpLineTable
2228 
2229 //----------------------------------------------------------------------
2230 // Image debug line table dumping command
2231 //----------------------------------------------------------------------
2232 
2233 class CommandObjectTargetModulesDumpLineTable : public CommandObjectTargetModulesSourceFileAutoComplete
2234 {
2235 public:
2236     CommandObjectTargetModulesDumpLineTable (CommandInterpreter &interpreter) :
2237     CommandObjectTargetModulesSourceFileAutoComplete (interpreter,
2238                                           "target modules dump line-table",
2239                                           "Dump the debug symbol file for one or more target modules.",
2240                                           NULL)
2241     {
2242     }
2243 
2244     virtual
2245     ~CommandObjectTargetModulesDumpLineTable ()
2246     {
2247     }
2248 
2249     virtual bool
2250     Execute (Args& command,
2251              CommandReturnObject &result)
2252     {
2253         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
2254         if (target == NULL)
2255         {
2256             result.AppendError ("invalid target, create a debug target using the 'target create' command");
2257             result.SetStatus (eReturnStatusFailed);
2258             return false;
2259         }
2260         else
2261         {
2262             ExecutionContext exe_ctx(m_interpreter.GetExecutionContext());
2263             uint32_t total_num_dumped = 0;
2264 
2265             uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize();
2266             result.GetOutputStream().SetAddressByteSize(addr_byte_size);
2267             result.GetErrorStream().SetAddressByteSize(addr_byte_size);
2268 
2269             if (command.GetArgumentCount() == 0)
2270             {
2271                 result.AppendErrorWithFormat ("\nSyntax: %s\n", m_cmd_syntax.c_str());
2272                 result.SetStatus (eReturnStatusFailed);
2273             }
2274             else
2275             {
2276                 // Dump specified images (by basename or fullpath)
2277                 const char *arg_cstr;
2278                 for (int arg_idx = 0; (arg_cstr = command.GetArgumentAtIndex(arg_idx)) != NULL; ++arg_idx)
2279                 {
2280                     FileSpec file_spec(arg_cstr, false);
2281                     const uint32_t num_modules = target->GetImages().GetSize();
2282                     if (num_modules > 0)
2283                     {
2284                         uint32_t num_dumped = 0;
2285                         for (uint32_t i = 0; i<num_modules; ++i)
2286                         {
2287                             if (DumpCompileUnitLineTable (m_interpreter,
2288                                                           result.GetOutputStream(),
2289                                                           target->GetImages().GetModulePointerAtIndex(i),
2290                                                           file_spec,
2291                                                           exe_ctx.GetProcessPtr() && exe_ctx.GetProcessRef().IsAlive()))
2292                                 num_dumped++;
2293                         }
2294                         if (num_dumped == 0)
2295                             result.AppendWarningWithFormat ("No source filenames matched '%s'.\n", arg_cstr);
2296                         else
2297                             total_num_dumped += num_dumped;
2298                     }
2299                 }
2300             }
2301 
2302             if (total_num_dumped > 0)
2303                 result.SetStatus (eReturnStatusSuccessFinishResult);
2304             else
2305             {
2306                 result.AppendError ("no source filenames matched any command arguments");
2307                 result.SetStatus (eReturnStatusFailed);
2308             }
2309         }
2310         return result.Succeeded();
2311     }
2312 };
2313 
2314 
2315 #pragma mark CommandObjectTargetModulesDump
2316 
2317 //----------------------------------------------------------------------
2318 // Dump multi-word command for target modules
2319 //----------------------------------------------------------------------
2320 
2321 class CommandObjectTargetModulesDump : public CommandObjectMultiword
2322 {
2323 public:
2324 
2325     //------------------------------------------------------------------
2326     // Constructors and Destructors
2327     //------------------------------------------------------------------
2328     CommandObjectTargetModulesDump(CommandInterpreter &interpreter) :
2329     CommandObjectMultiword (interpreter,
2330                             "target modules dump",
2331                             "A set of commands for dumping information about one or more target modules.",
2332                             "target modules dump [symtab|sections|symfile|line-table] [<file1> <file2> ...]")
2333     {
2334         LoadSubCommand ("symtab",      CommandObjectSP (new CommandObjectTargetModulesDumpSymtab (interpreter)));
2335         LoadSubCommand ("sections",    CommandObjectSP (new CommandObjectTargetModulesDumpSections (interpreter)));
2336         LoadSubCommand ("symfile",     CommandObjectSP (new CommandObjectTargetModulesDumpSymfile (interpreter)));
2337         LoadSubCommand ("line-table",  CommandObjectSP (new CommandObjectTargetModulesDumpLineTable (interpreter)));
2338     }
2339 
2340     virtual
2341     ~CommandObjectTargetModulesDump()
2342     {
2343     }
2344 };
2345 
2346 class CommandObjectTargetModulesAdd : public CommandObject
2347 {
2348 public:
2349     CommandObjectTargetModulesAdd (CommandInterpreter &interpreter) :
2350     CommandObject (interpreter,
2351                    "target modules add",
2352                    "Add a new module to the current target's modules.",
2353                    "target modules add [<module>]")
2354     {
2355     }
2356 
2357     virtual
2358     ~CommandObjectTargetModulesAdd ()
2359     {
2360     }
2361 
2362     virtual bool
2363     Execute (Args& args,
2364              CommandReturnObject &result)
2365     {
2366         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
2367         if (target == NULL)
2368         {
2369             result.AppendError ("invalid target, create a debug target using the 'target create' command");
2370             result.SetStatus (eReturnStatusFailed);
2371             return false;
2372         }
2373         else
2374         {
2375             const size_t argc = args.GetArgumentCount();
2376             if (argc == 0)
2377             {
2378                 result.AppendError ("one or more executable image paths must be specified");
2379                 result.SetStatus (eReturnStatusFailed);
2380                 return false;
2381             }
2382             else
2383             {
2384                 for (size_t i=0; i<argc; ++i)
2385                 {
2386                     const char *path = args.GetArgumentAtIndex(i);
2387                     if (path)
2388                     {
2389                         FileSpec file_spec(path, true);
2390                         if (file_spec.Exists())
2391                         {
2392                             ModuleSpec module_spec (file_spec);
2393                             ModuleSP module_sp (target->GetSharedModule (module_spec));
2394                             if (!module_sp)
2395                             {
2396                                 result.AppendError ("one or more executable image paths must be specified");
2397                                 result.SetStatus (eReturnStatusFailed);
2398                                 return false;
2399                             }
2400                             result.SetStatus (eReturnStatusSuccessFinishResult);
2401                         }
2402                         else
2403                         {
2404                             char resolved_path[PATH_MAX];
2405                             result.SetStatus (eReturnStatusFailed);
2406                             if (file_spec.GetPath (resolved_path, sizeof(resolved_path)))
2407                             {
2408                                 if (strcmp (resolved_path, path) != 0)
2409                                 {
2410                                     result.AppendErrorWithFormat ("invalid module path '%s' with resolved path '%s'\n", path, resolved_path);
2411                                     break;
2412                                 }
2413                             }
2414                             result.AppendErrorWithFormat ("invalid module path '%s'\n", path);
2415                             break;
2416                         }
2417                     }
2418                 }
2419             }
2420         }
2421         return result.Succeeded();
2422     }
2423 
2424     int
2425     HandleArgumentCompletion (Args &input,
2426                               int &cursor_index,
2427                               int &cursor_char_position,
2428                               OptionElementVector &opt_element_vector,
2429                               int match_start_point,
2430                               int max_return_elements,
2431                               bool &word_complete,
2432                               StringList &matches)
2433     {
2434         std::string completion_str (input.GetArgumentAtIndex(cursor_index));
2435         completion_str.erase (cursor_char_position);
2436 
2437         CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
2438                                                              CommandCompletions::eDiskFileCompletion,
2439                                                              completion_str.c_str(),
2440                                                              match_start_point,
2441                                                              max_return_elements,
2442                                                              NULL,
2443                                                              word_complete,
2444                                                              matches);
2445         return matches.GetSize();
2446     }
2447 
2448 };
2449 
2450 class CommandObjectTargetModulesLoad : public CommandObjectTargetModulesModuleAutoComplete
2451 {
2452 public:
2453     CommandObjectTargetModulesLoad (CommandInterpreter &interpreter) :
2454         CommandObjectTargetModulesModuleAutoComplete (interpreter,
2455                                                       "target modules load",
2456                                                       "Set the load addresses for one or more sections in a target module.",
2457                                                       "target modules load [--file <module> --uuid <uuid>] <sect-name> <address> [<sect-name> <address> ....]"),
2458         m_option_group (interpreter),
2459         m_file_option (LLDB_OPT_SET_1, false, "file", 'f', 0, eArgTypePath, "Fullpath or basename for module to load."),
2460         m_slide_option(LLDB_OPT_SET_1, false, "slide", 's', 0, eArgTypeOffset, "Set the load address for all sections to be the virtual address in the file plus the offset.", 0)
2461     {
2462         m_option_group.Append (&m_uuid_option_group, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
2463         m_option_group.Append (&m_file_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
2464         m_option_group.Append (&m_slide_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
2465         m_option_group.Finalize();
2466     }
2467 
2468     virtual
2469     ~CommandObjectTargetModulesLoad ()
2470     {
2471     }
2472 
2473     virtual bool
2474     Execute (Args& args,
2475              CommandReturnObject &result)
2476     {
2477         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
2478         if (target == NULL)
2479         {
2480             result.AppendError ("invalid target, create a debug target using the 'target create' command");
2481             result.SetStatus (eReturnStatusFailed);
2482             return false;
2483         }
2484         else
2485         {
2486             const size_t argc = args.GetArgumentCount();
2487             ModuleSpec module_spec;
2488             bool search_using_module_spec = false;
2489             if (m_file_option.GetOptionValue().OptionWasSet())
2490             {
2491                 search_using_module_spec = true;
2492                 module_spec.GetFileSpec() = m_file_option.GetOptionValue().GetCurrentValue();
2493             }
2494 
2495             if (m_uuid_option_group.GetOptionValue().OptionWasSet())
2496             {
2497                 search_using_module_spec = true;
2498                 module_spec.GetUUID() = m_uuid_option_group.GetOptionValue().GetCurrentValue();
2499             }
2500 
2501             if (search_using_module_spec)
2502             {
2503 
2504                 ModuleList matching_modules;
2505                 const size_t num_matches = target->GetImages().FindModules (module_spec, matching_modules);
2506 
2507                 char path[PATH_MAX];
2508                 if (num_matches == 1)
2509                 {
2510                     Module *module = matching_modules.GetModulePointerAtIndex(0);
2511                     if (module)
2512                     {
2513                         ObjectFile *objfile = module->GetObjectFile();
2514                         if (objfile)
2515                         {
2516                             SectionList *section_list = objfile->GetSectionList();
2517                             if (section_list)
2518                             {
2519                                 if (argc == 0)
2520                                 {
2521                                     if (m_slide_option.GetOptionValue().OptionWasSet())
2522                                     {
2523                                         Module *module = matching_modules.GetModulePointerAtIndex(0);
2524                                         if (module)
2525                                         {
2526                                             ObjectFile *objfile = module->GetObjectFile();
2527                                             if (objfile)
2528                                             {
2529                                                 SectionList *section_list = objfile->GetSectionList();
2530                                                 if (section_list)
2531                                                 {
2532                                                     const size_t num_sections = section_list->GetSize();
2533                                                     const addr_t slide = m_slide_option.GetOptionValue().GetCurrentValue();
2534                                                     for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx)
2535                                                     {
2536                                                         SectionSP section_sp (section_list->GetSectionAtIndex(sect_idx));
2537                                                         if (section_sp)
2538                                                             target->GetSectionLoadList().SetSectionLoadAddress (section_sp.get(), section_sp->GetFileAddress() + slide);
2539                                                     }
2540                                                 }
2541                                             }
2542                                         }
2543                                     }
2544                                     else
2545                                     {
2546                                         result.AppendError ("one or more section name + load address pair must be specified");
2547                                         result.SetStatus (eReturnStatusFailed);
2548                                         return false;
2549                                     }
2550                                 }
2551                                 else
2552                                 {
2553                                     if (m_slide_option.GetOptionValue().OptionWasSet())
2554                                     {
2555                                         result.AppendError ("The \"--slide <offset>\" option can't be used in conjunction with setting section load addresses.\n");
2556                                         result.SetStatus (eReturnStatusFailed);
2557                                         return false;
2558                                     }
2559 
2560                                     for (size_t i=0; i<argc; i += 2)
2561                                     {
2562                                         const char *sect_name = args.GetArgumentAtIndex(i);
2563                                         const char *load_addr_cstr = args.GetArgumentAtIndex(i+1);
2564                                         if (sect_name && load_addr_cstr)
2565                                         {
2566                                             ConstString const_sect_name(sect_name);
2567                                             bool success = false;
2568                                             addr_t load_addr = Args::StringToUInt64(load_addr_cstr, LLDB_INVALID_ADDRESS, 0, &success);
2569                                             if (success)
2570                                             {
2571                                                 SectionSP section_sp (section_list->FindSectionByName(const_sect_name));
2572                                                 if (section_sp)
2573                                                 {
2574                                                     target->GetSectionLoadList().SetSectionLoadAddress (section_sp.get(), load_addr);
2575                                                     result.AppendMessageWithFormat("section '%s' loaded at 0x%llx\n", sect_name, load_addr);
2576                                                 }
2577                                                 else
2578                                                 {
2579                                                     result.AppendErrorWithFormat ("no section found that matches the section name '%s'\n", sect_name);
2580                                                     result.SetStatus (eReturnStatusFailed);
2581                                                     break;
2582                                                 }
2583                                             }
2584                                             else
2585                                             {
2586                                                 result.AppendErrorWithFormat ("invalid load address string '%s'\n", load_addr_cstr);
2587                                                 result.SetStatus (eReturnStatusFailed);
2588                                                 break;
2589                                             }
2590                                         }
2591                                         else
2592                                         {
2593                                             if (sect_name)
2594                                                 result.AppendError ("section names must be followed by a load address.\n");
2595                                             else
2596                                                 result.AppendError ("one or more section name + load address pair must be specified.\n");
2597                                             result.SetStatus (eReturnStatusFailed);
2598                                             break;
2599                                         }
2600                                     }
2601                                 }
2602                             }
2603                             else
2604                             {
2605                                 module->GetFileSpec().GetPath (path, sizeof(path));
2606                                 result.AppendErrorWithFormat ("no sections in object file '%s'\n", path);
2607                                 result.SetStatus (eReturnStatusFailed);
2608                             }
2609                         }
2610                         else
2611                         {
2612                             module->GetFileSpec().GetPath (path, sizeof(path));
2613                             result.AppendErrorWithFormat ("no object file for module '%s'\n", path);
2614                             result.SetStatus (eReturnStatusFailed);
2615                         }
2616                     }
2617                     else
2618                     {
2619                         module->GetFileSpec().GetPath (path, sizeof(path));
2620                         result.AppendErrorWithFormat ("invalid module '%s'.\n", path);
2621                         result.SetStatus (eReturnStatusFailed);
2622                     }
2623                 }
2624                 else
2625                 {
2626                     char uuid_cstr[64];
2627 
2628                     if (module_spec.GetFileSpec())
2629                         module_spec.GetFileSpec().GetPath (path, sizeof(path));
2630                     else
2631                         path[0] = '\0';
2632 
2633                     if (module_spec.GetUUIDPtr())
2634                         module_spec.GetUUID().GetAsCString(uuid_cstr, sizeof(uuid_cstr));
2635                     else
2636                         uuid_cstr[0] = '\0';
2637                     if (num_matches > 1)
2638                     {
2639                         result.AppendErrorWithFormat ("multiple modules match%s%s%s%s:\n",
2640                                                       path[0] ? " file=" : "",
2641                                                       path,
2642                                                       uuid_cstr[0] ? " uuid=" : "",
2643                                                       uuid_cstr);
2644                         for (size_t i=0; i<num_matches; ++i)
2645                         {
2646                             if (matching_modules.GetModulePointerAtIndex(i)->GetFileSpec().GetPath (path, sizeof(path)))
2647                                 result.AppendMessageWithFormat("%s\n", path);
2648                         }
2649                     }
2650                     else
2651                     {
2652                         result.AppendErrorWithFormat ("no modules were found  that match%s%s%s%s.\n",
2653                                                       path[0] ? " file=" : "",
2654                                                       path,
2655                                                       uuid_cstr[0] ? " uuid=" : "",
2656                                                       uuid_cstr);
2657                     }
2658                     result.SetStatus (eReturnStatusFailed);
2659                 }
2660             }
2661             else
2662             {
2663                 result.AppendError ("either the \"--file <module>\" or the \"--uuid <uuid>\" option must be specified.\n");
2664                 result.SetStatus (eReturnStatusFailed);
2665                 return false;
2666             }
2667         }
2668         return result.Succeeded();
2669     }
2670 
2671     virtual Options *
2672     GetOptions ()
2673     {
2674         return &m_option_group;
2675     }
2676 
2677 protected:
2678     OptionGroupOptions m_option_group;
2679     OptionGroupUUID m_uuid_option_group;
2680     OptionGroupFile m_file_option;
2681     OptionGroupUInt64 m_slide_option;
2682 };
2683 
2684 //----------------------------------------------------------------------
2685 // List images with associated information
2686 //----------------------------------------------------------------------
2687 class CommandObjectTargetModulesList : public CommandObject
2688 {
2689 public:
2690 
2691     class CommandOptions : public Options
2692     {
2693     public:
2694 
2695         CommandOptions (CommandInterpreter &interpreter) :
2696             Options(interpreter),
2697             m_format_array(),
2698             m_use_global_module_list (false),
2699             m_module_addr (LLDB_INVALID_ADDRESS)
2700         {
2701         }
2702 
2703         virtual
2704         ~CommandOptions ()
2705         {
2706         }
2707 
2708         virtual Error
2709         SetOptionValue (uint32_t option_idx, const char *option_arg)
2710         {
2711             char short_option = (char) m_getopt_table[option_idx].val;
2712             if (short_option == 'g')
2713             {
2714                 m_use_global_module_list = true;
2715             }
2716             else if (short_option == 'a')
2717             {
2718                 bool success;
2719                 m_module_addr = Args::StringToAddress(option_arg, LLDB_INVALID_ADDRESS, &success);
2720                 if (!success)
2721                 {
2722                     Error error;
2723                     error.SetErrorStringWithFormat("invalid address: \"%s\"", option_arg);
2724                 }
2725             }
2726             else
2727             {
2728                 uint32_t width = 0;
2729                 if (option_arg)
2730                     width = strtoul (option_arg, NULL, 0);
2731                 m_format_array.push_back(std::make_pair(short_option, width));
2732             }
2733             Error error;
2734             return error;
2735         }
2736 
2737         void
2738         OptionParsingStarting ()
2739         {
2740             m_format_array.clear();
2741             m_use_global_module_list = false;
2742             m_module_addr = LLDB_INVALID_ADDRESS;
2743         }
2744 
2745         const OptionDefinition*
2746         GetDefinitions ()
2747         {
2748             return g_option_table;
2749         }
2750 
2751         // Options table: Required for subclasses of Options.
2752 
2753         static OptionDefinition g_option_table[];
2754 
2755         // Instance variables to hold the values for command options.
2756         typedef std::vector< std::pair<char, uint32_t> > FormatWidthCollection;
2757         FormatWidthCollection m_format_array;
2758         bool m_use_global_module_list;
2759         lldb::addr_t m_module_addr;
2760     };
2761 
2762     CommandObjectTargetModulesList (CommandInterpreter &interpreter) :
2763     CommandObject (interpreter,
2764                    "target modules list",
2765                    "List current executable and dependent shared library images.",
2766                    "target modules list [<cmd-options>]"),
2767         m_options (interpreter)
2768     {
2769     }
2770 
2771     virtual
2772     ~CommandObjectTargetModulesList ()
2773     {
2774     }
2775 
2776     virtual
2777     Options *
2778     GetOptions ()
2779     {
2780         return &m_options;
2781     }
2782 
2783     virtual bool
2784     Execute (Args& command,
2785              CommandReturnObject &result)
2786     {
2787         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
2788         const bool use_global_module_list = m_options.m_use_global_module_list;
2789         if (target == NULL && use_global_module_list == false)
2790         {
2791             result.AppendError ("invalid target, create a debug target using the 'target create' command");
2792             result.SetStatus (eReturnStatusFailed);
2793             return false;
2794         }
2795         else
2796         {
2797             if (target)
2798             {
2799                 uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize();
2800                 result.GetOutputStream().SetAddressByteSize(addr_byte_size);
2801                 result.GetErrorStream().SetAddressByteSize(addr_byte_size);
2802             }
2803             // Dump all sections for all modules images
2804             uint32_t num_modules = 0;
2805             Mutex::Locker locker;
2806 
2807             Stream &strm = result.GetOutputStream();
2808 
2809             if (m_options.m_module_addr != LLDB_INVALID_ADDRESS)
2810             {
2811                 if (target)
2812                 {
2813                     Address module_address;
2814                     if (module_address.SetLoadAddress(m_options.m_module_addr, target))
2815                     {
2816                         ModuleSP module_sp (module_address.GetModule());
2817                         if (module_sp)
2818                         {
2819                             PrintModule (target, module_sp.get(), UINT32_MAX, 0, strm);
2820                             result.SetStatus (eReturnStatusSuccessFinishResult);
2821                         }
2822                         else
2823                         {
2824                             result.AppendError ("Couldn't find module matching address: 0x%llx.", m_options.m_module_addr);
2825                             result.SetStatus (eReturnStatusFailed);
2826                         }
2827                     }
2828                     else
2829                     {
2830                         result.AppendError ("Couldn't find module containing address: 0x%llx.", m_options.m_module_addr);
2831                         result.SetStatus (eReturnStatusFailed);
2832                     }
2833                 }
2834                 else
2835                 {
2836                     result.AppendError ("Can only look up modules by address with a valid target.");
2837                     result.SetStatus (eReturnStatusFailed);
2838                 }
2839                 return result.Succeeded();
2840             }
2841 
2842             if (use_global_module_list)
2843             {
2844                 locker.Reset (Module::GetAllocationModuleCollectionMutex()->GetMutex());
2845                 num_modules = Module::GetNumberAllocatedModules();
2846             }
2847             else
2848                 num_modules = target->GetImages().GetSize();
2849 
2850             if (num_modules > 0)
2851             {
2852                 for (uint32_t image_idx = 0; image_idx<num_modules; ++image_idx)
2853                 {
2854                     ModuleSP module_sp;
2855                     Module *module;
2856                     if (use_global_module_list)
2857                     {
2858                         module = Module::GetAllocatedModuleAtIndex(image_idx);
2859                         module_sp = module->shared_from_this();
2860                     }
2861                     else
2862                     {
2863                         module_sp = target->GetImages().GetModuleAtIndex(image_idx);
2864                         module = module_sp.get();
2865                     }
2866 
2867                     int indent = strm.Printf("[%3u] ", image_idx);
2868                     PrintModule (target, module, image_idx, indent, strm);
2869 
2870                 }
2871                 result.SetStatus (eReturnStatusSuccessFinishResult);
2872             }
2873             else
2874             {
2875                 if (use_global_module_list)
2876                     result.AppendError ("the global module list is empty");
2877                 else
2878                     result.AppendError ("the target has no associated executable images");
2879                 result.SetStatus (eReturnStatusFailed);
2880                 return false;
2881             }
2882         }
2883         return result.Succeeded();
2884     }
2885 protected:
2886 
2887     void
2888     PrintModule (Target *target, Module *module, uint32_t idx, int indent, Stream &strm)
2889     {
2890 
2891         bool dump_object_name = false;
2892         if (m_options.m_format_array.empty())
2893         {
2894             m_options.m_format_array.push_back(std::make_pair('u', 0));
2895             m_options.m_format_array.push_back(std::make_pair('h', 0));
2896             m_options.m_format_array.push_back(std::make_pair('f', 0));
2897             m_options.m_format_array.push_back(std::make_pair('S', 0));
2898         }
2899         const size_t num_entries = m_options.m_format_array.size();
2900         bool print_space = false;
2901         for (size_t i=0; i<num_entries; ++i)
2902         {
2903             if (print_space)
2904                 strm.PutChar(' ');
2905             print_space = true;
2906             const char format_char = m_options.m_format_array[i].first;
2907             uint32_t width = m_options.m_format_array[i].second;
2908             switch (format_char)
2909             {
2910                 case 'A':
2911                     DumpModuleArchitecture (strm, module, false, width);
2912                     break;
2913 
2914                 case 't':
2915                     DumpModuleArchitecture (strm, module, true, width);
2916                     break;
2917 
2918                 case 'f':
2919                     DumpFullpath (strm, &module->GetFileSpec(), width);
2920                     dump_object_name = true;
2921                     break;
2922 
2923                 case 'd':
2924                     DumpDirectory (strm, &module->GetFileSpec(), width);
2925                     break;
2926 
2927                 case 'b':
2928                     DumpBasename (strm, &module->GetFileSpec(), width);
2929                     dump_object_name = true;
2930                     break;
2931 
2932                 case 'h':
2933                 case 'o':
2934                     // Image header address
2935                     {
2936                         uint32_t addr_nibble_width = target ? (target->GetArchitecture().GetAddressByteSize() * 2) : 16;
2937 
2938                         ObjectFile *objfile = module->GetObjectFile ();
2939                         if (objfile)
2940                         {
2941                             Address header_addr(objfile->GetHeaderAddress());
2942                             if (header_addr.IsValid())
2943                             {
2944                                 if (target && !target->GetSectionLoadList().IsEmpty())
2945                                 {
2946                                     lldb::addr_t header_load_addr = header_addr.GetLoadAddress (target);
2947                                     if (header_load_addr == LLDB_INVALID_ADDRESS)
2948                                     {
2949                                         header_addr.Dump (&strm, target, Address::DumpStyleModuleWithFileAddress, Address::DumpStyleFileAddress);
2950                                     }
2951                                     else
2952                                     {
2953                                         if (format_char == 'o')
2954                                         {
2955                                             // Show the offset of slide for the image
2956                                             strm.Printf ("0x%*.*llx", addr_nibble_width, addr_nibble_width, header_load_addr - header_addr.GetFileAddress());
2957                                         }
2958                                         else
2959                                         {
2960                                             // Show the load address of the image
2961                                             strm.Printf ("0x%*.*llx", addr_nibble_width, addr_nibble_width, header_load_addr);
2962                                         }
2963                                     }
2964                                     break;
2965                                 }
2966                                 // The address was valid, but the image isn't loaded, output the address in an appropriate format
2967                                 header_addr.Dump (&strm, target, Address::DumpStyleFileAddress);
2968                                 break;
2969                             }
2970                         }
2971                         strm.Printf ("%*s", addr_nibble_width + 2, "");
2972                     }
2973                     break;
2974                 case 'r':
2975                     {
2976                         uint32_t ref_count = 0;
2977                         ModuleSP module_sp (module->shared_from_this());
2978                         if (module_sp)
2979                         {
2980                             // Take one away to make sure we don't count our local "module_sp"
2981                             ref_count = module_sp.use_count() - 1;
2982                         }
2983                         if (width)
2984                             strm.Printf("{%*u}", width, ref_count);
2985                         else
2986                             strm.Printf("{%u}", ref_count);
2987                     }
2988                     break;
2989 
2990                 case 's':
2991                 case 'S':
2992                     {
2993                         SymbolVendor *symbol_vendor = module->GetSymbolVendor();
2994                         if (symbol_vendor)
2995                         {
2996                             SymbolFile *symbol_file = symbol_vendor->GetSymbolFile();
2997                             if (symbol_file)
2998                             {
2999                                 if (format_char == 'S')
3000                                 {
3001                                     FileSpec &symfile_spec = symbol_file->GetObjectFile()->GetFileSpec();
3002                                     // Dump symbol file only if different from module file
3003                                     if (!symfile_spec || symfile_spec == module->GetFileSpec())
3004                                     {
3005                                         print_space = false;
3006                                         break;
3007                                     }
3008                                     // Add a newline and indent past the index
3009                                     strm.Printf ("\n%*s", indent, "");
3010                                 }
3011                                 DumpFullpath (strm, &symbol_file->GetObjectFile()->GetFileSpec(), width);
3012                                 dump_object_name = true;
3013                                 break;
3014                             }
3015                         }
3016                         strm.Printf("%.*s", width, "<NONE>");
3017                     }
3018                     break;
3019 
3020                 case 'm':
3021                     module->GetModificationTime().Dump(&strm, width);
3022                     break;
3023 
3024                 case 'p':
3025                     strm.Printf("%p", module);
3026                     break;
3027 
3028                 case 'u':
3029                     DumpModuleUUID(strm, module);
3030                     break;
3031 
3032                 default:
3033                     break;
3034             }
3035 
3036         }
3037         if (dump_object_name)
3038         {
3039             const char *object_name = module->GetObjectName().GetCString();
3040             if (object_name)
3041                 strm.Printf ("(%s)", object_name);
3042         }
3043         strm.EOL();
3044     }
3045 
3046     CommandOptions m_options;
3047 };
3048 
3049 OptionDefinition
3050 CommandObjectTargetModulesList::CommandOptions::g_option_table[] =
3051 {
3052     { LLDB_OPT_SET_1, false, "address",    'a', required_argument, NULL, 0, eArgTypeAddress, "Display the image at this address."},
3053     { LLDB_OPT_SET_1, false, "arch",       'A', optional_argument, NULL, 0, eArgTypeWidth,   "Display the architecture when listing images."},
3054     { LLDB_OPT_SET_1, false, "triple",     't', optional_argument, NULL, 0, eArgTypeWidth,   "Display the triple when listing images."},
3055     { LLDB_OPT_SET_1, false, "header",     'h', no_argument,       NULL, 0, eArgTypeNone,    "Display the image header address as a load address if debugging, a file address otherwise."},
3056     { LLDB_OPT_SET_1, false, "offset",     'o', no_argument,       NULL, 0, eArgTypeNone,    "Display the image header address offset from the header file address (the slide amount)."},
3057     { LLDB_OPT_SET_1, false, "uuid",       'u', no_argument,       NULL, 0, eArgTypeNone,    "Display the UUID when listing images."},
3058     { LLDB_OPT_SET_1, false, "fullpath",   'f', optional_argument, NULL, 0, eArgTypeWidth,   "Display the fullpath to the image object file."},
3059     { LLDB_OPT_SET_1, false, "directory",  'd', optional_argument, NULL, 0, eArgTypeWidth,   "Display the directory with optional width for the image object file."},
3060     { LLDB_OPT_SET_1, false, "basename",   'b', optional_argument, NULL, 0, eArgTypeWidth,   "Display the basename with optional width for the image object file."},
3061     { LLDB_OPT_SET_1, false, "symfile",    's', optional_argument, NULL, 0, eArgTypeWidth,   "Display the fullpath to the image symbol file with optional width."},
3062     { LLDB_OPT_SET_1, false, "symfile-unique", 'S', optional_argument, NULL, 0, eArgTypeWidth,   "Display the symbol file with optional width only if it is different from the executable object file."},
3063     { LLDB_OPT_SET_1, false, "mod-time",   'm', optional_argument, NULL, 0, eArgTypeWidth,   "Display the modification time with optional width of the module."},
3064     { LLDB_OPT_SET_1, false, "ref-count",  'r', optional_argument, NULL, 0, eArgTypeWidth,   "Display the reference count if the module is still in the shared module cache."},
3065     { LLDB_OPT_SET_1, false, "pointer",    'p', optional_argument, NULL, 0, eArgTypeNone,    "Display the module pointer."},
3066     { LLDB_OPT_SET_1, false, "global",     'g', no_argument,       NULL, 0, eArgTypeNone,    "Display the modules from the global module list, not just the current target."},
3067     { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
3068 };
3069 
3070 
3071 
3072 //----------------------------------------------------------------------
3073 // Lookup information in images
3074 //----------------------------------------------------------------------
3075 class CommandObjectTargetModulesLookup : public CommandObject
3076 {
3077 public:
3078 
3079     enum
3080     {
3081         eLookupTypeInvalid = -1,
3082         eLookupTypeAddress = 0,
3083         eLookupTypeSymbol,
3084         eLookupTypeFileLine,    // Line is optional
3085         eLookupTypeFunction,
3086         eLookupTypeType,
3087         kNumLookupTypes
3088     };
3089 
3090     class CommandOptions : public Options
3091     {
3092     public:
3093 
3094         CommandOptions (CommandInterpreter &interpreter) :
3095         Options(interpreter)
3096         {
3097             OptionParsingStarting();
3098         }
3099 
3100         virtual
3101         ~CommandOptions ()
3102         {
3103         }
3104 
3105         virtual Error
3106         SetOptionValue (uint32_t option_idx, const char *option_arg)
3107         {
3108             Error error;
3109 
3110             char short_option = (char) m_getopt_table[option_idx].val;
3111 
3112             switch (short_option)
3113             {
3114                 case 'a':
3115                     m_type = eLookupTypeAddress;
3116                     m_addr = Args::StringToUInt64(option_arg, LLDB_INVALID_ADDRESS);
3117                     if (m_addr == LLDB_INVALID_ADDRESS)
3118                         error.SetErrorStringWithFormat ("invalid address string '%s'", option_arg);
3119                     break;
3120 
3121                 case 'o':
3122                     m_offset = Args::StringToUInt64(option_arg, LLDB_INVALID_ADDRESS);
3123                     if (m_offset == LLDB_INVALID_ADDRESS)
3124                         error.SetErrorStringWithFormat ("invalid offset string '%s'", option_arg);
3125                     break;
3126 
3127                 case 's':
3128                     m_str = option_arg;
3129                     m_type = eLookupTypeSymbol;
3130                     break;
3131 
3132                 case 'f':
3133                     m_file.SetFile (option_arg, false);
3134                     m_type = eLookupTypeFileLine;
3135                     break;
3136 
3137                 case 'i':
3138                     m_include_inlines = false;
3139                     break;
3140 
3141                 case 'l':
3142                     m_line_number = Args::StringToUInt32(option_arg, UINT32_MAX);
3143                     if (m_line_number == UINT32_MAX)
3144                         error.SetErrorStringWithFormat ("invalid line number string '%s'", option_arg);
3145                     else if (m_line_number == 0)
3146                         error.SetErrorString ("zero is an invalid line number");
3147                     m_type = eLookupTypeFileLine;
3148                     break;
3149 
3150                 case 'n':
3151                     m_str = option_arg;
3152                     m_type = eLookupTypeFunction;
3153                     break;
3154 
3155                 case 't':
3156                     m_str = option_arg;
3157                     m_type = eLookupTypeType;
3158                     break;
3159 
3160                 case 'v':
3161                     m_verbose = 1;
3162                     break;
3163 
3164                 case 'r':
3165                     m_use_regex = true;
3166                     break;
3167             }
3168 
3169             return error;
3170         }
3171 
3172         void
3173         OptionParsingStarting ()
3174         {
3175             m_type = eLookupTypeInvalid;
3176             m_str.clear();
3177             m_file.Clear();
3178             m_addr = LLDB_INVALID_ADDRESS;
3179             m_offset = 0;
3180             m_line_number = 0;
3181             m_use_regex = false;
3182             m_include_inlines = true;
3183             m_verbose = false;
3184         }
3185 
3186         const OptionDefinition*
3187         GetDefinitions ()
3188         {
3189             return g_option_table;
3190         }
3191 
3192         // Options table: Required for subclasses of Options.
3193 
3194         static OptionDefinition g_option_table[];
3195         int             m_type;         // Should be a eLookupTypeXXX enum after parsing options
3196         std::string     m_str;          // Holds name lookup
3197         FileSpec        m_file;         // Files for file lookups
3198         lldb::addr_t    m_addr;         // Holds the address to lookup
3199         lldb::addr_t    m_offset;       // Subtract this offset from m_addr before doing lookups.
3200         uint32_t        m_line_number;  // Line number for file+line lookups
3201         bool            m_use_regex;    // Name lookups in m_str are regular expressions.
3202         bool            m_include_inlines;// Check for inline entries when looking up by file/line.
3203         bool            m_verbose;      // Enable verbose lookup info
3204 
3205     };
3206 
3207     CommandObjectTargetModulesLookup (CommandInterpreter &interpreter) :
3208     CommandObject (interpreter,
3209                    "target modules lookup",
3210                    "Look up information within executable and dependent shared library images.",
3211                    NULL),
3212     m_options (interpreter)
3213     {
3214         CommandArgumentEntry arg;
3215         CommandArgumentData file_arg;
3216 
3217         // Define the first (and only) variant of this arg.
3218         file_arg.arg_type = eArgTypeFilename;
3219         file_arg.arg_repetition = eArgRepeatStar;
3220 
3221         // There is only one variant this argument could be; put it into the argument entry.
3222         arg.push_back (file_arg);
3223 
3224         // Push the data for the first argument into the m_arguments vector.
3225         m_arguments.push_back (arg);
3226     }
3227 
3228     virtual
3229     ~CommandObjectTargetModulesLookup ()
3230     {
3231     }
3232 
3233     virtual Options *
3234     GetOptions ()
3235     {
3236         return &m_options;
3237     }
3238 
3239 
3240     bool
3241     LookupInModule (CommandInterpreter &interpreter, Module *module, CommandReturnObject &result, bool &syntax_error)
3242     {
3243         switch (m_options.m_type)
3244         {
3245             case eLookupTypeAddress:
3246                 if (m_options.m_addr != LLDB_INVALID_ADDRESS)
3247                 {
3248                     if (LookupAddressInModule (m_interpreter,
3249                                                result.GetOutputStream(),
3250                                                module,
3251                                                eSymbolContextEverything,
3252                                                m_options.m_addr,
3253                                                m_options.m_offset,
3254                                                m_options.m_verbose))
3255                     {
3256                         result.SetStatus(eReturnStatusSuccessFinishResult);
3257                         return true;
3258                     }
3259                 }
3260                 break;
3261 
3262             case eLookupTypeSymbol:
3263                 if (!m_options.m_str.empty())
3264                 {
3265                     if (LookupSymbolInModule (m_interpreter, result.GetOutputStream(), module, m_options.m_str.c_str(), m_options.m_use_regex))
3266                     {
3267                         result.SetStatus(eReturnStatusSuccessFinishResult);
3268                         return true;
3269                     }
3270                 }
3271                 break;
3272 
3273             case eLookupTypeFileLine:
3274                 if (m_options.m_file)
3275                 {
3276 
3277                     if (LookupFileAndLineInModule (m_interpreter,
3278                                                    result.GetOutputStream(),
3279                                                    module,
3280                                                    m_options.m_file,
3281                                                    m_options.m_line_number,
3282                                                    m_options.m_include_inlines,
3283                                                    m_options.m_verbose))
3284                     {
3285                         result.SetStatus(eReturnStatusSuccessFinishResult);
3286                         return true;
3287                     }
3288                 }
3289                 break;
3290 
3291             case eLookupTypeFunction:
3292                 if (!m_options.m_str.empty())
3293                 {
3294                     if (LookupFunctionInModule (m_interpreter,
3295                                                 result.GetOutputStream(),
3296                                                 module,
3297                                                 m_options.m_str.c_str(),
3298                                                 m_options.m_use_regex,
3299                                                 m_options.m_include_inlines,
3300                                                 m_options.m_verbose))
3301                     {
3302                         result.SetStatus(eReturnStatusSuccessFinishResult);
3303                         return true;
3304                     }
3305                 }
3306                 break;
3307 
3308             case eLookupTypeType:
3309                 if (!m_options.m_str.empty())
3310                 {
3311                     if (LookupTypeInModule (m_interpreter,
3312                                             result.GetOutputStream(),
3313                                             module,
3314                                             m_options.m_str.c_str(),
3315                                             m_options.m_use_regex))
3316                     {
3317                         result.SetStatus(eReturnStatusSuccessFinishResult);
3318                         return true;
3319                     }
3320                 }
3321                 break;
3322 
3323             default:
3324                 m_options.GenerateOptionUsage (result.GetErrorStream(), this);
3325                 syntax_error = true;
3326                 break;
3327         }
3328 
3329         result.SetStatus (eReturnStatusFailed);
3330         return false;
3331     }
3332 
3333     virtual bool
3334     Execute (Args& command,
3335              CommandReturnObject &result)
3336     {
3337         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
3338         if (target == NULL)
3339         {
3340             result.AppendError ("invalid target, create a debug target using the 'target create' command");
3341             result.SetStatus (eReturnStatusFailed);
3342             return false;
3343         }
3344         else
3345         {
3346             bool syntax_error = false;
3347             uint32_t i;
3348             uint32_t num_successful_lookups = 0;
3349             uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize();
3350             result.GetOutputStream().SetAddressByteSize(addr_byte_size);
3351             result.GetErrorStream().SetAddressByteSize(addr_byte_size);
3352             // Dump all sections for all modules images
3353 
3354             if (command.GetArgumentCount() == 0)
3355             {
3356                 // Dump all sections for all modules images
3357                 const uint32_t num_modules = target->GetImages().GetSize();
3358                 if (num_modules > 0)
3359                 {
3360                     for (i = 0; i<num_modules && syntax_error == false; ++i)
3361                     {
3362                         if (LookupInModule (m_interpreter, target->GetImages().GetModulePointerAtIndex(i), result, syntax_error))
3363                         {
3364                             result.GetOutputStream().EOL();
3365                             num_successful_lookups++;
3366                         }
3367                     }
3368                 }
3369                 else
3370                 {
3371                     result.AppendError ("the target has no associated executable images");
3372                     result.SetStatus (eReturnStatusFailed);
3373                     return false;
3374                 }
3375             }
3376             else
3377             {
3378                 // Dump specified images (by basename or fullpath)
3379                 const char *arg_cstr;
3380                 for (i = 0; (arg_cstr = command.GetArgumentAtIndex(i)) != NULL && syntax_error == false; ++i)
3381                 {
3382                     ModuleList module_list;
3383                     const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, false);
3384                     if (num_matches > 0)
3385                     {
3386                         for (size_t i=0; i<num_matches; ++i)
3387                         {
3388                             Module *module = module_list.GetModulePointerAtIndex(i);
3389                             if (module)
3390                             {
3391                                 if (LookupInModule (m_interpreter, module, result, syntax_error))
3392                                 {
3393                                     result.GetOutputStream().EOL();
3394                                     num_successful_lookups++;
3395                                 }
3396                             }
3397                         }
3398                     }
3399                     else
3400                         result.AppendWarningWithFormat("Unable to find an image that matches '%s'.\n", arg_cstr);
3401                 }
3402             }
3403 
3404             if (num_successful_lookups > 0)
3405                 result.SetStatus (eReturnStatusSuccessFinishResult);
3406             else
3407                 result.SetStatus (eReturnStatusFailed);
3408         }
3409         return result.Succeeded();
3410     }
3411 protected:
3412 
3413     CommandOptions m_options;
3414 };
3415 
3416 OptionDefinition
3417 CommandObjectTargetModulesLookup::CommandOptions::g_option_table[] =
3418 {
3419     { LLDB_OPT_SET_1,   true,  "address",    'a', required_argument, NULL, 0, eArgTypeAddress,      "Lookup an address in one or more target modules."},
3420     { LLDB_OPT_SET_1,   false, "offset",     'o', required_argument, NULL, 0, eArgTypeOffset,       "When looking up an address subtract <offset> from any addresses before doing the lookup."},
3421     { LLDB_OPT_SET_2| LLDB_OPT_SET_4
3422       /* FIXME: re-enable this for types when the LookupTypeInModule actually uses the regex option: | LLDB_OPT_SET_5 */ ,
3423                         false, "regex",      'r', no_argument,       NULL, 0, eArgTypeNone,         "The <name> argument for name lookups are regular expressions."},
3424     { LLDB_OPT_SET_2,   true,  "symbol",     's', required_argument, NULL, 0, eArgTypeSymbol,       "Lookup a symbol by name in the symbol tables in one or more target modules."},
3425     { LLDB_OPT_SET_3,   true,  "file",       'f', required_argument, NULL, 0, eArgTypeFilename,     "Lookup a file by fullpath or basename in one or more target modules."},
3426     { LLDB_OPT_SET_3,   false, "line",       'l', required_argument, NULL, 0, eArgTypeLineNum,      "Lookup a line number in a file (must be used in conjunction with --file)."},
3427     { LLDB_OPT_SET_3|
3428       LLDB_OPT_SET_4,   false, "no-inlines", 'i', no_argument,       NULL, 0, eArgTypeNone,         "Ignore inline entries (must be used in conjunction with --file or --function)."},
3429     { LLDB_OPT_SET_4,   true,  "function",   'n', required_argument, NULL, 0, eArgTypeFunctionName, "Lookup a function by name in the debug symbols in one or more target modules."},
3430     { LLDB_OPT_SET_5,   true,  "type",       't', required_argument, NULL, 0, eArgTypeName,         "Lookup a type by name in the debug symbols in one or more target modules."},
3431     { LLDB_OPT_SET_ALL, false, "verbose",    'v', no_argument,       NULL, 0, eArgTypeNone,         "Enable verbose lookup information."},
3432     { 0, false, NULL,           0, 0,                 NULL, 0, eArgTypeNone, NULL }
3433 };
3434 
3435 
3436 #pragma mark CommandObjectMultiwordImageSearchPaths
3437 
3438 //-------------------------------------------------------------------------
3439 // CommandObjectMultiwordImageSearchPaths
3440 //-------------------------------------------------------------------------
3441 
3442 class CommandObjectTargetModulesImageSearchPaths : public CommandObjectMultiword
3443 {
3444 public:
3445 
3446     CommandObjectTargetModulesImageSearchPaths (CommandInterpreter &interpreter) :
3447     CommandObjectMultiword (interpreter,
3448                             "target modules search-paths",
3449                             "A set of commands for operating on debugger target image search paths.",
3450                             "target modules search-paths <subcommand> [<subcommand-options>]")
3451     {
3452         LoadSubCommand ("add",     CommandObjectSP (new CommandObjectTargetModulesSearchPathsAdd (interpreter)));
3453         LoadSubCommand ("clear",   CommandObjectSP (new CommandObjectTargetModulesSearchPathsClear (interpreter)));
3454         LoadSubCommand ("insert",  CommandObjectSP (new CommandObjectTargetModulesSearchPathsInsert (interpreter)));
3455         LoadSubCommand ("list",    CommandObjectSP (new CommandObjectTargetModulesSearchPathsList (interpreter)));
3456         LoadSubCommand ("query",   CommandObjectSP (new CommandObjectTargetModulesSearchPathsQuery (interpreter)));
3457     }
3458 
3459     ~CommandObjectTargetModulesImageSearchPaths()
3460     {
3461     }
3462 };
3463 
3464 
3465 
3466 #pragma mark CommandObjectTargetModules
3467 
3468 //-------------------------------------------------------------------------
3469 // CommandObjectTargetModules
3470 //-------------------------------------------------------------------------
3471 
3472 class CommandObjectTargetModules : public CommandObjectMultiword
3473 {
3474 public:
3475     //------------------------------------------------------------------
3476     // Constructors and Destructors
3477     //------------------------------------------------------------------
3478     CommandObjectTargetModules(CommandInterpreter &interpreter) :
3479         CommandObjectMultiword (interpreter,
3480                                 "target modules",
3481                                 "A set of commands for accessing information for one or more target modules.",
3482                                 "target modules <sub-command> ...")
3483     {
3484         LoadSubCommand ("add",          CommandObjectSP (new CommandObjectTargetModulesAdd (interpreter)));
3485         LoadSubCommand ("load",         CommandObjectSP (new CommandObjectTargetModulesLoad (interpreter)));
3486         //LoadSubCommand ("unload",       CommandObjectSP (new CommandObjectTargetModulesUnload (interpreter)));
3487         LoadSubCommand ("dump",         CommandObjectSP (new CommandObjectTargetModulesDump (interpreter)));
3488         LoadSubCommand ("list",         CommandObjectSP (new CommandObjectTargetModulesList (interpreter)));
3489         LoadSubCommand ("lookup",       CommandObjectSP (new CommandObjectTargetModulesLookup (interpreter)));
3490         LoadSubCommand ("search-paths", CommandObjectSP (new CommandObjectTargetModulesImageSearchPaths (interpreter)));
3491 
3492     }
3493     virtual
3494     ~CommandObjectTargetModules()
3495     {
3496     }
3497 
3498 private:
3499     //------------------------------------------------------------------
3500     // For CommandObjectTargetModules only
3501     //------------------------------------------------------------------
3502     DISALLOW_COPY_AND_ASSIGN (CommandObjectTargetModules);
3503 };
3504 
3505 
3506 
3507 class CommandObjectTargetSymbolsAdd : public CommandObject
3508 {
3509 public:
3510     CommandObjectTargetSymbolsAdd (CommandInterpreter &interpreter) :
3511     CommandObject (interpreter,
3512                    "target symbols add",
3513                    "Add a debug symbol file to one of the target's current modules.",
3514                    "target symbols add [<symfile>]")
3515     {
3516     }
3517 
3518     virtual
3519     ~CommandObjectTargetSymbolsAdd ()
3520     {
3521     }
3522 
3523     virtual bool
3524     Execute (Args& args,
3525              CommandReturnObject &result)
3526     {
3527         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
3528         if (target == NULL)
3529         {
3530             result.AppendError ("invalid target, create a debug target using the 'target create' command");
3531             result.SetStatus (eReturnStatusFailed);
3532             return false;
3533         }
3534         else
3535         {
3536             const size_t argc = args.GetArgumentCount();
3537             if (argc == 0)
3538             {
3539                 result.AppendError ("one or more symbol file paths must be specified");
3540                 result.SetStatus (eReturnStatusFailed);
3541                 return false;
3542             }
3543             else
3544             {
3545                 for (size_t i=0; i<argc; ++i)
3546                 {
3547                     const char *symfile_path = args.GetArgumentAtIndex(i);
3548                     if (symfile_path)
3549                     {
3550                         FileSpec symfile_spec(symfile_path, true);
3551                         ArchSpec arch;
3552                         if (symfile_spec.Exists())
3553                         {
3554                             ModuleSP symfile_module_sp (new Module (symfile_spec, target->GetArchitecture()));
3555                             if (symfile_module_sp)
3556                             {
3557                                 // We now have a module that represents a symbol file
3558                                 // that can be used for a module that might exist in the
3559                                 // current target, so we need to find that module in the
3560                                 // target
3561 
3562                                 ModuleSP old_module_sp (target->GetImages().FindModule (symfile_module_sp->GetUUID()));
3563                                 if (old_module_sp)
3564                                 {
3565                                     const bool can_create = false;
3566                                     if (old_module_sp->GetSymbolVendor (can_create))
3567                                     {
3568                                         // The current module already has a symbol file, so we need
3569                                         // need to unload the existing references to this module,
3570                                         // and reload with the new one.
3571 
3572                                         ModuleSP target_exe_module_sp (target->GetExecutableModule());
3573                                         const bool adding_symbols_to_executable = target_exe_module_sp.get() == old_module_sp.get();
3574                                         ModuleSpec module_spec (old_module_sp->GetFileSpec(), old_module_sp->GetArchitecture());
3575                                         module_spec.GetSymbolFileSpec() = symfile_spec;
3576                                         // Unload the old module
3577                                         ModuleList module_list;
3578                                         module_list.Append (old_module_sp);
3579                                         target->ModulesDidUnload (module_list);
3580 
3581                                         // Remove the module from the shared list
3582                                         ModuleList::RemoveSharedModule (old_module_sp);
3583 
3584                                         // Now create the new module and load it
3585                                         module_list.Clear();
3586                                         //ModuleSP new_module_sp (new Module (target_module_file, target_module_arch));
3587                                         ModuleSP new_module_sp;
3588 
3589                                         new_module_sp = target->GetSharedModule (module_spec);
3590 
3591                                         if (new_module_sp)
3592                                         {
3593                                             new_module_sp->SetSymbolFileFileSpec (symfile_module_sp->GetFileSpec());
3594 
3595                                             if (adding_symbols_to_executable)
3596                                             {
3597                                                 bool get_dependent_files = true;
3598                                                 target->SetExecutableModule(new_module_sp, get_dependent_files);
3599                                             }
3600                                             else
3601                                             {
3602                                                 module_list.Append (new_module_sp);
3603                                                 target->ModulesDidLoad(module_list);
3604                                             }
3605                                         }
3606                                     }
3607                                     else
3608                                     {
3609                                         // The module has not yet created its symbol vendor, we can just
3610                                         // give the existing target module the symfile path to use for
3611                                         // when it decides to create it!
3612                                         old_module_sp->SetSymbolFileFileSpec (symfile_module_sp->GetFileSpec());
3613                                     }
3614                                 }
3615                             }
3616                             else
3617                             {
3618                                 result.AppendError ("one or more executable image paths must be specified");
3619                                 result.SetStatus (eReturnStatusFailed);
3620                                 return false;
3621                             }
3622                             result.SetStatus (eReturnStatusSuccessFinishResult);
3623                         }
3624                         else
3625                         {
3626                             char resolved_symfile_path[PATH_MAX];
3627                             result.SetStatus (eReturnStatusFailed);
3628                             if (symfile_spec.GetPath (resolved_symfile_path, sizeof(resolved_symfile_path)))
3629                             {
3630                                 if (strcmp (resolved_symfile_path, symfile_path) != 0)
3631                                 {
3632                                     result.AppendErrorWithFormat ("invalid module path '%s' with resolved path '%s'\n", symfile_path, resolved_symfile_path);
3633                                     break;
3634                                 }
3635                             }
3636                             result.AppendErrorWithFormat ("invalid module path '%s'\n", symfile_path);
3637                             break;
3638                         }
3639                     }
3640                 }
3641             }
3642         }
3643         return result.Succeeded();
3644     }
3645 
3646     int
3647     HandleArgumentCompletion (Args &input,
3648                               int &cursor_index,
3649                               int &cursor_char_position,
3650                               OptionElementVector &opt_element_vector,
3651                               int match_start_point,
3652                               int max_return_elements,
3653                               bool &word_complete,
3654                               StringList &matches)
3655     {
3656         std::string completion_str (input.GetArgumentAtIndex(cursor_index));
3657         completion_str.erase (cursor_char_position);
3658 
3659         CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
3660                                                              CommandCompletions::eDiskFileCompletion,
3661                                                              completion_str.c_str(),
3662                                                              match_start_point,
3663                                                              max_return_elements,
3664                                                              NULL,
3665                                                              word_complete,
3666                                                              matches);
3667         return matches.GetSize();
3668     }
3669 
3670 };
3671 
3672 
3673 #pragma mark CommandObjectTargetSymbols
3674 
3675 //-------------------------------------------------------------------------
3676 // CommandObjectTargetSymbols
3677 //-------------------------------------------------------------------------
3678 
3679 class CommandObjectTargetSymbols : public CommandObjectMultiword
3680 {
3681 public:
3682     //------------------------------------------------------------------
3683     // Constructors and Destructors
3684     //------------------------------------------------------------------
3685     CommandObjectTargetSymbols(CommandInterpreter &interpreter) :
3686         CommandObjectMultiword (interpreter,
3687                             "target symbols",
3688                             "A set of commands for adding and managing debug symbol files.",
3689                             "target symbols <sub-command> ...")
3690     {
3691         LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetSymbolsAdd (interpreter)));
3692 
3693     }
3694     virtual
3695     ~CommandObjectTargetSymbols()
3696     {
3697     }
3698 
3699 private:
3700     //------------------------------------------------------------------
3701     // For CommandObjectTargetModules only
3702     //------------------------------------------------------------------
3703     DISALLOW_COPY_AND_ASSIGN (CommandObjectTargetSymbols);
3704 };
3705 
3706 
3707 #pragma mark CommandObjectTargetStopHookAdd
3708 
3709 //-------------------------------------------------------------------------
3710 // CommandObjectTargetStopHookAdd
3711 //-------------------------------------------------------------------------
3712 
3713 class CommandObjectTargetStopHookAdd : public CommandObject
3714 {
3715 public:
3716 
3717     class CommandOptions : public Options
3718     {
3719     public:
3720         CommandOptions (CommandInterpreter &interpreter) :
3721             Options(interpreter),
3722             m_line_start(0),
3723             m_line_end (UINT_MAX),
3724             m_func_name_type_mask (eFunctionNameTypeAuto),
3725             m_sym_ctx_specified (false),
3726             m_thread_specified (false),
3727             m_use_one_liner (false),
3728             m_one_liner()
3729         {
3730         }
3731 
3732         ~CommandOptions () {}
3733 
3734         const OptionDefinition*
3735         GetDefinitions ()
3736         {
3737             return g_option_table;
3738         }
3739 
3740         virtual Error
3741         SetOptionValue (uint32_t option_idx, const char *option_arg)
3742         {
3743             Error error;
3744             char short_option = (char) m_getopt_table[option_idx].val;
3745             bool success;
3746 
3747             switch (short_option)
3748             {
3749                 case 'c':
3750                     m_class_name = option_arg;
3751                     m_sym_ctx_specified = true;
3752                 break;
3753 
3754                 case 'e':
3755                     m_line_end = Args::StringToUInt32 (option_arg, UINT_MAX, 0, &success);
3756                     if (!success)
3757                     {
3758                         error.SetErrorStringWithFormat ("invalid end line number: \"%s\"", option_arg);
3759                         break;
3760                     }
3761                     m_sym_ctx_specified = true;
3762                 break;
3763 
3764                 case 'l':
3765                     m_line_start = Args::StringToUInt32 (option_arg, 0, 0, &success);
3766                     if (!success)
3767                     {
3768                         error.SetErrorStringWithFormat ("invalid start line number: \"%s\"", option_arg);
3769                         break;
3770                     }
3771                     m_sym_ctx_specified = true;
3772                 break;
3773 
3774                 case 'i':
3775                     m_no_inlines = true;
3776                 break;
3777 
3778                 case 'n':
3779                     m_function_name = option_arg;
3780                     m_func_name_type_mask |= eFunctionNameTypeAuto;
3781                     m_sym_ctx_specified = true;
3782                 break;
3783 
3784                 case 'f':
3785                     m_file_name = option_arg;
3786                     m_sym_ctx_specified = true;
3787                 break;
3788                 case 's':
3789                     m_module_name = option_arg;
3790                     m_sym_ctx_specified = true;
3791                 break;
3792                 case 't' :
3793                 {
3794                     m_thread_id = Args::StringToUInt64(option_arg, LLDB_INVALID_THREAD_ID, 0);
3795                     if (m_thread_id == LLDB_INVALID_THREAD_ID)
3796                        error.SetErrorStringWithFormat ("invalid thread id string '%s'", option_arg);
3797                     m_thread_specified = true;
3798                 }
3799                 break;
3800                 case 'T':
3801                     m_thread_name = option_arg;
3802                     m_thread_specified = true;
3803                 break;
3804                 case 'q':
3805                     m_queue_name = option_arg;
3806                     m_thread_specified = true;
3807                     break;
3808                 case 'x':
3809                 {
3810                     m_thread_index = Args::StringToUInt32(option_arg, UINT32_MAX, 0);
3811                     if (m_thread_id == UINT32_MAX)
3812                        error.SetErrorStringWithFormat ("invalid thread index string '%s'", option_arg);
3813                     m_thread_specified = true;
3814                 }
3815                 break;
3816                 case 'o':
3817                     m_use_one_liner = true;
3818                     m_one_liner = option_arg;
3819                 break;
3820                 default:
3821                     error.SetErrorStringWithFormat ("unrecognized option %c.", short_option);
3822                 break;
3823             }
3824             return error;
3825         }
3826 
3827         void
3828         OptionParsingStarting ()
3829         {
3830             m_class_name.clear();
3831             m_function_name.clear();
3832             m_line_start = 0;
3833             m_line_end = UINT_MAX;
3834             m_file_name.clear();
3835             m_module_name.clear();
3836             m_func_name_type_mask = eFunctionNameTypeAuto;
3837             m_thread_id = LLDB_INVALID_THREAD_ID;
3838             m_thread_index = UINT32_MAX;
3839             m_thread_name.clear();
3840             m_queue_name.clear();
3841 
3842             m_no_inlines = false;
3843             m_sym_ctx_specified = false;
3844             m_thread_specified = false;
3845 
3846             m_use_one_liner = false;
3847             m_one_liner.clear();
3848         }
3849 
3850 
3851         static OptionDefinition g_option_table[];
3852 
3853         std::string m_class_name;
3854         std::string m_function_name;
3855         uint32_t    m_line_start;
3856         uint32_t    m_line_end;
3857         std::string m_file_name;
3858         std::string m_module_name;
3859         uint32_t m_func_name_type_mask;  // A pick from lldb::FunctionNameType.
3860         lldb::tid_t m_thread_id;
3861         uint32_t m_thread_index;
3862         std::string m_thread_name;
3863         std::string m_queue_name;
3864         bool        m_sym_ctx_specified;
3865         bool        m_no_inlines;
3866         bool        m_thread_specified;
3867         // Instance variables to hold the values for one_liner options.
3868         bool m_use_one_liner;
3869         std::string m_one_liner;
3870     };
3871 
3872     Options *
3873     GetOptions ()
3874     {
3875         return &m_options;
3876     }
3877 
3878     CommandObjectTargetStopHookAdd (CommandInterpreter &interpreter) :
3879         CommandObject (interpreter,
3880                        "target stop-hook add ",
3881                        "Add a hook to be executed when the target stops.",
3882                        "target stop-hook add"),
3883         m_options (interpreter)
3884     {
3885     }
3886 
3887     ~CommandObjectTargetStopHookAdd ()
3888     {
3889     }
3890 
3891     static size_t
3892     ReadCommandsCallbackFunction (void *baton,
3893                                   InputReader &reader,
3894                                   lldb::InputReaderAction notification,
3895                                   const char *bytes,
3896                                   size_t bytes_len)
3897     {
3898         StreamSP out_stream = reader.GetDebugger().GetAsyncOutputStream();
3899         Target::StopHook *new_stop_hook = ((Target::StopHook *) baton);
3900         static bool got_interrupted;
3901         bool batch_mode = reader.GetDebugger().GetCommandInterpreter().GetBatchCommandMode();
3902 
3903         switch (notification)
3904         {
3905         case eInputReaderActivate:
3906             if (!batch_mode)
3907             {
3908                 out_stream->Printf ("%s\n", "Enter your stop hook command(s).  Type 'DONE' to end.");
3909                 if (reader.GetPrompt())
3910                     out_stream->Printf ("%s", reader.GetPrompt());
3911                 out_stream->Flush();
3912             }
3913             got_interrupted = false;
3914             break;
3915 
3916         case eInputReaderDeactivate:
3917             break;
3918 
3919         case eInputReaderReactivate:
3920             if (reader.GetPrompt() && !batch_mode)
3921             {
3922                 out_stream->Printf ("%s", reader.GetPrompt());
3923                 out_stream->Flush();
3924             }
3925             got_interrupted = false;
3926             break;
3927 
3928         case eInputReaderAsynchronousOutputWritten:
3929             break;
3930 
3931         case eInputReaderGotToken:
3932             if (bytes && bytes_len && baton)
3933             {
3934                 StringList *commands = new_stop_hook->GetCommandPointer();
3935                 if (commands)
3936                 {
3937                     commands->AppendString (bytes, bytes_len);
3938                 }
3939             }
3940             if (!reader.IsDone() && reader.GetPrompt() && !batch_mode)
3941             {
3942                 out_stream->Printf ("%s", reader.GetPrompt());
3943                 out_stream->Flush();
3944             }
3945             break;
3946 
3947         case eInputReaderInterrupt:
3948             {
3949                 // Finish, and cancel the stop hook.
3950                 new_stop_hook->GetTarget()->RemoveStopHookByID(new_stop_hook->GetID());
3951                 if (!batch_mode)
3952                 {
3953                     out_stream->Printf ("Stop hook cancelled.\n");
3954                     out_stream->Flush();
3955                 }
3956 
3957                 reader.SetIsDone (true);
3958             }
3959             got_interrupted = true;
3960             break;
3961 
3962         case eInputReaderEndOfFile:
3963             reader.SetIsDone (true);
3964             break;
3965 
3966         case eInputReaderDone:
3967             if (!got_interrupted && !batch_mode)
3968             {
3969                 out_stream->Printf ("Stop hook #%llu added.\n", new_stop_hook->GetID());
3970                 out_stream->Flush();
3971             }
3972             break;
3973         }
3974 
3975         return bytes_len;
3976     }
3977 
3978     bool
3979     Execute (Args& command,
3980              CommandReturnObject &result)
3981     {
3982         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
3983         if (target)
3984         {
3985             Target::StopHookSP new_hook_sp;
3986             target->AddStopHook (new_hook_sp);
3987 
3988             //  First step, make the specifier.
3989             std::auto_ptr<SymbolContextSpecifier> specifier_ap;
3990             if (m_options.m_sym_ctx_specified)
3991             {
3992                 specifier_ap.reset(new SymbolContextSpecifier(m_interpreter.GetDebugger().GetSelectedTarget()));
3993 
3994                 if (!m_options.m_module_name.empty())
3995                 {
3996                     specifier_ap->AddSpecification (m_options.m_module_name.c_str(), SymbolContextSpecifier::eModuleSpecified);
3997                 }
3998 
3999                 if (!m_options.m_class_name.empty())
4000                 {
4001                     specifier_ap->AddSpecification (m_options.m_class_name.c_str(), SymbolContextSpecifier::eClassOrNamespaceSpecified);
4002                 }
4003 
4004                 if (!m_options.m_file_name.empty())
4005                 {
4006                     specifier_ap->AddSpecification (m_options.m_file_name.c_str(), SymbolContextSpecifier::eFileSpecified);
4007                 }
4008 
4009                 if (m_options.m_line_start != 0)
4010                 {
4011                     specifier_ap->AddLineSpecification (m_options.m_line_start, SymbolContextSpecifier::eLineStartSpecified);
4012                 }
4013 
4014                 if (m_options.m_line_end != UINT_MAX)
4015                 {
4016                     specifier_ap->AddLineSpecification (m_options.m_line_end, SymbolContextSpecifier::eLineEndSpecified);
4017                 }
4018 
4019                 if (!m_options.m_function_name.empty())
4020                 {
4021                     specifier_ap->AddSpecification (m_options.m_function_name.c_str(), SymbolContextSpecifier::eFunctionSpecified);
4022                 }
4023             }
4024 
4025             if (specifier_ap.get())
4026                 new_hook_sp->SetSpecifier (specifier_ap.release());
4027 
4028             // Next see if any of the thread options have been entered:
4029 
4030             if (m_options.m_thread_specified)
4031             {
4032                 ThreadSpec *thread_spec = new ThreadSpec();
4033 
4034                 if (m_options.m_thread_id != LLDB_INVALID_THREAD_ID)
4035                 {
4036                     thread_spec->SetTID (m_options.m_thread_id);
4037                 }
4038 
4039                 if (m_options.m_thread_index != UINT32_MAX)
4040                     thread_spec->SetIndex (m_options.m_thread_index);
4041 
4042                 if (!m_options.m_thread_name.empty())
4043                     thread_spec->SetName (m_options.m_thread_name.c_str());
4044 
4045                 if (!m_options.m_queue_name.empty())
4046                     thread_spec->SetQueueName (m_options.m_queue_name.c_str());
4047 
4048                 new_hook_sp->SetThreadSpecifier (thread_spec);
4049 
4050             }
4051             if (m_options.m_use_one_liner)
4052             {
4053                 // Use one-liner.
4054                 new_hook_sp->GetCommandPointer()->AppendString (m_options.m_one_liner.c_str());
4055                 result.AppendMessageWithFormat("Stop hook #%llu added.\n", new_hook_sp->GetID());
4056             }
4057             else
4058             {
4059                 // Otherwise gather up the command list, we'll push an input reader and suck the data from that directly into
4060                 // the new stop hook's command string.
4061                 InputReaderSP reader_sp (new InputReader(m_interpreter.GetDebugger()));
4062                 if (!reader_sp)
4063                 {
4064                     result.AppendError("out of memory\n");
4065                     result.SetStatus (eReturnStatusFailed);
4066                     target->RemoveStopHookByID (new_hook_sp->GetID());
4067                     return false;
4068                 }
4069 
4070                 Error err (reader_sp->Initialize (CommandObjectTargetStopHookAdd::ReadCommandsCallbackFunction,
4071                                                   new_hook_sp.get(), // baton
4072                                                   eInputReaderGranularityLine,  // token size, to pass to callback function
4073                                                   "DONE",                       // end token
4074                                                   "> ",                         // prompt
4075                                                   true));                       // echo input
4076                 if (!err.Success())
4077                 {
4078                     result.AppendError (err.AsCString());
4079                     result.SetStatus (eReturnStatusFailed);
4080                     target->RemoveStopHookByID (new_hook_sp->GetID());
4081                     return false;
4082                 }
4083                 m_interpreter.GetDebugger().PushInputReader (reader_sp);
4084             }
4085             result.SetStatus (eReturnStatusSuccessFinishNoResult);
4086         }
4087         else
4088         {
4089             result.AppendError ("invalid target\n");
4090             result.SetStatus (eReturnStatusFailed);
4091         }
4092 
4093         return result.Succeeded();
4094     }
4095 private:
4096     CommandOptions m_options;
4097 };
4098 
4099 OptionDefinition
4100 CommandObjectTargetStopHookAdd::CommandOptions::g_option_table[] =
4101 {
4102     { LLDB_OPT_SET_ALL, false, "one-liner", 'o', required_argument, NULL, NULL, eArgTypeOneLiner,
4103         "Specify a one-line breakpoint command inline. Be sure to surround it with quotes." },
4104     { LLDB_OPT_SET_ALL, false, "shlib", 's', required_argument, NULL, CommandCompletions::eModuleCompletion, eArgTypeShlibName,
4105         "Set the module within which the stop-hook is to be run."},
4106     { LLDB_OPT_SET_ALL, false, "thread-index", 'x', required_argument, NULL, NULL, eArgTypeThreadIndex,
4107         "The stop hook is run only for the thread whose index matches this argument."},
4108     { LLDB_OPT_SET_ALL, false, "thread-id", 't', required_argument, NULL, NULL, eArgTypeThreadID,
4109         "The stop hook is run only for the thread whose TID matches this argument."},
4110     { LLDB_OPT_SET_ALL, false, "thread-name", 'T', required_argument, NULL, NULL, eArgTypeThreadName,
4111         "The stop hook is run only for the thread whose thread name matches this argument."},
4112     { LLDB_OPT_SET_ALL, false, "queue-name", 'q', required_argument, NULL, NULL, eArgTypeQueueName,
4113         "The stop hook is run only for threads in the queue whose name is given by this argument."},
4114     { LLDB_OPT_SET_1, false, "file", 'f', required_argument, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename,
4115         "Specify the source file within which the stop-hook is to be run." },
4116     { LLDB_OPT_SET_1, false, "start-line", 'l', required_argument, NULL, 0, eArgTypeLineNum,
4117         "Set the start of the line range for which the stop-hook is to be run."},
4118     { LLDB_OPT_SET_1, false, "end-line", 'e', required_argument, NULL, 0, eArgTypeLineNum,
4119         "Set the end of the line range for which the stop-hook is to be run."},
4120     { LLDB_OPT_SET_2, false, "classname", 'c', required_argument, NULL, NULL, eArgTypeClassName,
4121         "Specify the class within which the stop-hook is to be run." },
4122     { LLDB_OPT_SET_3, false, "name", 'n', required_argument, NULL, CommandCompletions::eSymbolCompletion, eArgTypeFunctionName,
4123         "Set the function name within which the stop hook will be run." },
4124     { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
4125 };
4126 
4127 #pragma mark CommandObjectTargetStopHookDelete
4128 
4129 //-------------------------------------------------------------------------
4130 // CommandObjectTargetStopHookDelete
4131 //-------------------------------------------------------------------------
4132 
4133 class CommandObjectTargetStopHookDelete : public CommandObject
4134 {
4135 public:
4136 
4137     CommandObjectTargetStopHookDelete (CommandInterpreter &interpreter) :
4138         CommandObject (interpreter,
4139                        "target stop-hook delete",
4140                        "Delete a stop-hook.",
4141                        "target stop-hook delete [<idx>]")
4142     {
4143     }
4144 
4145     ~CommandObjectTargetStopHookDelete ()
4146     {
4147     }
4148 
4149     bool
4150     Execute (Args& command,
4151              CommandReturnObject &result)
4152     {
4153         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
4154         if (target)
4155         {
4156             // FIXME: see if we can use the breakpoint id style parser?
4157             size_t num_args = command.GetArgumentCount();
4158             if (num_args == 0)
4159             {
4160                 if (!m_interpreter.Confirm ("Delete all stop hooks?", true))
4161                 {
4162                     result.SetStatus (eReturnStatusFailed);
4163                     return false;
4164                 }
4165                 else
4166                 {
4167                     target->RemoveAllStopHooks();
4168                 }
4169             }
4170             else
4171             {
4172                 bool success;
4173                 for (size_t i = 0; i < num_args; i++)
4174                 {
4175                     lldb::user_id_t user_id = Args::StringToUInt32 (command.GetArgumentAtIndex(i), 0, 0, &success);
4176                     if (!success)
4177                     {
4178                         result.AppendErrorWithFormat ("invalid stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
4179                         result.SetStatus(eReturnStatusFailed);
4180                         return false;
4181                     }
4182                     success = target->RemoveStopHookByID (user_id);
4183                     if (!success)
4184                     {
4185                         result.AppendErrorWithFormat ("unknown stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
4186                         result.SetStatus(eReturnStatusFailed);
4187                         return false;
4188                     }
4189                 }
4190             }
4191             result.SetStatus (eReturnStatusSuccessFinishNoResult);
4192         }
4193         else
4194         {
4195             result.AppendError ("invalid target\n");
4196             result.SetStatus (eReturnStatusFailed);
4197         }
4198 
4199         return result.Succeeded();
4200     }
4201 };
4202 #pragma mark CommandObjectTargetStopHookEnableDisable
4203 
4204 //-------------------------------------------------------------------------
4205 // CommandObjectTargetStopHookEnableDisable
4206 //-------------------------------------------------------------------------
4207 
4208 class CommandObjectTargetStopHookEnableDisable : public CommandObject
4209 {
4210 public:
4211 
4212     CommandObjectTargetStopHookEnableDisable (CommandInterpreter &interpreter, bool enable, const char *name, const char *help, const char *syntax) :
4213         CommandObject (interpreter,
4214                        name,
4215                        help,
4216                        syntax),
4217         m_enable (enable)
4218     {
4219     }
4220 
4221     ~CommandObjectTargetStopHookEnableDisable ()
4222     {
4223     }
4224 
4225     bool
4226     Execute (Args& command,
4227              CommandReturnObject &result)
4228     {
4229         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
4230         if (target)
4231         {
4232             // FIXME: see if we can use the breakpoint id style parser?
4233             size_t num_args = command.GetArgumentCount();
4234             bool success;
4235 
4236             if (num_args == 0)
4237             {
4238                 target->SetAllStopHooksActiveState (m_enable);
4239             }
4240             else
4241             {
4242                 for (size_t i = 0; i < num_args; i++)
4243                 {
4244                     lldb::user_id_t user_id = Args::StringToUInt32 (command.GetArgumentAtIndex(i), 0, 0, &success);
4245                     if (!success)
4246                     {
4247                         result.AppendErrorWithFormat ("invalid stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
4248                         result.SetStatus(eReturnStatusFailed);
4249                         return false;
4250                     }
4251                     success = target->SetStopHookActiveStateByID (user_id, m_enable);
4252                     if (!success)
4253                     {
4254                         result.AppendErrorWithFormat ("unknown stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
4255                         result.SetStatus(eReturnStatusFailed);
4256                         return false;
4257                     }
4258                 }
4259             }
4260             result.SetStatus (eReturnStatusSuccessFinishNoResult);
4261         }
4262         else
4263         {
4264             result.AppendError ("invalid target\n");
4265             result.SetStatus (eReturnStatusFailed);
4266         }
4267         return result.Succeeded();
4268     }
4269 private:
4270     bool m_enable;
4271 };
4272 
4273 #pragma mark CommandObjectTargetStopHookList
4274 
4275 //-------------------------------------------------------------------------
4276 // CommandObjectTargetStopHookList
4277 //-------------------------------------------------------------------------
4278 
4279 class CommandObjectTargetStopHookList : public CommandObject
4280 {
4281 public:
4282 
4283     CommandObjectTargetStopHookList (CommandInterpreter &interpreter) :
4284         CommandObject (interpreter,
4285                        "target stop-hook list",
4286                        "List all stop-hooks.",
4287                        "target stop-hook list [<type>]")
4288     {
4289     }
4290 
4291     ~CommandObjectTargetStopHookList ()
4292     {
4293     }
4294 
4295     bool
4296     Execute (Args& command,
4297              CommandReturnObject &result)
4298     {
4299         Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
4300         if (!target)
4301         {
4302             result.AppendError ("invalid target\n");
4303             result.SetStatus (eReturnStatusFailed);
4304             return result.Succeeded();
4305         }
4306 
4307         size_t num_hooks = target->GetNumStopHooks ();
4308         if (num_hooks == 0)
4309         {
4310             result.GetOutputStream().PutCString ("No stop hooks.\n");
4311         }
4312         else
4313         {
4314             for (size_t i = 0; i < num_hooks; i++)
4315             {
4316                 Target::StopHookSP this_hook = target->GetStopHookAtIndex (i);
4317                 if (i > 0)
4318                     result.GetOutputStream().PutCString ("\n");
4319                 this_hook->GetDescription (&(result.GetOutputStream()), eDescriptionLevelFull);
4320             }
4321         }
4322         result.SetStatus (eReturnStatusSuccessFinishResult);
4323         return result.Succeeded();
4324     }
4325 };
4326 
4327 #pragma mark CommandObjectMultiwordTargetStopHooks
4328 //-------------------------------------------------------------------------
4329 // CommandObjectMultiwordTargetStopHooks
4330 //-------------------------------------------------------------------------
4331 
4332 class CommandObjectMultiwordTargetStopHooks : public CommandObjectMultiword
4333 {
4334 public:
4335 
4336     CommandObjectMultiwordTargetStopHooks (CommandInterpreter &interpreter) :
4337         CommandObjectMultiword (interpreter,
4338                                 "target stop-hook",
4339                                 "A set of commands for operating on debugger target stop-hooks.",
4340                                 "target stop-hook <subcommand> [<subcommand-options>]")
4341     {
4342         LoadSubCommand ("add",      CommandObjectSP (new CommandObjectTargetStopHookAdd (interpreter)));
4343         LoadSubCommand ("delete",   CommandObjectSP (new CommandObjectTargetStopHookDelete (interpreter)));
4344         LoadSubCommand ("disable",  CommandObjectSP (new CommandObjectTargetStopHookEnableDisable (interpreter,
4345                                                                                                    false,
4346                                                                                                    "target stop-hook disable [<id>]",
4347                                                                                                    "Disable a stop-hook.",
4348                                                                                                    "target stop-hook disable")));
4349         LoadSubCommand ("enable",   CommandObjectSP (new CommandObjectTargetStopHookEnableDisable (interpreter,
4350                                                                                                    true,
4351                                                                                                    "target stop-hook enable [<id>]",
4352                                                                                                    "Enable a stop-hook.",
4353                                                                                                    "target stop-hook enable")));
4354         LoadSubCommand ("list",     CommandObjectSP (new CommandObjectTargetStopHookList (interpreter)));
4355     }
4356 
4357     ~CommandObjectMultiwordTargetStopHooks()
4358     {
4359     }
4360 };
4361 
4362 
4363 
4364 #pragma mark CommandObjectMultiwordTarget
4365 
4366 //-------------------------------------------------------------------------
4367 // CommandObjectMultiwordTarget
4368 //-------------------------------------------------------------------------
4369 
4370 CommandObjectMultiwordTarget::CommandObjectMultiwordTarget (CommandInterpreter &interpreter) :
4371     CommandObjectMultiword (interpreter,
4372                             "target",
4373                             "A set of commands for operating on debugger targets.",
4374                             "target <subcommand> [<subcommand-options>]")
4375 {
4376 
4377     LoadSubCommand ("create",    CommandObjectSP (new CommandObjectTargetCreate (interpreter)));
4378     LoadSubCommand ("delete",    CommandObjectSP (new CommandObjectTargetDelete (interpreter)));
4379     LoadSubCommand ("list",      CommandObjectSP (new CommandObjectTargetList   (interpreter)));
4380     LoadSubCommand ("select",    CommandObjectSP (new CommandObjectTargetSelect (interpreter)));
4381     LoadSubCommand ("stop-hook", CommandObjectSP (new CommandObjectMultiwordTargetStopHooks (interpreter)));
4382     LoadSubCommand ("modules",   CommandObjectSP (new CommandObjectTargetModules (interpreter)));
4383     LoadSubCommand ("symbols",   CommandObjectSP (new CommandObjectTargetSymbols (interpreter)));
4384     LoadSubCommand ("variable",  CommandObjectSP (new CommandObjectTargetVariable (interpreter)));
4385 }
4386 
4387 CommandObjectMultiwordTarget::~CommandObjectMultiwordTarget ()
4388 {
4389 }
4390 
4391 
4392