1//===-- llvm-dwarfdump.cpp - Debug info dumping utility for llvm ----------===//
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// This program is a utility that works like "dwarfdump".
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/ADT/OwningPtr.h"
15#include "llvm/ADT/STLExtras.h"
16#include "llvm/ADT/Triple.h"
17#include "llvm/DebugInfo/DIContext.h"
18#include "llvm/Object/ObjectFile.h"
19#include "llvm/Object/RelocVisitor.h"
20#include "llvm/Support/CommandLine.h"
21#include "llvm/Support/Debug.h"
22#include "llvm/Support/Format.h"
23#include "llvm/Support/ManagedStatic.h"
24#include "llvm/Support/MemoryBuffer.h"
25#include "llvm/Support/MemoryObject.h"
26#include "llvm/Support/PrettyStackTrace.h"
27#include "llvm/Support/Signals.h"
28#include "llvm/Support/raw_ostream.h"
29#include "llvm/Support/system_error.h"
30#include <algorithm>
31#include <cstring>
32#include <list>
33#include <string>
34
35using namespace llvm;
36using namespace object;
37
38static cl::list<std::string>
39InputFilenames(cl::Positional, cl::desc("<input object files>"),
40               cl::ZeroOrMore);
41
42static cl::opt<unsigned long long>
43Address("address", cl::init(-1ULL),
44        cl::desc("Print line information for a given address"));
45
46static cl::opt<bool>
47PrintFunctions("functions", cl::init(false),
48               cl::desc("Print function names as well as line information "
49                        "for a given address"));
50
51static cl::opt<bool>
52PrintInlining("inlining", cl::init(false),
53              cl::desc("Print all inlined frames for a given address"));
54
55static cl::opt<DIDumpType>
56DumpType("debug-dump", cl::init(DIDT_All),
57  cl::desc("Dump of debug sections:"),
58  cl::values(
59        clEnumValN(DIDT_All, "all", "Dump all debug sections"),
60        clEnumValN(DIDT_Abbrev, "abbrev", ".debug_abbrev"),
61        clEnumValN(DIDT_AbbrevDwo, "abbrev.dwo", ".debug_abbrev.dwo"),
62        clEnumValN(DIDT_Aranges, "aranges", ".debug_aranges"),
63        clEnumValN(DIDT_Info, "info", ".debug_info"),
64        clEnumValN(DIDT_InfoDwo, "info.dwo", ".debug_info.dwo"),
65        clEnumValN(DIDT_Line, "line", ".debug_line"),
66        clEnumValN(DIDT_Loc, "loc", ".debug_loc"),
67        clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
68        clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
69        clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
70        clEnumValN(DIDT_Str, "str", ".debug_str"),
71        clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
72        clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo", ".debug_str_offsets.dwo"),
73        clEnumValEnd));
74
75static void PrintDILineInfo(DILineInfo dli) {
76  if (PrintFunctions)
77    outs() << (dli.getFunctionName() ? dli.getFunctionName() : "<unknown>")
78           << "\n";
79  outs() << (dli.getFileName() ? dli.getFileName() : "<unknown>") << ':'
80         << dli.getLine() << ':' << dli.getColumn() << '\n';
81}
82
83static void DumpInput(const StringRef &Filename) {
84  OwningPtr<MemoryBuffer> Buff;
85
86  if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
87    errs() << Filename << ": " << ec.message() << "\n";
88    return;
89  }
90
91  OwningPtr<ObjectFile> Obj(ObjectFile::createObjectFile(Buff.take()));
92  if (!Obj) {
93    errs() << Filename << ": Unknown object file format\n";
94    return;
95  }
96
97  OwningPtr<DIContext> DICtx(DIContext::getDWARFContext(Obj.get()));
98
99  if (Address == -1ULL) {
100    outs() << Filename
101           << ":\tfile format " << Obj->getFileFormatName() << "\n\n";
102    // Dump the complete DWARF structure.
103    DICtx->dump(outs(), DumpType);
104  } else {
105    // Print line info for the specified address.
106    int SpecFlags = DILineInfoSpecifier::FileLineInfo |
107                    DILineInfoSpecifier::AbsoluteFilePath;
108    if (PrintFunctions)
109      SpecFlags |= DILineInfoSpecifier::FunctionName;
110    if (PrintInlining) {
111      DIInliningInfo InliningInfo =
112        DICtx->getInliningInfoForAddress(Address, SpecFlags);
113      uint32_t n = InliningInfo.getNumberOfFrames();
114      if (n == 0) {
115        // Print one empty debug line info in any case.
116        PrintDILineInfo(DILineInfo());
117      } else {
118        for (uint32_t i = 0; i < n; i++) {
119          DILineInfo dli = InliningInfo.getFrame(i);
120          PrintDILineInfo(dli);
121        }
122      }
123    } else {
124      DILineInfo dli = DICtx->getLineInfoForAddress(Address, SpecFlags);
125      PrintDILineInfo(dli);
126    }
127  }
128}
129
130int main(int argc, char **argv) {
131  // Print a stack trace if we signal out.
132  sys::PrintStackTraceOnErrorSignal();
133  PrettyStackTraceProgram X(argc, argv);
134  llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
135
136  cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
137
138  // Defaults to a.out if no filenames specified.
139  if (InputFilenames.size() == 0)
140    InputFilenames.push_back("a.out");
141
142  std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
143
144  return 0;
145}
146