blob: e396a8b27e3e723028b8033a500647301661f49b [file] [log] [blame]
Chris Lattner24943d22010-06-08 16:52:24 +00001//===-- 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>
Greg Clayton81040f42011-02-01 01:13:32 +000014
Chris Lattner24943d22010-06-08 16:52:24 +000015// C++ Includes
16// Other libraries and framework includes
17// Project includes
Jim Ingham84cdc152010-06-15 19:49:27 +000018#include "lldb/Interpreter/Args.h"
Chris Lattner24943d22010-06-08 16:52:24 +000019#include "lldb/Core/Debugger.h"
Jim Inghamd60d94a2011-03-11 03:53:59 +000020#include "lldb/Core/InputReader.h"
Greg Claytone1f50b92011-05-03 22:09:39 +000021#include "lldb/Core/Section.h"
Greg Claytonabe0fed2011-04-18 08:33:37 +000022#include "lldb/Core/State.h"
Chris Lattner24943d22010-06-08 16:52:24 +000023#include "lldb/Core/Timer.h"
Greg Clayton801417e2011-07-07 01:59:51 +000024#include "lldb/Core/ValueObjectVariable.h"
Chris Lattner24943d22010-06-08 16:52:24 +000025#include "lldb/Interpreter/CommandInterpreter.h"
26#include "lldb/Interpreter/CommandReturnObject.h"
Greg Claytone1f50b92011-05-03 22:09:39 +000027#include "lldb/Interpreter/Options.h"
Greg Claytonabe0fed2011-04-18 08:33:37 +000028#include "lldb/Interpreter/OptionGroupArchitecture.h"
Greg Clayton5beb99d2011-08-11 02:48:45 +000029#include "lldb/Interpreter/OptionGroupBoolean.h"
Greg Claytone1f50b92011-05-03 22:09:39 +000030#include "lldb/Interpreter/OptionGroupFile.h"
Greg Claytona42880a2011-10-25 06:44:01 +000031#include "lldb/Interpreter/OptionGroupFormat.h"
Greg Clayton368f8222011-07-07 04:38:25 +000032#include "lldb/Interpreter/OptionGroupVariable.h"
Greg Claytonabe0fed2011-04-18 08:33:37 +000033#include "lldb/Interpreter/OptionGroupPlatform.h"
Greg Claytone1f50b92011-05-03 22:09:39 +000034#include "lldb/Interpreter/OptionGroupUInt64.h"
35#include "lldb/Interpreter/OptionGroupUUID.h"
Greg Clayton801417e2011-07-07 01:59:51 +000036#include "lldb/Interpreter/OptionGroupValueObjectDisplay.h"
Greg Claytone1f50b92011-05-03 22:09:39 +000037#include "lldb/Symbol/LineTable.h"
38#include "lldb/Symbol/ObjectFile.h"
39#include "lldb/Symbol/SymbolFile.h"
40#include "lldb/Symbol/SymbolVendor.h"
Greg Clayton801417e2011-07-07 01:59:51 +000041#include "lldb/Symbol/VariableList.h"
Chris Lattner24943d22010-06-08 16:52:24 +000042#include "lldb/Target/Process.h"
43#include "lldb/Target/StackFrame.h"
44#include "lldb/Target/Thread.h"
Jim Inghamd60d94a2011-03-11 03:53:59 +000045#include "lldb/Target/ThreadSpec.h"
Chris Lattner24943d22010-06-08 16:52:24 +000046
47using namespace lldb;
48using namespace lldb_private;
49
Greg Claytonabe0fed2011-04-18 08:33:37 +000050
51
52static void
53DumpTargetInfo (uint32_t target_idx, Target *target, const char *prefix_cstr, bool show_stopped_process_status, Stream &strm)
54{
Greg Clayton52c8b6e2011-04-19 04:19:37 +000055 const ArchSpec &target_arch = target->GetArchitecture();
Greg Claytonabe0fed2011-04-18 08:33:37 +000056
Greg Clayton5beb99d2011-08-11 02:48:45 +000057 Module *exe_module = target->GetExecutableModulePointer();
Greg Claytonabe0fed2011-04-18 08:33:37 +000058 char exe_path[PATH_MAX];
59 bool exe_valid = false;
Greg Clayton5beb99d2011-08-11 02:48:45 +000060 if (exe_module)
61 exe_valid = exe_module->GetFileSpec().GetPath (exe_path, sizeof(exe_path));
Greg Claytonabe0fed2011-04-18 08:33:37 +000062
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)
Greg Clayton20206082011-11-17 01:23:07 +000085 show_process_status = StateIsStoppedState(state, true);
Greg Claytonabe0fed2011-04-18 08:33:37 +000086 const char *state_cstr = StateAsCString (state);
87 if (pid != LLDB_INVALID_PROCESS_ID)
Greg Claytond9919d32011-12-01 23:28:38 +000088 strm.Printf ("%spid=%llu", properties++ > 0 ? ", " : " ( ", pid);
Greg Claytonabe0fed2011-04-18 08:33:37 +000089 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
111static uint32_t
112DumpTargetList (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
141class CommandObjectTargetCreate : public CommandObject
142{
143public:
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),
Greg Clayton801417e2011-07-07 01:59:51 +0000150 m_arch_option (),
Greg Clayton46c9a352012-02-09 06:16:32 +0000151 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.")
Greg Claytonabe0fed2011-04-18 08:33:37 +0000153 {
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
Greg Clayton801417e2011-07-07 01:59:51 +0000167 m_option_group.Append (&m_arch_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
Greg Claytonabe0fed2011-04-18 08:33:37 +0000168 m_option_group.Append (&m_platform_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
Greg Clayton46c9a352012-02-09 06:16:32 +0000169 m_option_group.Append (&m_core_file, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
Greg Claytonabe0fed2011-04-18 08:33:37 +0000170 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();
Greg Clayton46c9a352012-02-09 06:16:32 +0000187 FileSpec core_file (m_core_file.GetOptionValue().GetCurrentValue());
188
189 if (argc == 1 || core_file)
Greg Claytonabe0fed2011-04-18 08:33:37 +0000190 {
191 const char *file_path = command.GetArgumentAtIndex(0);
192 Timer scoped_timer(__PRETTY_FUNCTION__, "(lldb) target create '%s'", file_path);
Greg Clayton46c9a352012-02-09 06:16:32 +0000193 FileSpec file_spec;
194
195 if (file_path)
196 file_spec.SetFile (file_path, true);
Greg Clayton3e8c25f2011-09-24 00:52:29 +0000197
Greg Claytonabe0fed2011-04-18 08:33:37 +0000198 TargetSP target_sp;
199 Debugger &debugger = m_interpreter.GetDebugger();
Greg Clayton3e8c25f2011-09-24 00:52:29 +0000200 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
Greg Claytonabe0fed2011-04-18 08:33:37 +0000209 if (target_sp)
210 {
211 debugger.GetTargetList().SetSelectedTarget(target_sp.get());
Greg Clayton46c9a352012-02-09 06:16:32 +0000212 if (core_file)
213 {
Greg Clayton46c9a352012-02-09 06:16:32 +0000214 char core_path[PATH_MAX];
215 core_file.GetPath(core_path, sizeof(core_path));
Greg Clayton9ce95382012-02-13 23:10:39 +0000216 if (core_file.Exists())
Greg Clayton46c9a352012-02-09 06:16:32 +0000217 {
Greg Clayton9ce95382012-02-13 23:10:39 +0000218 FileSpec core_file_dir;
219 core_file_dir.GetDirectory() = core_file.GetDirectory();
220 target_sp->GetExecutableSearchPaths ().Append (core_file_dir);
Greg Clayton46c9a352012-02-09 06:16:32 +0000221
Greg Clayton9ce95382012-02-13 23:10:39 +0000222 ProcessSP process_sp (target_sp->CreateProcess (m_interpreter.GetDebugger().GetListener(), NULL, &core_file));
223
224 if (process_sp)
Greg Clayton46c9a352012-02-09 06:16:32 +0000225 {
Greg Clayton9ce95382012-02-13 23:10:39 +0000226 // 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 }
Greg Clayton46c9a352012-02-09 06:16:32 +0000241 }
242 else
243 {
Greg Clayton9ce95382012-02-13 23:10:39 +0000244 result.AppendErrorWithFormat ("Unable to find process plug-in for core file '%s'\n", core_path);
245 result.SetStatus (eReturnStatusFailed);
Greg Clayton46c9a352012-02-09 06:16:32 +0000246 }
247 }
248 else
249 {
Greg Clayton9ce95382012-02-13 23:10:39 +0000250 result.AppendErrorWithFormat ("Core file '%s' does not exist\n", core_path);
Greg Clayton46c9a352012-02-09 06:16:32 +0000251 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 }
Greg Claytonabe0fed2011-04-18 08:33:37 +0000259 }
260 else
261 {
262 result.AppendError(error.AsCString());
263 result.SetStatus (eReturnStatusFailed);
264 }
265 }
266 else
267 {
Greg Clayton46c9a352012-02-09 06:16:32 +0000268 result.AppendErrorWithFormat("'%s' takes exactly one executable path argument, or use the --core-file option.\n", m_cmd_name.c_str());
Greg Claytonabe0fed2011-04-18 08:33:37 +0000269 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 }
298private:
299 OptionGroupOptions m_option_group;
Greg Clayton801417e2011-07-07 01:59:51 +0000300 OptionGroupArchitecture m_arch_option;
Greg Claytonabe0fed2011-04-18 08:33:37 +0000301 OptionGroupPlatform m_platform_options;
Greg Clayton46c9a352012-02-09 06:16:32 +0000302 OptionGroupFile m_core_file;
Greg Claytonabe0fed2011-04-18 08:33:37 +0000303
304};
305
306#pragma mark CommandObjectTargetList
307
308//----------------------------------------------------------------------
309// "target list"
310//----------------------------------------------------------------------
311
312class CommandObjectTargetList : public CommandObject
313{
314public:
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 }
Johnny Chen44dc9d32011-04-18 21:08:05 +0000341 result.SetStatus (eReturnStatusSuccessFinishResult);
Greg Claytonabe0fed2011-04-18 08:33:37 +0000342 }
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
359class CommandObjectTargetSelect : public CommandObject
360{
361public:
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);
Johnny Chen44dc9d32011-04-18 21:08:05 +0000397 result.SetStatus (eReturnStatusSuccessFinishResult);
Greg Claytonabe0fed2011-04-18 08:33:37 +0000398 }
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
Greg Clayton153ccd72011-08-10 02:10:13 +0000428#pragma mark CommandObjectTargetSelect
429
430//----------------------------------------------------------------------
431// "target delete"
432//----------------------------------------------------------------------
433
434class CommandObjectTargetDelete : public CommandObject
435{
436public:
437 CommandObjectTargetDelete (CommandInterpreter &interpreter) :
Greg Clayton5beb99d2011-08-11 02:48:45 +0000438 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)
Greg Clayton153ccd72011-08-10 02:10:13 +0000445 {
Greg Clayton5beb99d2011-08-11 02:48:45 +0000446 m_option_group.Append (&m_cleanup_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
447 m_option_group.Finalize();
Greg Clayton153ccd72011-08-10 02:10:13 +0000448 }
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 }
Greg Clayton5beb99d2011-08-11 02:48:45 +0000519 // 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 }
Greg Clayton153ccd72011-08-10 02:10:13 +0000525 result.GetOutputStream().Printf("%u targets deleted.\n", (uint32_t)num_targets_to_delete);
526 result.SetStatus(eReturnStatusSuccessFinishResult);
527 }
528
529 return result.Succeeded();
530 }
Greg Clayton5beb99d2011-08-11 02:48:45 +0000531
532 Options *
533 GetOptions ()
534 {
535 return &m_option_group;
536 }
537
538protected:
539 OptionGroupOptions m_option_group;
540 OptionGroupBoolean m_cleanup_option;
Greg Clayton153ccd72011-08-10 02:10:13 +0000541};
542
Greg Claytonabe0fed2011-04-18 08:33:37 +0000543
Greg Clayton801417e2011-07-07 01:59:51 +0000544#pragma mark CommandObjectTargetVariable
545
546//----------------------------------------------------------------------
547// "target variable"
548//----------------------------------------------------------------------
549
550class CommandObjectTargetVariable : public CommandObject
551{
552public:
553 CommandObjectTargetVariable (CommandInterpreter &interpreter) :
554 CommandObject (interpreter,
Johnny Chen34bfa4f2011-07-12 22:34:30 +0000555 "target variable",
556 "Read global variable(s) prior to running your binary.",
Greg Clayton801417e2011-07-07 01:59:51 +0000557 NULL,
558 0),
559 m_option_group (interpreter),
Greg Clayton368f8222011-07-07 04:38:25 +0000560 m_option_variable (false), // Don't include frame options
Greg Claytona42880a2011-10-25 06:44:01 +0000561 m_option_format (eFormatDefault),
Greg Clayton801417e2011-07-07 01:59:51 +0000562 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 {
Johnny Chen24b81e32011-08-22 22:22:00 +0000566 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
Greg Clayton801417e2011-07-07 01:59:51 +0000579 m_option_group.Append (&m_varobj_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
Greg Clayton368f8222011-07-07 04:38:25 +0000580 m_option_group.Append (&m_option_variable, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
Greg Clayton24a6bd92011-10-27 17:55:14 +0000581 m_option_group.Append (&m_option_format, OptionGroupFormat::OPTION_GROUP_FORMAT | OptionGroupFormat::OPTION_GROUP_GDB_FMT, LLDB_OPT_SET_1);
Greg Clayton801417e2011-07-07 01:59:51 +0000582 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 }
Greg Clayton5d81f492011-07-08 21:46:14 +0000591
592 void
593 DumpValueObject (Stream &s, VariableSP &var_sp, ValueObjectSP &valobj_sp, const char *root_name)
594 {
Enrico Granata19030d82011-08-15 18:01:31 +0000595 ValueObject::DumpValueObjectOptions options;
596
597 options.SetPointerDepth(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
Greg Clayton5d81f492011-07-08 21:46:14 +0000608 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
Greg Claytonfb816422011-07-10 19:21:23 +0000634 if (m_option_variable.show_decl)
Greg Clayton5d81f492011-07-08 21:46:14 +0000635 {
Greg Claytonfb816422011-07-10 19:21:23 +0000636 bool show_fullpaths = false;
637 bool show_module = true;
638 if (var_sp->DumpDeclaration(&s, show_fullpaths, show_module))
639 s.PutCString (": ");
Greg Clayton5d81f492011-07-08 21:46:14 +0000640 }
641
Greg Claytona42880a2011-10-25 06:44:01 +0000642 const Format format = m_option_format.GetFormat();
Greg Clayton5d81f492011-07-08 21:46:14 +0000643 if (format != eFormatDefault)
644 valobj_sp->SetFormat (format);
645
646 ValueObject::DumpValueObject (s,
647 valobj_sp.get(),
648 root_name,
Greg Claytonccf44502012-01-26 21:08:30 +0000649 options,
650 format);
Greg Clayton5d81f492011-07-08 21:46:14 +0000651
652 }
Greg Clayton801417e2011-07-07 01:59:51 +0000653
Greg Clayton5d81f492011-07-08 21:46:14 +0000654
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
Greg Clayton801417e2011-07-07 01:59:51 +0000672 virtual bool
673 Execute (Args& args, CommandReturnObject &result)
674 {
675 ExecutionContext exe_ctx (m_interpreter.GetExecutionContext());
Greg Clayton567e7f32011-09-22 04:58:26 +0000676 Target *target = exe_ctx.GetTargetPtr();
677 if (target)
Greg Clayton801417e2011-07-07 01:59:51 +0000678 {
679 const size_t argc = args.GetArgumentCount();
Greg Claytonfac93882011-10-05 22:17:32 +0000680 Stream &s = result.GetOutputStream();
Greg Clayton801417e2011-07-07 01:59:51 +0000681 if (argc > 0)
682 {
Greg Clayton5d81f492011-07-08 21:46:14 +0000683
Greg Clayton801417e2011-07-07 01:59:51 +0000684 for (size_t idx = 0; idx < argc; ++idx)
685 {
Greg Clayton5d81f492011-07-08 21:46:14 +0000686 VariableList variable_list;
687 ValueObjectList valobj_list;
688
Greg Clayton368f8222011-07-07 04:38:25 +0000689 const char *arg = args.GetArgumentAtIndex(idx);
690 uint32_t matches = 0;
Greg Claytonfb816422011-07-10 19:21:23 +0000691 bool use_var_name = false;
Greg Clayton368f8222011-07-07 04:38:25 +0000692 if (m_option_variable.use_regex)
Greg Clayton801417e2011-07-07 01:59:51 +0000693 {
Greg Clayton368f8222011-07-07 04:38:25 +0000694 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 }
Greg Claytonfb816422011-07-10 19:21:23 +0000701 use_var_name = true;
Greg Clayton567e7f32011-09-22 04:58:26 +0000702 matches = target->GetImages().FindGlobalVariables (regex,
703 true,
704 UINT32_MAX,
705 variable_list);
Greg Clayton801417e2011-07-07 01:59:51 +0000706 }
707 else
708 {
Greg Clayton5d81f492011-07-08 21:46:14 +0000709 Error error (Variable::GetValuesForVariableExpressionPath (arg,
Greg Clayton24b03102011-07-09 20:12:33 +0000710 exe_ctx.GetBestExecutionContextScope(),
Greg Clayton5d81f492011-07-08 21:46:14 +0000711 GetVariableCallback,
Greg Clayton567e7f32011-09-22 04:58:26 +0000712 target,
Greg Clayton5d81f492011-07-08 21:46:14 +0000713 variable_list,
714 valobj_list));
Greg Clayton5d81f492011-07-08 21:46:14 +0000715 matches = variable_list.GetSize();
Greg Clayton368f8222011-07-07 04:38:25 +0000716 }
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 {
Greg Clayton801417e2011-07-07 01:59:51 +0000726 for (uint32_t global_idx=0; global_idx<matches; ++global_idx)
727 {
Greg Clayton5d81f492011-07-08 21:46:14 +0000728 VariableSP var_sp (variable_list.GetVariableAtIndex(global_idx));
Greg Clayton801417e2011-07-07 01:59:51 +0000729 if (var_sp)
730 {
Greg Clayton5d81f492011-07-08 21:46:14 +0000731 ValueObjectSP valobj_sp (valobj_list.GetValueObjectAtIndex(global_idx));
732 if (!valobj_sp)
Greg Claytonfb816422011-07-10 19:21:23 +0000733 valobj_sp = ValueObjectVariable::Create (exe_ctx.GetBestExecutionContextScope(), var_sp);
Greg Clayton801417e2011-07-07 01:59:51 +0000734
735 if (valobj_sp)
Greg Claytonb304a742011-10-13 18:31:02 +0000736 DumpValueObject (s, var_sp, valobj_sp, use_var_name ? var_sp->GetName().GetCString() : arg);
Greg Clayton801417e2011-07-07 01:59:51 +0000737 }
738 }
739 }
740 }
741 }
742 else
743 {
Greg Claytonfac93882011-10-05 22:17:32 +0000744 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 {
Greg Claytona1b9a902011-11-13 04:15:56 +0000759 s.Printf ("Global variables for %s/%s:\n",
Greg Claytonfac93882011-10-05 22:17:32 +0000760 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 }
Greg Clayton801417e2011-07-07 01:59:51 +0000794 }
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 }
Enrico Granatadb64d952011-08-12 16:42:31 +0000802
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
Greg Clayton801417e2011-07-07 01:59:51 +0000810 return result.Succeeded();
811 }
812
813 Options *
814 GetOptions ()
815 {
816 return &m_option_group;
817 }
818
819protected:
820 OptionGroupOptions m_option_group;
Greg Clayton368f8222011-07-07 04:38:25 +0000821 OptionGroupVariable m_option_variable;
Greg Claytona42880a2011-10-25 06:44:01 +0000822 OptionGroupFormat m_option_format;
Greg Clayton801417e2011-07-07 01:59:51 +0000823 OptionGroupFileList m_option_compile_units;
824 OptionGroupFileList m_option_shared_libraries;
825 OptionGroupValueObjectDisplay m_varobj_options;
826
827};
828
829
Greg Claytone1f50b92011-05-03 22:09:39 +0000830#pragma mark CommandObjectTargetModulesSearchPathsAdd
Chris Lattner24943d22010-06-08 16:52:24 +0000831
Greg Claytone1f50b92011-05-03 22:09:39 +0000832class CommandObjectTargetModulesSearchPathsAdd : public CommandObject
Chris Lattner24943d22010-06-08 16:52:24 +0000833{
834public:
835
Greg Claytone1f50b92011-05-03 22:09:39 +0000836 CommandObjectTargetModulesSearchPathsAdd (CommandInterpreter &interpreter) :
Greg Clayton238c0a12010-09-18 01:14:36 +0000837 CommandObject (interpreter,
Greg Claytone1f50b92011-05-03 22:09:39 +0000838 "target modules search-paths add",
Chris Lattner24943d22010-06-08 16:52:24 +0000839 "Add new image search paths substitution pairs to the current target.",
Caroline Tice43b014a2010-10-04 22:28:36 +0000840 NULL)
Chris Lattner24943d22010-06-08 16:52:24 +0000841 {
Caroline Tice43b014a2010-10-04 22:28:36 +0000842 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);
Chris Lattner24943d22010-06-08 16:52:24 +0000862 }
863
Greg Claytone1f50b92011-05-03 22:09:39 +0000864 ~CommandObjectTargetModulesSearchPathsAdd ()
Chris Lattner24943d22010-06-08 16:52:24 +0000865 {
866 }
867
868 bool
Greg Clayton238c0a12010-09-18 01:14:36 +0000869 Execute (Args& command,
Chris Lattner24943d22010-06-08 16:52:24 +0000870 CommandReturnObject &result)
871 {
Greg Clayton238c0a12010-09-18 01:14:36 +0000872 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
Chris Lattner24943d22010-06-08 16:52:24 +0000873 if (target)
874 {
875 uint32_t argc = command.GetArgumentCount();
876 if (argc & 1)
877 {
Greg Claytonabe0fed2011-04-18 08:33:37 +0000878 result.AppendError ("add requires an even number of arguments\n");
Chris Lattner24943d22010-06-08 16:52:24 +0000879 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);
Greg Clayton63094e02010-06-23 01:19:29 +0000891 target->GetImageSearchPathList().Append (ConstString(from),
892 ConstString(to),
893 last_pair); // Notify if this is the last pair
Johnny Chen4d661352011-02-03 00:30:19 +0000894 result.SetStatus (eReturnStatusSuccessFinishNoResult);
Chris Lattner24943d22010-06-08 16:52:24 +0000895 }
896 else
897 {
898 if (from[0])
Greg Claytonabe0fed2011-04-18 08:33:37 +0000899 result.AppendError ("<path-prefix> can't be empty\n");
Chris Lattner24943d22010-06-08 16:52:24 +0000900 else
Greg Claytonabe0fed2011-04-18 08:33:37 +0000901 result.AppendError ("<new-path-prefix> can't be empty\n");
Chris Lattner24943d22010-06-08 16:52:24 +0000902 result.SetStatus (eReturnStatusFailed);
903 }
904 }
905 }
906 }
907 else
908 {
Greg Claytonabe0fed2011-04-18 08:33:37 +0000909 result.AppendError ("invalid target\n");
Chris Lattner24943d22010-06-08 16:52:24 +0000910 result.SetStatus (eReturnStatusFailed);
911 }
912 return result.Succeeded();
913 }
914};
915
Greg Claytone1f50b92011-05-03 22:09:39 +0000916#pragma mark CommandObjectTargetModulesSearchPathsClear
917
918class CommandObjectTargetModulesSearchPathsClear : public CommandObject
Chris Lattner24943d22010-06-08 16:52:24 +0000919{
920public:
921
Greg Claytone1f50b92011-05-03 22:09:39 +0000922 CommandObjectTargetModulesSearchPathsClear (CommandInterpreter &interpreter) :
Greg Clayton238c0a12010-09-18 01:14:36 +0000923 CommandObject (interpreter,
Greg Claytone1f50b92011-05-03 22:09:39 +0000924 "target modules search-paths clear",
Caroline Ticeabb507a2010-09-08 21:06:11 +0000925 "Clear all current image search path substitution pairs from the current target.",
Greg Claytone1f50b92011-05-03 22:09:39 +0000926 "target modules search-paths clear")
Chris Lattner24943d22010-06-08 16:52:24 +0000927 {
928 }
929
Greg Claytone1f50b92011-05-03 22:09:39 +0000930 ~CommandObjectTargetModulesSearchPathsClear ()
Chris Lattner24943d22010-06-08 16:52:24 +0000931 {
932 }
933
934 bool
Greg Clayton238c0a12010-09-18 01:14:36 +0000935 Execute (Args& command,
Chris Lattner24943d22010-06-08 16:52:24 +0000936 CommandReturnObject &result)
937 {
Greg Clayton238c0a12010-09-18 01:14:36 +0000938 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
Chris Lattner24943d22010-06-08 16:52:24 +0000939 if (target)
940 {
941 bool notify = true;
942 target->GetImageSearchPathList().Clear(notify);
Johnny Chen4d661352011-02-03 00:30:19 +0000943 result.SetStatus (eReturnStatusSuccessFinishNoResult);
Chris Lattner24943d22010-06-08 16:52:24 +0000944 }
945 else
946 {
Greg Claytonabe0fed2011-04-18 08:33:37 +0000947 result.AppendError ("invalid target\n");
Chris Lattner24943d22010-06-08 16:52:24 +0000948 result.SetStatus (eReturnStatusFailed);
949 }
950 return result.Succeeded();
951 }
952};
953
Greg Claytone1f50b92011-05-03 22:09:39 +0000954#pragma mark CommandObjectTargetModulesSearchPathsInsert
955
956class CommandObjectTargetModulesSearchPathsInsert : public CommandObject
Chris Lattner24943d22010-06-08 16:52:24 +0000957{
958public:
959
Greg Claytone1f50b92011-05-03 22:09:39 +0000960 CommandObjectTargetModulesSearchPathsInsert (CommandInterpreter &interpreter) :
Greg Clayton238c0a12010-09-18 01:14:36 +0000961 CommandObject (interpreter,
Greg Claytone1f50b92011-05-03 22:09:39 +0000962 "target modules search-paths insert",
Caroline Ticeabb507a2010-09-08 21:06:11 +0000963 "Insert a new image search path substitution pair into the current target at the specified index.",
Caroline Tice43b014a2010-10-04 22:28:36 +0000964 NULL)
Chris Lattner24943d22010-06-08 16:52:24 +0000965 {
Caroline Tice43b014a2010-10-04 22:28:36 +0000966 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);
Chris Lattner24943d22010-06-08 16:52:24 +0000997 }
998
Greg Claytone1f50b92011-05-03 22:09:39 +0000999 ~CommandObjectTargetModulesSearchPathsInsert ()
Chris Lattner24943d22010-06-08 16:52:24 +00001000 {
1001 }
1002
1003 bool
Greg Clayton238c0a12010-09-18 01:14:36 +00001004 Execute (Args& command,
Chris Lattner24943d22010-06-08 16:52:24 +00001005 CommandReturnObject &result)
1006 {
Greg Clayton238c0a12010-09-18 01:14:36 +00001007 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
Chris Lattner24943d22010-06-08 16:52:24 +00001008 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);
Johnny Chen4d661352011-02-03 00:30:19 +00001041 result.SetStatus (eReturnStatusSuccessFinishNoResult);
Chris Lattner24943d22010-06-08 16:52:24 +00001042 }
1043 else
1044 {
1045 if (from[0])
Greg Claytonabe0fed2011-04-18 08:33:37 +00001046 result.AppendError ("<path-prefix> can't be empty\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001047 else
Greg Claytonabe0fed2011-04-18 08:33:37 +00001048 result.AppendError ("<new-path-prefix> can't be empty\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001049 result.SetStatus (eReturnStatusFailed);
1050 return false;
1051 }
1052 }
1053 }
1054 else
1055 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00001056 result.AppendError ("insert requires at least three arguments\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001057 result.SetStatus (eReturnStatusFailed);
1058 return result.Succeeded();
1059 }
1060
1061 }
1062 else
1063 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00001064 result.AppendError ("invalid target\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001065 result.SetStatus (eReturnStatusFailed);
1066 }
1067 return result.Succeeded();
1068 }
1069};
1070
Greg Claytone1f50b92011-05-03 22:09:39 +00001071
1072#pragma mark CommandObjectTargetModulesSearchPathsList
1073
1074
1075class CommandObjectTargetModulesSearchPathsList : public CommandObject
Chris Lattner24943d22010-06-08 16:52:24 +00001076{
1077public:
1078
Greg Claytone1f50b92011-05-03 22:09:39 +00001079 CommandObjectTargetModulesSearchPathsList (CommandInterpreter &interpreter) :
Greg Clayton238c0a12010-09-18 01:14:36 +00001080 CommandObject (interpreter,
Greg Claytone1f50b92011-05-03 22:09:39 +00001081 "target modules search-paths list",
Caroline Ticeabb507a2010-09-08 21:06:11 +00001082 "List all current image search path substitution pairs in the current target.",
Greg Claytone1f50b92011-05-03 22:09:39 +00001083 "target modules search-paths list")
Chris Lattner24943d22010-06-08 16:52:24 +00001084 {
1085 }
1086
Greg Claytone1f50b92011-05-03 22:09:39 +00001087 ~CommandObjectTargetModulesSearchPathsList ()
Chris Lattner24943d22010-06-08 16:52:24 +00001088 {
1089 }
1090
1091 bool
Greg Clayton238c0a12010-09-18 01:14:36 +00001092 Execute (Args& command,
Chris Lattner24943d22010-06-08 16:52:24 +00001093 CommandReturnObject &result)
1094 {
Greg Clayton238c0a12010-09-18 01:14:36 +00001095 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
Chris Lattner24943d22010-06-08 16:52:24 +00001096 if (target)
1097 {
1098 if (command.GetArgumentCount() != 0)
1099 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00001100 result.AppendError ("list takes no arguments\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001101 result.SetStatus (eReturnStatusFailed);
1102 return result.Succeeded();
1103 }
1104
1105 target->GetImageSearchPathList().Dump(&result.GetOutputStream());
Johnny Chen4d661352011-02-03 00:30:19 +00001106 result.SetStatus (eReturnStatusSuccessFinishResult);
Chris Lattner24943d22010-06-08 16:52:24 +00001107 }
1108 else
1109 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00001110 result.AppendError ("invalid target\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001111 result.SetStatus (eReturnStatusFailed);
1112 }
1113 return result.Succeeded();
1114 }
1115};
1116
Greg Claytone1f50b92011-05-03 22:09:39 +00001117#pragma mark CommandObjectTargetModulesSearchPathsQuery
1118
1119class CommandObjectTargetModulesSearchPathsQuery : public CommandObject
Chris Lattner24943d22010-06-08 16:52:24 +00001120{
1121public:
1122
Greg Claytone1f50b92011-05-03 22:09:39 +00001123 CommandObjectTargetModulesSearchPathsQuery (CommandInterpreter &interpreter) :
Greg Clayton238c0a12010-09-18 01:14:36 +00001124 CommandObject (interpreter,
Greg Claytone1f50b92011-05-03 22:09:39 +00001125 "target modules search-paths query",
Caroline Ticeabb507a2010-09-08 21:06:11 +00001126 "Transform a path using the first applicable image search path.",
Caroline Tice43b014a2010-10-04 22:28:36 +00001127 NULL)
Chris Lattner24943d22010-06-08 16:52:24 +00001128 {
Caroline Tice43b014a2010-10-04 22:28:36 +00001129 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);
Chris Lattner24943d22010-06-08 16:52:24 +00001141 }
1142
Greg Claytone1f50b92011-05-03 22:09:39 +00001143 ~CommandObjectTargetModulesSearchPathsQuery ()
Chris Lattner24943d22010-06-08 16:52:24 +00001144 {
1145 }
1146
1147 bool
Greg Clayton238c0a12010-09-18 01:14:36 +00001148 Execute (Args& command,
Chris Lattner24943d22010-06-08 16:52:24 +00001149 CommandReturnObject &result)
1150 {
Greg Clayton238c0a12010-09-18 01:14:36 +00001151 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
Chris Lattner24943d22010-06-08 16:52:24 +00001152 if (target)
1153 {
1154 if (command.GetArgumentCount() != 1)
1155 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00001156 result.AppendError ("query requires one argument\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001157 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());
Johnny Chen4d661352011-02-03 00:30:19 +00001167
1168 result.SetStatus (eReturnStatusSuccessFinishResult);
Chris Lattner24943d22010-06-08 16:52:24 +00001169 }
1170 else
1171 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00001172 result.AppendError ("invalid target\n");
Chris Lattner24943d22010-06-08 16:52:24 +00001173 result.SetStatus (eReturnStatusFailed);
1174 }
1175 return result.Succeeded();
1176 }
1177};
1178
Greg Claytone1f50b92011-05-03 22:09:39 +00001179//----------------------------------------------------------------------
1180// Static Helper functions
1181//----------------------------------------------------------------------
1182static void
1183DumpModuleArchitecture (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
1199static void
1200DumpModuleUUID (Stream &strm, Module *module)
1201{
Greg Clayton153ccd72011-08-10 02:10:13 +00001202 if (module->GetUUID().IsValid())
1203 module->GetUUID().Dump (&strm);
1204 else
1205 strm.PutCString(" ");
Greg Claytone1f50b92011-05-03 22:09:39 +00001206}
1207
1208static uint32_t
1209DumpCompileUnitLineTable
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,
Greg Clayton567e7f32011-09-22 04:58:26 +00001241 interpreter.GetExecutionContext().GetTargetPtr(),
Greg Claytone1f50b92011-05-03 22:09:39 +00001242 lldb::eDescriptionLevelBrief);
1243 else
1244 strm << "No line table";
1245 }
1246 }
1247 }
1248 return num_matches;
1249}
1250
1251static void
1252DumpFullpath (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
1276static void
1277DumpDirectory (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
1292static void
1293DumpBasename (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
1309static void
1310DumpModuleSymtab (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)
Greg Clayton567e7f32011-09-22 04:58:26 +00001319 symtab->Dump(&strm, interpreter.GetExecutionContext().GetTargetPtr(), sort_order);
Greg Claytone1f50b92011-05-03 22:09:39 +00001320 }
1321 }
1322}
1323
1324static void
1325DumpModuleSections (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();
Greg Clayton567e7f32011-09-22 04:58:26 +00001341 section_list->Dump(&strm, interpreter.GetExecutionContext().GetTargetPtr(), true, UINT32_MAX);
Greg Claytone1f50b92011-05-03 22:09:39 +00001342 strm.IndentLess();
1343 }
1344 }
1345 }
1346}
1347
1348static bool
1349DumpModuleSymbolVendor (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
1363static bool
Greg Clayton3508c382012-02-24 01:59:29 +00001364LookupAddressInModule (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)
Greg Claytone1f50b92011-05-03 22:09:39 +00001371{
1372 if (module)
1373 {
1374 lldb::addr_t addr = raw_addr - offset;
1375 Address so_addr;
1376 SymbolContext sc;
Greg Clayton567e7f32011-09-22 04:58:26 +00001377 Target *target = interpreter.GetExecutionContext().GetTargetPtr();
Greg Claytone1f50b92011-05-03 22:09:39 +00001378 if (target && !target->GetSectionLoadList().IsEmpty())
1379 {
1380 if (!target->GetSectionLoadList().ResolveLoadAddress (addr, so_addr))
1381 return false;
Greg Clayton3508c382012-02-24 01:59:29 +00001382 else if (so_addr.GetModule().get() != module)
Greg Claytone1f50b92011-05-03 22:09:39 +00001383 return false;
1384 }
1385 else
1386 {
1387 if (!module->ResolveFileAddress (addr, so_addr))
1388 return false;
1389 }
1390
Greg Claytone1f50b92011-05-03 22:09:39 +00001391 ExecutionContextScope *exe_scope = interpreter.GetExecutionContext().GetBestExecutionContextScope();
1392 strm.IndentMore();
1393 strm.Indent (" Address: ");
Greg Clayton00b11c32012-01-10 00:25:18 +00001394 so_addr.Dump (&strm, exe_scope, Address::DumpStyleModuleWithFileAddress);
1395 strm.PutCString (" (");
Greg Claytone1f50b92011-05-03 22:09:39 +00001396 so_addr.Dump (&strm, exe_scope, Address::DumpStyleSectionNameOffset);
Greg Clayton00b11c32012-01-10 00:25:18 +00001397 strm.PutCString (")\n");
Greg Claytone1f50b92011-05-03 22:09:39 +00001398 strm.Indent (" Summary: ");
1399 const uint32_t save_indent = strm.GetIndentLevel ();
Greg Clayton2f57db02011-10-01 00:45:15 +00001400 strm.SetIndentLevel (save_indent + 13);
Greg Claytone1f50b92011-05-03 22:09:39 +00001401 so_addr.Dump (&strm, exe_scope, Address::DumpStyleResolvedDescription);
1402 strm.SetIndentLevel (save_indent);
Greg Claytone1f50b92011-05-03 22:09:39 +00001403 // Print out detailed address information when verbose is enabled
1404 if (verbose)
1405 {
Greg Clayton2f57db02011-10-01 00:45:15 +00001406 strm.EOL();
Jason Molendafb66bb52011-09-23 00:27:44 +00001407 so_addr.Dump (&strm, exe_scope, Address::DumpStyleDetailedSymbolContext);
Greg Claytone1f50b92011-05-03 22:09:39 +00001408 }
1409 strm.IndentLess();
1410 return true;
1411 }
1412
1413 return false;
1414}
1415
1416static uint32_t
1417LookupSymbolInModule (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 ();
Greg Clayton567e7f32011-09-22 04:58:26 +00001459 symbol->Dump (&strm, interpreter.GetExecutionContext().GetTargetPtr(), i);
Greg Claytone1f50b92011-05-03 22:09:39 +00001460 }
1461 strm.IndentLess ();
1462 return num_matches;
1463 }
1464 }
1465 }
1466 }
1467 return 0;
1468}
1469
1470
1471static void
1472DumpSymbolContextList (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 }
Sean Callanand7793d22012-02-11 00:24:04 +00001497
1498 AddressRange range;
1499
1500 sc.GetAddressRange(eSymbolContextEverything,
1501 0,
1502 true,
1503 range);
1504
Greg Claytone1f50b92011-05-03 22:09:39 +00001505 sc.DumpStopContext(&strm,
1506 exe_scope,
Sean Callanand7793d22012-02-11 00:24:04 +00001507 range.GetBaseAddress(),
Greg Claytone1f50b92011-05-03 22:09:39 +00001508 true,
1509 true,
1510 false);
Sean Callanand7793d22012-02-11 00:24:04 +00001511
Greg Claytone1f50b92011-05-03 22:09:39 +00001512 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
1535static uint32_t
Sean Callanan9ad19532012-02-11 01:22:21 +00001536LookupFunctionInModule (CommandInterpreter &interpreter, Stream &strm, Module *module, const char *name, bool name_is_regex, bool include_inlines, bool verbose)
Greg Claytone1f50b92011-05-03 22:09:39 +00001537{
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,
Sean Callanan302d78c2012-02-10 22:52:19 +00001549 include_inlines,
Greg Claytone1f50b92011-05-03 22:09:39 +00001550 append,
1551 sc_list);
1552 }
1553 else
1554 {
1555 ConstString function_name (name);
Sean Callanan3e80cd92011-10-12 02:08:07 +00001556 num_matches = module->FindFunctions (function_name,
1557 NULL,
Greg Claytone1f50b92011-05-03 22:09:39 +00001558 eFunctionNameTypeBase | eFunctionNameTypeFull | eFunctionNameTypeMethod | eFunctionNameTypeSelector,
1559 include_symbols,
Sean Callanan302d78c2012-02-10 22:52:19 +00001560 include_inlines,
Greg Claytone1f50b92011-05-03 22:09:39 +00001561 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
1578static uint32_t
Greg Clayton801417e2011-07-07 01:59:51 +00001579LookupTypeInModule (CommandInterpreter &interpreter,
1580 Stream &strm,
1581 Module *module,
1582 const char *name_cstr,
1583 bool name_is_regex)
Greg Claytone1f50b92011-05-03 22:09:39 +00001584{
1585 if (module && name_cstr && name_cstr[0])
1586 {
Greg Clayton37bb8dd2011-12-08 02:13:16 +00001587 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);
Greg Claytone1f50b92011-05-03 22:09:39 +00001594
Greg Clayton37bb8dd2011-12-08 02:13:16 +00001595 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)
Greg Claytone1f50b92011-05-03 22:09:39 +00001603 {
Greg Clayton37bb8dd2011-12-08 02:13:16 +00001604 TypeSP type_sp (type_list.GetTypeAtIndex(i));
1605 if (type_sp)
Greg Claytone1f50b92011-05-03 22:09:39 +00001606 {
Greg Clayton37bb8dd2011-12-08 02:13:16 +00001607 // 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);
Greg Claytone1f50b92011-05-03 22:09:39 +00001611 }
Greg Clayton37bb8dd2011-12-08 02:13:16 +00001612 strm.EOL();
Greg Claytone1f50b92011-05-03 22:09:39 +00001613 }
Greg Clayton37bb8dd2011-12-08 02:13:16 +00001614 }
1615 return num_matches;
Greg Claytone1f50b92011-05-03 22:09:39 +00001616 }
1617 return 0;
1618}
1619
1620static uint32_t
1621LookupFileAndLineInModule (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
Greg Clayton91048ef2011-11-10 01:18:58 +00001652
1653static size_t
1654FindModulesByName (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);
Greg Clayton444fe992012-02-26 05:51:37 +00001661 ModuleSpec module_spec (module_file_spec);
Greg Clayton91048ef2011-11-10 01:18:58 +00001662
1663 const size_t initial_size = module_list.GetSize ();
1664
1665 size_t num_matches = 0;
1666
1667 if (target)
1668 {
Greg Clayton444fe992012-02-26 05:51:37 +00001669 num_matches = target->GetImages().FindModules (module_spec, module_list);
Greg Clayton91048ef2011-11-10 01:18:58 +00001670
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)
Greg Clayton444fe992012-02-26 05:51:37 +00001675 {
1676 module_spec.GetArchitecture() = target->GetArchitecture();
1677 num_matches = ModuleList::FindSharedModules (module_spec, module_list);
1678 }
Greg Clayton91048ef2011-11-10 01:18:58 +00001679 }
1680 else
1681 {
Greg Clayton444fe992012-02-26 05:51:37 +00001682 num_matches = ModuleList::FindSharedModules (module_spec,module_list);
Greg Clayton91048ef2011-11-10 01:18:58 +00001683 }
1684
1685 if (check_global_list && num_matches == 0)
1686 {
1687 // Check the global list
Greg Claytonc149c8b2012-01-27 18:08:35 +00001688 Mutex::Locker locker(Module::GetAllocationModuleCollectionMutex());
Greg Clayton91048ef2011-11-10 01:18:58 +00001689 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 {
Greg Clayton444fe992012-02-26 05:51:37 +00001697 if (module->MatchesModuleSpec (module_spec))
Greg Clayton91048ef2011-11-10 01:18:58 +00001698 {
Greg Clayton13d24fb2012-01-29 20:56:30 +00001699 module_sp = module->shared_from_this();
Greg Clayton91048ef2011-11-10 01:18:58 +00001700 module_list.AppendIfNeeded(module_sp);
1701 }
1702 }
1703 }
1704 }
1705 return module_list.GetSize () - initial_size;
1706}
1707
Greg Claytone1f50b92011-05-03 22:09:39 +00001708#pragma mark CommandObjectTargetModulesModuleAutoComplete
1709
1710//----------------------------------------------------------------------
1711// A base command object class that can auto complete with module file
1712// paths
1713//----------------------------------------------------------------------
1714
1715class CommandObjectTargetModulesModuleAutoComplete : public CommandObject
1716{
1717public:
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
1777class CommandObjectTargetModulesSourceFileAutoComplete : public CommandObject
1778{
1779public:
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
1836class CommandObjectTargetModulesDumpSymtab : public CommandObjectTargetModulesModuleAutoComplete
1837{
1838public:
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 {
Greg Clayton91048ef2011-11-10 01:18:58 +00001903 ModuleList module_list;
1904 const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, true);
1905 if (num_matches > 0)
Greg Claytone1f50b92011-05-03 22:09:39 +00001906 {
Greg Clayton91048ef2011-11-10 01:18:58 +00001907 for (size_t i=0; i<num_matches; ++i)
Greg Claytone1f50b92011-05-03 22:09:39 +00001908 {
Greg Clayton91048ef2011-11-10 01:18:58 +00001909 Module *module = module_list.GetModulePointerAtIndex(i);
1910 if (module)
Greg Claytone1f50b92011-05-03 22:09:39 +00001911 {
1912 if (num_dumped > 0)
1913 {
1914 result.GetOutputStream().EOL();
1915 result.GetOutputStream().EOL();
1916 }
1917 num_dumped++;
Greg Clayton91048ef2011-11-10 01:18:58 +00001918 DumpModuleSymtab (m_interpreter, result.GetOutputStream(), module, m_options.m_sort_order);
Greg Claytone1f50b92011-05-03 22:09:39 +00001919 }
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':
Greg Claytone1f50b92011-05-03 22:09:39 +00001968 m_sort_order = (SortOrder) Args::StringToOptionEnum (option_arg,
1969 g_option_table[option_idx].enum_values,
1970 eSortOrderNone,
Greg Clayton61aca5d2011-10-07 18:58:12 +00001971 error);
Greg Claytone1f50b92011-05-03 22:09:39 +00001972 break;
1973
1974 default:
Greg Clayton9c236732011-10-26 00:56:27 +00001975 error.SetErrorStringWithFormat("invalid short option character '%c'", short_option);
Greg Claytone1f50b92011-05-03 22:09:39 +00001976 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
2000protected:
2001
2002 CommandOptions m_options;
2003};
2004
2005static OptionEnumValueElement
2006g_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
2015OptionDefinition
2016CommandObjectTargetModulesDumpSymtab::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
2028class CommandObjectTargetModulesDumpSections : public CommandObjectTargetModulesModuleAutoComplete
2029{
2030public:
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 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002090 ModuleList module_list;
2091 const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, true);
2092 if (num_matches > 0)
Greg Claytone1f50b92011-05-03 22:09:39 +00002093 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002094 for (size_t i=0; i<num_matches; ++i)
Greg Claytone1f50b92011-05-03 22:09:39 +00002095 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002096 Module *module = module_list.GetModulePointerAtIndex(i);
2097 if (module)
Greg Claytone1f50b92011-05-03 22:09:39 +00002098 {
2099 num_dumped++;
Greg Clayton91048ef2011-11-10 01:18:58 +00002100 DumpModuleSections (m_interpreter, result.GetOutputStream(), module);
Greg Claytone1f50b92011-05-03 22:09:39 +00002101 }
2102 }
2103 }
2104 else
Greg Clayton91048ef2011-11-10 01:18:58 +00002105 {
2106 // Check the global list
Greg Claytonc149c8b2012-01-27 18:08:35 +00002107 Mutex::Locker locker(Module::GetAllocationModuleCollectionMutex());
Greg Clayton91048ef2011-11-10 01:18:58 +00002108
Greg Claytone1f50b92011-05-03 22:09:39 +00002109 result.AppendWarningWithFormat("Unable to find an image that matches '%s'.\n", arg_cstr);
Greg Clayton91048ef2011-11-10 01:18:58 +00002110 }
Greg Claytone1f50b92011-05-03 22:09:39 +00002111 }
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
2133class CommandObjectTargetModulesDumpSymfile : public CommandObjectTargetModulesModuleAutoComplete
2134{
2135public:
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 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002195 ModuleList module_list;
2196 const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, true);
2197 if (num_matches > 0)
Greg Claytone1f50b92011-05-03 22:09:39 +00002198 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002199 for (size_t i=0; i<num_matches; ++i)
Greg Claytone1f50b92011-05-03 22:09:39 +00002200 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002201 Module *module = module_list.GetModulePointerAtIndex(i);
2202 if (module)
Greg Claytone1f50b92011-05-03 22:09:39 +00002203 {
Greg Clayton91048ef2011-11-10 01:18:58 +00002204 if (DumpModuleSymbolVendor (result.GetOutputStream(), module))
Greg Claytone1f50b92011-05-03 22:09:39 +00002205 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
2233class CommandObjectTargetModulesDumpLineTable : public CommandObjectTargetModulesSourceFileAutoComplete
2234{
2235public:
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,
Greg Clayton567e7f32011-09-22 04:58:26 +00002291 exe_ctx.GetProcessPtr() && exe_ctx.GetProcessRef().IsAlive()))
Greg Claytone1f50b92011-05-03 22:09:39 +00002292 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
2321class CommandObjectTargetModulesDump : public CommandObjectMultiword
2322{
2323public:
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
2346class CommandObjectTargetModulesAdd : public CommandObject
2347{
2348public:
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);
Greg Claytone1f50b92011-05-03 22:09:39 +00002390 if (file_spec.Exists())
2391 {
Greg Clayton444fe992012-02-26 05:51:37 +00002392 ModuleSpec module_spec (file_spec);
2393 ModuleSP module_sp (target->GetSharedModule (module_spec));
Greg Claytone1f50b92011-05-03 22:09:39 +00002394 if (!module_sp)
2395 {
2396 result.AppendError ("one or more executable image paths must be specified");
2397 result.SetStatus (eReturnStatusFailed);
2398 return false;
2399 }
Jason Molenda36f6fb92011-08-02 23:28:55 +00002400 result.SetStatus (eReturnStatusSuccessFinishResult);
Greg Claytone1f50b92011-05-03 22:09:39 +00002401 }
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
2450class CommandObjectTargetModulesLoad : public CommandObjectTargetModulesModuleAutoComplete
2451{
2452public:
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();
Greg Clayton444fe992012-02-26 05:51:37 +00002487 ModuleSpec module_spec;
2488 bool search_using_module_spec = false;
Greg Claytone1f50b92011-05-03 22:09:39 +00002489 if (m_file_option.GetOptionValue().OptionWasSet())
Greg Clayton444fe992012-02-26 05:51:37 +00002490 {
2491 search_using_module_spec = true;
2492 module_spec.GetFileSpec() = m_file_option.GetOptionValue().GetCurrentValue();
2493 }
Greg Claytone1f50b92011-05-03 22:09:39 +00002494
2495 if (m_uuid_option_group.GetOptionValue().OptionWasSet())
Greg Clayton444fe992012-02-26 05:51:37 +00002496 {
2497 search_using_module_spec = true;
2498 module_spec.GetUUID() = m_uuid_option_group.GetOptionValue().GetCurrentValue();
2499 }
Greg Claytone1f50b92011-05-03 22:09:39 +00002500
Greg Clayton444fe992012-02-26 05:51:37 +00002501 if (search_using_module_spec)
Greg Claytone1f50b92011-05-03 22:09:39 +00002502 {
2503
2504 ModuleList matching_modules;
Greg Clayton444fe992012-02-26 05:51:37 +00002505 const size_t num_matches = target->GetImages().FindModules (module_spec, matching_modules);
Greg Claytone1f50b92011-05-03 22:09:39 +00002506
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];
Greg Clayton444fe992012-02-26 05:51:37 +00002627
2628 if (module_spec.GetFileSpec())
2629 module_spec.GetFileSpec().GetPath (path, sizeof(path));
Greg Claytone1f50b92011-05-03 22:09:39 +00002630 else
2631 path[0] = '\0';
2632
Greg Clayton444fe992012-02-26 05:51:37 +00002633 if (module_spec.GetUUIDPtr())
2634 module_spec.GetUUID().GetAsCString(uuid_cstr, sizeof(uuid_cstr));
Greg Claytone1f50b92011-05-03 22:09:39 +00002635 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
2677protected:
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//----------------------------------------------------------------------
2687class CommandObjectTargetModulesList : public CommandObject
2688{
2689public:
2690
2691 class CommandOptions : public Options
2692 {
2693 public:
2694
2695 CommandOptions (CommandInterpreter &interpreter) :
Greg Clayton899025f2011-08-09 00:01:09 +00002696 Options(interpreter),
Jim Ingham6bdea822011-10-24 18:36:33 +00002697 m_format_array(),
Daniel Dunbar97c89572011-10-31 22:50:49 +00002698 m_use_global_module_list (false),
Jim Ingham6bdea822011-10-24 18:36:33 +00002699 m_module_addr (LLDB_INVALID_ADDRESS)
Greg Claytone1f50b92011-05-03 22:09:39 +00002700 {
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;
Greg Clayton899025f2011-08-09 00:01:09 +00002712 if (short_option == 'g')
2713 {
2714 m_use_global_module_list = true;
2715 }
Jim Ingham6bdea822011-10-24 18:36:33 +00002716 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;
Greg Clayton9c236732011-10-26 00:56:27 +00002723 error.SetErrorStringWithFormat("invalid address: \"%s\"", option_arg);
Jim Ingham6bdea822011-10-24 18:36:33 +00002724 }
2725 }
Greg Clayton899025f2011-08-09 00:01:09 +00002726 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 }
Greg Claytone1f50b92011-05-03 22:09:39 +00002733 Error error;
2734 return error;
2735 }
2736
2737 void
2738 OptionParsingStarting ()
2739 {
2740 m_format_array.clear();
Greg Clayton899025f2011-08-09 00:01:09 +00002741 m_use_global_module_list = false;
Jim Ingham6bdea822011-10-24 18:36:33 +00002742 m_module_addr = LLDB_INVALID_ADDRESS;
Greg Claytone1f50b92011-05-03 22:09:39 +00002743 }
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;
Greg Clayton899025f2011-08-09 00:01:09 +00002758 bool m_use_global_module_list;
Jim Ingham6bdea822011-10-24 18:36:33 +00002759 lldb::addr_t m_module_addr;
Greg Claytone1f50b92011-05-03 22:09:39 +00002760 };
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();
Greg Clayton153ccd72011-08-10 02:10:13 +00002788 const bool use_global_module_list = m_options.m_use_global_module_list;
2789 if (target == NULL && use_global_module_list == false)
Greg Claytone1f50b92011-05-03 22:09:39 +00002790 {
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 {
Greg Clayton153ccd72011-08-10 02:10:13 +00002797 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 }
Greg Claytone1f50b92011-05-03 22:09:39 +00002803 // Dump all sections for all modules images
Greg Clayton899025f2011-08-09 00:01:09 +00002804 uint32_t num_modules = 0;
2805 Mutex::Locker locker;
Jim Ingham6bdea822011-10-24 18:36:33 +00002806
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 {
Greg Clayton3508c382012-02-24 01:59:29 +00002816 ModuleSP module_sp (module_address.GetModule());
2817 if (module_sp)
Jim Ingham6bdea822011-10-24 18:36:33 +00002818 {
Greg Clayton3508c382012-02-24 01:59:29 +00002819 PrintModule (target, module_sp.get(), UINT32_MAX, 0, strm);
Jim Ingham6bdea822011-10-24 18:36:33 +00002820 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
Greg Clayton153ccd72011-08-10 02:10:13 +00002842 if (use_global_module_list)
Greg Clayton899025f2011-08-09 00:01:09 +00002843 {
Greg Claytonc149c8b2012-01-27 18:08:35 +00002844 locker.Reset (Module::GetAllocationModuleCollectionMutex()->GetMutex());
Greg Clayton899025f2011-08-09 00:01:09 +00002845 num_modules = Module::GetNumberAllocatedModules();
2846 }
2847 else
2848 num_modules = target->GetImages().GetSize();
2849
Greg Claytone1f50b92011-05-03 22:09:39 +00002850 if (num_modules > 0)
Jim Ingham6bdea822011-10-24 18:36:33 +00002851 {
Greg Claytone1f50b92011-05-03 22:09:39 +00002852 for (uint32_t image_idx = 0; image_idx<num_modules; ++image_idx)
2853 {
Greg Clayton153ccd72011-08-10 02:10:13 +00002854 ModuleSP module_sp;
Greg Clayton899025f2011-08-09 00:01:09 +00002855 Module *module;
Greg Clayton153ccd72011-08-10 02:10:13 +00002856 if (use_global_module_list)
Greg Clayton899025f2011-08-09 00:01:09 +00002857 {
2858 module = Module::GetAllocatedModuleAtIndex(image_idx);
Greg Clayton13d24fb2012-01-29 20:56:30 +00002859 module_sp = module->shared_from_this();
Greg Clayton899025f2011-08-09 00:01:09 +00002860 }
2861 else
2862 {
Greg Clayton153ccd72011-08-10 02:10:13 +00002863 module_sp = target->GetImages().GetModuleAtIndex(image_idx);
2864 module = module_sp.get();
Greg Clayton899025f2011-08-09 00:01:09 +00002865 }
Jim Ingham6bdea822011-10-24 18:36:33 +00002866
Greg Claytonb5a8f142012-02-05 02:38:54 +00002867 int indent = strm.Printf("[%3u] ", image_idx);
2868 PrintModule (target, module, image_idx, indent, strm);
Greg Clayton153ccd72011-08-10 02:10:13 +00002869
Greg Claytone1f50b92011-05-03 22:09:39 +00002870 }
2871 result.SetStatus (eReturnStatusSuccessFinishResult);
2872 }
2873 else
2874 {
Greg Clayton153ccd72011-08-10 02:10:13 +00002875 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");
Greg Claytone1f50b92011-05-03 22:09:39 +00002879 result.SetStatus (eReturnStatusFailed);
2880 return false;
2881 }
2882 }
2883 return result.Succeeded();
2884 }
2885protected:
Jim Ingham6bdea822011-10-24 18:36:33 +00002886
2887 void
Greg Claytonb5a8f142012-02-05 02:38:54 +00002888 PrintModule (Target *target, Module *module, uint32_t idx, int indent, Stream &strm)
Jim Ingham6bdea822011-10-24 18:36:33 +00002889 {
2890
2891 bool dump_object_name = false;
2892 if (m_options.m_format_array.empty())
2893 {
Greg Claytonb5a8f142012-02-05 02:38:54 +00002894 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));
Jim Ingham6bdea822011-10-24 18:36:33 +00002898 }
Greg Claytonb5a8f142012-02-05 02:38:54 +00002899 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)
Jim Ingham6bdea822011-10-24 18:36:33 +00002902 {
Greg Claytonb5a8f142012-02-05 02:38:54 +00002903 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)
Jim Ingham6bdea822011-10-24 18:36:33 +00002909 {
Greg Claytonb5a8f142012-02-05 02:38:54 +00002910 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;
Jim Ingham6bdea822011-10-24 18:36:33 +00002937
Greg Claytonb5a8f142012-02-05 02:38:54 +00002938 ObjectFile *objfile = module->GetObjectFile ();
2939 if (objfile)
Jim Ingham6bdea822011-10-24 18:36:33 +00002940 {
Greg Claytonb5a8f142012-02-05 02:38:54 +00002941 Address header_addr(objfile->GetHeaderAddress());
2942 if (header_addr.IsValid())
Jim Ingham6bdea822011-10-24 18:36:33 +00002943 {
Greg Claytonb5a8f142012-02-05 02:38:54 +00002944 if (target && !target->GetSectionLoadList().IsEmpty())
Jim Ingham6bdea822011-10-24 18:36:33 +00002945 {
Greg Claytonb5a8f142012-02-05 02:38:54 +00002946 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 }
Jim Ingham6bdea822011-10-24 18:36:33 +00002951 else
Greg Claytonb5a8f142012-02-05 02:38:54 +00002952 {
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 }
Jim Ingham6bdea822011-10-24 18:36:33 +00002964 break;
2965 }
Greg Claytonb5a8f142012-02-05 02:38:54 +00002966 // 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;
Jim Ingham6bdea822011-10-24 18:36:33 +00002969 }
Jim Ingham6bdea822011-10-24 18:36:33 +00002970 }
Greg Claytonb5a8f142012-02-05 02:38:54 +00002971 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;
Jim Ingham6bdea822011-10-24 18:36:33 +00002989
Greg Claytonb5a8f142012-02-05 02:38:54 +00002990 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;
Jim Ingham6bdea822011-10-24 18:36:33 +00003023
Greg Claytonb5a8f142012-02-05 02:38:54 +00003024 case 'p':
3025 strm.Printf("%p", module);
3026 break;
3027
3028 case 'u':
3029 DumpModuleUUID(strm, module);
3030 break;
3031
3032 default:
3033 break;
Jim Ingham6bdea822011-10-24 18:36:33 +00003034 }
Greg Claytonb5a8f142012-02-05 02:38:54 +00003035
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);
Jim Ingham6bdea822011-10-24 18:36:33 +00003042 }
3043 strm.EOL();
3044 }
3045
Greg Claytone1f50b92011-05-03 22:09:39 +00003046 CommandOptions m_options;
3047};
3048
3049OptionDefinition
3050CommandObjectTargetModulesList::CommandOptions::g_option_table[] =
3051{
Jim Ingham6bdea822011-10-24 18:36:33 +00003052 { 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."},
Greg Claytone1f50b92011-05-03 22:09:39 +00003054 { LLDB_OPT_SET_1, false, "triple", 't', optional_argument, NULL, 0, eArgTypeWidth, "Display the triple when listing images."},
Greg Claytonb5a8f142012-02-05 02:38:54 +00003055 { 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)."},
Greg Claytone1f50b92011-05-03 22:09:39 +00003057 { 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."},
Greg Claytonb5a8f142012-02-05 02:38:54 +00003062 { 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."},
Greg Clayton153ccd72011-08-10 02:10:13 +00003063 { 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."},
Greg Clayton899025f2011-08-09 00:01:09 +00003066 { 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."},
Greg Claytone1f50b92011-05-03 22:09:39 +00003067 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
3068};
3069
3070
3071
3072//----------------------------------------------------------------------
3073// Lookup information in images
3074//----------------------------------------------------------------------
3075class CommandObjectTargetModulesLookup : public CommandObject
3076{
3077public:
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)
Greg Clayton9c236732011-10-26 00:56:27 +00003118 error.SetErrorStringWithFormat ("invalid address string '%s'", option_arg);
Greg Claytone1f50b92011-05-03 22:09:39 +00003119 break;
3120
3121 case 'o':
3122 m_offset = Args::StringToUInt64(option_arg, LLDB_INVALID_ADDRESS);
3123 if (m_offset == LLDB_INVALID_ADDRESS)
Greg Clayton9c236732011-10-26 00:56:27 +00003124 error.SetErrorStringWithFormat ("invalid offset string '%s'", option_arg);
Greg Claytone1f50b92011-05-03 22:09:39 +00003125 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':
Sean Callanan9ad19532012-02-11 01:22:21 +00003138 m_include_inlines = false;
Greg Claytone1f50b92011-05-03 22:09:39 +00003139 break;
3140
3141 case 'l':
3142 m_line_number = Args::StringToUInt32(option_arg, UINT32_MAX);
3143 if (m_line_number == UINT32_MAX)
Greg Clayton9c236732011-10-26 00:56:27 +00003144 error.SetErrorStringWithFormat ("invalid line number string '%s'", option_arg);
Greg Claytone1f50b92011-05-03 22:09:39 +00003145 else if (m_line_number == 0)
Greg Clayton9c236732011-10-26 00:56:27 +00003146 error.SetErrorString ("zero is an invalid line number");
Greg Claytone1f50b92011-05-03 22:09:39 +00003147 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;
Sean Callanan9ad19532012-02-11 01:22:21 +00003182 m_include_inlines = true;
Greg Claytone1f50b92011-05-03 22:09:39 +00003183 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.
Sean Callanan9ad19532012-02-11 01:22:21 +00003202 bool m_include_inlines;// Check for inline entries when looking up by file/line.
Greg Claytone1f50b92011-05-03 22:09:39 +00003203 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,
Sean Callanan9ad19532012-02-11 01:22:21 +00003282 m_options.m_include_inlines,
Greg Claytone1f50b92011-05-03 22:09:39 +00003283 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,
Sean Callanan9ad19532012-02-11 01:22:21 +00003299 m_options.m_include_inlines,
Greg Claytone1f50b92011-05-03 22:09:39 +00003300 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 {
Greg Clayton91048ef2011-11-10 01:18:58 +00003382 ModuleList module_list;
3383 const size_t num_matches = FindModulesByName (target, arg_cstr, module_list, false);
3384 if (num_matches > 0)
Greg Claytone1f50b92011-05-03 22:09:39 +00003385 {
Greg Clayton91048ef2011-11-10 01:18:58 +00003386 for (size_t i=0; i<num_matches; ++i)
Greg Claytone1f50b92011-05-03 22:09:39 +00003387 {
Greg Clayton91048ef2011-11-10 01:18:58 +00003388 Module *module = module_list.GetModulePointerAtIndex(i);
3389 if (module)
Greg Claytone1f50b92011-05-03 22:09:39 +00003390 {
Greg Clayton91048ef2011-11-10 01:18:58 +00003391 if (LookupInModule (m_interpreter, module, result, syntax_error))
Greg Claytone1f50b92011-05-03 22:09:39 +00003392 {
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 }
3411protected:
3412
3413 CommandOptions m_options;
3414};
3415
3416OptionDefinition
3417CommandObjectTargetModulesLookup::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."},
Jim Inghame7a91c12011-06-20 23:38:11 +00003421 { 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."},
Greg Claytone1f50b92011-05-03 22:09:39 +00003424 { 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."},
Greg Claytone1f50b92011-05-03 22:09:39 +00003425 { 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)."},
Sean Callanan9ad19532012-02-11 01:22:21 +00003427 { 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)."},
Greg Claytone1f50b92011-05-03 22:09:39 +00003429 { 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};
Chris Lattner24943d22010-06-08 16:52:24 +00003434
3435
Jim Inghamd60d94a2011-03-11 03:53:59 +00003436#pragma mark CommandObjectMultiwordImageSearchPaths
Chris Lattner24943d22010-06-08 16:52:24 +00003437
3438//-------------------------------------------------------------------------
3439// CommandObjectMultiwordImageSearchPaths
3440//-------------------------------------------------------------------------
3441
Greg Claytone1f50b92011-05-03 22:09:39 +00003442class CommandObjectTargetModulesImageSearchPaths : public CommandObjectMultiword
Chris Lattner24943d22010-06-08 16:52:24 +00003443{
3444public:
Greg Claytone1f50b92011-05-03 22:09:39 +00003445
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>]")
Chris Lattner24943d22010-06-08 16:52:24 +00003451 {
Greg Claytone1f50b92011-05-03 22:09:39 +00003452 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)));
Chris Lattner24943d22010-06-08 16:52:24 +00003457 }
Greg Claytone1f50b92011-05-03 22:09:39 +00003458
3459 ~CommandObjectTargetModulesImageSearchPaths()
Chris Lattner24943d22010-06-08 16:52:24 +00003460 {
3461 }
3462};
3463
Greg Claytone1f50b92011-05-03 22:09:39 +00003464
3465
3466#pragma mark CommandObjectTargetModules
3467
3468//-------------------------------------------------------------------------
3469// CommandObjectTargetModules
3470//-------------------------------------------------------------------------
3471
3472class CommandObjectTargetModules : public CommandObjectMultiword
3473{
3474public:
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
3498private:
3499 //------------------------------------------------------------------
3500 // For CommandObjectTargetModules only
3501 //------------------------------------------------------------------
3502 DISALLOW_COPY_AND_ASSIGN (CommandObjectTargetModules);
3503};
3504
3505
Greg Clayton3508c382012-02-24 01:59:29 +00003506
3507class CommandObjectTargetSymbolsAdd : public CommandObject
3508{
3509public:
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();
Greg Clayton444fe992012-02-26 05:51:37 +00003574 ModuleSpec module_spec (old_module_sp->GetFileSpec(), old_module_sp->GetArchitecture());
3575 module_spec.GetSymbolFileSpec() = symfile_spec;
Greg Clayton3508c382012-02-24 01:59:29 +00003576 // 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));
Greg Clayton444fe992012-02-26 05:51:37 +00003587 ModuleSP new_module_sp;
3588
3589 Error error (ModuleList::GetSharedModule (module_spec,
3590 new_module_sp,
3591 &target->GetExecutableSearchPaths(),
3592 NULL,
3593 NULL));
3594
Greg Clayton3508c382012-02-24 01:59:29 +00003595 if (new_module_sp)
3596 {
3597 new_module_sp->SetSymbolFileFileSpec (symfile_module_sp->GetFileSpec());
3598
3599 if (adding_symbols_to_executable)
3600 {
3601 bool get_dependent_files = true;
3602 target->SetExecutableModule(new_module_sp, get_dependent_files);
3603 }
3604 else
3605 {
3606 module_list.Append (new_module_sp);
3607 target->ModulesDidLoad(module_list);
3608 }
3609 }
3610 }
3611 else
3612 {
3613 // The module has not yet created its symbol vendor, we can just
3614 // give the existing target module the symfile path to use for
3615 // when it decides to create it!
3616 old_module_sp->SetSymbolFileFileSpec (symfile_module_sp->GetFileSpec());
3617 }
3618 }
3619 }
3620 else
3621 {
3622 result.AppendError ("one or more executable image paths must be specified");
3623 result.SetStatus (eReturnStatusFailed);
3624 return false;
3625 }
3626 result.SetStatus (eReturnStatusSuccessFinishResult);
3627 }
3628 else
3629 {
3630 char resolved_symfile_path[PATH_MAX];
3631 result.SetStatus (eReturnStatusFailed);
3632 if (symfile_spec.GetPath (resolved_symfile_path, sizeof(resolved_symfile_path)))
3633 {
3634 if (strcmp (resolved_symfile_path, symfile_path) != 0)
3635 {
3636 result.AppendErrorWithFormat ("invalid module path '%s' with resolved path '%s'\n", symfile_path, resolved_symfile_path);
3637 break;
3638 }
3639 }
3640 result.AppendErrorWithFormat ("invalid module path '%s'\n", symfile_path);
3641 break;
3642 }
3643 }
3644 }
3645 }
3646 }
3647 return result.Succeeded();
3648 }
3649
3650 int
3651 HandleArgumentCompletion (Args &input,
3652 int &cursor_index,
3653 int &cursor_char_position,
3654 OptionElementVector &opt_element_vector,
3655 int match_start_point,
3656 int max_return_elements,
3657 bool &word_complete,
3658 StringList &matches)
3659 {
3660 std::string completion_str (input.GetArgumentAtIndex(cursor_index));
3661 completion_str.erase (cursor_char_position);
3662
3663 CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
3664 CommandCompletions::eDiskFileCompletion,
3665 completion_str.c_str(),
3666 match_start_point,
3667 max_return_elements,
3668 NULL,
3669 word_complete,
3670 matches);
3671 return matches.GetSize();
3672 }
3673
3674};
3675
3676
3677#pragma mark CommandObjectTargetSymbols
3678
3679//-------------------------------------------------------------------------
3680// CommandObjectTargetSymbols
3681//-------------------------------------------------------------------------
3682
3683class CommandObjectTargetSymbols : public CommandObjectMultiword
3684{
3685public:
3686 //------------------------------------------------------------------
3687 // Constructors and Destructors
3688 //------------------------------------------------------------------
3689 CommandObjectTargetSymbols(CommandInterpreter &interpreter) :
3690 CommandObjectMultiword (interpreter,
3691 "target symbols",
3692 "A set of commands for adding and managing debug symbol files.",
3693 "target symbols <sub-command> ...")
3694 {
3695 LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetSymbolsAdd (interpreter)));
3696
3697 }
3698 virtual
3699 ~CommandObjectTargetSymbols()
3700 {
3701 }
3702
3703private:
3704 //------------------------------------------------------------------
3705 // For CommandObjectTargetModules only
3706 //------------------------------------------------------------------
3707 DISALLOW_COPY_AND_ASSIGN (CommandObjectTargetSymbols);
3708};
3709
3710
Jim Inghamd60d94a2011-03-11 03:53:59 +00003711#pragma mark CommandObjectTargetStopHookAdd
3712
3713//-------------------------------------------------------------------------
3714// CommandObjectTargetStopHookAdd
3715//-------------------------------------------------------------------------
3716
3717class CommandObjectTargetStopHookAdd : public CommandObject
3718{
3719public:
3720
3721 class CommandOptions : public Options
3722 {
3723 public:
Greg Claytonf15996e2011-04-07 22:46:35 +00003724 CommandOptions (CommandInterpreter &interpreter) :
3725 Options(interpreter),
Jim Inghamd60d94a2011-03-11 03:53:59 +00003726 m_line_start(0),
3727 m_line_end (UINT_MAX),
3728 m_func_name_type_mask (eFunctionNameTypeAuto),
3729 m_sym_ctx_specified (false),
Johnny Chen60fe60e2011-05-02 23:47:55 +00003730 m_thread_specified (false),
3731 m_use_one_liner (false),
3732 m_one_liner()
Jim Inghamd60d94a2011-03-11 03:53:59 +00003733 {
3734 }
3735
3736 ~CommandOptions () {}
3737
Greg Claytonb3448432011-03-24 21:19:54 +00003738 const OptionDefinition*
Jim Inghamd60d94a2011-03-11 03:53:59 +00003739 GetDefinitions ()
3740 {
3741 return g_option_table;
3742 }
3743
3744 virtual Error
Greg Clayton143fcc32011-04-13 00:18:08 +00003745 SetOptionValue (uint32_t option_idx, const char *option_arg)
Jim Inghamd60d94a2011-03-11 03:53:59 +00003746 {
3747 Error error;
3748 char short_option = (char) m_getopt_table[option_idx].val;
3749 bool success;
3750
3751 switch (short_option)
3752 {
3753 case 'c':
3754 m_class_name = option_arg;
3755 m_sym_ctx_specified = true;
3756 break;
3757
3758 case 'e':
3759 m_line_end = Args::StringToUInt32 (option_arg, UINT_MAX, 0, &success);
3760 if (!success)
3761 {
Greg Clayton9c236732011-10-26 00:56:27 +00003762 error.SetErrorStringWithFormat ("invalid end line number: \"%s\"", option_arg);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003763 break;
3764 }
3765 m_sym_ctx_specified = true;
3766 break;
3767
3768 case 'l':
3769 m_line_start = Args::StringToUInt32 (option_arg, 0, 0, &success);
3770 if (!success)
3771 {
Greg Clayton9c236732011-10-26 00:56:27 +00003772 error.SetErrorStringWithFormat ("invalid start line number: \"%s\"", option_arg);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003773 break;
3774 }
3775 m_sym_ctx_specified = true;
3776 break;
Sean Callanan9ad19532012-02-11 01:22:21 +00003777
3778 case 'i':
3779 m_no_inlines = true;
3780 break;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003781
3782 case 'n':
3783 m_function_name = option_arg;
3784 m_func_name_type_mask |= eFunctionNameTypeAuto;
3785 m_sym_ctx_specified = true;
3786 break;
3787
3788 case 'f':
3789 m_file_name = option_arg;
3790 m_sym_ctx_specified = true;
3791 break;
3792 case 's':
3793 m_module_name = option_arg;
3794 m_sym_ctx_specified = true;
3795 break;
3796 case 't' :
3797 {
Jim Ingham7a4c8ea2011-03-22 01:53:33 +00003798 m_thread_id = Args::StringToUInt64(option_arg, LLDB_INVALID_THREAD_ID, 0);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003799 if (m_thread_id == LLDB_INVALID_THREAD_ID)
Greg Clayton9c236732011-10-26 00:56:27 +00003800 error.SetErrorStringWithFormat ("invalid thread id string '%s'", option_arg);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003801 m_thread_specified = true;
3802 }
3803 break;
3804 case 'T':
3805 m_thread_name = option_arg;
3806 m_thread_specified = true;
3807 break;
3808 case 'q':
3809 m_queue_name = option_arg;
3810 m_thread_specified = true;
3811 break;
3812 case 'x':
3813 {
Jim Ingham7a4c8ea2011-03-22 01:53:33 +00003814 m_thread_index = Args::StringToUInt32(option_arg, UINT32_MAX, 0);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003815 if (m_thread_id == UINT32_MAX)
Greg Clayton9c236732011-10-26 00:56:27 +00003816 error.SetErrorStringWithFormat ("invalid thread index string '%s'", option_arg);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003817 m_thread_specified = true;
3818 }
3819 break;
Johnny Chen60fe60e2011-05-02 23:47:55 +00003820 case 'o':
3821 m_use_one_liner = true;
3822 m_one_liner = option_arg;
3823 break;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003824 default:
Greg Clayton9c236732011-10-26 00:56:27 +00003825 error.SetErrorStringWithFormat ("unrecognized option %c.", short_option);
Jim Inghamd60d94a2011-03-11 03:53:59 +00003826 break;
3827 }
3828 return error;
3829 }
3830
3831 void
Greg Clayton143fcc32011-04-13 00:18:08 +00003832 OptionParsingStarting ()
Jim Inghamd60d94a2011-03-11 03:53:59 +00003833 {
3834 m_class_name.clear();
3835 m_function_name.clear();
3836 m_line_start = 0;
3837 m_line_end = UINT_MAX;
3838 m_file_name.clear();
3839 m_module_name.clear();
3840 m_func_name_type_mask = eFunctionNameTypeAuto;
3841 m_thread_id = LLDB_INVALID_THREAD_ID;
3842 m_thread_index = UINT32_MAX;
3843 m_thread_name.clear();
3844 m_queue_name.clear();
Sean Callanan9ad19532012-02-11 01:22:21 +00003845
3846 m_no_inlines = false;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003847 m_sym_ctx_specified = false;
3848 m_thread_specified = false;
Johnny Chen60fe60e2011-05-02 23:47:55 +00003849
3850 m_use_one_liner = false;
3851 m_one_liner.clear();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003852 }
3853
3854
Greg Claytonb3448432011-03-24 21:19:54 +00003855 static OptionDefinition g_option_table[];
Jim Inghamd60d94a2011-03-11 03:53:59 +00003856
3857 std::string m_class_name;
3858 std::string m_function_name;
3859 uint32_t m_line_start;
3860 uint32_t m_line_end;
3861 std::string m_file_name;
3862 std::string m_module_name;
3863 uint32_t m_func_name_type_mask; // A pick from lldb::FunctionNameType.
3864 lldb::tid_t m_thread_id;
3865 uint32_t m_thread_index;
3866 std::string m_thread_name;
3867 std::string m_queue_name;
3868 bool m_sym_ctx_specified;
Sean Callanan9ad19532012-02-11 01:22:21 +00003869 bool m_no_inlines;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003870 bool m_thread_specified;
Johnny Chen60fe60e2011-05-02 23:47:55 +00003871 // Instance variables to hold the values for one_liner options.
3872 bool m_use_one_liner;
3873 std::string m_one_liner;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003874 };
3875
3876 Options *
3877 GetOptions ()
3878 {
3879 return &m_options;
3880 }
3881
3882 CommandObjectTargetStopHookAdd (CommandInterpreter &interpreter) :
3883 CommandObject (interpreter,
3884 "target stop-hook add ",
3885 "Add a hook to be executed when the target stops.",
Greg Claytonf15996e2011-04-07 22:46:35 +00003886 "target stop-hook add"),
3887 m_options (interpreter)
Jim Inghamd60d94a2011-03-11 03:53:59 +00003888 {
3889 }
3890
3891 ~CommandObjectTargetStopHookAdd ()
3892 {
3893 }
3894
3895 static size_t
3896 ReadCommandsCallbackFunction (void *baton,
3897 InputReader &reader,
3898 lldb::InputReaderAction notification,
3899 const char *bytes,
3900 size_t bytes_len)
3901 {
Caroline Tice892fadd2011-06-16 16:27:19 +00003902 StreamSP out_stream = reader.GetDebugger().GetAsyncOutputStream();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003903 Target::StopHook *new_stop_hook = ((Target::StopHook *) baton);
Jim Inghame15511a2011-05-05 01:03:36 +00003904 static bool got_interrupted;
Caroline Tice892fadd2011-06-16 16:27:19 +00003905 bool batch_mode = reader.GetDebugger().GetCommandInterpreter().GetBatchCommandMode();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003906
3907 switch (notification)
3908 {
3909 case eInputReaderActivate:
Caroline Tice892fadd2011-06-16 16:27:19 +00003910 if (!batch_mode)
3911 {
3912 out_stream->Printf ("%s\n", "Enter your stop hook command(s). Type 'DONE' to end.");
3913 if (reader.GetPrompt())
3914 out_stream->Printf ("%s", reader.GetPrompt());
3915 out_stream->Flush();
3916 }
Jim Inghame15511a2011-05-05 01:03:36 +00003917 got_interrupted = false;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003918 break;
3919
3920 case eInputReaderDeactivate:
3921 break;
3922
3923 case eInputReaderReactivate:
Caroline Tice892fadd2011-06-16 16:27:19 +00003924 if (reader.GetPrompt() && !batch_mode)
Jim Inghamd60d94a2011-03-11 03:53:59 +00003925 {
Caroline Tice892fadd2011-06-16 16:27:19 +00003926 out_stream->Printf ("%s", reader.GetPrompt());
3927 out_stream->Flush();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003928 }
Jim Inghame15511a2011-05-05 01:03:36 +00003929 got_interrupted = false;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003930 break;
3931
Caroline Tice4a348082011-05-02 20:41:46 +00003932 case eInputReaderAsynchronousOutputWritten:
3933 break;
3934
Jim Inghamd60d94a2011-03-11 03:53:59 +00003935 case eInputReaderGotToken:
3936 if (bytes && bytes_len && baton)
3937 {
3938 StringList *commands = new_stop_hook->GetCommandPointer();
3939 if (commands)
3940 {
3941 commands->AppendString (bytes, bytes_len);
3942 }
3943 }
Caroline Tice892fadd2011-06-16 16:27:19 +00003944 if (!reader.IsDone() && reader.GetPrompt() && !batch_mode)
Jim Inghamd60d94a2011-03-11 03:53:59 +00003945 {
Caroline Tice892fadd2011-06-16 16:27:19 +00003946 out_stream->Printf ("%s", reader.GetPrompt());
3947 out_stream->Flush();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003948 }
3949 break;
3950
3951 case eInputReaderInterrupt:
3952 {
3953 // Finish, and cancel the stop hook.
3954 new_stop_hook->GetTarget()->RemoveStopHookByID(new_stop_hook->GetID());
Caroline Tice892fadd2011-06-16 16:27:19 +00003955 if (!batch_mode)
3956 {
3957 out_stream->Printf ("Stop hook cancelled.\n");
3958 out_stream->Flush();
3959 }
3960
Jim Inghamd60d94a2011-03-11 03:53:59 +00003961 reader.SetIsDone (true);
3962 }
Jim Inghame15511a2011-05-05 01:03:36 +00003963 got_interrupted = true;
Jim Inghamd60d94a2011-03-11 03:53:59 +00003964 break;
3965
3966 case eInputReaderEndOfFile:
3967 reader.SetIsDone (true);
3968 break;
3969
3970 case eInputReaderDone:
Caroline Tice892fadd2011-06-16 16:27:19 +00003971 if (!got_interrupted && !batch_mode)
3972 {
Greg Clayton444e35b2011-10-19 18:09:39 +00003973 out_stream->Printf ("Stop hook #%llu added.\n", new_stop_hook->GetID());
Caroline Tice892fadd2011-06-16 16:27:19 +00003974 out_stream->Flush();
3975 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00003976 break;
3977 }
3978
3979 return bytes_len;
3980 }
3981
3982 bool
3983 Execute (Args& command,
3984 CommandReturnObject &result)
3985 {
3986 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
3987 if (target)
3988 {
3989 Target::StopHookSP new_hook_sp;
3990 target->AddStopHook (new_hook_sp);
3991
3992 // First step, make the specifier.
3993 std::auto_ptr<SymbolContextSpecifier> specifier_ap;
3994 if (m_options.m_sym_ctx_specified)
3995 {
3996 specifier_ap.reset(new SymbolContextSpecifier(m_interpreter.GetDebugger().GetSelectedTarget()));
3997
3998 if (!m_options.m_module_name.empty())
3999 {
4000 specifier_ap->AddSpecification (m_options.m_module_name.c_str(), SymbolContextSpecifier::eModuleSpecified);
4001 }
4002
4003 if (!m_options.m_class_name.empty())
4004 {
4005 specifier_ap->AddSpecification (m_options.m_class_name.c_str(), SymbolContextSpecifier::eClassOrNamespaceSpecified);
4006 }
4007
4008 if (!m_options.m_file_name.empty())
4009 {
4010 specifier_ap->AddSpecification (m_options.m_file_name.c_str(), SymbolContextSpecifier::eFileSpecified);
4011 }
4012
4013 if (m_options.m_line_start != 0)
4014 {
4015 specifier_ap->AddLineSpecification (m_options.m_line_start, SymbolContextSpecifier::eLineStartSpecified);
4016 }
4017
4018 if (m_options.m_line_end != UINT_MAX)
4019 {
4020 specifier_ap->AddLineSpecification (m_options.m_line_end, SymbolContextSpecifier::eLineEndSpecified);
4021 }
4022
4023 if (!m_options.m_function_name.empty())
4024 {
4025 specifier_ap->AddSpecification (m_options.m_function_name.c_str(), SymbolContextSpecifier::eFunctionSpecified);
4026 }
4027 }
4028
4029 if (specifier_ap.get())
4030 new_hook_sp->SetSpecifier (specifier_ap.release());
4031
4032 // Next see if any of the thread options have been entered:
4033
4034 if (m_options.m_thread_specified)
4035 {
4036 ThreadSpec *thread_spec = new ThreadSpec();
4037
4038 if (m_options.m_thread_id != LLDB_INVALID_THREAD_ID)
4039 {
4040 thread_spec->SetTID (m_options.m_thread_id);
4041 }
4042
4043 if (m_options.m_thread_index != UINT32_MAX)
4044 thread_spec->SetIndex (m_options.m_thread_index);
4045
4046 if (!m_options.m_thread_name.empty())
4047 thread_spec->SetName (m_options.m_thread_name.c_str());
4048
4049 if (!m_options.m_queue_name.empty())
4050 thread_spec->SetQueueName (m_options.m_queue_name.c_str());
4051
4052 new_hook_sp->SetThreadSpecifier (thread_spec);
4053
4054 }
Johnny Chen60fe60e2011-05-02 23:47:55 +00004055 if (m_options.m_use_one_liner)
Jim Inghamd60d94a2011-03-11 03:53:59 +00004056 {
Johnny Chen60fe60e2011-05-02 23:47:55 +00004057 // Use one-liner.
4058 new_hook_sp->GetCommandPointer()->AppendString (m_options.m_one_liner.c_str());
Greg Clayton444e35b2011-10-19 18:09:39 +00004059 result.AppendMessageWithFormat("Stop hook #%llu added.\n", new_hook_sp->GetID());
Jim Inghamd60d94a2011-03-11 03:53:59 +00004060 }
Johnny Chen60fe60e2011-05-02 23:47:55 +00004061 else
Jim Inghamd60d94a2011-03-11 03:53:59 +00004062 {
Johnny Chen60fe60e2011-05-02 23:47:55 +00004063 // Otherwise gather up the command list, we'll push an input reader and suck the data from that directly into
4064 // the new stop hook's command string.
4065 InputReaderSP reader_sp (new InputReader(m_interpreter.GetDebugger()));
4066 if (!reader_sp)
4067 {
4068 result.AppendError("out of memory\n");
4069 result.SetStatus (eReturnStatusFailed);
4070 target->RemoveStopHookByID (new_hook_sp->GetID());
4071 return false;
4072 }
4073
4074 Error err (reader_sp->Initialize (CommandObjectTargetStopHookAdd::ReadCommandsCallbackFunction,
4075 new_hook_sp.get(), // baton
4076 eInputReaderGranularityLine, // token size, to pass to callback function
4077 "DONE", // end token
4078 "> ", // prompt
4079 true)); // echo input
4080 if (!err.Success())
4081 {
4082 result.AppendError (err.AsCString());
4083 result.SetStatus (eReturnStatusFailed);
4084 target->RemoveStopHookByID (new_hook_sp->GetID());
4085 return false;
4086 }
4087 m_interpreter.GetDebugger().PushInputReader (reader_sp);
Jim Inghamd60d94a2011-03-11 03:53:59 +00004088 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00004089 result.SetStatus (eReturnStatusSuccessFinishNoResult);
4090 }
4091 else
4092 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004093 result.AppendError ("invalid target\n");
Jim Inghamd60d94a2011-03-11 03:53:59 +00004094 result.SetStatus (eReturnStatusFailed);
4095 }
4096
4097 return result.Succeeded();
4098 }
4099private:
4100 CommandOptions m_options;
4101};
4102
Greg Claytonb3448432011-03-24 21:19:54 +00004103OptionDefinition
Jim Inghamd60d94a2011-03-11 03:53:59 +00004104CommandObjectTargetStopHookAdd::CommandOptions::g_option_table[] =
4105{
Johnny Chen60fe60e2011-05-02 23:47:55 +00004106 { LLDB_OPT_SET_ALL, false, "one-liner", 'o', required_argument, NULL, NULL, eArgTypeOneLiner,
4107 "Specify a one-line breakpoint command inline. Be sure to surround it with quotes." },
Jim Inghamd60d94a2011-03-11 03:53:59 +00004108 { LLDB_OPT_SET_ALL, false, "shlib", 's', required_argument, NULL, CommandCompletions::eModuleCompletion, eArgTypeShlibName,
4109 "Set the module within which the stop-hook is to be run."},
4110 { LLDB_OPT_SET_ALL, false, "thread-index", 'x', required_argument, NULL, NULL, eArgTypeThreadIndex,
4111 "The stop hook is run only for the thread whose index matches this argument."},
4112 { LLDB_OPT_SET_ALL, false, "thread-id", 't', required_argument, NULL, NULL, eArgTypeThreadID,
4113 "The stop hook is run only for the thread whose TID matches this argument."},
4114 { LLDB_OPT_SET_ALL, false, "thread-name", 'T', required_argument, NULL, NULL, eArgTypeThreadName,
4115 "The stop hook is run only for the thread whose thread name matches this argument."},
4116 { LLDB_OPT_SET_ALL, false, "queue-name", 'q', required_argument, NULL, NULL, eArgTypeQueueName,
4117 "The stop hook is run only for threads in the queue whose name is given by this argument."},
4118 { LLDB_OPT_SET_1, false, "file", 'f', required_argument, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename,
4119 "Specify the source file within which the stop-hook is to be run." },
4120 { LLDB_OPT_SET_1, false, "start-line", 'l', required_argument, NULL, 0, eArgTypeLineNum,
4121 "Set the start of the line range for which the stop-hook is to be run."},
4122 { LLDB_OPT_SET_1, false, "end-line", 'e', required_argument, NULL, 0, eArgTypeLineNum,
4123 "Set the end of the line range for which the stop-hook is to be run."},
4124 { LLDB_OPT_SET_2, false, "classname", 'c', required_argument, NULL, NULL, eArgTypeClassName,
4125 "Specify the class within which the stop-hook is to be run." },
4126 { LLDB_OPT_SET_3, false, "name", 'n', required_argument, NULL, CommandCompletions::eSymbolCompletion, eArgTypeFunctionName,
4127 "Set the function name within which the stop hook will be run." },
4128 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
4129};
4130
4131#pragma mark CommandObjectTargetStopHookDelete
4132
4133//-------------------------------------------------------------------------
4134// CommandObjectTargetStopHookDelete
4135//-------------------------------------------------------------------------
4136
4137class CommandObjectTargetStopHookDelete : public CommandObject
4138{
4139public:
4140
4141 CommandObjectTargetStopHookDelete (CommandInterpreter &interpreter) :
4142 CommandObject (interpreter,
Jason Molenda3fccc902011-11-10 23:03:44 +00004143 "target stop-hook delete",
Jim Inghamd60d94a2011-03-11 03:53:59 +00004144 "Delete a stop-hook.",
Jason Molenda3fccc902011-11-10 23:03:44 +00004145 "target stop-hook delete [<idx>]")
Jim Inghamd60d94a2011-03-11 03:53:59 +00004146 {
4147 }
4148
4149 ~CommandObjectTargetStopHookDelete ()
4150 {
4151 }
4152
4153 bool
4154 Execute (Args& command,
4155 CommandReturnObject &result)
4156 {
4157 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
4158 if (target)
4159 {
4160 // FIXME: see if we can use the breakpoint id style parser?
4161 size_t num_args = command.GetArgumentCount();
4162 if (num_args == 0)
4163 {
4164 if (!m_interpreter.Confirm ("Delete all stop hooks?", true))
4165 {
4166 result.SetStatus (eReturnStatusFailed);
4167 return false;
4168 }
4169 else
4170 {
4171 target->RemoveAllStopHooks();
4172 }
4173 }
4174 else
4175 {
4176 bool success;
4177 for (size_t i = 0; i < num_args; i++)
4178 {
4179 lldb::user_id_t user_id = Args::StringToUInt32 (command.GetArgumentAtIndex(i), 0, 0, &success);
4180 if (!success)
4181 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004182 result.AppendErrorWithFormat ("invalid stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
Jim Inghamd60d94a2011-03-11 03:53:59 +00004183 result.SetStatus(eReturnStatusFailed);
4184 return false;
4185 }
4186 success = target->RemoveStopHookByID (user_id);
4187 if (!success)
4188 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004189 result.AppendErrorWithFormat ("unknown stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
Jim Inghamd60d94a2011-03-11 03:53:59 +00004190 result.SetStatus(eReturnStatusFailed);
4191 return false;
4192 }
4193 }
4194 }
4195 result.SetStatus (eReturnStatusSuccessFinishNoResult);
4196 }
4197 else
4198 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004199 result.AppendError ("invalid target\n");
Jim Inghamd60d94a2011-03-11 03:53:59 +00004200 result.SetStatus (eReturnStatusFailed);
4201 }
4202
4203 return result.Succeeded();
4204 }
4205};
4206#pragma mark CommandObjectTargetStopHookEnableDisable
4207
4208//-------------------------------------------------------------------------
4209// CommandObjectTargetStopHookEnableDisable
4210//-------------------------------------------------------------------------
4211
4212class CommandObjectTargetStopHookEnableDisable : public CommandObject
4213{
4214public:
4215
4216 CommandObjectTargetStopHookEnableDisable (CommandInterpreter &interpreter, bool enable, const char *name, const char *help, const char *syntax) :
4217 CommandObject (interpreter,
4218 name,
4219 help,
4220 syntax),
4221 m_enable (enable)
4222 {
4223 }
4224
4225 ~CommandObjectTargetStopHookEnableDisable ()
4226 {
4227 }
4228
4229 bool
4230 Execute (Args& command,
4231 CommandReturnObject &result)
4232 {
4233 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
4234 if (target)
4235 {
4236 // FIXME: see if we can use the breakpoint id style parser?
4237 size_t num_args = command.GetArgumentCount();
4238 bool success;
4239
4240 if (num_args == 0)
4241 {
4242 target->SetAllStopHooksActiveState (m_enable);
4243 }
4244 else
4245 {
4246 for (size_t i = 0; i < num_args; i++)
4247 {
4248 lldb::user_id_t user_id = Args::StringToUInt32 (command.GetArgumentAtIndex(i), 0, 0, &success);
4249 if (!success)
4250 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004251 result.AppendErrorWithFormat ("invalid stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
Jim Inghamd60d94a2011-03-11 03:53:59 +00004252 result.SetStatus(eReturnStatusFailed);
4253 return false;
4254 }
4255 success = target->SetStopHookActiveStateByID (user_id, m_enable);
4256 if (!success)
4257 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004258 result.AppendErrorWithFormat ("unknown stop hook id: \"%s\".\n", command.GetArgumentAtIndex(i));
Jim Inghamd60d94a2011-03-11 03:53:59 +00004259 result.SetStatus(eReturnStatusFailed);
4260 return false;
4261 }
4262 }
4263 }
4264 result.SetStatus (eReturnStatusSuccessFinishNoResult);
4265 }
4266 else
4267 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004268 result.AppendError ("invalid target\n");
Jim Inghamd60d94a2011-03-11 03:53:59 +00004269 result.SetStatus (eReturnStatusFailed);
4270 }
4271 return result.Succeeded();
4272 }
4273private:
4274 bool m_enable;
4275};
4276
4277#pragma mark CommandObjectTargetStopHookList
4278
4279//-------------------------------------------------------------------------
4280// CommandObjectTargetStopHookList
4281//-------------------------------------------------------------------------
4282
4283class CommandObjectTargetStopHookList : public CommandObject
4284{
4285public:
4286
4287 CommandObjectTargetStopHookList (CommandInterpreter &interpreter) :
4288 CommandObject (interpreter,
Jason Molenda3fccc902011-11-10 23:03:44 +00004289 "target stop-hook list",
Jim Inghamd60d94a2011-03-11 03:53:59 +00004290 "List all stop-hooks.",
Jason Molenda3fccc902011-11-10 23:03:44 +00004291 "target stop-hook list [<type>]")
Jim Inghamd60d94a2011-03-11 03:53:59 +00004292 {
4293 }
4294
4295 ~CommandObjectTargetStopHookList ()
4296 {
4297 }
4298
4299 bool
4300 Execute (Args& command,
4301 CommandReturnObject &result)
4302 {
4303 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get();
Johnny Chen9fc16922011-11-29 23:56:14 +00004304 if (!target)
Jim Inghamd60d94a2011-03-11 03:53:59 +00004305 {
Greg Claytonabe0fed2011-04-18 08:33:37 +00004306 result.AppendError ("invalid target\n");
Jim Inghamd60d94a2011-03-11 03:53:59 +00004307 result.SetStatus (eReturnStatusFailed);
Jason Molenda6e3a2412011-09-23 21:15:42 +00004308 return result.Succeeded();
Jim Inghamd60d94a2011-03-11 03:53:59 +00004309 }
4310
4311 size_t num_hooks = target->GetNumStopHooks ();
4312 if (num_hooks == 0)
4313 {
4314 result.GetOutputStream().PutCString ("No stop hooks.\n");
4315 }
4316 else
4317 {
4318 for (size_t i = 0; i < num_hooks; i++)
4319 {
4320 Target::StopHookSP this_hook = target->GetStopHookAtIndex (i);
4321 if (i > 0)
4322 result.GetOutputStream().PutCString ("\n");
4323 this_hook->GetDescription (&(result.GetOutputStream()), eDescriptionLevelFull);
4324 }
4325 }
Johnny Chen6c7c3902011-11-30 19:09:20 +00004326 result.SetStatus (eReturnStatusSuccessFinishResult);
Jim Inghamd60d94a2011-03-11 03:53:59 +00004327 return result.Succeeded();
4328 }
4329};
4330
4331#pragma mark CommandObjectMultiwordTargetStopHooks
4332//-------------------------------------------------------------------------
4333// CommandObjectMultiwordTargetStopHooks
4334//-------------------------------------------------------------------------
4335
4336class CommandObjectMultiwordTargetStopHooks : public CommandObjectMultiword
4337{
4338public:
4339
4340 CommandObjectMultiwordTargetStopHooks (CommandInterpreter &interpreter) :
4341 CommandObjectMultiword (interpreter,
4342 "target stop-hook",
4343 "A set of commands for operating on debugger target stop-hooks.",
4344 "target stop-hook <subcommand> [<subcommand-options>]")
4345 {
4346 LoadSubCommand ("add", CommandObjectSP (new CommandObjectTargetStopHookAdd (interpreter)));
4347 LoadSubCommand ("delete", CommandObjectSP (new CommandObjectTargetStopHookDelete (interpreter)));
4348 LoadSubCommand ("disable", CommandObjectSP (new CommandObjectTargetStopHookEnableDisable (interpreter,
4349 false,
4350 "target stop-hook disable [<id>]",
4351 "Disable a stop-hook.",
4352 "target stop-hook disable")));
4353 LoadSubCommand ("enable", CommandObjectSP (new CommandObjectTargetStopHookEnableDisable (interpreter,
4354 true,
4355 "target stop-hook enable [<id>]",
4356 "Enable a stop-hook.",
4357 "target stop-hook enable")));
4358 LoadSubCommand ("list", CommandObjectSP (new CommandObjectTargetStopHookList (interpreter)));
4359 }
4360
4361 ~CommandObjectMultiwordTargetStopHooks()
4362 {
4363 }
4364};
4365
4366
Chris Lattner24943d22010-06-08 16:52:24 +00004367
4368#pragma mark CommandObjectMultiwordTarget
4369
4370//-------------------------------------------------------------------------
4371// CommandObjectMultiwordTarget
4372//-------------------------------------------------------------------------
4373
Greg Clayton63094e02010-06-23 01:19:29 +00004374CommandObjectMultiwordTarget::CommandObjectMultiwordTarget (CommandInterpreter &interpreter) :
Greg Clayton238c0a12010-09-18 01:14:36 +00004375 CommandObjectMultiword (interpreter,
4376 "target",
Chris Lattner24943d22010-06-08 16:52:24 +00004377 "A set of commands for operating on debugger targets.",
4378 "target <subcommand> [<subcommand-options>]")
4379{
Greg Claytonabe0fed2011-04-18 08:33:37 +00004380
4381 LoadSubCommand ("create", CommandObjectSP (new CommandObjectTargetCreate (interpreter)));
Greg Clayton153ccd72011-08-10 02:10:13 +00004382 LoadSubCommand ("delete", CommandObjectSP (new CommandObjectTargetDelete (interpreter)));
Greg Claytonabe0fed2011-04-18 08:33:37 +00004383 LoadSubCommand ("list", CommandObjectSP (new CommandObjectTargetList (interpreter)));
4384 LoadSubCommand ("select", CommandObjectSP (new CommandObjectTargetSelect (interpreter)));
Jim Inghamd60d94a2011-03-11 03:53:59 +00004385 LoadSubCommand ("stop-hook", CommandObjectSP (new CommandObjectMultiwordTargetStopHooks (interpreter)));
Greg Claytone1f50b92011-05-03 22:09:39 +00004386 LoadSubCommand ("modules", CommandObjectSP (new CommandObjectTargetModules (interpreter)));
Greg Clayton3508c382012-02-24 01:59:29 +00004387 LoadSubCommand ("symbols", CommandObjectSP (new CommandObjectTargetSymbols (interpreter)));
Greg Clayton801417e2011-07-07 01:59:51 +00004388 LoadSubCommand ("variable", CommandObjectSP (new CommandObjectTargetVariable (interpreter)));
Chris Lattner24943d22010-06-08 16:52:24 +00004389}
4390
4391CommandObjectMultiwordTarget::~CommandObjectMultiwordTarget ()
4392{
4393}
4394
Greg Claytonabe0fed2011-04-18 08:33:37 +00004395