1 //===- Config.h -------------------------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef LLD_MACHO_CONFIG_H
10 #define LLD_MACHO_CONFIG_H
12 #include "llvm/ADT/CachedHashString.h"
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/ADT/DenseSet.h"
15 #include "llvm/ADT/MapVector.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/ADT/StringSet.h"
18 #include "llvm/BinaryFormat/MachO.h"
19 #include "llvm/Support/CachePruning.h"
20 #include "llvm/Support/GlobPattern.h"
21 #include "llvm/Support/VersionTuple.h"
22 #include "llvm/TextAPI/Architecture.h"
23 #include "llvm/TextAPI/Platform.h"
24 #include "llvm/TextAPI/Target.h"
34 using NamePair = std::pair<llvm::StringRef, llvm::StringRef>;
35 using SectionRenameMap = llvm::DenseMap<NamePair, NamePair>;
36 using SegmentRenameMap = llvm::DenseMap<llvm::StringRef, llvm::StringRef>;
39 llvm::MachO::Target target;
40 llvm::VersionTuple minimum;
41 llvm::VersionTuple sdk;
44 inline uint32_t encodeVersion(const llvm::VersionTuple &version) {
45 return ((version.getMajor() << 020) |
46 (version.getMinor().value_or(0) << 010) |
47 version.getSubminor().value_or(0));
50 enum class NamespaceKind {
55 enum class UndefinedSymbolTreatment {
71 llvm::StringRef segName;
72 llvm::StringRef sectName;
76 struct SegmentProtection {
82 class SymbolPatterns {
84 // GlobPattern can also match literals,
85 // but we prefer the O(1) lookup of DenseSet.
86 llvm::DenseSet<llvm::CachedHashStringRef> literals;
87 std::vector<llvm::GlobPattern> globs;
89 bool empty() const { return literals.empty() && globs.empty(); }
91 void insert(llvm::StringRef symbolName);
92 bool matchLiteral(llvm::StringRef symbolName) const;
93 bool matchGlob(llvm::StringRef symbolName) const;
94 bool match(llvm::StringRef symbolName) const;
97 enum class SymtabPresence {
104 struct Configuration {
105 Symbol *entry = nullptr;
106 bool hasReexports = false;
107 bool allLoad = false;
108 bool applicationExtension = false;
109 bool archMultiple = false;
110 bool exportDynamic = false;
111 bool forceLoadObjC = false;
112 bool forceLoadSwift = false;
113 bool staticLink = false;
114 bool implicitDylibs = false;
116 bool headerPadMaxInstallNames = false;
117 bool markDeadStrippableDylib = false;
118 bool printDylibSearch = false;
119 bool printEachFile = false;
120 bool printWhyLoad = false;
121 bool searchDylibsFirst = false;
122 bool saveTemps = false;
123 bool adhocCodesign = false;
124 bool emitFunctionStarts = false;
125 bool emitBitcodeBundle = false;
126 bool emitDataInCodeInfo = false;
127 bool emitEncryptionInfo = false;
128 bool timeTraceEnabled = false;
129 bool dataConst = false;
130 bool dedupLiterals = true;
131 bool omitDebugInfo = false;
132 bool warnDylibInstallName = false;
133 bool ignoreOptimizationHints = false;
135 uint32_t dylibCompatibilityVersion = 0;
136 uint32_t dylibCurrentVersion = 0;
137 uint32_t timeTraceGranularity = 500;
139 std::string progName;
141 // For `clang -arch arm64 -arch x86_64`, clang will:
142 // 1. invoke the linker twice, to write one temporary output per arch
143 // 2. invoke `lipo` to merge the two outputs into a single file
144 // `outputFile` is the name of the temporary file the linker writes to.
145 // `finalOutput `is the name of the file lipo writes to after the link.
146 llvm::StringRef outputFile;
147 llvm::StringRef finalOutput;
149 llvm::StringRef installName;
150 llvm::StringRef mapFile;
151 llvm::StringRef ltoObjPath;
152 llvm::StringRef thinLTOJobs;
153 llvm::StringRef umbrella;
155 llvm::CachePruningPolicy thinLTOCachePolicy;
156 llvm::StringRef thinLTOCacheDir;
157 bool deadStripDylibs = false;
158 bool demangle = false;
159 bool deadStrip = false;
160 bool errorForArchMismatch = false;
161 PlatformInfo platformInfo;
162 llvm::Optional<PlatformInfo> secondaryPlatformInfo;
163 NamespaceKind namespaceKind = NamespaceKind::twolevel;
164 UndefinedSymbolTreatment undefinedSymbolTreatment =
165 UndefinedSymbolTreatment::error;
166 ICFLevel icfLevel = ICFLevel::none;
167 llvm::MachO::HeaderFileType outputType;
168 std::vector<llvm::StringRef> systemLibraryRoots;
169 std::vector<llvm::StringRef> librarySearchPaths;
170 std::vector<llvm::StringRef> frameworkSearchPaths;
171 std::vector<llvm::StringRef> runtimePaths;
172 std::vector<std::string> astPaths;
173 std::vector<Symbol *> explicitUndefineds;
174 llvm::StringSet<> explicitDynamicLookups;
175 // There are typically few custom sectionAlignments or segmentProtections,
176 // so use a vector instead of a map.
177 std::vector<SectionAlign> sectionAlignments;
178 std::vector<SegmentProtection> segmentProtections;
180 bool callGraphProfileSort = false;
181 llvm::StringRef printSymbolOrder;
183 SectionRenameMap sectionRenameMap;
184 SegmentRenameMap segmentRenameMap;
186 bool hasExplicitExports = false;
187 SymbolPatterns exportedSymbols;
188 SymbolPatterns unexportedSymbols;
189 SymbolPatterns whyLive;
191 SymtabPresence localSymbolsPresence = SymtabPresence::All;
192 SymbolPatterns localSymbolPatterns;
194 bool zeroModTime = false;
196 llvm::StringRef osoPrefix;
198 llvm::MachO::Architecture arch() const { return platformInfo.target.Arch; }
200 llvm::MachO::PlatformType platform() const {
201 return platformInfo.target.Platform;
205 // Whether to force-load an archive.
206 enum class ForceLoad {
207 Default, // Apply -all_load or -ObjC behaviors if those flags are enabled
208 Yes, // Always load the archive, regardless of other flags
209 No, // Never load the archive, regardless of other flags
212 extern std::unique_ptr<Configuration> config;