tools/dsymutil/dsymutil.h

   1 //===- tools/dsymutil/dsymutil.h - dsymutil high-level functionality ------===//
   2 //
   3 //                             The LLVM Linker
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 ///
  12 /// This file contains the class declaration for the code that parses STABS
  13 /// debug maps that are embedded in the binaries symbol tables.
  14 ///
  15 //===----------------------------------------------------------------------===//
  16 #ifndef LLVM_TOOLS_DSYMUTIL_DSYMUTIL_H
  17 #define LLVM_TOOLS_DSYMUTIL_DSYMUTIL_H
  18
  19 #include "DebugMap.h"
  20 #include "llvm/ADT/StringRef.h"
  21 #include "llvm/Support/ErrorOr.h"
  22 #include <memory>
  23
  24 namespace llvm {
  25 namespace dsymutil {
  26
  27 struct LinkOptions {
  28   bool Verbose;  ///< Verbosity
  29   bool NoOutput; ///< Skip emitting output
  30   bool NoODR;    ///< Do not unique types according to ODR
  31
  32   LinkOptions() : Verbose(false), NoOutput(false) {}
  33 };
  34
  35 /// \brief Extract the DebugMap from the given file.
  36 /// The file has to be a MachO object file.
  37 llvm::ErrorOr<std::unique_ptr<DebugMap>> parseDebugMap(StringRef InputFile,
  38                                                        StringRef PrependPath,
  39                                                        bool Verbose,
  40                                                        bool InputIsYAML);
  41
  42 /// \brief Link the Dwarf debuginfo as directed by the passed DebugMap
  43 /// \p DM into a DwarfFile named \p OutputFilename.
  44 /// \returns false if the link failed.
  45 bool linkDwarf(StringRef OutputFilename, const DebugMap &DM,
  46                const LinkOptions &Options);
  47
  48 /// \brief Exit the dsymutil process, cleaning up every temporary
  49 /// files that we created.
  50 LLVM_ATTRIBUTE_NORETURN void exitDsymutil(int ExitStatus);
  51
  52 }
  53 }
  54 #endif // LLVM_TOOLS_DSYMUTIL_DSYMUTIL_H