1 //===- Config.h -------------------------------------------------*- C++ -*-===//
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLD_ELF_CONFIG_H
11 #define LLD_ELF_CONFIG_H
13 #include "llvm/ADT/MapVector.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/ADT/StringSet.h"
16 #include "llvm/BinaryFormat/ELF.h"
17 #include "llvm/Support/CachePruning.h"
18 #include "llvm/Support/CodeGen.h"
19 #include "llvm/Support/Endian.h"
38 enum class BuildIdKind { None, Fast, Md5, Sha1, Hexstring, Uuid };
40 // For --discard-{all,locals,none}.
41 enum class DiscardPolicy { Default, All, Locals, None };
43 // For --strip-{all,debug}.
44 enum class StripPolicy { None, All, Debug };
46 // For --unresolved-symbols.
47 enum class UnresolvedPolicy { ReportError, Warn, WarnAll, Ignore, IgnoreAll };
49 // For --sort-section and linkerscript sorting rules.
50 enum class SortSectionPolicy { Default, None, Alignment, Name, Priority };
53 enum class Target2Policy { Abs, Rel, GotRel };
55 struct SymbolVersion {
61 // This struct contains symbols version definition that
62 // can be found in version script if it is used for link.
63 struct VersionDefinition {
66 std::vector<SymbolVersion> Globals;
67 size_t NameOff = 0; // Offset in the string table
70 // Structure for mapping renamed symbols
71 struct RenamedSymbol {
73 uint8_t OriginalBinding;
76 // This struct contains the global configuration for the linker.
77 // Most fields are direct mapping from the command line options
78 // and such fields have the same name as the corresponding options.
79 // Most fields are initialized by the driver.
80 struct Configuration {
81 InputFile *FirstElf = nullptr;
83 llvm::CachePruningPolicy ThinLTOCachePolicy;
84 llvm::StringMap<uint64_t> SectionStartMap;
85 llvm::StringRef DynamicLinker;
86 llvm::StringRef Entry;
87 llvm::StringRef Emulation;
90 llvm::StringRef LTOAAPipeline;
91 llvm::StringRef LTONewPmPasses;
92 llvm::StringRef MapFile;
93 llvm::StringRef OutputFile;
94 llvm::StringRef OptRemarksFilename;
95 llvm::StringRef SoName;
96 llvm::StringRef Sysroot;
97 llvm::StringRef ThinLTOCacheDir;
99 std::vector<VersionDefinition> VersionDefinitions;
100 std::vector<llvm::StringRef> AuxiliaryList;
101 std::vector<llvm::StringRef> SearchPaths;
102 std::vector<llvm::StringRef> SymbolOrderingFile;
103 std::vector<llvm::StringRef> Undefined;
104 std::vector<SymbolVersion> VersionScriptGlobals;
105 std::vector<SymbolVersion> VersionScriptLocals;
106 std::vector<uint8_t> BuildIdVector;
107 llvm::MapVector<Symbol *, RenamedSymbol> RenamedSymbols;
108 bool AllowMultipleDefinition;
109 bool AsNeeded = false;
111 bool BsymbolicFunctions;
112 bool ColorDiagnostics = false;
113 bool CompressDebugSections;
115 bool Demangle = true;
126 bool MipsN32Abi = false;
128 bool NoUndefinedVersion;
132 bool OptRemarksWithHotness;
134 bool PrintGcSections;
146 bool WarnMissingEntry;
159 DiscardPolicy Discard;
160 SortSectionPolicy SortSection;
162 UnresolvedPolicy UnresolvedSymbols;
163 Target2Policy Target2;
164 BuildIdKind BuildId = BuildIdKind::None;
165 ELFKind EKind = ELFNoneKind;
166 uint16_t DefaultSymbolVersion = llvm::ELF::VER_NDX_GLOBAL;
167 uint16_t EMachine = llvm::ELF::EM_NONE;
168 uint64_t ErrorLimit = 20;
170 uint64_t MaxPageSize;
172 unsigned LTOPartitions;
175 unsigned ThinLTOJobs;
177 // The following config options do not directly correspond to any
178 // particualr command line options.
180 // True if we need to pass through relocations in input files to the
181 // output file. Usually false because we consume relocations.
184 // True if the target is ELF64. False if ELF32.
187 // True if the target is little-endian. False if big-endian.
190 // endianness::little if IsLE is true. endianness::big otherwise.
191 llvm::support::endianness Endianness;
193 // True if the target is the little-endian MIPS64.
195 // The reason why we have this variable only for the MIPS is because
196 // we use this often. Some ELF headers for MIPS64EL are in a
197 // mixed-endian (which is horrible and I'd say that's a serious spec
198 // bug), and we need to know whether we are reading MIPS ELF files or
199 // not in various places.
201 // (Note that MIPS64EL is not a typo for MIPS64LE. This is the official
202 // name whatever that means. A fun hypothesis is that "EL" is short for
203 // little-endian written in the little-endian order, but I don't know
207 // The ELF spec defines two types of relocation table entries, RELA and
208 // REL. RELA is a triplet of (offset, info, addend) while REL is a
209 // tuple of (offset, info). Addends for REL are implicit and read from
210 // the location where the relocations are applied. So, REL is more
211 // compact than RELA but requires a bit of more work to process.
213 // (From the linker writer's view, this distinction is not necessary.
214 // If the ELF had chosen whichever and sticked with it, it would have
215 // been easier to write code to process relocations, but it's too late
216 // to change the spec.)
218 // Each ABI defines its relocation type. IsRela is true if target
219 // uses RELA. As far as we know, all 64-bit ABIs are using RELA. A
220 // few 32-bit ABIs are using RELA too.
223 // True if we are creating position-independent code.
226 // 4 for ELF32, 8 for ELF64.
230 // The only instance of Configuration struct.
231 extern Configuration *Config;