1//===- Config.h -------------------------------------------------*- 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 LLD_COFF_CONFIG_H
10#define LLD_COFF_CONFIG_H
11
12#include "lld/Common/ErrorHandler.h"
13#include "llvm/ADT/MapVector.h"
14#include "llvm/ADT/SetVector.h"
15#include "llvm/ADT/SmallVector.h"
16#include "llvm/ADT/StringMap.h"
17#include "llvm/ADT/StringRef.h"
18#include "llvm/Object/COFF.h"
19#include "llvm/Support/CachePruning.h"
20#include "llvm/Support/VirtualFileSystem.h"
21#include <cstdint>
22#include <map>
23#include <set>
24#include <string>
25
26namespace lld::coff {
27
28using llvm::COFF::IMAGE_FILE_MACHINE_UNKNOWN;
29using llvm::COFF::WindowsSubsystem;
30using llvm::StringRef;
31class COFFLinkerContext;
32class DefinedAbsolute;
33class StringChunk;
34class Symbol;
35class InputFile;
36class SectionChunk;
37
38// Short aliases.
39static const auto AMD64 = llvm::COFF::IMAGE_FILE_MACHINE_AMD64;
40static const auto ARM64 = llvm::COFF::IMAGE_FILE_MACHINE_ARM64;
41static const auto ARM64EC = llvm::COFF::IMAGE_FILE_MACHINE_ARM64EC;
42static const auto ARM64X = llvm::COFF::IMAGE_FILE_MACHINE_ARM64X;
43static const auto ARMNT = llvm::COFF::IMAGE_FILE_MACHINE_ARMNT;
44static const auto I386 = llvm::COFF::IMAGE_FILE_MACHINE_I386;
45
46enum class ExportSource {
47 Unset,
48 Directives,
49 Export,
50 ModuleDefinition,
51};
52
53enum class EmitKind { Obj, LLVM, ASM };
54
55// Represents an /export option.
56struct Export {
57 StringRef name; // N in /export:N or /export:E=N
58 StringRef extName; // E in /export:E=N
59 StringRef exportAs; // E in /export:N,EXPORTAS,E
60 StringRef importName; // GNU specific: N in "othername == N"
61 Symbol *sym = nullptr;
62 uint16_t ordinal = 0;
63 bool noname = false;
64 bool data = false;
65 bool isPrivate = false;
66 bool constant = false;
67
68 // If an export is a form of /export:foo=dllname.bar, that means
69 // that foo should be exported as an alias to bar in the DLL.
70 // forwardTo is set to "dllname.bar" part. Usually empty.
71 StringRef forwardTo;
72 StringChunk *forwardChunk = nullptr;
73
74 ExportSource source = ExportSource::Unset;
75 StringRef symbolName;
76 StringRef exportName; // Name in DLL
77
78 bool operator==(const Export &e) const {
79 return (name == e.name && extName == e.extName && exportAs == e.exportAs &&
80 importName == e.importName && ordinal == e.ordinal &&
81 noname == e.noname && data == e.data && isPrivate == e.isPrivate);
82 }
83};
84
85enum class DebugType {
86 None = 0x0,
87 CV = 0x1, /// CodeView
88 PData = 0x2, /// Procedure Data
89 Fixup = 0x4, /// Relocation Table
90};
91
92enum GuardCFLevel {
93 Off = 0x0,
94 CF = 0x1, /// Emit gfids tables
95 LongJmp = 0x2, /// Emit longjmp tables
96 EHCont = 0x4, /// Emit ehcont tables
97 All = 0x7 /// Enable all protections
98};
99
100enum class ICFLevel {
101 None,
102 Safe, // Safe ICF for all sections.
103 All, // Aggressive ICF for code, but safe ICF for data, similar to MSVC's
104 // behavior.
105};
106
107enum class BuildIDHash {
108 None,
109 PDB,
110 Binary,
111};
112
113// Global configuration.
114struct Configuration {
115 enum ManifestKind { Default, SideBySide, Embed, No };
116 bool is64() const { return llvm::COFF::is64Bit(Machine: machine); }
117
118 std::unique_ptr<MemoryBuffer> dosStub;
119 llvm::COFF::MachineTypes machine = IMAGE_FILE_MACHINE_UNKNOWN;
120 bool machineInferred = false;
121 size_t wordsize;
122 bool verbose = false;
123 WindowsSubsystem subsystem = llvm::COFF::IMAGE_SUBSYSTEM_UNKNOWN;
124 bool noEntry = false;
125 std::string outputFile;
126 std::string importName;
127 bool demangle = true;
128 bool doGC = true;
129 ICFLevel doICF = ICFLevel::None;
130 bool tailMerge;
131 bool relocatable = true;
132 bool forceMultiple = false;
133 bool forceMultipleRes = false;
134 bool forceUnresolved = false;
135 bool debug = false;
136 bool includeDwarfChunks = false;
137 bool debugGHashes = false;
138 bool writeSymtab = false;
139 bool driver = false;
140 bool driverUponly = false;
141 bool driverWdm = false;
142 bool showTiming = false;
143 bool showSummary = false;
144 bool printSearchPaths = false;
145 unsigned debugTypes = static_cast<unsigned>(DebugType::None);
146 llvm::SmallVector<llvm::StringRef, 0> mllvmOpts;
147 std::vector<std::string> natvisFiles;
148 llvm::StringMap<std::string> namedStreams;
149 llvm::SmallString<128> pdbAltPath;
150 int pdbPageSize = 4096;
151 llvm::SmallString<128> pdbPath;
152 llvm::SmallString<128> pdbSourcePath;
153 std::vector<llvm::StringRef> argv;
154
155 // Symbols in this set are considered as live by the garbage collector.
156 std::vector<Symbol *> gcroot;
157
158 std::set<std::string> noDefaultLibs;
159 bool noDefaultLibAll = false;
160
161 // True if we are creating a DLL.
162 bool dll = false;
163 StringRef implib;
164 bool noimplib = false;
165 std::set<std::string> delayLoads;
166 std::map<std::string, int> dllOrder;
167 Symbol *arm64ECIcallHelper = nullptr;
168
169 llvm::DenseSet<llvm::StringRef> saveTempsArgs;
170
171 // /guard:cf
172 int guardCF = GuardCFLevel::Off;
173
174 // Used for SafeSEH.
175 bool safeSEH = false;
176 Symbol *sehTable = nullptr;
177 Symbol *sehCount = nullptr;
178 bool noSEH = false;
179
180 // Used for /opt:lldlto=N
181 unsigned ltoo = 2;
182 // Used for /opt:lldltocgo=N
183 std::optional<unsigned> ltoCgo;
184
185 // Used for /opt:lldltojobs=N
186 std::string thinLTOJobs;
187 // Used for /opt:lldltopartitions=N
188 unsigned ltoPartitions = 1;
189
190 // Used for /lldltocache=path
191 StringRef ltoCache;
192 // Used for /lldltocachepolicy=policy
193 llvm::CachePruningPolicy ltoCachePolicy;
194
195 // Used for /opt:[no]ltodebugpassmanager
196 bool ltoDebugPassManager = false;
197
198 // Used for /merge:from=to (e.g. /merge:.rdata=.text)
199 std::map<StringRef, StringRef> merge;
200
201 // Used for /section=.name,{DEKPRSW} to set section attributes.
202 std::map<StringRef, uint32_t> section;
203
204 // Options for manifest files.
205 ManifestKind manifest = Default;
206 int manifestID = 1;
207 llvm::SetVector<StringRef> manifestDependencies;
208 bool manifestUAC = true;
209 std::vector<std::string> manifestInput;
210 StringRef manifestLevel = "'asInvoker'";
211 StringRef manifestUIAccess = "'false'";
212 StringRef manifestFile;
213
214 // used for /dwodir
215 StringRef dwoDir;
216
217 // Used for /failifmismatch.
218 std::map<StringRef, std::pair<StringRef, InputFile *>> mustMatch;
219
220 // Used for /order.
221 llvm::StringMap<int> order;
222
223 // Used for /lldmap.
224 std::string lldmapFile;
225
226 // Used for /map.
227 std::string mapFile;
228
229 // Used for /mapinfo.
230 bool mapInfo = false;
231
232 // Used for /thinlto-index-only:
233 llvm::StringRef thinLTOIndexOnlyArg;
234
235 // Used for /thinlto-prefix-replace:
236 // Replace the prefix in paths generated for ThinLTO, replacing
237 // thinLTOPrefixReplaceOld with thinLTOPrefixReplaceNew. If
238 // thinLTOPrefixReplaceNativeObject is defined, replace the prefix of object
239 // file paths written to the response file given in the
240 // --thinlto-index-only=${response} option with
241 // thinLTOPrefixReplaceNativeObject, instead of thinLTOPrefixReplaceNew.
242 llvm::StringRef thinLTOPrefixReplaceOld;
243 llvm::StringRef thinLTOPrefixReplaceNew;
244 llvm::StringRef thinLTOPrefixReplaceNativeObject;
245
246 // Used for /thinlto-object-suffix-replace:
247 std::pair<llvm::StringRef, llvm::StringRef> thinLTOObjectSuffixReplace;
248
249 // Used for /lto-obj-path:
250 llvm::StringRef ltoObjPath;
251
252 // Used for /lto-cs-profile-generate:
253 bool ltoCSProfileGenerate = false;
254
255 // Used for /lto-cs-profile-path
256 llvm::StringRef ltoCSProfileFile;
257
258 // Used for /lto-pgo-warn-mismatch:
259 bool ltoPGOWarnMismatch = true;
260
261 // Used for /lto-sample-profile:
262 llvm::StringRef ltoSampleProfileName;
263
264 // Used for /call-graph-ordering-file:
265 llvm::MapVector<std::pair<const SectionChunk *, const SectionChunk *>,
266 uint64_t>
267 callGraphProfile;
268 bool callGraphProfileSort = false;
269
270 // Used for /print-symbol-order:
271 StringRef printSymbolOrder;
272
273 // Used for /vfsoverlay:
274 std::unique_ptr<llvm::vfs::FileSystem> vfs;
275
276 uint64_t align = 4096;
277 uint64_t imageBase = -1;
278 uint64_t fileAlign = 512;
279 uint64_t stackReserve = 1024 * 1024;
280 uint64_t stackCommit = 4096;
281 uint64_t heapReserve = 1024 * 1024;
282 uint64_t heapCommit = 4096;
283 uint32_t majorImageVersion = 0;
284 uint32_t minorImageVersion = 0;
285 // If changing the default os/subsys version here, update the default in
286 // the MinGW driver accordingly.
287 uint32_t majorOSVersion = 6;
288 uint32_t minorOSVersion = 0;
289 uint32_t majorSubsystemVersion = 6;
290 uint32_t minorSubsystemVersion = 0;
291 uint32_t timestamp = 0;
292 uint32_t functionPadMin = 0;
293 uint32_t timeTraceGranularity = 0;
294 uint16_t dependentLoadFlags = 0;
295 bool dynamicBase = true;
296 bool allowBind = true;
297 bool cetCompat = false;
298 bool nxCompat = true;
299 bool allowIsolation = true;
300 bool terminalServerAware = true;
301 bool largeAddressAware = false;
302 bool highEntropyVA = false;
303 bool appContainer = false;
304 bool mingw = false;
305 bool warnMissingOrderSymbol = true;
306 bool warnLocallyDefinedImported = true;
307 bool warnDebugInfoUnusable = true;
308 bool warnLongSectionNames = true;
309 bool warnStdcallFixup = true;
310 bool warnExportedDllMain = true;
311 bool incremental = true;
312 bool integrityCheck = false;
313 bool killAt = false;
314 bool repro = false;
315 bool swaprunCD = false;
316 bool swaprunNet = false;
317 bool thinLTOEmitImportsFiles;
318 bool thinLTOIndexOnly;
319 bool timeTraceEnabled = false;
320 bool autoImport = false;
321 bool pseudoRelocs = false;
322 bool stdcallFixup = false;
323 bool writeCheckSum = false;
324 EmitKind emit = EmitKind::Obj;
325 bool allowDuplicateWeak = false;
326 BuildIDHash buildIDHash = BuildIDHash::None;
327};
328
329struct COFFSyncStream : SyncStream {
330 COFFLinkerContext &ctx;
331 COFFSyncStream(COFFLinkerContext &ctx, DiagLevel level);
332};
333
334template <typename T>
335std::enable_if_t<!std::is_pointer_v<std::remove_reference_t<T>>,
336 const COFFSyncStream &>
337operator<<(const COFFSyncStream &s, T &&v) {
338 s.os << std::forward<T>(v);
339 return s;
340}
341
342inline const COFFSyncStream &operator<<(const COFFSyncStream &s,
343 const char *v) {
344 s.os << v;
345 return s;
346}
347
348inline const COFFSyncStream &operator<<(const COFFSyncStream &s, Error v) {
349 s.os << llvm::toString(E: std::move(v));
350 return s;
351}
352
353// Report a log if -verbose is specified.
354COFFSyncStream Log(COFFLinkerContext &ctx);
355
356// Print a message to stdout.
357COFFSyncStream Msg(COFFLinkerContext &ctx);
358
359// Report a warning. Upgraded to an error if /WX is specified.
360COFFSyncStream Warn(COFFLinkerContext &ctx);
361
362// Report an error that will suppress the output file generation.
363COFFSyncStream Err(COFFLinkerContext &ctx);
364
365// Report a fatal error that exits immediately. This should generally be avoided
366// in favor of Err.
367COFFSyncStream Fatal(COFFLinkerContext &ctx);
368
369uint64_t errCount(COFFLinkerContext &ctx);
370
371} // namespace lld::coff
372
373#endif
374