tools/dsymutil/dsymutil.cpp

   1 //===-- dsymutil.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 aims to be a dropin replacement for
  11 // Darwin's dsymutil.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "DebugMap.h"
  16 #include "dsymutil.h"
  17 #include "llvm/Support/ManagedStatic.h"
  18 #include "llvm/Support/Options.h"
  19 #include "llvm/Support/PrettyStackTrace.h"
  20 #include "llvm/Support/Signals.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 #include "llvm/Support/TargetSelect.h"
  23 #include <string>
  24
  25 using namespace llvm::dsymutil;
  26
  27 namespace {
  28 using namespace llvm::cl;
  29
  30 OptionCategory DsymCategory("Specific Options");
  31 static opt<bool> Help("h", desc("Alias for -help"), Hidden);
  32 static opt<bool> Version("v", desc("Alias for -version"), Hidden);
  33
  34 static opt<std::string> InputFile(Positional, desc("<input file>"),
  35                                   init("a.out"), cat(DsymCategory));
  36
  37 static opt<std::string>
  38     OutputFileOpt("o",
  39                   desc("Specify the output file. default: <input file>.dwarf"),
  40                   value_desc("filename"), cat(DsymCategory));
  41
  42 static opt<std::string> OsoPrependPath(
  43     "oso-prepend-path",
  44     desc("Specify a directory to prepend to the paths of object files."),
  45     value_desc("path"), cat(DsymCategory));
  46
  47 static opt<bool> Verbose("verbose", desc("Verbosity level"), init(false),
  48                          cat(DsymCategory));
  49
  50 static opt<bool>
  51     NoOutput("no-output",
  52              desc("Do the link in memory, but do not emit the result file."),
  53              init(false), cat(DsymCategory));
  54
  55 static opt<bool>
  56     NoODR("no-odr",
  57           desc("Do not use ODR (One Definition Rule) for type uniquing."),
  58           init(false), cat(DsymCategory));
  59
  60 static opt<bool> DumpDebugMap(
  61     "dump-debug-map",
  62     desc("Parse and dump the debug map to standard output. Not DWARF link "
  63          "will take place."),
  64     init(false), cat(DsymCategory));
  65
  66 static opt<bool> InputIsYAMLDebugMap(
  67     "y", desc("Treat the input file is a YAML debug map rather than a binary."),
  68     init(false), cat(DsymCategory));
  69 }
  70
  71 int main(int argc, char **argv) {
  72   llvm::sys::PrintStackTraceOnErrorSignal();
  73   llvm::PrettyStackTraceProgram StackPrinter(argc, argv);
  74   llvm::llvm_shutdown_obj Shutdown;
  75   LinkOptions Options;
  76
  77   HideUnrelatedOptions(DsymCategory);
  78   llvm::cl::ParseCommandLineOptions(
  79       argc, argv,
  80       "manipulate archived DWARF debug symbol files.\n\n"
  81       "dsymutil links the DWARF debug information found in the object files\n"
  82       "for the executable <input file> by using debug symbols information\n"
  83       "contained in its symbol table.\n");
  84
  85   if (Help)
  86     PrintHelpMessage();
  87
  88   if (Version) {
  89     llvm::cl::PrintVersionMessage();
  90     return 0;
  91   }
  92
  93   auto DebugMapPtrOrErr =
  94       parseDebugMap(InputFile, OsoPrependPath, Verbose, InputIsYAMLDebugMap);
  95
  96   Options.Verbose = Verbose;
  97   Options.NoOutput = NoOutput;
  98   Options.NoODR = NoODR;
  99
 100   llvm::InitializeAllTargetInfos();
 101   llvm::InitializeAllTargetMCs();
 102   llvm::InitializeAllTargets();
 103   llvm::InitializeAllAsmPrinters();
 104
 105   if (auto EC = DebugMapPtrOrErr.getError()) {
 106     llvm::errs() << "error: cannot parse the debug map for \"" << InputFile
 107                  << "\": " << EC.message() << '\n';
 108     return 1;
 109   }
 110
 111   if (Verbose || DumpDebugMap)
 112     (*DebugMapPtrOrErr)->print(llvm::outs());
 113
 114   if (DumpDebugMap)
 115     return 0;
 116
 117   std::string OutputFile;
 118   if (OutputFileOpt.empty()) {
 119     if (InputFile == "-")
 120       OutputFile = "a.out.dwarf";
 121     else
 122       OutputFile = InputFile + ".dwarf";
 123   } else {
 124     OutputFile = OutputFileOpt;
 125   }
 126
 127   return !linkDwarf(OutputFile, **DebugMapPtrOrErr, Options);
 128 }