llvm/tools/dsymutil/LinkUtils.h

   1 //===- tools/dsymutil/LinkUtils.h - Dwarf linker utilities ------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_TOOLS_DSYMUTIL_LINKOPTIONS_H
  10 #define LLVM_TOOLS_DSYMUTIL_LINKOPTIONS_H
  11
  12 #include "SymbolMap.h"
  13
  14 #include "llvm/ADT/Twine.h"
  15 #include "llvm/Remarks/RemarkFormat.h"
  16 #include "llvm/Support/VirtualFileSystem.h"
  17 #include "llvm/Support/WithColor.h"
  18
  19 #include "llvm/DWARFLinker/DWARFLinker.h"
  20 #include "llvm/DWARFLinker/DWARFStreamer.h"
  21 #include <string>
  22
  23 namespace llvm {
  24 namespace dsymutil {
  25
  26 enum class DsymutilAccelTableKind : uint8_t {
  27   None,
  28   Apple,   ///< .apple_names, .apple_namespaces, .apple_types, .apple_objc.
  29   Dwarf,   ///< DWARF v5 .debug_names.
  30   Default, ///< Dwarf for DWARF5 or later, Apple otherwise.
  31   Pub,     ///< .debug_pubnames, .debug_pubtypes
  32 };
  33
  34 enum class DsymutilDWARFLinkerType : uint8_t {
  35   Apple, /// Apple`s implementation of DWARFLinker.
  36   LLVM   /// LLVM implementation of DWARFLinker.
  37 };
  38
  39 struct LinkOptions {
  40   /// Verbosity
  41   bool Verbose = false;
  42
  43   /// Statistics
  44   bool Statistics = false;
  45
  46   /// Verify the input DWARF.
  47   bool VerifyInputDWARF = false;
  48
  49   /// Skip emitting output
  50   bool NoOutput = false;
  51
  52   /// Do not unique types according to ODR
  53   bool NoODR = false;
  54
  55   /// Update
  56   bool Update = false;
  57
  58   /// Do not check swiftmodule timestamp
  59   bool NoTimestamp = false;
  60
  61   /// Whether we want a static variable to force us to keep its enclosing
  62   /// function.
  63   bool KeepFunctionForStatic = false;
  64
  65   /// Type of DWARFLinker to use.
  66   DsymutilDWARFLinkerType DWARFLinkerType = DsymutilDWARFLinkerType::Apple;
  67
  68   /// Use a 64-bit header when emitting universal binaries.
  69   bool Fat64 = false;
  70
  71   /// Number of threads.
  72   unsigned Threads = 1;
  73
  74   // Output file type.
  75   DWARFLinker::OutputFileType FileType = DWARFLinker::OutputFileType::Object;
  76
  77   /// The accelerator table kind
  78   DsymutilAccelTableKind TheAccelTableKind;
  79
  80   /// -oso-prepend-path
  81   std::string PrependPath;
  82
  83   /// The -object-prefix-map.
  84   std::map<std::string, std::string> ObjectPrefixMap;
  85
  86   /// The Resources directory in the .dSYM bundle.
  87   std::optional<std::string> ResourceDir;
  88
  89   /// Symbol map translator.
  90   SymbolMapTranslator Translator;
  91
  92   /// Virtual File System.
  93   llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS =
  94       vfs::getRealFileSystem();
  95
  96   /// -build-variant-suffix.
  97   std::string BuildVariantSuffix;
  98
  99   /// Paths where to search for the .dSYM files of merged libraries.
 100   std::vector<std::string> DSYMSearchPaths;
 101
 102   /// Fields used for linking and placing remarks into the .dSYM bundle.
 103   /// @{
 104
 105   /// Number of debug maps processed in total.
 106   unsigned NumDebugMaps = 0;
 107
 108   /// -remarks-prepend-path: prepend a path to all the external remark file
 109   /// paths found in remark metadata.
 110   std::string RemarksPrependPath;
 111
 112   /// The output format of the remarks.
 113   remarks::Format RemarksFormat = remarks::Format::Bitstream;
 114
 115   /// Whether all remarks should be kept or only remarks with valid debug
 116   /// locations.
 117   bool RemarksKeepAll = true;
 118   /// @}
 119
 120   LinkOptions() = default;
 121 };
 122
 123 inline void warn(Twine Warning, Twine Context = {}) {
 124   WithColor::warning() << Warning + "\n";
 125   if (!Context.isTriviallyEmpty())
 126     WithColor::note() << Twine("while processing ") + Context + "\n";
 127 }
 128
 129 inline bool error(Twine Error, Twine Context = {}) {
 130   WithColor::error() << Error + "\n";
 131   if (!Context.isTriviallyEmpty())
 132     WithColor::note() << Twine("while processing ") + Context + "\n";
 133   return false;
 134 }
 135
 136 } // end namespace dsymutil
 137 } // end namespace llvm
 138
 139 #endif // LLVM_TOOLS_DSYMUTIL_LINKOPTIONS_H