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_StrDwo, "str.dwo", ".debug_str.dwo"),
  71         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo",
  72                    ".debug_str_offsets.dwo"),
  73         clEnumValN(DIDT_CUIndex, "cu_index", ".debug_cu_index"),
  74         clEnumValN(DIDT_GdbIndex, "gdb_index", ".gdb_index"),
  75         clEnumValN(DIDT_TUIndex, "tu_index", ".debug_tu_index")));
  76
  77 static cl::opt<bool>
  78     SummarizeTypes("summarize-types",
  79                    cl::desc("Abbreviate the description of type unit entries"));
  80
  81 static cl::opt<bool> Verify("verify", cl::desc("Verify the DWARF debug info"));
  82
  83 static cl::opt<bool> Quiet("quiet",
  84                            cl::desc("Use with -verify to not emit to STDOUT."));
  85
  86 static void error(StringRef Filename, std::error_code EC) {
  87   if (!EC)
  88     return;
  89   errs() << Filename << ": " << EC.message() << "\n";
  90   exit(1);
  91 }
  92
  93 static void DumpObjectFile(ObjectFile &Obj, Twine Filename) {
  94   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
  95
  96   outs() << Filename.str() << ":\tfile format " << Obj.getFileFormatName()
  97          << "\n\n";
  98   // Dump the complete DWARF structure.
  99   DICtx->dump(outs(), DumpType, false, SummarizeTypes);
 100 }
 101
 102 static void DumpInput(StringRef Filename) {
 103   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
 104       MemoryBuffer::getFileOrSTDIN(Filename);
 105   error(Filename, BuffOrErr.getError());
 106   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
 107
 108   Expected<std::unique_ptr<Binary>> BinOrErr =
 109       object::createBinary(Buff->getMemBufferRef());
 110   if (!BinOrErr)
 111     error(Filename, errorToErrorCode(BinOrErr.takeError()));
 112
 113   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
 114     DumpObjectFile(*Obj, Filename);
 115   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
 116     for (auto &ObjForArch : Fat->objects()) {
 117       auto MachOOrErr = ObjForArch.getAsObjectFile();
 118       error(Filename, errorToErrorCode(MachOOrErr.takeError()));
 119       DumpObjectFile(**MachOOrErr,
 120                      Filename + " (" + ObjForArch.getArchFlagName() + ")");
 121     }
 122 }
 123
 124 static bool VerifyObjectFile(ObjectFile &Obj, Twine Filename) {
 125   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
 126
 127   // Verify the DWARF and exit with non-zero exit status if verification
 128   // fails.
 129   raw_ostream &stream = Quiet ? nulls() : outs();
 130   stream << "Verifying " << Filename.str() << ":\tfile format "
 131   << Obj.getFileFormatName() << "\n";
 132   bool Result = DICtx->verify(stream, DumpType);
 133   if (Result)
 134     stream << "No errors.\n";
 135   else
 136     stream << "Errors detected.\n";
 137   return Result;
 138 }
 139
 140 static bool VerifyInput(StringRef Filename) {
 141   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
 142   MemoryBuffer::getFileOrSTDIN(Filename);
 143   error(Filename, BuffOrErr.getError());
 144   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
 145
 146   Expected<std::unique_ptr<Binary>> BinOrErr =
 147   object::createBinary(Buff->getMemBufferRef());
 148   if (!BinOrErr)
 149     error(Filename, errorToErrorCode(BinOrErr.takeError()));
 150
 151   bool Result = true;
 152   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
 153     Result = VerifyObjectFile(*Obj, Filename);
 154   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
 155     for (auto &ObjForArch : Fat->objects()) {
 156       auto MachOOrErr = ObjForArch.getAsObjectFile();
 157       error(Filename, errorToErrorCode(MachOOrErr.takeError()));
 158       if (!VerifyObjectFile(**MachOOrErr, Filename + " (" + ObjForArch.getArchFlagName() + ")"))
 159         Result = false;
 160     }
 161   return Result;
 162 }
 163
 164 /// If the input path is a .dSYM bundle (as created by the dsymutil tool),
 165 /// replace it with individual entries for each of the object files inside the
 166 /// bundle otherwise return the input path.
 167 static std::vector<std::string> expandBundle(const std::string &InputPath) {
 168   std::vector<std::string> BundlePaths;
 169   SmallString<256> BundlePath(InputPath);
 170   // Manually open up the bundle to avoid introducing additional dependencies.
 171   if (sys::fs::is_directory(BundlePath) &&
 172       sys::path::extension(BundlePath) == ".dSYM") {
 173     std::error_code EC;
 174     sys::path::append(BundlePath, "Contents", "Resources", "DWARF");
 175     for (sys::fs::directory_iterator Dir(BundlePath, EC), DirEnd;
 176          Dir != DirEnd && !EC; Dir.increment(EC)) {
 177       const std::string &Path = Dir->path();
 178       sys::fs::file_status Status;
 179       EC = sys::fs::status(Path, Status);
 180       error(Path, EC);
 181       switch (Status.type()) {
 182       case sys::fs::file_type::regular_file:
 183       case sys::fs::file_type::symlink_file:
 184       case sys::fs::file_type::type_unknown:
 185         BundlePaths.push_back(Path);
 186         break;
 187       default: /*ignore*/;
 188       }
 189     }
 190     error(BundlePath, EC);
 191   }
 192   if (!BundlePaths.size())
 193     BundlePaths.push_back(InputPath);
 194   return BundlePaths;
 195 }
 196
 197 int main(int argc, char **argv) {
 198   // Print a stack trace if we signal out.
 199   sys::PrintStackTraceOnErrorSignal(argv[0]);
 200   PrettyStackTraceProgram X(argc, argv);
 201   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 202
 203   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
 204
 205   // Defaults to a.out if no filenames specified.
 206   if (InputFilenames.size() == 0)
 207     InputFilenames.push_back("a.out");
 208
 209   // Expand any .dSYM bundles to the individual object files contained therein.
 210   std::vector<std::string> Objects;
 211   for (const auto &F : InputFilenames) {
 212     auto Objs = expandBundle(F);
 213     Objects.insert(Objects.end(), Objs.begin(), Objs.end());
 214   }
 215
 216   if (Verify) {
 217     // If we encountered errors during verify, exit with a non-zero exit status.
 218     if (!std::all_of(Objects.begin(), Objects.end(), VerifyInput))
 219       exit(1);
 220   } else {
 221     std::for_each(Objects.begin(), Objects.end(), DumpInput);
 222   }
 223
 224   return EXIT_SUCCESS;
 225 }