1 //===-- CommandObjectSource.cpp ---------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-python.h"
12 #include "CommandObjectSource.h"
16 // Other libraries and framework includes
18 #include "lldb/Interpreter/Args.h"
19 #include "lldb/Core/Debugger.h"
20 #include "lldb/Core/FileLineResolver.h"
21 #include "lldb/Core/Module.h"
22 #include "lldb/Core/ModuleSpec.h"
23 #include "lldb/Core/SourceManager.h"
24 #include "lldb/Interpreter/CommandInterpreter.h"
25 #include "lldb/Interpreter/CommandReturnObject.h"
26 #include "lldb/Host/FileSpec.h"
27 #include "lldb/Symbol/CompileUnit.h"
28 #include "lldb/Symbol/Function.h"
29 #include "lldb/Symbol/Symbol.h"
30 #include "lldb/Target/Process.h"
31 #include "lldb/Target/SectionLoadList.h"
32 #include "lldb/Target/TargetList.h"
33 #include "lldb/Interpreter/CommandCompletions.h"
34 #include "lldb/Interpreter/Options.h"
37 using namespace lldb_private;
39 //-------------------------------------------------------------------------
40 // CommandObjectSourceInfo
41 //-------------------------------------------------------------------------
43 class CommandObjectSourceInfo : public CommandObjectParsed
46 class CommandOptions : public Options
49 CommandOptions (CommandInterpreter &interpreter) :
59 SetOptionValue (uint32_t option_idx, const char *option_arg)
62 const int short_option = g_option_table[option_idx].short_option;
66 start_line = Args::StringToUInt32 (option_arg, 0);
68 error.SetErrorStringWithFormat("invalid line number: '%s'", option_arg);
72 file_name = option_arg;
76 error.SetErrorStringWithFormat("unrecognized short option '%c'", short_option);
84 OptionParsingStarting ()
91 const OptionDefinition*
94 return g_option_table;
96 static OptionDefinition g_option_table[];
98 // Instance variables to hold the values for command options.
100 std::string file_name;
106 CommandObjectSourceInfo(CommandInterpreter &interpreter) :
107 CommandObjectParsed (interpreter,
109 "Display information about the source lines from the current executable's debug info.",
110 "source info [<cmd-options>]"),
111 m_options (interpreter)
115 ~CommandObjectSourceInfo ()
128 DoExecute (Args& command, CommandReturnObject &result)
130 result.AppendError ("Not yet implemented");
131 result.SetStatus (eReturnStatusFailed);
135 CommandOptions m_options;
139 CommandObjectSourceInfo::CommandOptions::g_option_table[] =
141 { LLDB_OPT_SET_1, false, "line", 'l', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeLineNum, "The line number at which to start the display source."},
142 { LLDB_OPT_SET_1, false, "file", 'f', OptionParser::eRequiredArgument, NULL, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename, "The file from which to display source."},
143 { 0, false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
146 #pragma mark CommandObjectSourceList
147 //-------------------------------------------------------------------------
148 // CommandObjectSourceList
149 //-------------------------------------------------------------------------
151 class CommandObjectSourceList : public CommandObjectParsed
154 class CommandOptions : public Options
157 CommandOptions (CommandInterpreter &interpreter) :
167 SetOptionValue (uint32_t option_idx, const char *option_arg)
170 const int short_option = g_option_table[option_idx].short_option;
171 switch (short_option)
174 start_line = Args::StringToUInt32 (option_arg, 0);
176 error.SetErrorStringWithFormat("invalid line number: '%s'", option_arg);
180 num_lines = Args::StringToUInt32 (option_arg, 0);
182 error.SetErrorStringWithFormat("invalid line count: '%s'", option_arg);
186 file_name = option_arg;
190 symbol_name = option_arg;
195 ExecutionContext exe_ctx (m_interpreter.GetExecutionContext());
196 address = Args::StringToAddress(&exe_ctx, option_arg, LLDB_INVALID_ADDRESS, &error);
200 modules.push_back (std::string (option_arg));
210 error.SetErrorStringWithFormat("unrecognized short option '%c'", short_option);
218 OptionParsingStarting ()
223 address = LLDB_INVALID_ADDRESS;
226 show_bp_locs = false;
231 const OptionDefinition*
234 return g_option_table;
236 static OptionDefinition g_option_table[];
238 // Instance variables to hold the values for command options.
240 std::string file_name;
241 std::string symbol_name;
242 lldb::addr_t address;
245 STLStringArray modules;
251 CommandObjectSourceList(CommandInterpreter &interpreter) :
252 CommandObjectParsed (interpreter,
254 "Display source code (as specified) based on the current executable's debug info.",
256 eFlagRequiresTarget),
257 m_options (interpreter)
261 ~CommandObjectSourceList ()
273 GetRepeatCommand (Args ¤t_command_args, uint32_t index)
275 // This is kind of gross, but the command hasn't been parsed yet so we can't look at the option
276 // values for this invocation... I have to scan the arguments directly.
277 size_t num_args = current_command_args.GetArgumentCount();
278 bool is_reverse = false;
279 for (size_t i = 0 ; i < num_args; i++)
281 const char *arg = current_command_args.GetArgumentAtIndex(i);
282 if (arg && (strcmp(arg, "-r") == 0 || strcmp(arg, "--reverse") == 0))
289 if (m_reverse_name.empty())
291 m_reverse_name = m_cmd_name;
292 m_reverse_name.append (" -r");
294 return m_reverse_name.c_str();
297 return m_cmd_name.c_str();
304 ConstString function;
305 LineEntry line_entry;
307 SourceInfo (const ConstString &name, const LineEntry &line_entry) :
309 line_entry(line_entry)
322 return (bool)function && line_entry.IsValid();
326 operator == (const SourceInfo &rhs) const
328 return function == rhs.function &&
329 line_entry.file == rhs.line_entry.file &&
330 line_entry.line == rhs.line_entry.line;
334 operator != (const SourceInfo &rhs) const
336 return function != rhs.function ||
337 line_entry.file != rhs.line_entry.file ||
338 line_entry.line != rhs.line_entry.line;
342 operator < (const SourceInfo &rhs) const
344 if (function.GetCString() < rhs.function.GetCString())
346 if (line_entry.file.GetDirectory().GetCString() < rhs.line_entry.file.GetDirectory().GetCString())
348 if (line_entry.file.GetFilename().GetCString() < rhs.line_entry.file.GetFilename().GetCString())
350 if (line_entry.line < rhs.line_entry.line)
357 DisplayFunctionSource (const SymbolContext &sc,
358 SourceInfo &source_info,
359 CommandReturnObject &result)
361 if (!source_info.IsValid())
363 source_info.function = sc.GetFunctionName();
364 source_info.line_entry = sc.GetFunctionStartLineEntry();
369 Target *target = m_exe_ctx.GetTargetPtr();
376 if (sc.block == NULL)
378 // Not an inlined function
379 sc.function->GetStartLineSourceInfo (start_file, start_line);
382 result.AppendErrorWithFormat("Could not find line information for start of function: \"%s\".\n", source_info.function.GetCString());
383 result.SetStatus (eReturnStatusFailed);
386 sc.function->GetEndLineSourceInfo (end_file, end_line);
390 // We have an inlined function
391 start_file = source_info.line_entry.file;
392 start_line = source_info.line_entry.line;
393 end_line = start_line + m_options.num_lines;
396 // This is a little hacky, but the first line table entry for a function points to the "{" that
397 // starts the function block. It would be nice to actually get the function
398 // declaration in there too. So back up a bit, but not further than what you're going to display.
399 uint32_t extra_lines;
400 if (m_options.num_lines >= 10)
403 extra_lines = m_options.num_lines/2;
405 if (start_line <= extra_lines)
408 line_no = start_line - extra_lines;
410 // For fun, if the function is shorter than the number of lines we're supposed to display,
411 // only display the function...
414 if (m_options.num_lines > end_line - line_no)
415 m_options.num_lines = end_line - line_no + extra_lines;
418 m_breakpoint_locations.Clear();
420 if (m_options.show_bp_locs)
422 const bool show_inlines = true;
423 m_breakpoint_locations.Reset (start_file, 0, show_inlines);
424 SearchFilterForUnconstrainedSearches target_search_filter (m_exe_ctx.GetTargetSP());
425 target_search_filter.Search (m_breakpoint_locations);
428 result.AppendMessageWithFormat("File: %s\n", start_file.GetPath().c_str());
429 return target->GetSourceManager().DisplaySourceLinesWithLineNumbers (start_file,
434 &result.GetOutputStream(),
435 GetBreakpointLocations ());
439 result.AppendErrorWithFormat("Could not find function info for: \"%s\".\n", m_options.symbol_name.c_str());
444 // From Jim: The FindMatchingFunctions / FindMatchingFunctionSymbols functions
445 // "take a possibly empty vector of strings which are names of modules, and
446 // run the two search functions on the subset of the full module list that
447 // matches the strings in the input vector". If we wanted to put these somewhere,
448 // there should probably be a module-filter-list that can be passed to the
449 // various ModuleList::Find* calls, which would either be a vector of string
450 // names or a ModuleSpecList.
451 size_t FindMatchingFunctions (Target *target, const ConstString &name, SymbolContextList& sc_list)
453 // Displaying the source for a symbol:
454 bool include_inlines = true;
456 bool include_symbols = false;
457 size_t num_matches = 0;
459 if (m_options.num_lines == 0)
460 m_options.num_lines = 10;
462 const size_t num_modules = m_options.modules.size();
465 ModuleList matching_modules;
466 for (size_t i = 0; i < num_modules; ++i)
468 FileSpec module_file_spec(m_options.modules[i].c_str(), false);
469 if (module_file_spec)
471 ModuleSpec module_spec (module_file_spec);
472 matching_modules.Clear();
473 target->GetImages().FindModules (module_spec, matching_modules);
474 num_matches += matching_modules.FindFunctions (name, eFunctionNameTypeAuto, include_symbols, include_inlines, append, sc_list);
480 num_matches = target->GetImages().FindFunctions (name, eFunctionNameTypeAuto, include_symbols, include_inlines, append, sc_list);
485 size_t FindMatchingFunctionSymbols (Target *target, const ConstString &name, SymbolContextList& sc_list)
487 size_t num_matches = 0;
488 const size_t num_modules = m_options.modules.size();
491 ModuleList matching_modules;
492 for (size_t i = 0; i < num_modules; ++i)
494 FileSpec module_file_spec(m_options.modules[i].c_str(), false);
495 if (module_file_spec)
497 ModuleSpec module_spec (module_file_spec);
498 matching_modules.Clear();
499 target->GetImages().FindModules (module_spec, matching_modules);
500 num_matches += matching_modules.FindFunctionSymbols (name, eFunctionNameTypeAuto, sc_list);
506 num_matches = target->GetImages().FindFunctionSymbols (name, eFunctionNameTypeAuto, sc_list);
512 DoExecute (Args& command, CommandReturnObject &result)
514 const size_t argc = command.GetArgumentCount();
518 result.AppendErrorWithFormat("'%s' takes no arguments, only flags.\n", GetCommandName());
519 result.SetStatus (eReturnStatusFailed);
523 Target *target = m_exe_ctx.GetTargetPtr();
525 if (!m_options.symbol_name.empty())
527 SymbolContextList sc_list;
528 ConstString name(m_options.symbol_name.c_str());
530 // Displaying the source for a symbol. Search for function named name.
531 size_t num_matches = FindMatchingFunctions (target, name, sc_list);
534 // If we didn't find any functions with that name, try searching for symbols
535 // that line up exactly with function addresses.
536 SymbolContextList sc_list_symbols;
537 size_t num_symbol_matches = FindMatchingFunctionSymbols (target, name, sc_list_symbols);
538 for (size_t i = 0; i < num_symbol_matches; i++)
541 sc_list_symbols.GetContextAtIndex (i, sc);
544 const Address &base_address = sc.symbol->GetAddress();
545 Function *function = base_address.CalculateSymbolContextFunction();
548 sc_list.Append (SymbolContext(function));
556 if (num_matches == 0)
558 result.AppendErrorWithFormat("Could not find function named: \"%s\".\n", m_options.symbol_name.c_str());
559 result.SetStatus (eReturnStatusFailed);
565 std::set<SourceInfo> source_match_set;
567 bool displayed_something = false;
568 for (size_t i = 0; i < num_matches; i++)
571 sc_list.GetContextAtIndex (i, sc);
572 SourceInfo source_info (sc.GetFunctionName(),
573 sc.GetFunctionStartLineEntry());
575 if (source_info.IsValid())
577 if (source_match_set.find(source_info) == source_match_set.end())
579 source_match_set.insert(source_info);
580 if (DisplayFunctionSource (sc, source_info, result))
581 displayed_something = true;
586 if (displayed_something)
587 result.SetStatus (eReturnStatusSuccessFinishResult);
589 result.SetStatus (eReturnStatusFailed);
594 sc_list.GetContextAtIndex (0, sc);
595 SourceInfo source_info;
597 if (DisplayFunctionSource (sc, source_info, result))
599 result.SetStatus (eReturnStatusSuccessFinishResult);
603 result.SetStatus (eReturnStatusFailed);
606 return result.Succeeded();
608 else if (m_options.address != LLDB_INVALID_ADDRESS)
611 StreamString error_strm;
612 SymbolContextList sc_list;
614 if (target->GetSectionLoadList().IsEmpty())
616 // The target isn't loaded yet, we need to lookup the file address
618 const ModuleList &module_list = target->GetImages();
619 const size_t num_modules = module_list.GetSize();
620 for (size_t i=0; i<num_modules; ++i)
622 ModuleSP module_sp (module_list.GetModuleAtIndex(i));
623 if (module_sp && module_sp->ResolveFileAddress(m_options.address, so_addr))
627 if (module_sp->ResolveSymbolContextForAddress (so_addr, eSymbolContextEverything, sc) & eSymbolContextLineEntry)
632 if (sc_list.GetSize() == 0)
634 result.AppendErrorWithFormat("no modules have source information for file address 0x%" PRIx64 ".\n",
636 result.SetStatus (eReturnStatusFailed);
642 // The target has some things loaded, resolve this address to a
643 // compile unit + file + line and display
644 if (target->GetSectionLoadList().ResolveLoadAddress (m_options.address, so_addr))
646 ModuleSP module_sp (so_addr.GetModule());
651 if (module_sp->ResolveSymbolContextForAddress (so_addr, eSymbolContextEverything, sc) & eSymbolContextLineEntry)
657 so_addr.Dump(&error_strm, NULL, Address::DumpStyleModuleWithFileAddress);
658 result.AppendErrorWithFormat("address resolves to %s, but there is no line table information available for this address.\n",
659 error_strm.GetData());
660 result.SetStatus (eReturnStatusFailed);
666 if (sc_list.GetSize() == 0)
668 result.AppendErrorWithFormat("no modules contain load address 0x%" PRIx64 ".\n", m_options.address);
669 result.SetStatus (eReturnStatusFailed);
673 uint32_t num_matches = sc_list.GetSize();
674 for (uint32_t i=0; i<num_matches; ++i)
677 sc_list.GetContextAtIndex(i, sc);
680 if (m_options.show_bp_locs)
682 m_breakpoint_locations.Clear();
683 const bool show_inlines = true;
684 m_breakpoint_locations.Reset (*sc.comp_unit, 0, show_inlines);
685 SearchFilterForUnconstrainedSearches target_search_filter (target->shared_from_this());
686 target_search_filter.Search (m_breakpoint_locations);
689 bool show_fullpaths = true;
690 bool show_module = true;
691 bool show_inlined_frames = true;
692 const bool show_function_arguments = true;
693 sc.DumpStopContext(&result.GetOutputStream(),
694 m_exe_ctx.GetBestExecutionContextScope(),
695 sc.line_entry.range.GetBaseAddress(),
699 show_function_arguments);
700 result.GetOutputStream().EOL();
702 if (m_options.num_lines == 0)
703 m_options.num_lines = 10;
705 size_t lines_to_back_up = m_options.num_lines >= 10 ? 5 : m_options.num_lines/2;
707 target->GetSourceManager().DisplaySourceLinesWithLineNumbers (sc.comp_unit,
710 m_options.num_lines - lines_to_back_up,
712 &result.GetOutputStream(),
713 GetBreakpointLocations ());
714 result.SetStatus (eReturnStatusSuccessFinishResult);
718 else if (m_options.file_name.empty())
720 // Last valid source manager context, or the current frame if no
721 // valid last context in source manager.
722 // One little trick here, if you type the exact same list command twice in a row, it is
723 // more likely because you typed it once, then typed it again
724 if (m_options.start_line == 0)
726 if (target->GetSourceManager().DisplayMoreWithLineNumbers (&result.GetOutputStream(),
729 GetBreakpointLocations ()))
731 result.SetStatus (eReturnStatusSuccessFinishResult);
736 if (m_options.num_lines == 0)
737 m_options.num_lines = 10;
739 if (m_options.show_bp_locs)
741 SourceManager::FileSP last_file_sp (target->GetSourceManager().GetLastFile ());
744 const bool show_inlines = true;
745 m_breakpoint_locations.Reset (last_file_sp->GetFileSpec(), 0, show_inlines);
746 SearchFilterForUnconstrainedSearches target_search_filter (target->shared_from_this());
747 target_search_filter.Search (m_breakpoint_locations);
751 m_breakpoint_locations.Clear();
753 if (target->GetSourceManager().DisplaySourceLinesWithLineNumbersUsingLastFile(
754 m_options.start_line, // Line to display
755 m_options.num_lines, // Lines after line to
756 UINT32_MAX, // Don't mark "line"
757 "", // Don't mark "line"
758 &result.GetOutputStream(),
759 GetBreakpointLocations ()))
761 result.SetStatus (eReturnStatusSuccessFinishResult);
768 const char *filename = m_options.file_name.c_str();
770 bool check_inlines = false;
771 SymbolContextList sc_list;
772 size_t num_matches = 0;
774 if (m_options.modules.size() > 0)
776 ModuleList matching_modules;
777 for (size_t i = 0, e = m_options.modules.size(); i < e; ++i)
779 FileSpec module_file_spec(m_options.modules[i].c_str(), false);
780 if (module_file_spec)
782 ModuleSpec module_spec (module_file_spec);
783 matching_modules.Clear();
784 target->GetImages().FindModules (module_spec, matching_modules);
785 num_matches += matching_modules.ResolveSymbolContextForFilePath (filename,
788 eSymbolContextModule | eSymbolContextCompUnit,
795 num_matches = target->GetImages().ResolveSymbolContextForFilePath (filename,
798 eSymbolContextModule | eSymbolContextCompUnit,
802 if (num_matches == 0)
804 result.AppendErrorWithFormat("Could not find source file \"%s\".\n",
805 m_options.file_name.c_str());
806 result.SetStatus (eReturnStatusFailed);
812 bool got_multiple = false;
813 FileSpec *test_cu_spec = NULL;
815 for (unsigned i = 0; i < num_matches; i++)
818 sc_list.GetContextAtIndex(i, sc);
823 if (test_cu_spec != static_cast<FileSpec *> (sc.comp_unit))
828 test_cu_spec = sc.comp_unit;
833 result.AppendErrorWithFormat("Multiple source files found matching: \"%s.\"\n",
834 m_options.file_name.c_str());
835 result.SetStatus (eReturnStatusFailed);
841 if (sc_list.GetContextAtIndex(0, sc))
845 if (m_options.show_bp_locs)
847 const bool show_inlines = true;
848 m_breakpoint_locations.Reset (*sc.comp_unit, 0, show_inlines);
849 SearchFilterForUnconstrainedSearches target_search_filter (target->shared_from_this());
850 target_search_filter.Search (m_breakpoint_locations);
853 m_breakpoint_locations.Clear();
855 if (m_options.num_lines == 0)
856 m_options.num_lines = 10;
858 target->GetSourceManager().DisplaySourceLinesWithLineNumbers (sc.comp_unit,
859 m_options.start_line,
863 &result.GetOutputStream(),
864 GetBreakpointLocations ());
866 result.SetStatus (eReturnStatusSuccessFinishResult);
870 result.AppendErrorWithFormat("No comp unit found for: \"%s.\"\n",
871 m_options.file_name.c_str());
872 result.SetStatus (eReturnStatusFailed);
877 return result.Succeeded();
880 const SymbolContextList *
881 GetBreakpointLocations ()
883 if (m_breakpoint_locations.GetFileLineMatches().GetSize() > 0)
884 return &m_breakpoint_locations.GetFileLineMatches();
887 CommandOptions m_options;
888 FileLineResolver m_breakpoint_locations;
889 std::string m_reverse_name;
894 CommandObjectSourceList::CommandOptions::g_option_table[] =
896 { LLDB_OPT_SET_ALL, false, "count", 'c', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeCount, "The number of source lines to display."},
898 LLDB_OPT_SET_2 , false, "shlib", 's', OptionParser::eRequiredArgument, NULL, NULL, CommandCompletions::eModuleCompletion, eArgTypeShlibName, "Look up the source file in the given shared library."},
899 { LLDB_OPT_SET_ALL, false, "show-breakpoints", 'b', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Show the line table locations from the debug information that indicate valid places to set source level breakpoints."},
900 { LLDB_OPT_SET_1 , false, "file", 'f', OptionParser::eRequiredArgument, NULL, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename, "The file from which to display source."},
901 { LLDB_OPT_SET_1 , false, "line", 'l', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeLineNum, "The line number at which to start the display source."},
902 { LLDB_OPT_SET_2 , false, "name", 'n', OptionParser::eRequiredArgument, NULL, NULL, CommandCompletions::eSymbolCompletion, eArgTypeSymbol, "The name of a function whose source to display."},
903 { LLDB_OPT_SET_3 , false, "address",'a', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeAddressOrExpression, "Lookup the address and display the source information for the corresponding file and line."},
904 { LLDB_OPT_SET_4, false, "reverse", 'r', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Reverse the listing to look backwards from the last displayed block of source."},
905 { 0, false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
908 #pragma mark CommandObjectMultiwordSource
910 //-------------------------------------------------------------------------
911 // CommandObjectMultiwordSource
912 //-------------------------------------------------------------------------
914 CommandObjectMultiwordSource::CommandObjectMultiwordSource (CommandInterpreter &interpreter) :
915 CommandObjectMultiword (interpreter,
917 "A set of commands for accessing source file information",
918 "source <subcommand> [<subcommand-options>]")
920 // "source info" isn't implemented yet...
921 //LoadSubCommand ("info", CommandObjectSP (new CommandObjectSourceInfo (interpreter)));
922 LoadSubCommand ("list", CommandObjectSP (new CommandObjectSourceList (interpreter)));
925 CommandObjectMultiwordSource::~CommandObjectMultiwordSource ()