contrib/llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

   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/STLExtras.h"
  15 #include "llvm/ADT/Triple.h"
  16 #include "llvm/DebugInfo/DIContext.h"
  17 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
  18 #include "llvm/Object/MachOUniversal.h"
  19 #include "llvm/Object/ObjectFile.h"
  20 #include "llvm/Object/RelocVisitor.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/Format.h"
  24 #include "llvm/Support/ManagedStatic.h"
  25 #include "llvm/Support/MemoryBuffer.h"
  26 #include "llvm/Support/Path.h"
  27 #include "llvm/Support/PrettyStackTrace.h"
  28 #include "llvm/Support/Signals.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include <algorithm>
  31 #include <cstring>
  32 #include <string>
  33 #include <system_error>
  34
  35 using namespace llvm;
  36 using namespace object;
  37
  38 static cl::list<std::string>
  39 InputFilenames(cl::Positional, cl::desc("<input object files or .dSYM bundles>"),
  40                cl::ZeroOrMore);
  41
  42 static cl::opt<DIDumpType> DumpType(
  43     "debug-dump", cl::init(DIDT_All), cl::desc("Dump of debug sections:"),
  44     cl::values(
  45         clEnumValN(DIDT_All, "all", "Dump all debug sections"),
  46         clEnumValN(DIDT_Abbrev, "abbrev", ".debug_abbrev"),
  47         clEnumValN(DIDT_AbbrevDwo, "abbrev.dwo", ".debug_abbrev.dwo"),
  48         clEnumValN(DIDT_AppleNames, "apple_names", ".apple_names"),
  49         clEnumValN(DIDT_AppleTypes, "apple_types", ".apple_types"),
  50         clEnumValN(DIDT_AppleNamespaces, "apple_namespaces",
  51                    ".apple_namespaces"),
  52         clEnumValN(DIDT_AppleObjC, "apple_objc", ".apple_objc"),
  53         clEnumValN(DIDT_Aranges, "aranges", ".debug_aranges"),
  54         clEnumValN(DIDT_Info, "info", ".debug_info"),
  55         clEnumValN(DIDT_InfoDwo, "info.dwo", ".debug_info.dwo"),
  56         clEnumValN(DIDT_Types, "types", ".debug_types"),
  57         clEnumValN(DIDT_TypesDwo, "types.dwo", ".debug_types.dwo"),
  58         clEnumValN(DIDT_Line, "line", ".debug_line"),
  59         clEnumValN(DIDT_LineDwo, "line.dwo", ".debug_line.dwo"),
  60         clEnumValN(DIDT_Loc, "loc", ".debug_loc"),
  61         clEnumValN(DIDT_LocDwo, "loc.dwo", ".debug_loc.dwo"),
  62         clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
  63         clEnumValN(DIDT_Macro, "macro", ".debug_macinfo"),
  64         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
  65         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
  66         clEnumValN(DIDT_Pubtypes, "pubtypes", ".debug_pubtypes"),
  67         clEnumValN(DIDT_GnuPubnames, "gnu_pubnames", ".debug_gnu_pubnames"),
  68         clEnumValN(DIDT_GnuPubtypes, "gnu_pubtypes", ".debug_gnu_pubtypes"),
  69         clEnumValN(DIDT_Str, "str", ".debug_str"),
  70         clEnumValN(DIDT_StrOffsets, "str_offsets", ".debug_str_offsets"),
  71         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
  72         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo",
  73                    ".debug_str_offsets.dwo"),
  74         clEnumValN(DIDT_CUIndex, "cu_index", ".debug_cu_index"),
  75         clEnumValN(DIDT_GdbIndex, "gdb_index", ".gdb_index"),
  76         clEnumValN(DIDT_TUIndex, "tu_index", ".debug_tu_index")));
  77
  78 static cl::opt<bool>
  79     SummarizeTypes("summarize-types",
  80                    cl::desc("Abbreviate the description of type unit entries"));
  81
  82 static cl::opt<bool> Verify("verify", cl::desc("Verify the DWARF debug info"));
  83
  84 static cl::opt<bool> Quiet("quiet",
  85                            cl::desc("Use with -verify to not emit to STDOUT."));
  86
  87 static cl::opt<bool> Brief("brief", cl::desc("Print fewer low-level details"));
  88
  89 static void error(StringRef Filename, std::error_code EC) {
  90   if (!EC)
  91     return;
  92   errs() << Filename << ": " << EC.message() << "\n";
  93   exit(1);
  94 }
  95
  96 static void DumpObjectFile(ObjectFile &Obj, Twine Filename) {
  97   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
  98
  99   outs() << Filename.str() << ":\tfile format " << Obj.getFileFormatName()
 100          << "\n\n";
 101
 102
 103   // Dump the complete DWARF structure.
 104   DIDumpOptions DumpOpts;
 105   DumpOpts.DumpType = DumpType;
 106   DumpOpts.SummarizeTypes = SummarizeTypes;
 107   DumpOpts.Brief = Brief;
 108   DICtx->dump(outs(), DumpOpts);
 109 }
 110
 111 static void DumpInput(StringRef Filename) {
 112   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
 113       MemoryBuffer::getFileOrSTDIN(Filename);
 114   error(Filename, BuffOrErr.getError());
 115   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
 116
 117   Expected<std::unique_ptr<Binary>> BinOrErr =
 118       object::createBinary(Buff->getMemBufferRef());
 119   if (!BinOrErr)
 120     error(Filename, errorToErrorCode(BinOrErr.takeError()));
 121
 122   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
 123     DumpObjectFile(*Obj, Filename);
 124   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
 125     for (auto &ObjForArch : Fat->objects()) {
 126       auto MachOOrErr = ObjForArch.getAsObjectFile();
 127       error(Filename, errorToErrorCode(MachOOrErr.takeError()));
 128       DumpObjectFile(**MachOOrErr,
 129                      Filename + " (" + ObjForArch.getArchFlagName() + ")");
 130     }
 131 }
 132
 133 static bool VerifyObjectFile(ObjectFile &Obj, Twine Filename) {
 134   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
 135
 136   // Verify the DWARF and exit with non-zero exit status if verification
 137   // fails.
 138   raw_ostream &stream = Quiet ? nulls() : outs();
 139   stream << "Verifying " << Filename.str() << ":\tfile format "
 140   << Obj.getFileFormatName() << "\n";
 141   bool Result = DICtx->verify(stream, DumpType);
 142   if (Result)
 143     stream << "No errors.\n";
 144   else
 145     stream << "Errors detected.\n";
 146   return Result;
 147 }
 148
 149 static bool VerifyInput(StringRef Filename) {
 150   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
 151   MemoryBuffer::getFileOrSTDIN(Filename);
 152   error(Filename, BuffOrErr.getError());
 153   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
 154
 155   Expected<std::unique_ptr<Binary>> BinOrErr =
 156   object::createBinary(Buff->getMemBufferRef());
 157   if (!BinOrErr)
 158     error(Filename, errorToErrorCode(BinOrErr.takeError()));
 159
 160   bool Result = true;
 161   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
 162     Result = VerifyObjectFile(*Obj, Filename);
 163   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
 164     for (auto &ObjForArch : Fat->objects()) {
 165       auto MachOOrErr = ObjForArch.getAsObjectFile();
 166       error(Filename, errorToErrorCode(MachOOrErr.takeError()));
 167       if (!VerifyObjectFile(**MachOOrErr, Filename + " (" + ObjForArch.getArchFlagName() + ")"))
 168         Result = false;
 169     }
 170   return Result;
 171 }
 172
 173 /// If the input path is a .dSYM bundle (as created by the dsymutil tool),
 174 /// replace it with individual entries for each of the object files inside the
 175 /// bundle otherwise return the input path.
 176 static std::vector<std::string> expandBundle(const std::string &InputPath) {
 177   std::vector<std::string> BundlePaths;
 178   SmallString<256> BundlePath(InputPath);
 179   // Manually open up the bundle to avoid introducing additional dependencies.
 180   if (sys::fs::is_directory(BundlePath) &&
 181       sys::path::extension(BundlePath) == ".dSYM") {
 182     std::error_code EC;
 183     sys::path::append(BundlePath, "Contents", "Resources", "DWARF");
 184     for (sys::fs::directory_iterator Dir(BundlePath, EC), DirEnd;
 185          Dir != DirEnd && !EC; Dir.increment(EC)) {
 186       const std::string &Path = Dir->path();
 187       sys::fs::file_status Status;
 188       EC = sys::fs::status(Path, Status);
 189       error(Path, EC);
 190       switch (Status.type()) {
 191       case sys::fs::file_type::regular_file:
 192       case sys::fs::file_type::symlink_file:
 193       case sys::fs::file_type::type_unknown:
 194         BundlePaths.push_back(Path);
 195         break;
 196       default: /*ignore*/;
 197       }
 198     }
 199     error(BundlePath, EC);
 200   }
 201   if (!BundlePaths.size())
 202     BundlePaths.push_back(InputPath);
 203   return BundlePaths;
 204 }
 205
 206 int main(int argc, char **argv) {
 207   // Print a stack trace if we signal out.
 208   sys::PrintStackTraceOnErrorSignal(argv[0]);
 209   PrettyStackTraceProgram X(argc, argv);
 210   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 211
 212   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
 213
 214   // Defaults to a.out if no filenames specified.
 215   if (InputFilenames.size() == 0)
 216     InputFilenames.push_back("a.out");
 217
 218   // Expand any .dSYM bundles to the individual object files contained therein.
 219   std::vector<std::string> Objects;
 220   for (const auto &F : InputFilenames) {
 221     auto Objs = expandBundle(F);
 222     Objects.insert(Objects.end(), Objs.begin(), Objs.end());
 223   }
 224
 225   if (Verify) {
 226     // If we encountered errors during verify, exit with a non-zero exit status.
 227     if (!std::all_of(Objects.begin(), Objects.end(), VerifyInput))
 228       exit(1);
 229   } else {
 230     std::for_each(Objects.begin(), Objects.end(), DumpInput);
 231   }
 232
 233   return EXIT_SUCCESS;
 234 }