File: | include/llvm/Support/Error.h |
Warning: | line 201, column 5 Potential leak of memory pointed to by 'Payload._M_t._M_head_impl' |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | //===- InputFiles.cpp -----------------------------------------------------===// | |||||
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 | #include "InputFiles.h" | |||||
11 | #include "InputSection.h" | |||||
12 | #include "LinkerScript.h" | |||||
13 | #include "SymbolTable.h" | |||||
14 | #include "Symbols.h" | |||||
15 | #include "SyntheticSections.h" | |||||
16 | #include "lld/Common/ErrorHandler.h" | |||||
17 | #include "lld/Common/Memory.h" | |||||
18 | #include "llvm/ADT/STLExtras.h" | |||||
19 | #include "llvm/CodeGen/Analysis.h" | |||||
20 | #include "llvm/DebugInfo/DWARF/DWARFContext.h" | |||||
21 | #include "llvm/IR/LLVMContext.h" | |||||
22 | #include "llvm/IR/Module.h" | |||||
23 | #include "llvm/LTO/LTO.h" | |||||
24 | #include "llvm/MC/StringTableBuilder.h" | |||||
25 | #include "llvm/Object/ELFObjectFile.h" | |||||
26 | #include "llvm/Support/ARMAttributeParser.h" | |||||
27 | #include "llvm/Support/ARMBuildAttributes.h" | |||||
28 | #include "llvm/Support/Path.h" | |||||
29 | #include "llvm/Support/TarWriter.h" | |||||
30 | #include "llvm/Support/raw_ostream.h" | |||||
31 | ||||||
32 | using namespace llvm; | |||||
33 | using namespace llvm::ELF; | |||||
34 | using namespace llvm::object; | |||||
35 | using namespace llvm::sys; | |||||
36 | using namespace llvm::sys::fs; | |||||
37 | ||||||
38 | using namespace lld; | |||||
39 | using namespace lld::elf; | |||||
40 | ||||||
41 | bool InputFile::IsInGroup; | |||||
42 | uint32_t InputFile::NextGroupId; | |||||
43 | std::vector<BinaryFile *> elf::BinaryFiles; | |||||
44 | std::vector<BitcodeFile *> elf::BitcodeFiles; | |||||
45 | std::vector<LazyObjFile *> elf::LazyObjFiles; | |||||
46 | std::vector<InputFile *> elf::ObjectFiles; | |||||
47 | std::vector<InputFile *> elf::SharedFiles; | |||||
48 | ||||||
49 | TarWriter *elf::Tar; | |||||
50 | ||||||
51 | InputFile::InputFile(Kind K, MemoryBufferRef M) | |||||
52 | : MB(M), GroupId(NextGroupId), FileKind(K) { | |||||
53 | // All files within the same --{start,end}-group get the same group ID. | |||||
54 | // Otherwise, a new file will get a new group ID. | |||||
55 | if (!IsInGroup) | |||||
56 | ++NextGroupId; | |||||
57 | } | |||||
58 | ||||||
59 | Optional<MemoryBufferRef> elf::readFile(StringRef Path) { | |||||
60 | // The --chroot option changes our virtual root directory. | |||||
61 | // This is useful when you are dealing with files created by --reproduce. | |||||
62 | if (!Config->Chroot.empty() && Path.startswith("/")) | |||||
63 | Path = Saver.save(Config->Chroot + Path); | |||||
64 | ||||||
65 | log(Path); | |||||
66 | ||||||
67 | auto MBOrErr = MemoryBuffer::getFile(Path, -1, false); | |||||
68 | if (auto EC = MBOrErr.getError()) { | |||||
69 | error("cannot open " + Path + ": " + EC.message()); | |||||
70 | return None; | |||||
71 | } | |||||
72 | ||||||
73 | std::unique_ptr<MemoryBuffer> &MB = *MBOrErr; | |||||
74 | MemoryBufferRef MBRef = MB->getMemBufferRef(); | |||||
75 | make<std::unique_ptr<MemoryBuffer>>(std::move(MB)); // take MB ownership | |||||
76 | ||||||
77 | if (Tar) | |||||
78 | Tar->append(relativeToRoot(Path), MBRef.getBuffer()); | |||||
79 | return MBRef; | |||||
80 | } | |||||
81 | ||||||
82 | // Concatenates arguments to construct a string representing an error location. | |||||
83 | static std::string createFileLineMsg(StringRef Path, unsigned Line) { | |||||
84 | std::string Filename = path::filename(Path); | |||||
85 | std::string Lineno = ":" + std::to_string(Line); | |||||
86 | if (Filename == Path) | |||||
87 | return Filename + Lineno; | |||||
88 | return Filename + Lineno + " (" + Path.str() + Lineno + ")"; | |||||
89 | } | |||||
90 | ||||||
91 | template <class ELFT> | |||||
92 | static std::string getSrcMsgAux(ObjFile<ELFT> &File, const Symbol &Sym, | |||||
93 | InputSectionBase &Sec, uint64_t Offset) { | |||||
94 | // In DWARF, functions and variables are stored to different places. | |||||
95 | // First, lookup a function for a given offset. | |||||
96 | if (Optional<DILineInfo> Info = File.getDILineInfo(&Sec, Offset)) | |||||
97 | return createFileLineMsg(Info->FileName, Info->Line); | |||||
98 | ||||||
99 | // If it failed, lookup again as a variable. | |||||
100 | if (Optional<std::pair<std::string, unsigned>> FileLine = | |||||
101 | File.getVariableLoc(Sym.getName())) | |||||
102 | return createFileLineMsg(FileLine->first, FileLine->second); | |||||
103 | ||||||
104 | // File.SourceFile contains STT_FILE symbol, and that is a last resort. | |||||
105 | return File.SourceFile; | |||||
106 | } | |||||
107 | ||||||
108 | std::string InputFile::getSrcMsg(const Symbol &Sym, InputSectionBase &Sec, | |||||
109 | uint64_t Offset) { | |||||
110 | if (kind() != ObjKind) | |||||
111 | return ""; | |||||
112 | switch (Config->EKind) { | |||||
113 | default: | |||||
114 | llvm_unreachable("Invalid kind")::llvm::llvm_unreachable_internal("Invalid kind", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.cpp" , 114); | |||||
115 | case ELF32LEKind: | |||||
116 | return getSrcMsgAux(cast<ObjFile<ELF32LE>>(*this), Sym, Sec, Offset); | |||||
117 | case ELF32BEKind: | |||||
118 | return getSrcMsgAux(cast<ObjFile<ELF32BE>>(*this), Sym, Sec, Offset); | |||||
119 | case ELF64LEKind: | |||||
120 | return getSrcMsgAux(cast<ObjFile<ELF64LE>>(*this), Sym, Sec, Offset); | |||||
121 | case ELF64BEKind: | |||||
122 | return getSrcMsgAux(cast<ObjFile<ELF64BE>>(*this), Sym, Sec, Offset); | |||||
123 | } | |||||
124 | } | |||||
125 | ||||||
126 | template <class ELFT> void ObjFile<ELFT>::initializeDwarf() { | |||||
127 | Dwarf = llvm::make_unique<DWARFContext>(make_unique<LLDDwarfObj<ELFT>>(this)); | |||||
128 | for (std::unique_ptr<DWARFUnit> &CU : Dwarf->compile_units()) { | |||||
129 | auto Report = [](Error Err) { | |||||
130 | handleAllErrors(std::move(Err), | |||||
131 | [](ErrorInfoBase &Info) { warn(Info.message()); }); | |||||
132 | }; | |||||
133 | Expected<const DWARFDebugLine::LineTable *> ExpectedLT = | |||||
134 | Dwarf->getLineTableForUnit(CU.get(), Report); | |||||
135 | const DWARFDebugLine::LineTable *LT = nullptr; | |||||
136 | if (ExpectedLT) | |||||
137 | LT = *ExpectedLT; | |||||
138 | else | |||||
139 | Report(ExpectedLT.takeError()); | |||||
140 | if (!LT) | |||||
141 | continue; | |||||
142 | LineTables.push_back(LT); | |||||
143 | ||||||
144 | // Loop over variable records and insert them to VariableLoc. | |||||
145 | for (const auto &Entry : CU->dies()) { | |||||
146 | DWARFDie Die(CU.get(), &Entry); | |||||
147 | // Skip all tags that are not variables. | |||||
148 | if (Die.getTag() != dwarf::DW_TAG_variable) | |||||
149 | continue; | |||||
150 | ||||||
151 | // Skip if a local variable because we don't need them for generating | |||||
152 | // error messages. In general, only non-local symbols can fail to be | |||||
153 | // linked. | |||||
154 | if (!dwarf::toUnsigned(Die.find(dwarf::DW_AT_external), 0)) | |||||
155 | continue; | |||||
156 | ||||||
157 | // Get the source filename index for the variable. | |||||
158 | unsigned File = dwarf::toUnsigned(Die.find(dwarf::DW_AT_decl_file), 0); | |||||
159 | if (!LT->hasFileAtIndex(File)) | |||||
160 | continue; | |||||
161 | ||||||
162 | // Get the line number on which the variable is declared. | |||||
163 | unsigned Line = dwarf::toUnsigned(Die.find(dwarf::DW_AT_decl_line), 0); | |||||
164 | ||||||
165 | // Here we want to take the variable name to add it into VariableLoc. | |||||
166 | // Variable can have regular and linkage name associated. At first, we try | |||||
167 | // to get linkage name as it can be different, for example when we have | |||||
168 | // two variables in different namespaces of the same object. Use common | |||||
169 | // name otherwise, but handle the case when it also absent in case if the | |||||
170 | // input object file lacks some debug info. | |||||
171 | StringRef Name = | |||||
172 | dwarf::toString(Die.find(dwarf::DW_AT_linkage_name), | |||||
173 | dwarf::toString(Die.find(dwarf::DW_AT_name), "")); | |||||
174 | if (!Name.empty()) | |||||
175 | VariableLoc.insert({Name, {LT, File, Line}}); | |||||
176 | } | |||||
177 | } | |||||
178 | } | |||||
179 | ||||||
180 | // Returns the pair of file name and line number describing location of data | |||||
181 | // object (variable, array, etc) definition. | |||||
182 | template <class ELFT> | |||||
183 | Optional<std::pair<std::string, unsigned>> | |||||
184 | ObjFile<ELFT>::getVariableLoc(StringRef Name) { | |||||
185 | llvm::call_once(InitDwarfLine, [this]() { initializeDwarf(); }); | |||||
186 | ||||||
187 | // Return if we have no debug information about data object. | |||||
188 | auto It = VariableLoc.find(Name); | |||||
189 | if (It == VariableLoc.end()) | |||||
190 | return None; | |||||
191 | ||||||
192 | // Take file name string from line table. | |||||
193 | std::string FileName; | |||||
194 | if (!It->second.LT->getFileNameByIndex( | |||||
195 | It->second.File, nullptr, | |||||
196 | DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath, FileName)) | |||||
197 | return None; | |||||
198 | ||||||
199 | return std::make_pair(FileName, It->second.Line); | |||||
200 | } | |||||
201 | ||||||
202 | // Returns source line information for a given offset | |||||
203 | // using DWARF debug info. | |||||
204 | template <class ELFT> | |||||
205 | Optional<DILineInfo> ObjFile<ELFT>::getDILineInfo(InputSectionBase *S, | |||||
206 | uint64_t Offset) { | |||||
207 | llvm::call_once(InitDwarfLine, [this]() { initializeDwarf(); }); | |||||
208 | ||||||
209 | // Use fake address calcuated by adding section file offset and offset in | |||||
210 | // section. See comments for ObjectInfo class. | |||||
211 | DILineInfo Info; | |||||
212 | for (const llvm::DWARFDebugLine::LineTable *LT : LineTables) | |||||
213 | if (LT->getFileLineInfoForAddress( | |||||
214 | S->getOffsetInFile() + Offset, nullptr, | |||||
215 | DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath, Info)) | |||||
216 | return Info; | |||||
217 | return None; | |||||
218 | } | |||||
219 | ||||||
220 | // Returns "<internal>", "foo.a(bar.o)" or "baz.o". | |||||
221 | std::string lld::toString(const InputFile *F) { | |||||
222 | if (!F) | |||||
223 | return "<internal>"; | |||||
224 | ||||||
225 | if (F->ToStringCache.empty()) { | |||||
226 | if (F->ArchiveName.empty()) | |||||
227 | F->ToStringCache = F->getName(); | |||||
228 | else | |||||
229 | F->ToStringCache = (F->ArchiveName + "(" + F->getName() + ")").str(); | |||||
230 | } | |||||
231 | return F->ToStringCache; | |||||
232 | } | |||||
233 | ||||||
234 | template <class ELFT> | |||||
235 | ELFFileBase<ELFT>::ELFFileBase(Kind K, MemoryBufferRef MB) : InputFile(K, MB) { | |||||
236 | if (ELFT::TargetEndianness == support::little) | |||||
237 | EKind = ELFT::Is64Bits ? ELF64LEKind : ELF32LEKind; | |||||
238 | else | |||||
239 | EKind = ELFT::Is64Bits ? ELF64BEKind : ELF32BEKind; | |||||
240 | ||||||
241 | EMachine = getObj().getHeader()->e_machine; | |||||
242 | OSABI = getObj().getHeader()->e_ident[llvm::ELF::EI_OSABI]; | |||||
243 | } | |||||
244 | ||||||
245 | template <class ELFT> | |||||
246 | typename ELFT::SymRange ELFFileBase<ELFT>::getGlobalELFSyms() { | |||||
247 | return makeArrayRef(ELFSyms.begin() + FirstGlobal, ELFSyms.end()); | |||||
248 | } | |||||
249 | ||||||
250 | template <class ELFT> | |||||
251 | uint32_t ELFFileBase<ELFT>::getSectionIndex(const Elf_Sym &Sym) const { | |||||
252 | return CHECK(getObj().getSectionIndex(&Sym, ELFSyms, SymtabSHNDX), this)check2((getObj().getSectionIndex(&Sym, ELFSyms, SymtabSHNDX )), [&] { return toString(this); }); | |||||
253 | } | |||||
254 | ||||||
255 | template <class ELFT> | |||||
256 | void ELFFileBase<ELFT>::initSymtab(ArrayRef<Elf_Shdr> Sections, | |||||
257 | const Elf_Shdr *Symtab) { | |||||
258 | FirstGlobal = Symtab->sh_info; | |||||
259 | ELFSyms = CHECK(getObj().symbols(Symtab), this)check2((getObj().symbols(Symtab)), [&] { return toString( this); }); | |||||
260 | if (FirstGlobal == 0 || FirstGlobal > ELFSyms.size()) | |||||
261 | fatal(toString(this) + ": invalid sh_info in symbol table"); | |||||
262 | ||||||
263 | StringTable = | |||||
264 | CHECK(getObj().getStringTableForSymtab(*Symtab, Sections), this)check2((getObj().getStringTableForSymtab(*Symtab, Sections)), [&] { return toString(this); }); | |||||
265 | } | |||||
266 | ||||||
267 | template <class ELFT> | |||||
268 | ObjFile<ELFT>::ObjFile(MemoryBufferRef M, StringRef ArchiveName) | |||||
269 | : ELFFileBase<ELFT>(Base::ObjKind, M) { | |||||
270 | this->ArchiveName = ArchiveName; | |||||
271 | } | |||||
272 | ||||||
273 | template <class ELFT> ArrayRef<Symbol *> ObjFile<ELFT>::getLocalSymbols() { | |||||
274 | if (this->Symbols.empty()) | |||||
275 | return {}; | |||||
276 | return makeArrayRef(this->Symbols).slice(1, this->FirstGlobal - 1); | |||||
277 | } | |||||
278 | ||||||
279 | template <class ELFT> ArrayRef<Symbol *> ObjFile<ELFT>::getGlobalSymbols() { | |||||
280 | return makeArrayRef(this->Symbols).slice(this->FirstGlobal); | |||||
281 | } | |||||
282 | ||||||
283 | template <class ELFT> | |||||
284 | void ObjFile<ELFT>::parse(DenseSet<CachedHashStringRef> &ComdatGroups) { | |||||
285 | // Read a section table. JustSymbols is usually false. | |||||
286 | if (this->JustSymbols) | |||||
287 | initializeJustSymbols(); | |||||
288 | else | |||||
289 | initializeSections(ComdatGroups); | |||||
290 | ||||||
291 | // Read a symbol table. | |||||
292 | initializeSymbols(); | |||||
293 | } | |||||
294 | ||||||
295 | // Sections with SHT_GROUP and comdat bits define comdat section groups. | |||||
296 | // They are identified and deduplicated by group name. This function | |||||
297 | // returns a group name. | |||||
298 | template <class ELFT> | |||||
299 | StringRef ObjFile<ELFT>::getShtGroupSignature(ArrayRef<Elf_Shdr> Sections, | |||||
300 | const Elf_Shdr &Sec) { | |||||
301 | // Group signatures are stored as symbol names in object files. | |||||
302 | // sh_info contains a symbol index, so we fetch a symbol and read its name. | |||||
303 | if (this->ELFSyms.empty()) | |||||
304 | this->initSymtab( | |||||
305 | Sections, CHECK(object::getSection<ELFT>(Sections, Sec.sh_link), this)check2((object::getSection<ELFT>(Sections, Sec.sh_link) ), [&] { return toString(this); })); | |||||
306 | ||||||
307 | const Elf_Sym *Sym = | |||||
308 | CHECK(object::getSymbol<ELFT>(this->ELFSyms, Sec.sh_info), this)check2((object::getSymbol<ELFT>(this->ELFSyms, Sec.sh_info )), [&] { return toString(this); }); | |||||
309 | StringRef Signature = CHECK(Sym->getName(this->StringTable), this)check2((Sym->getName(this->StringTable)), [&] { return toString(this); }); | |||||
310 | ||||||
311 | // As a special case, if a symbol is a section symbol and has no name, | |||||
312 | // we use a section name as a signature. | |||||
313 | // | |||||
314 | // Such SHT_GROUP sections are invalid from the perspective of the ELF | |||||
315 | // standard, but GNU gold 1.14 (the newest version as of July 2017) or | |||||
316 | // older produce such sections as outputs for the -r option, so we need | |||||
317 | // a bug-compatibility. | |||||
318 | if (Signature.empty() && Sym->getType() == STT_SECTION) | |||||
319 | return getSectionName(Sec); | |||||
320 | return Signature; | |||||
321 | } | |||||
322 | ||||||
323 | template <class ELFT> | |||||
324 | ArrayRef<typename ObjFile<ELFT>::Elf_Word> | |||||
325 | ObjFile<ELFT>::getShtGroupEntries(const Elf_Shdr &Sec) { | |||||
326 | const ELFFile<ELFT> &Obj = this->getObj(); | |||||
327 | ArrayRef<Elf_Word> Entries = | |||||
328 | CHECK(Obj.template getSectionContentsAsArray<Elf_Word>(&Sec), this)check2((Obj.template getSectionContentsAsArray<Elf_Word> (&Sec)), [&] { return toString(this); }); | |||||
329 | if (Entries.empty() || Entries[0] != GRP_COMDAT) | |||||
330 | fatal(toString(this) + ": unsupported SHT_GROUP format"); | |||||
331 | return Entries.slice(1); | |||||
332 | } | |||||
333 | ||||||
334 | template <class ELFT> bool ObjFile<ELFT>::shouldMerge(const Elf_Shdr &Sec) { | |||||
335 | // On a regular link we don't merge sections if -O0 (default is -O1). This | |||||
336 | // sometimes makes the linker significantly faster, although the output will | |||||
337 | // be bigger. | |||||
338 | // | |||||
339 | // Doing the same for -r would create a problem as it would combine sections | |||||
340 | // with different sh_entsize. One option would be to just copy every SHF_MERGE | |||||
341 | // section as is to the output. While this would produce a valid ELF file with | |||||
342 | // usable SHF_MERGE sections, tools like (llvm-)?dwarfdump get confused when | |||||
343 | // they see two .debug_str. We could have separate logic for combining | |||||
344 | // SHF_MERGE sections based both on their name and sh_entsize, but that seems | |||||
345 | // to be more trouble than it is worth. Instead, we just use the regular (-O1) | |||||
346 | // logic for -r. | |||||
347 | if (Config->Optimize == 0 && !Config->Relocatable) | |||||
348 | return false; | |||||
349 | ||||||
350 | // A mergeable section with size 0 is useless because they don't have | |||||
351 | // any data to merge. A mergeable string section with size 0 can be | |||||
352 | // argued as invalid because it doesn't end with a null character. | |||||
353 | // We'll avoid a mess by handling them as if they were non-mergeable. | |||||
354 | if (Sec.sh_size == 0) | |||||
355 | return false; | |||||
356 | ||||||
357 | // Check for sh_entsize. The ELF spec is not clear about the zero | |||||
358 | // sh_entsize. It says that "the member [sh_entsize] contains 0 if | |||||
359 | // the section does not hold a table of fixed-size entries". We know | |||||
360 | // that Rust 1.13 produces a string mergeable section with a zero | |||||
361 | // sh_entsize. Here we just accept it rather than being picky about it. | |||||
362 | uint64_t EntSize = Sec.sh_entsize; | |||||
363 | if (EntSize == 0) | |||||
364 | return false; | |||||
365 | if (Sec.sh_size % EntSize) | |||||
366 | fatal(toString(this) + | |||||
367 | ": SHF_MERGE section size must be a multiple of sh_entsize"); | |||||
368 | ||||||
369 | uint64_t Flags = Sec.sh_flags; | |||||
370 | if (!(Flags & SHF_MERGE)) | |||||
371 | return false; | |||||
372 | if (Flags & SHF_WRITE) | |||||
373 | fatal(toString(this) + ": writable SHF_MERGE section is not supported"); | |||||
374 | ||||||
375 | return true; | |||||
376 | } | |||||
377 | ||||||
378 | // This is for --just-symbols. | |||||
379 | // | |||||
380 | // --just-symbols is a very minor feature that allows you to link your | |||||
381 | // output against other existing program, so that if you load both your | |||||
382 | // program and the other program into memory, your output can refer the | |||||
383 | // other program's symbols. | |||||
384 | // | |||||
385 | // When the option is given, we link "just symbols". The section table is | |||||
386 | // initialized with null pointers. | |||||
387 | template <class ELFT> void ObjFile<ELFT>::initializeJustSymbols() { | |||||
388 | ArrayRef<Elf_Shdr> ObjSections = CHECK(this->getObj().sections(), this)check2((this->getObj().sections()), [&] { return toString (this); }); | |||||
389 | this->Sections.resize(ObjSections.size()); | |||||
390 | ||||||
391 | for (const Elf_Shdr &Sec : ObjSections) { | |||||
392 | if (Sec.sh_type != SHT_SYMTAB) | |||||
393 | continue; | |||||
394 | this->initSymtab(ObjSections, &Sec); | |||||
395 | return; | |||||
396 | } | |||||
397 | } | |||||
398 | ||||||
399 | template <class ELFT> | |||||
400 | void ObjFile<ELFT>::initializeSections( | |||||
401 | DenseSet<CachedHashStringRef> &ComdatGroups) { | |||||
402 | const ELFFile<ELFT> &Obj = this->getObj(); | |||||
403 | ||||||
404 | ArrayRef<Elf_Shdr> ObjSections = CHECK(Obj.sections(), this)check2((Obj.sections()), [&] { return toString(this); }); | |||||
405 | uint64_t Size = ObjSections.size(); | |||||
406 | this->Sections.resize(Size); | |||||
407 | this->SectionStringTable = | |||||
408 | CHECK(Obj.getSectionStringTable(ObjSections), this)check2((Obj.getSectionStringTable(ObjSections)), [&] { return toString(this); }); | |||||
409 | ||||||
410 | for (size_t I = 0, E = ObjSections.size(); I < E; I++) { | |||||
411 | if (this->Sections[I] == &InputSection::Discarded) | |||||
412 | continue; | |||||
413 | const Elf_Shdr &Sec = ObjSections[I]; | |||||
414 | ||||||
415 | if (Sec.sh_type == ELF::SHT_LLVM_CALL_GRAPH_PROFILE) | |||||
416 | CGProfile = check( | |||||
417 | this->getObj().template getSectionContentsAsArray<Elf_CGProfile>( | |||||
418 | &Sec)); | |||||
419 | ||||||
420 | // SHF_EXCLUDE'ed sections are discarded by the linker. However, | |||||
421 | // if -r is given, we'll let the final link discard such sections. | |||||
422 | // This is compatible with GNU. | |||||
423 | if ((Sec.sh_flags & SHF_EXCLUDE) && !Config->Relocatable) { | |||||
424 | if (Sec.sh_type == SHT_LLVM_ADDRSIG) { | |||||
425 | // We ignore the address-significance table if we know that the object | |||||
426 | // file was created by objcopy or ld -r. This is because these tools | |||||
427 | // will reorder the symbols in the symbol table, invalidating the data | |||||
428 | // in the address-significance table, which refers to symbols by index. | |||||
429 | if (Sec.sh_link != 0) | |||||
430 | this->AddrsigSec = &Sec; | |||||
431 | else if (Config->ICF == ICFLevel::Safe) | |||||
432 | warn(toString(this) + ": --icf=safe is incompatible with object " | |||||
433 | "files created using objcopy or ld -r"); | |||||
434 | } | |||||
435 | this->Sections[I] = &InputSection::Discarded; | |||||
436 | continue; | |||||
437 | } | |||||
438 | ||||||
439 | switch (Sec.sh_type) { | |||||
440 | case SHT_GROUP: { | |||||
441 | // De-duplicate section groups by their signatures. | |||||
442 | StringRef Signature = getShtGroupSignature(ObjSections, Sec); | |||||
443 | bool IsNew = ComdatGroups.insert(CachedHashStringRef(Signature)).second; | |||||
444 | this->Sections[I] = &InputSection::Discarded; | |||||
445 | ||||||
446 | // We only support GRP_COMDAT type of group. Get the all entries of the | |||||
447 | // section here to let getShtGroupEntries to check the type early for us. | |||||
448 | ArrayRef<Elf_Word> Entries = getShtGroupEntries(Sec); | |||||
449 | ||||||
450 | // If it is a new section group, we want to keep group members. | |||||
451 | // Group leader sections, which contain indices of group members, are | |||||
452 | // discarded because they are useless beyond this point. The only | |||||
453 | // exception is the -r option because in order to produce re-linkable | |||||
454 | // object files, we want to pass through basically everything. | |||||
455 | if (IsNew) { | |||||
456 | if (Config->Relocatable) | |||||
457 | this->Sections[I] = createInputSection(Sec); | |||||
458 | continue; | |||||
459 | } | |||||
460 | ||||||
461 | // Otherwise, discard group members. | |||||
462 | for (uint32_t SecIndex : Entries) { | |||||
463 | if (SecIndex >= Size) | |||||
464 | fatal(toString(this) + | |||||
465 | ": invalid section index in group: " + Twine(SecIndex)); | |||||
466 | this->Sections[SecIndex] = &InputSection::Discarded; | |||||
467 | } | |||||
468 | break; | |||||
469 | } | |||||
470 | case SHT_SYMTAB: | |||||
471 | this->initSymtab(ObjSections, &Sec); | |||||
472 | break; | |||||
473 | case SHT_SYMTAB_SHNDX: | |||||
474 | this->SymtabSHNDX = CHECK(Obj.getSHNDXTable(Sec, ObjSections), this)check2((Obj.getSHNDXTable(Sec, ObjSections)), [&] { return toString(this); }); | |||||
475 | break; | |||||
476 | case SHT_STRTAB: | |||||
477 | case SHT_NULL: | |||||
478 | break; | |||||
479 | default: | |||||
480 | this->Sections[I] = createInputSection(Sec); | |||||
481 | } | |||||
482 | ||||||
483 | // .ARM.exidx sections have a reverse dependency on the InputSection they | |||||
484 | // have a SHF_LINK_ORDER dependency, this is identified by the sh_link. | |||||
485 | if (Sec.sh_flags & SHF_LINK_ORDER) { | |||||
486 | InputSectionBase *LinkSec = nullptr; | |||||
487 | if (Sec.sh_link < this->Sections.size()) | |||||
488 | LinkSec = this->Sections[Sec.sh_link]; | |||||
489 | if (!LinkSec) | |||||
490 | fatal(toString(this) + | |||||
491 | ": invalid sh_link index: " + Twine(Sec.sh_link)); | |||||
492 | ||||||
493 | InputSection *IS = cast<InputSection>(this->Sections[I]); | |||||
494 | LinkSec->DependentSections.push_back(IS); | |||||
495 | if (!isa<InputSection>(LinkSec)) | |||||
496 | error("a section " + IS->Name + | |||||
497 | " with SHF_LINK_ORDER should not refer a non-regular " | |||||
498 | "section: " + | |||||
499 | toString(LinkSec)); | |||||
500 | } | |||||
501 | } | |||||
502 | } | |||||
503 | ||||||
504 | // For ARM only, to set the EF_ARM_ABI_FLOAT_SOFT or EF_ARM_ABI_FLOAT_HARD | |||||
505 | // flag in the ELF Header we need to look at Tag_ABI_VFP_args to find out how | |||||
506 | // the input objects have been compiled. | |||||
507 | static void updateARMVFPArgs(const ARMAttributeParser &Attributes, | |||||
508 | const InputFile *F) { | |||||
509 | if (!Attributes.hasAttribute(ARMBuildAttrs::ABI_VFP_args)) | |||||
510 | // If an ABI tag isn't present then it is implicitly given the value of 0 | |||||
511 | // which maps to ARMBuildAttrs::BaseAAPCS. However many assembler files, | |||||
512 | // including some in glibc that don't use FP args (and should have value 3) | |||||
513 | // don't have the attribute so we do not consider an implicit value of 0 | |||||
514 | // as a clash. | |||||
515 | return; | |||||
516 | ||||||
517 | unsigned VFPArgs = Attributes.getAttributeValue(ARMBuildAttrs::ABI_VFP_args); | |||||
518 | ARMVFPArgKind Arg; | |||||
519 | switch (VFPArgs) { | |||||
520 | case ARMBuildAttrs::BaseAAPCS: | |||||
521 | Arg = ARMVFPArgKind::Base; | |||||
522 | break; | |||||
523 | case ARMBuildAttrs::HardFPAAPCS: | |||||
524 | Arg = ARMVFPArgKind::VFP; | |||||
525 | break; | |||||
526 | case ARMBuildAttrs::ToolChainFPPCS: | |||||
527 | // Tool chain specific convention that conforms to neither AAPCS variant. | |||||
528 | Arg = ARMVFPArgKind::ToolChain; | |||||
529 | break; | |||||
530 | case ARMBuildAttrs::CompatibleFPAAPCS: | |||||
531 | // Object compatible with all conventions. | |||||
532 | return; | |||||
533 | default: | |||||
534 | error(toString(F) + ": unknown Tag_ABI_VFP_args value: " + Twine(VFPArgs)); | |||||
535 | return; | |||||
536 | } | |||||
537 | // Follow ld.bfd and error if there is a mix of calling conventions. | |||||
538 | if (Config->ARMVFPArgs != Arg && Config->ARMVFPArgs != ARMVFPArgKind::Default) | |||||
539 | error(toString(F) + ": incompatible Tag_ABI_VFP_args"); | |||||
540 | else | |||||
541 | Config->ARMVFPArgs = Arg; | |||||
542 | } | |||||
543 | ||||||
544 | // The ARM support in lld makes some use of instructions that are not available | |||||
545 | // on all ARM architectures. Namely: | |||||
546 | // - Use of BLX instruction for interworking between ARM and Thumb state. | |||||
547 | // - Use of the extended Thumb branch encoding in relocation. | |||||
548 | // - Use of the MOVT/MOVW instructions in Thumb Thunks. | |||||
549 | // The ARM Attributes section contains information about the architecture chosen | |||||
550 | // at compile time. We follow the convention that if at least one input object | |||||
551 | // is compiled with an architecture that supports these features then lld is | |||||
552 | // permitted to use them. | |||||
553 | static void updateSupportedARMFeatures(const ARMAttributeParser &Attributes) { | |||||
554 | if (!Attributes.hasAttribute(ARMBuildAttrs::CPU_arch)) | |||||
555 | return; | |||||
556 | auto Arch = Attributes.getAttributeValue(ARMBuildAttrs::CPU_arch); | |||||
557 | switch (Arch) { | |||||
558 | case ARMBuildAttrs::Pre_v4: | |||||
559 | case ARMBuildAttrs::v4: | |||||
560 | case ARMBuildAttrs::v4T: | |||||
561 | // Architectures prior to v5 do not support BLX instruction | |||||
562 | break; | |||||
563 | case ARMBuildAttrs::v5T: | |||||
564 | case ARMBuildAttrs::v5TE: | |||||
565 | case ARMBuildAttrs::v5TEJ: | |||||
566 | case ARMBuildAttrs::v6: | |||||
567 | case ARMBuildAttrs::v6KZ: | |||||
568 | case ARMBuildAttrs::v6K: | |||||
569 | Config->ARMHasBlx = true; | |||||
570 | // Architectures used in pre-Cortex processors do not support | |||||
571 | // The J1 = 1 J2 = 1 Thumb branch range extension, with the exception | |||||
572 | // of Architecture v6T2 (arm1156t2-s and arm1156t2f-s) that do. | |||||
573 | break; | |||||
574 | default: | |||||
575 | // All other Architectures have BLX and extended branch encoding | |||||
576 | Config->ARMHasBlx = true; | |||||
577 | Config->ARMJ1J2BranchEncoding = true; | |||||
578 | if (Arch != ARMBuildAttrs::v6_M && Arch != ARMBuildAttrs::v6S_M) | |||||
579 | // All Architectures used in Cortex processors with the exception | |||||
580 | // of v6-M and v6S-M have the MOVT and MOVW instructions. | |||||
581 | Config->ARMHasMovtMovw = true; | |||||
582 | break; | |||||
583 | } | |||||
584 | } | |||||
585 | ||||||
586 | template <class ELFT> | |||||
587 | InputSectionBase *ObjFile<ELFT>::getRelocTarget(const Elf_Shdr &Sec) { | |||||
588 | uint32_t Idx = Sec.sh_info; | |||||
589 | if (Idx >= this->Sections.size()) | |||||
590 | fatal(toString(this) + ": invalid relocated section index: " + Twine(Idx)); | |||||
591 | InputSectionBase *Target = this->Sections[Idx]; | |||||
592 | ||||||
593 | // Strictly speaking, a relocation section must be included in the | |||||
594 | // group of the section it relocates. However, LLVM 3.3 and earlier | |||||
595 | // would fail to do so, so we gracefully handle that case. | |||||
596 | if (Target == &InputSection::Discarded) | |||||
597 | return nullptr; | |||||
598 | ||||||
599 | if (!Target) | |||||
600 | fatal(toString(this) + ": unsupported relocation reference"); | |||||
601 | return Target; | |||||
602 | } | |||||
603 | ||||||
604 | // Create a regular InputSection class that has the same contents | |||||
605 | // as a given section. | |||||
606 | static InputSection *toRegularSection(MergeInputSection *Sec) { | |||||
607 | return make<InputSection>(Sec->File, Sec->Flags, Sec->Type, Sec->Alignment, | |||||
608 | Sec->data(), Sec->Name); | |||||
609 | } | |||||
610 | ||||||
611 | template <class ELFT> | |||||
612 | InputSectionBase *ObjFile<ELFT>::createInputSection(const Elf_Shdr &Sec) { | |||||
613 | StringRef Name = getSectionName(Sec); | |||||
614 | ||||||
615 | switch (Sec.sh_type) { | |||||
616 | case SHT_ARM_ATTRIBUTES: { | |||||
617 | if (Config->EMachine != EM_ARM) | |||||
618 | break; | |||||
619 | ARMAttributeParser Attributes; | |||||
620 | ArrayRef<uint8_t> Contents = check(this->getObj().getSectionContents(&Sec)); | |||||
621 | Attributes.Parse(Contents, /*isLittle*/ Config->EKind == ELF32LEKind); | |||||
622 | updateSupportedARMFeatures(Attributes); | |||||
623 | updateARMVFPArgs(Attributes, this); | |||||
624 | ||||||
625 | // FIXME: Retain the first attribute section we see. The eglibc ARM | |||||
626 | // dynamic loaders require the presence of an attribute section for dlopen | |||||
627 | // to work. In a full implementation we would merge all attribute sections. | |||||
628 | if (In.ARMAttributes == nullptr) { | |||||
629 | In.ARMAttributes = make<InputSection>(*this, Sec, Name); | |||||
630 | return In.ARMAttributes; | |||||
631 | } | |||||
632 | return &InputSection::Discarded; | |||||
633 | } | |||||
634 | case SHT_RELA: | |||||
635 | case SHT_REL: { | |||||
636 | // Find a relocation target section and associate this section with that. | |||||
637 | // Target may have been discarded if it is in a different section group | |||||
638 | // and the group is discarded, even though it's a violation of the | |||||
639 | // spec. We handle that situation gracefully by discarding dangling | |||||
640 | // relocation sections. | |||||
641 | InputSectionBase *Target = getRelocTarget(Sec); | |||||
642 | if (!Target) | |||||
643 | return nullptr; | |||||
644 | ||||||
645 | // This section contains relocation information. | |||||
646 | // If -r is given, we do not interpret or apply relocation | |||||
647 | // but just copy relocation sections to output. | |||||
648 | if (Config->Relocatable) | |||||
649 | return make<InputSection>(*this, Sec, Name); | |||||
650 | ||||||
651 | if (Target->FirstRelocation) | |||||
652 | fatal(toString(this) + | |||||
653 | ": multiple relocation sections to one section are not supported"); | |||||
654 | ||||||
655 | // ELF spec allows mergeable sections with relocations, but they are | |||||
656 | // rare, and it is in practice hard to merge such sections by contents, | |||||
657 | // because applying relocations at end of linking changes section | |||||
658 | // contents. So, we simply handle such sections as non-mergeable ones. | |||||
659 | // Degrading like this is acceptable because section merging is optional. | |||||
660 | if (auto *MS = dyn_cast<MergeInputSection>(Target)) { | |||||
661 | Target = toRegularSection(MS); | |||||
662 | this->Sections[Sec.sh_info] = Target; | |||||
663 | } | |||||
664 | ||||||
665 | if (Sec.sh_type == SHT_RELA) { | |||||
666 | ArrayRef<Elf_Rela> Rels = CHECK(this->getObj().relas(&Sec), this)check2((this->getObj().relas(&Sec)), [&] { return toString (this); }); | |||||
667 | Target->FirstRelocation = Rels.begin(); | |||||
668 | Target->NumRelocations = Rels.size(); | |||||
669 | Target->AreRelocsRela = true; | |||||
670 | } else { | |||||
671 | ArrayRef<Elf_Rel> Rels = CHECK(this->getObj().rels(&Sec), this)check2((this->getObj().rels(&Sec)), [&] { return toString (this); }); | |||||
672 | Target->FirstRelocation = Rels.begin(); | |||||
673 | Target->NumRelocations = Rels.size(); | |||||
674 | Target->AreRelocsRela = false; | |||||
675 | } | |||||
676 | assert(isUInt<31>(Target->NumRelocations))((isUInt<31>(Target->NumRelocations)) ? static_cast< void> (0) : __assert_fail ("isUInt<31>(Target->NumRelocations)" , "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.cpp" , 676, __PRETTY_FUNCTION__)); | |||||
677 | ||||||
678 | // Relocation sections processed by the linker are usually removed | |||||
679 | // from the output, so returning `nullptr` for the normal case. | |||||
680 | // However, if -emit-relocs is given, we need to leave them in the output. | |||||
681 | // (Some post link analysis tools need this information.) | |||||
682 | if (Config->EmitRelocs) { | |||||
683 | InputSection *RelocSec = make<InputSection>(*this, Sec, Name); | |||||
684 | // We will not emit relocation section if target was discarded. | |||||
685 | Target->DependentSections.push_back(RelocSec); | |||||
686 | return RelocSec; | |||||
687 | } | |||||
688 | return nullptr; | |||||
689 | } | |||||
690 | } | |||||
691 | ||||||
692 | // The GNU linker uses .note.GNU-stack section as a marker indicating | |||||
693 | // that the code in the object file does not expect that the stack is | |||||
694 | // executable (in terms of NX bit). If all input files have the marker, | |||||
695 | // the GNU linker adds a PT_GNU_STACK segment to tells the loader to | |||||
696 | // make the stack non-executable. Most object files have this section as | |||||
697 | // of 2017. | |||||
698 | // | |||||
699 | // But making the stack non-executable is a norm today for security | |||||
700 | // reasons. Failure to do so may result in a serious security issue. | |||||
701 | // Therefore, we make LLD always add PT_GNU_STACK unless it is | |||||
702 | // explicitly told to do otherwise (by -z execstack). Because the stack | |||||
703 | // executable-ness is controlled solely by command line options, | |||||
704 | // .note.GNU-stack sections are simply ignored. | |||||
705 | if (Name == ".note.GNU-stack") | |||||
706 | return &InputSection::Discarded; | |||||
707 | ||||||
708 | // Split stacks is a feature to support a discontiguous stack, | |||||
709 | // commonly used in the programming language Go. For the details, | |||||
710 | // see https://gcc.gnu.org/wiki/SplitStacks. An object file compiled | |||||
711 | // for split stack will include a .note.GNU-split-stack section. | |||||
712 | if (Name == ".note.GNU-split-stack") { | |||||
713 | if (Config->Relocatable) { | |||||
714 | error("cannot mix split-stack and non-split-stack in a relocatable link"); | |||||
715 | return &InputSection::Discarded; | |||||
716 | } | |||||
717 | this->SplitStack = true; | |||||
718 | return &InputSection::Discarded; | |||||
719 | } | |||||
720 | ||||||
721 | // An object file cmpiled for split stack, but where some of the | |||||
722 | // functions were compiled with the no_split_stack_attribute will | |||||
723 | // include a .note.GNU-no-split-stack section. | |||||
724 | if (Name == ".note.GNU-no-split-stack") { | |||||
725 | this->SomeNoSplitStack = true; | |||||
726 | return &InputSection::Discarded; | |||||
727 | } | |||||
728 | ||||||
729 | // The linkonce feature is a sort of proto-comdat. Some glibc i386 object | |||||
730 | // files contain definitions of symbol "__x86.get_pc_thunk.bx" in linkonce | |||||
731 | // sections. Drop those sections to avoid duplicate symbol errors. | |||||
732 | // FIXME: This is glibc PR20543, we should remove this hack once that has been | |||||
733 | // fixed for a while. | |||||
734 | if (Name.startswith(".gnu.linkonce.")) | |||||
735 | return &InputSection::Discarded; | |||||
736 | ||||||
737 | // If we are creating a new .build-id section, strip existing .build-id | |||||
738 | // sections so that the output won't have more than one .build-id. | |||||
739 | // This is not usually a problem because input object files normally don't | |||||
740 | // have .build-id sections, but you can create such files by | |||||
741 | // "ld.{bfd,gold,lld} -r --build-id", and we want to guard against it. | |||||
742 | if (Name == ".note.gnu.build-id" && Config->BuildId != BuildIdKind::None) | |||||
743 | return &InputSection::Discarded; | |||||
744 | ||||||
745 | // The linker merges EH (exception handling) frames and creates a | |||||
746 | // .eh_frame_hdr section for runtime. So we handle them with a special | |||||
747 | // class. For relocatable outputs, they are just passed through. | |||||
748 | if (Name == ".eh_frame" && !Config->Relocatable) | |||||
749 | return make<EhInputSection>(*this, Sec, Name); | |||||
750 | ||||||
751 | if (shouldMerge(Sec)) | |||||
752 | return make<MergeInputSection>(*this, Sec, Name); | |||||
753 | return make<InputSection>(*this, Sec, Name); | |||||
754 | } | |||||
755 | ||||||
756 | template <class ELFT> | |||||
757 | StringRef ObjFile<ELFT>::getSectionName(const Elf_Shdr &Sec) { | |||||
758 | return CHECK(this->getObj().getSectionName(&Sec, SectionStringTable), this)check2((this->getObj().getSectionName(&Sec, SectionStringTable )), [&] { return toString(this); }); | |||||
759 | } | |||||
760 | ||||||
761 | template <class ELFT> void ObjFile<ELFT>::initializeSymbols() { | |||||
762 | this->Symbols.reserve(this->ELFSyms.size()); | |||||
763 | for (const Elf_Sym &Sym : this->ELFSyms) | |||||
764 | this->Symbols.push_back(createSymbol(&Sym)); | |||||
765 | } | |||||
766 | ||||||
767 | template <class ELFT> Symbol *ObjFile<ELFT>::createSymbol(const Elf_Sym *Sym) { | |||||
768 | int Binding = Sym->getBinding(); | |||||
769 | ||||||
770 | uint32_t SecIdx = this->getSectionIndex(*Sym); | |||||
771 | if (SecIdx >= this->Sections.size()) | |||||
772 | fatal(toString(this) + ": invalid section index: " + Twine(SecIdx)); | |||||
773 | ||||||
774 | InputSectionBase *Sec = this->Sections[SecIdx]; | |||||
775 | uint8_t StOther = Sym->st_other; | |||||
776 | uint8_t Type = Sym->getType(); | |||||
777 | uint64_t Value = Sym->st_value; | |||||
778 | uint64_t Size = Sym->st_size; | |||||
779 | ||||||
780 | if (Binding == STB_LOCAL) { | |||||
781 | if (Sym->getType() == STT_FILE) | |||||
782 | SourceFile = CHECK(Sym->getName(this->StringTable), this)check2((Sym->getName(this->StringTable)), [&] { return toString(this); }); | |||||
783 | ||||||
784 | if (this->StringTable.size() <= Sym->st_name) | |||||
785 | fatal(toString(this) + ": invalid symbol name offset"); | |||||
786 | ||||||
787 | StringRefZ Name = this->StringTable.data() + Sym->st_name; | |||||
788 | if (Sym->st_shndx == SHN_UNDEF) | |||||
789 | return make<Undefined>(this, Name, Binding, StOther, Type); | |||||
790 | ||||||
791 | return make<Defined>(this, Name, Binding, StOther, Type, Value, Size, Sec); | |||||
792 | } | |||||
793 | ||||||
794 | StringRef Name = CHECK(Sym->getName(this->StringTable), this)check2((Sym->getName(this->StringTable)), [&] { return toString(this); }); | |||||
795 | ||||||
796 | switch (Sym->st_shndx) { | |||||
797 | case SHN_UNDEF: | |||||
798 | return Symtab->addUndefined<ELFT>(Name, Binding, StOther, Type, | |||||
799 | /*CanOmitFromDynSym=*/false, this); | |||||
800 | case SHN_COMMON: | |||||
801 | if (Value == 0 || Value >= UINT32_MAX(4294967295U)) | |||||
802 | fatal(toString(this) + ": common symbol '" + Name + | |||||
803 | "' has invalid alignment: " + Twine(Value)); | |||||
804 | return Symtab->addCommon(Name, Size, Value, Binding, StOther, Type, *this); | |||||
805 | } | |||||
806 | ||||||
807 | switch (Binding) { | |||||
808 | default: | |||||
809 | fatal(toString(this) + ": unexpected binding: " + Twine(Binding)); | |||||
810 | case STB_GLOBAL: | |||||
811 | case STB_WEAK: | |||||
812 | case STB_GNU_UNIQUE: | |||||
813 | if (Sec == &InputSection::Discarded) | |||||
814 | return Symtab->addUndefined<ELFT>(Name, Binding, StOther, Type, | |||||
815 | /*CanOmitFromDynSym=*/false, this); | |||||
816 | return Symtab->addDefined(Name, StOther, Type, Value, Size, Binding, Sec, | |||||
817 | this); | |||||
818 | } | |||||
819 | } | |||||
820 | ||||||
821 | ArchiveFile::ArchiveFile(std::unique_ptr<Archive> &&File) | |||||
822 | : InputFile(ArchiveKind, File->getMemoryBufferRef()), | |||||
823 | File(std::move(File)) {} | |||||
824 | ||||||
825 | template <class ELFT> void ArchiveFile::parse() { | |||||
826 | for (const Archive::Symbol &Sym : File->symbols()) | |||||
827 | Symtab->addLazyArchive<ELFT>(Sym.getName(), *this, Sym); | |||||
828 | } | |||||
829 | ||||||
830 | // Returns a buffer pointing to a member file containing a given symbol. | |||||
831 | InputFile *ArchiveFile::fetch(const Archive::Symbol &Sym) { | |||||
832 | Archive::Child C = | |||||
833 | CHECK(Sym.getMember(), toString(this) +check2((Sym.getMember()), [&] { return toString(toString( this) + ": could not get the member for symbol " + Sym.getName ()); }) | |||||
834 | ": could not get the member for symbol " +check2((Sym.getMember()), [&] { return toString(toString( this) + ": could not get the member for symbol " + Sym.getName ()); }) | |||||
835 | Sym.getName())check2((Sym.getMember()), [&] { return toString(toString( this) + ": could not get the member for symbol " + Sym.getName ()); }); | |||||
836 | ||||||
837 | if (!Seen.insert(C.getChildOffset()).second) | |||||
838 | return nullptr; | |||||
839 | ||||||
840 | MemoryBufferRef MB = | |||||
841 | CHECK(C.getMemoryBufferRef(),check2((C.getMemoryBufferRef()), [&] { return toString(toString (this) + ": could not get the buffer for the member defining symbol " + Sym.getName()); }) | |||||
842 | toString(this) +check2((C.getMemoryBufferRef()), [&] { return toString(toString (this) + ": could not get the buffer for the member defining symbol " + Sym.getName()); }) | |||||
843 | ": could not get the buffer for the member defining symbol " +check2((C.getMemoryBufferRef()), [&] { return toString(toString (this) + ": could not get the buffer for the member defining symbol " + Sym.getName()); }) | |||||
844 | Sym.getName())check2((C.getMemoryBufferRef()), [&] { return toString(toString (this) + ": could not get the buffer for the member defining symbol " + Sym.getName()); }); | |||||
845 | ||||||
846 | if (Tar && C.getParent()->isThin()) | |||||
847 | Tar->append(relativeToRoot(CHECK(C.getFullName(), this)check2((C.getFullName()), [&] { return toString(this); })), MB.getBuffer()); | |||||
848 | ||||||
849 | InputFile *File = createObjectFile( | |||||
850 | MB, getName(), C.getParent()->isThin() ? 0 : C.getChildOffset()); | |||||
851 | File->GroupId = GroupId; | |||||
852 | return File; | |||||
853 | } | |||||
854 | ||||||
855 | template <class ELFT> | |||||
856 | SharedFile<ELFT>::SharedFile(MemoryBufferRef M, StringRef DefaultSoName) | |||||
857 | : ELFFileBase<ELFT>(Base::SharedKind, M), SoName(DefaultSoName), | |||||
858 | IsNeeded(!Config->AsNeeded) {} | |||||
859 | ||||||
860 | // Partially parse the shared object file so that we can call | |||||
861 | // getSoName on this object. | |||||
862 | template <class ELFT> void SharedFile<ELFT>::parseSoName() { | |||||
863 | const Elf_Shdr *DynamicSec = nullptr; | |||||
864 | const ELFFile<ELFT> Obj = this->getObj(); | |||||
865 | ArrayRef<Elf_Shdr> Sections = CHECK(Obj.sections(), this)check2((Obj.sections()), [&] { return toString(this); }); | |||||
866 | ||||||
867 | // Search for .dynsym, .dynamic, .symtab, .gnu.version and .gnu.version_d. | |||||
868 | for (const Elf_Shdr &Sec : Sections) { | |||||
869 | switch (Sec.sh_type) { | |||||
870 | default: | |||||
871 | continue; | |||||
872 | case SHT_DYNSYM: | |||||
873 | this->initSymtab(Sections, &Sec); | |||||
874 | break; | |||||
875 | case SHT_DYNAMIC: | |||||
876 | DynamicSec = &Sec; | |||||
877 | break; | |||||
878 | case SHT_SYMTAB_SHNDX: | |||||
879 | this->SymtabSHNDX = CHECK(Obj.getSHNDXTable(Sec, Sections), this)check2((Obj.getSHNDXTable(Sec, Sections)), [&] { return toString (this); }); | |||||
880 | break; | |||||
881 | case SHT_GNU_versym: | |||||
882 | this->VersymSec = &Sec; | |||||
883 | break; | |||||
884 | case SHT_GNU_verdef: | |||||
885 | this->VerdefSec = &Sec; | |||||
886 | break; | |||||
887 | } | |||||
888 | } | |||||
889 | ||||||
890 | if (this->VersymSec && this->ELFSyms.empty()) | |||||
891 | error("SHT_GNU_versym should be associated with symbol table"); | |||||
892 | ||||||
893 | // Search for a DT_SONAME tag to initialize this->SoName. | |||||
894 | if (!DynamicSec) | |||||
895 | return; | |||||
896 | ArrayRef<Elf_Dyn> Arr = | |||||
897 | CHECK(Obj.template getSectionContentsAsArray<Elf_Dyn>(DynamicSec), this)check2((Obj.template getSectionContentsAsArray<Elf_Dyn> (DynamicSec)), [&] { return toString(this); }); | |||||
898 | for (const Elf_Dyn &Dyn : Arr) { | |||||
899 | if (Dyn.d_tag == DT_SONAME) { | |||||
900 | uint64_t Val = Dyn.getVal(); | |||||
901 | if (Val >= this->StringTable.size()) | |||||
902 | fatal(toString(this) + ": invalid DT_SONAME entry"); | |||||
903 | SoName = this->StringTable.data() + Val; | |||||
904 | return; | |||||
905 | } | |||||
906 | } | |||||
907 | } | |||||
908 | ||||||
909 | // Parses ".gnu.version" section which is a parallel array for the symbol table. | |||||
910 | // If a given file doesn't have ".gnu.version" section, returns VER_NDX_GLOBAL. | |||||
911 | template <class ELFT> std::vector<uint32_t> SharedFile<ELFT>::parseVersyms() { | |||||
912 | size_t Size = this->ELFSyms.size() - this->FirstGlobal; | |||||
913 | if (!VersymSec) | |||||
914 | return std::vector<uint32_t>(Size, VER_NDX_GLOBAL); | |||||
915 | ||||||
916 | const char *Base = this->MB.getBuffer().data(); | |||||
917 | const Elf_Versym *Versym = | |||||
918 | reinterpret_cast<const Elf_Versym *>(Base + VersymSec->sh_offset) + | |||||
919 | this->FirstGlobal; | |||||
920 | ||||||
921 | std::vector<uint32_t> Ret(Size); | |||||
922 | for (size_t I = 0; I < Size; ++I) | |||||
923 | Ret[I] = Versym[I].vs_index; | |||||
924 | return Ret; | |||||
925 | } | |||||
926 | ||||||
927 | // Parse the version definitions in the object file if present. Returns a vector | |||||
928 | // whose nth element contains a pointer to the Elf_Verdef for version identifier | |||||
929 | // n. Version identifiers that are not definitions map to nullptr. | |||||
930 | template <class ELFT> | |||||
931 | std::vector<const typename ELFT::Verdef *> SharedFile<ELFT>::parseVerdefs() { | |||||
932 | if (!VerdefSec) | |||||
933 | return {}; | |||||
934 | ||||||
935 | // We cannot determine the largest verdef identifier without inspecting | |||||
936 | // every Elf_Verdef, but both bfd and gold assign verdef identifiers | |||||
937 | // sequentially starting from 1, so we predict that the largest identifier | |||||
938 | // will be VerdefCount. | |||||
939 | unsigned VerdefCount = VerdefSec->sh_info; | |||||
940 | std::vector<const Elf_Verdef *> Verdefs(VerdefCount + 1); | |||||
941 | ||||||
942 | // Build the Verdefs array by following the chain of Elf_Verdef objects | |||||
943 | // from the start of the .gnu.version_d section. | |||||
944 | const char *Base = this->MB.getBuffer().data(); | |||||
945 | const char *Verdef = Base + VerdefSec->sh_offset; | |||||
946 | for (unsigned I = 0; I != VerdefCount; ++I) { | |||||
947 | auto *CurVerdef = reinterpret_cast<const Elf_Verdef *>(Verdef); | |||||
948 | Verdef += CurVerdef->vd_next; | |||||
949 | unsigned VerdefIndex = CurVerdef->vd_ndx; | |||||
950 | Verdefs.resize(VerdefIndex + 1); | |||||
951 | Verdefs[VerdefIndex] = CurVerdef; | |||||
952 | } | |||||
953 | ||||||
954 | return Verdefs; | |||||
955 | } | |||||
956 | ||||||
957 | // We do not usually care about alignments of data in shared object | |||||
958 | // files because the loader takes care of it. However, if we promote a | |||||
959 | // DSO symbol to point to .bss due to copy relocation, we need to keep | |||||
960 | // the original alignment requirements. We infer it in this function. | |||||
961 | template <class ELFT> | |||||
962 | uint32_t SharedFile<ELFT>::getAlignment(ArrayRef<Elf_Shdr> Sections, | |||||
963 | const Elf_Sym &Sym) { | |||||
964 | uint64_t Ret = UINT64_MAX(18446744073709551615UL); | |||||
965 | if (Sym.st_value) | |||||
966 | Ret = 1ULL << countTrailingZeros((uint64_t)Sym.st_value); | |||||
967 | if (0 < Sym.st_shndx && Sym.st_shndx < Sections.size()) | |||||
968 | Ret = std::min<uint64_t>(Ret, Sections[Sym.st_shndx].sh_addralign); | |||||
969 | return (Ret > UINT32_MAX(4294967295U)) ? 0 : Ret; | |||||
970 | } | |||||
971 | ||||||
972 | // Fully parse the shared object file. This must be called after parseSoName(). | |||||
973 | // | |||||
974 | // This function parses symbol versions. If a DSO has version information, | |||||
975 | // the file has a ".gnu.version_d" section which contains symbol version | |||||
976 | // definitions. Each symbol is associated to one version through a table in | |||||
977 | // ".gnu.version" section. That table is a parallel array for the symbol | |||||
978 | // table, and each table entry contains an index in ".gnu.version_d". | |||||
979 | // | |||||
980 | // The special index 0 is reserved for VERF_NDX_LOCAL and 1 is for | |||||
981 | // VER_NDX_GLOBAL. There's no table entry for these special versions in | |||||
982 | // ".gnu.version_d". | |||||
983 | // | |||||
984 | // The file format for symbol versioning is perhaps a bit more complicated | |||||
985 | // than necessary, but you can easily understand the code if you wrap your | |||||
986 | // head around the data structure described above. | |||||
987 | template <class ELFT> void SharedFile<ELFT>::parseRest() { | |||||
988 | Verdefs = parseVerdefs(); // parse .gnu.version_d | |||||
989 | std::vector<uint32_t> Versyms = parseVersyms(); // parse .gnu.version | |||||
990 | ArrayRef<Elf_Shdr> Sections = CHECK(this->getObj().sections(), this)check2((this->getObj().sections()), [&] { return toString (this); }); | |||||
| ||||||
991 | ||||||
992 | // System libraries can have a lot of symbols with versions. Using a | |||||
993 | // fixed buffer for computing the versions name (foo@ver) can save a | |||||
994 | // lot of allocations. | |||||
995 | SmallString<0> VersionedNameBuffer; | |||||
996 | ||||||
997 | // Add symbols to the symbol table. | |||||
998 | ArrayRef<Elf_Sym> Syms = this->getGlobalELFSyms(); | |||||
999 | for (size_t I = 0; I < Syms.size(); ++I) { | |||||
1000 | const Elf_Sym &Sym = Syms[I]; | |||||
1001 | ||||||
1002 | // ELF spec requires that all local symbols precede weak or global | |||||
1003 | // symbols in each symbol table, and the index of first non-local symbol | |||||
1004 | // is stored to sh_info. If a local symbol appears after some non-local | |||||
1005 | // symbol, that's a violation of the spec. | |||||
1006 | StringRef Name = CHECK(Sym.getName(this->StringTable), this)check2((Sym.getName(this->StringTable)), [&] { return toString (this); }); | |||||
1007 | if (Sym.getBinding() == STB_LOCAL) { | |||||
1008 | warn("found local symbol '" + Name + | |||||
1009 | "' in global part of symbol table in file " + toString(this)); | |||||
1010 | continue; | |||||
1011 | } | |||||
1012 | ||||||
1013 | if (Sym.isUndefined()) { | |||||
1014 | Symbol *S = Symtab->addUndefined<ELFT>(Name, Sym.getBinding(), | |||||
1015 | Sym.st_other, Sym.getType(), | |||||
1016 | /*CanOmitFromDynSym=*/false, this); | |||||
1017 | S->ExportDynamic = true; | |||||
1018 | continue; | |||||
1019 | } | |||||
1020 | ||||||
1021 | // MIPS BFD linker puts _gp_disp symbol into DSO files and incorrectly | |||||
1022 | // assigns VER_NDX_LOCAL to this section global symbol. Here is a | |||||
1023 | // workaround for this bug. | |||||
1024 | uint32_t Idx = Versyms[I] & ~VERSYM_HIDDEN; | |||||
1025 | if (Config->EMachine == EM_MIPS && Idx == VER_NDX_LOCAL && | |||||
1026 | Name == "_gp_disp") | |||||
1027 | continue; | |||||
1028 | ||||||
1029 | uint64_t Alignment = getAlignment(Sections, Sym); | |||||
1030 | if (!(Versyms[I] & VERSYM_HIDDEN)) | |||||
1031 | Symtab->addShared(Name, *this, Sym, Alignment, Idx); | |||||
1032 | ||||||
1033 | // Also add the symbol with the versioned name to handle undefined symbols | |||||
1034 | // with explicit versions. | |||||
1035 | if (Idx == VER_NDX_GLOBAL) | |||||
1036 | continue; | |||||
1037 | ||||||
1038 | if (Idx >= Verdefs.size() || Idx == VER_NDX_LOCAL) { | |||||
1039 | error("corrupt input file: version definition index " + Twine(Idx) + | |||||
1040 | " for symbol " + Name + " is out of bounds\n>>> defined in " + | |||||
1041 | toString(this)); | |||||
1042 | continue; | |||||
1043 | } | |||||
1044 | ||||||
1045 | StringRef VerName = | |||||
1046 | this->StringTable.data() + Verdefs[Idx]->getAux()->vda_name; | |||||
1047 | VersionedNameBuffer.clear(); | |||||
1048 | Name = (Name + "@" + VerName).toStringRef(VersionedNameBuffer); | |||||
1049 | Symtab->addShared(Saver.save(Name), *this, Sym, Alignment, Idx); | |||||
1050 | } | |||||
1051 | } | |||||
1052 | ||||||
1053 | static ELFKind getBitcodeELFKind(const Triple &T) { | |||||
1054 | if (T.isLittleEndian()) | |||||
1055 | return T.isArch64Bit() ? ELF64LEKind : ELF32LEKind; | |||||
1056 | return T.isArch64Bit() ? ELF64BEKind : ELF32BEKind; | |||||
1057 | } | |||||
1058 | ||||||
1059 | static uint8_t getBitcodeMachineKind(StringRef Path, const Triple &T) { | |||||
1060 | switch (T.getArch()) { | |||||
1061 | case Triple::aarch64: | |||||
1062 | return EM_AARCH64; | |||||
1063 | case Triple::amdgcn: | |||||
1064 | case Triple::r600: | |||||
1065 | return EM_AMDGPU; | |||||
1066 | case Triple::arm: | |||||
1067 | case Triple::thumb: | |||||
1068 | return EM_ARM; | |||||
1069 | case Triple::avr: | |||||
1070 | return EM_AVR; | |||||
1071 | case Triple::mips: | |||||
1072 | case Triple::mipsel: | |||||
1073 | case Triple::mips64: | |||||
1074 | case Triple::mips64el: | |||||
1075 | return EM_MIPS; | |||||
1076 | case Triple::ppc: | |||||
1077 | return EM_PPC; | |||||
1078 | case Triple::ppc64: | |||||
1079 | case Triple::ppc64le: | |||||
1080 | return EM_PPC64; | |||||
1081 | case Triple::x86: | |||||
1082 | return T.isOSIAMCU() ? EM_IAMCU : EM_386; | |||||
1083 | case Triple::x86_64: | |||||
1084 | return EM_X86_64; | |||||
1085 | default: | |||||
1086 | error(Path + ": could not infer e_machine from bitcode target triple " + | |||||
1087 | T.str()); | |||||
1088 | return EM_NONE; | |||||
1089 | } | |||||
1090 | } | |||||
1091 | ||||||
1092 | BitcodeFile::BitcodeFile(MemoryBufferRef MB, StringRef ArchiveName, | |||||
1093 | uint64_t OffsetInArchive) | |||||
1094 | : InputFile(BitcodeKind, MB) { | |||||
1095 | this->ArchiveName = ArchiveName; | |||||
1096 | ||||||
1097 | std::string Path = MB.getBufferIdentifier().str(); | |||||
1098 | if (Config->ThinLTOIndexOnly) | |||||
1099 | Path = replaceThinLTOSuffix(MB.getBufferIdentifier()); | |||||
1100 | ||||||
1101 | // ThinLTO assumes that all MemoryBufferRefs given to it have a unique | |||||
1102 | // name. If two archives define two members with the same name, this | |||||
1103 | // causes a collision which result in only one of the objects being taken | |||||
1104 | // into consideration at LTO time (which very likely causes undefined | |||||
1105 | // symbols later in the link stage). So we append file offset to make | |||||
1106 | // filename unique. | |||||
1107 | MemoryBufferRef MBRef( | |||||
1108 | MB.getBuffer(), | |||||
1109 | Saver.save(ArchiveName + Path + | |||||
1110 | (ArchiveName.empty() ? "" : utostr(OffsetInArchive)))); | |||||
1111 | ||||||
1112 | Obj = CHECK(lto::InputFile::create(MBRef), this)check2((lto::InputFile::create(MBRef)), [&] { return toString (this); }); | |||||
1113 | ||||||
1114 | Triple T(Obj->getTargetTriple()); | |||||
1115 | EKind = getBitcodeELFKind(T); | |||||
1116 | EMachine = getBitcodeMachineKind(MB.getBufferIdentifier(), T); | |||||
1117 | } | |||||
1118 | ||||||
1119 | static uint8_t mapVisibility(GlobalValue::VisibilityTypes GvVisibility) { | |||||
1120 | switch (GvVisibility) { | |||||
1121 | case GlobalValue::DefaultVisibility: | |||||
1122 | return STV_DEFAULT; | |||||
1123 | case GlobalValue::HiddenVisibility: | |||||
1124 | return STV_HIDDEN; | |||||
1125 | case GlobalValue::ProtectedVisibility: | |||||
1126 | return STV_PROTECTED; | |||||
1127 | } | |||||
1128 | llvm_unreachable("unknown visibility")::llvm::llvm_unreachable_internal("unknown visibility", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.cpp" , 1128); | |||||
1129 | } | |||||
1130 | ||||||
1131 | template <class ELFT> | |||||
1132 | static Symbol *createBitcodeSymbol(const std::vector<bool> &KeptComdats, | |||||
1133 | const lto::InputFile::Symbol &ObjSym, | |||||
1134 | BitcodeFile &F) { | |||||
1135 | StringRef Name = Saver.save(ObjSym.getName()); | |||||
1136 | uint32_t Binding = ObjSym.isWeak() ? STB_WEAK : STB_GLOBAL; | |||||
1137 | ||||||
1138 | uint8_t Type = ObjSym.isTLS() ? STT_TLS : STT_NOTYPE; | |||||
1139 | uint8_t Visibility = mapVisibility(ObjSym.getVisibility()); | |||||
1140 | bool CanOmitFromDynSym = ObjSym.canBeOmittedFromSymbolTable(); | |||||
1141 | ||||||
1142 | int C = ObjSym.getComdatIndex(); | |||||
1143 | if (C != -1 && !KeptComdats[C]) | |||||
1144 | return Symtab->addUndefined<ELFT>(Name, Binding, Visibility, Type, | |||||
1145 | CanOmitFromDynSym, &F); | |||||
1146 | ||||||
1147 | if (ObjSym.isUndefined()) | |||||
1148 | return Symtab->addUndefined<ELFT>(Name, Binding, Visibility, Type, | |||||
1149 | CanOmitFromDynSym, &F); | |||||
1150 | ||||||
1151 | if (ObjSym.isCommon()) | |||||
1152 | return Symtab->addCommon(Name, ObjSym.getCommonSize(), | |||||
1153 | ObjSym.getCommonAlignment(), Binding, Visibility, | |||||
1154 | STT_OBJECT, F); | |||||
1155 | ||||||
1156 | return Symtab->addBitcode(Name, Binding, Visibility, Type, CanOmitFromDynSym, | |||||
1157 | F); | |||||
1158 | } | |||||
1159 | ||||||
1160 | template <class ELFT> | |||||
1161 | void BitcodeFile::parse(DenseSet<CachedHashStringRef> &ComdatGroups) { | |||||
1162 | std::vector<bool> KeptComdats; | |||||
1163 | for (StringRef S : Obj->getComdatTable()) | |||||
1164 | KeptComdats.push_back(ComdatGroups.insert(CachedHashStringRef(S)).second); | |||||
1165 | ||||||
1166 | for (const lto::InputFile::Symbol &ObjSym : Obj->symbols()) | |||||
1167 | Symbols.push_back(createBitcodeSymbol<ELFT>(KeptComdats, ObjSym, *this)); | |||||
1168 | } | |||||
1169 | ||||||
1170 | static ELFKind getELFKind(MemoryBufferRef MB) { | |||||
1171 | unsigned char Size; | |||||
1172 | unsigned char Endian; | |||||
1173 | std::tie(Size, Endian) = getElfArchType(MB.getBuffer()); | |||||
1174 | ||||||
1175 | if (Endian != ELFDATA2LSB && Endian != ELFDATA2MSB) | |||||
1176 | fatal(MB.getBufferIdentifier() + ": invalid data encoding"); | |||||
1177 | if (Size != ELFCLASS32 && Size != ELFCLASS64) | |||||
1178 | fatal(MB.getBufferIdentifier() + ": invalid file class"); | |||||
1179 | ||||||
1180 | size_t BufSize = MB.getBuffer().size(); | |||||
1181 | if ((Size == ELFCLASS32 && BufSize < sizeof(Elf32_Ehdr)) || | |||||
1182 | (Size == ELFCLASS64 && BufSize < sizeof(Elf64_Ehdr))) | |||||
1183 | fatal(MB.getBufferIdentifier() + ": file is too short"); | |||||
1184 | ||||||
1185 | if (Size == ELFCLASS32) | |||||
1186 | return (Endian == ELFDATA2LSB) ? ELF32LEKind : ELF32BEKind; | |||||
1187 | return (Endian == ELFDATA2LSB) ? ELF64LEKind : ELF64BEKind; | |||||
1188 | } | |||||
1189 | ||||||
1190 | void BinaryFile::parse() { | |||||
1191 | ArrayRef<uint8_t> Data = arrayRefFromStringRef(MB.getBuffer()); | |||||
1192 | auto *Section = make<InputSection>(this, SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, | |||||
1193 | 8, Data, ".data"); | |||||
1194 | Sections.push_back(Section); | |||||
1195 | ||||||
1196 | // For each input file foo that is embedded to a result as a binary | |||||
1197 | // blob, we define _binary_foo_{start,end,size} symbols, so that | |||||
1198 | // user programs can access blobs by name. Non-alphanumeric | |||||
1199 | // characters in a filename are replaced with underscore. | |||||
1200 | std::string S = "_binary_" + MB.getBufferIdentifier().str(); | |||||
1201 | for (size_t I = 0; I < S.size(); ++I) | |||||
1202 | if (!isAlnum(S[I])) | |||||
1203 | S[I] = '_'; | |||||
1204 | ||||||
1205 | Symtab->addDefined(Saver.save(S + "_start"), STV_DEFAULT, STT_OBJECT, 0, 0, | |||||
1206 | STB_GLOBAL, Section, nullptr); | |||||
1207 | Symtab->addDefined(Saver.save(S + "_end"), STV_DEFAULT, STT_OBJECT, | |||||
1208 | Data.size(), 0, STB_GLOBAL, Section, nullptr); | |||||
1209 | Symtab->addDefined(Saver.save(S + "_size"), STV_DEFAULT, STT_OBJECT, | |||||
1210 | Data.size(), 0, STB_GLOBAL, nullptr, nullptr); | |||||
1211 | } | |||||
1212 | ||||||
1213 | InputFile *elf::createObjectFile(MemoryBufferRef MB, StringRef ArchiveName, | |||||
1214 | uint64_t OffsetInArchive) { | |||||
1215 | if (isBitcode(MB)) | |||||
1216 | return make<BitcodeFile>(MB, ArchiveName, OffsetInArchive); | |||||
1217 | ||||||
1218 | switch (getELFKind(MB)) { | |||||
1219 | case ELF32LEKind: | |||||
1220 | return make<ObjFile<ELF32LE>>(MB, ArchiveName); | |||||
1221 | case ELF32BEKind: | |||||
1222 | return make<ObjFile<ELF32BE>>(MB, ArchiveName); | |||||
1223 | case ELF64LEKind: | |||||
1224 | return make<ObjFile<ELF64LE>>(MB, ArchiveName); | |||||
1225 | case ELF64BEKind: | |||||
1226 | return make<ObjFile<ELF64BE>>(MB, ArchiveName); | |||||
1227 | default: | |||||
1228 | llvm_unreachable("getELFKind")::llvm::llvm_unreachable_internal("getELFKind", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.cpp" , 1228); | |||||
1229 | } | |||||
1230 | } | |||||
1231 | ||||||
1232 | InputFile *elf::createSharedFile(MemoryBufferRef MB, StringRef DefaultSoName) { | |||||
1233 | switch (getELFKind(MB)) { | |||||
1234 | case ELF32LEKind: | |||||
1235 | return make<SharedFile<ELF32LE>>(MB, DefaultSoName); | |||||
1236 | case ELF32BEKind: | |||||
1237 | return make<SharedFile<ELF32BE>>(MB, DefaultSoName); | |||||
1238 | case ELF64LEKind: | |||||
1239 | return make<SharedFile<ELF64LE>>(MB, DefaultSoName); | |||||
1240 | case ELF64BEKind: | |||||
1241 | return make<SharedFile<ELF64BE>>(MB, DefaultSoName); | |||||
1242 | default: | |||||
1243 | llvm_unreachable("getELFKind")::llvm::llvm_unreachable_internal("getELFKind", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.cpp" , 1243); | |||||
1244 | } | |||||
1245 | } | |||||
1246 | ||||||
1247 | MemoryBufferRef LazyObjFile::getBuffer() { | |||||
1248 | if (AddedToLink) | |||||
1249 | return MemoryBufferRef(); | |||||
1250 | AddedToLink = true; | |||||
1251 | return MB; | |||||
1252 | } | |||||
1253 | ||||||
1254 | InputFile *LazyObjFile::fetch() { | |||||
1255 | MemoryBufferRef MBRef = getBuffer(); | |||||
1256 | if (MBRef.getBuffer().empty()) | |||||
1257 | return nullptr; | |||||
1258 | ||||||
1259 | InputFile *File = createObjectFile(MBRef, ArchiveName, OffsetInArchive); | |||||
1260 | File->GroupId = GroupId; | |||||
1261 | return File; | |||||
1262 | } | |||||
1263 | ||||||
1264 | template <class ELFT> void LazyObjFile::parse() { | |||||
1265 | // A lazy object file wraps either a bitcode file or an ELF file. | |||||
1266 | if (isBitcode(this->MB)) { | |||||
1267 | std::unique_ptr<lto::InputFile> Obj = | |||||
1268 | CHECK(lto::InputFile::create(this->MB), this)check2((lto::InputFile::create(this->MB)), [&] { return toString(this); }); | |||||
1269 | for (const lto::InputFile::Symbol &Sym : Obj->symbols()) | |||||
1270 | if (!Sym.isUndefined()) | |||||
1271 | Symtab->addLazyObject<ELFT>(Saver.save(Sym.getName()), *this); | |||||
1272 | return; | |||||
1273 | } | |||||
1274 | ||||||
1275 | if (getELFKind(this->MB) != Config->EKind) { | |||||
1276 | error("incompatible file: " + this->MB.getBufferIdentifier()); | |||||
1277 | return; | |||||
1278 | } | |||||
1279 | ||||||
1280 | ELFFile<ELFT> Obj = check(ELFFile<ELFT>::create(MB.getBuffer())); | |||||
1281 | ArrayRef<typename ELFT::Shdr> Sections = CHECK(Obj.sections(), this)check2((Obj.sections()), [&] { return toString(this); }); | |||||
1282 | ||||||
1283 | for (const typename ELFT::Shdr &Sec : Sections) { | |||||
1284 | if (Sec.sh_type != SHT_SYMTAB) | |||||
1285 | continue; | |||||
1286 | ||||||
1287 | typename ELFT::SymRange Syms = CHECK(Obj.symbols(&Sec), this)check2((Obj.symbols(&Sec)), [&] { return toString(this ); }); | |||||
1288 | uint32_t FirstGlobal = Sec.sh_info; | |||||
1289 | StringRef StringTable = | |||||
1290 | CHECK(Obj.getStringTableForSymtab(Sec, Sections), this)check2((Obj.getStringTableForSymtab(Sec, Sections)), [&] { return toString(this); }); | |||||
1291 | ||||||
1292 | for (const typename ELFT::Sym &Sym : Syms.slice(FirstGlobal)) | |||||
1293 | if (Sym.st_shndx != SHN_UNDEF) | |||||
1294 | Symtab->addLazyObject<ELFT>(CHECK(Sym.getName(StringTable), this)check2((Sym.getName(StringTable)), [&] { return toString( this); }), | |||||
1295 | *this); | |||||
1296 | return; | |||||
1297 | } | |||||
1298 | } | |||||
1299 | ||||||
1300 | std::string elf::replaceThinLTOSuffix(StringRef Path) { | |||||
1301 | StringRef Suffix = Config->ThinLTOObjectSuffixReplace.first; | |||||
1302 | StringRef Repl = Config->ThinLTOObjectSuffixReplace.second; | |||||
1303 | ||||||
1304 | if (Path.consume_back(Suffix)) | |||||
1305 | return (Path + Repl).str(); | |||||
1306 | return Path; | |||||
1307 | } | |||||
1308 | ||||||
1309 | template void ArchiveFile::parse<ELF32LE>(); | |||||
1310 | template void ArchiveFile::parse<ELF32BE>(); | |||||
1311 | template void ArchiveFile::parse<ELF64LE>(); | |||||
1312 | template void ArchiveFile::parse<ELF64BE>(); | |||||
1313 | ||||||
1314 | template void BitcodeFile::parse<ELF32LE>(DenseSet<CachedHashStringRef> &); | |||||
1315 | template void BitcodeFile::parse<ELF32BE>(DenseSet<CachedHashStringRef> &); | |||||
1316 | template void BitcodeFile::parse<ELF64LE>(DenseSet<CachedHashStringRef> &); | |||||
1317 | template void BitcodeFile::parse<ELF64BE>(DenseSet<CachedHashStringRef> &); | |||||
1318 | ||||||
1319 | template void LazyObjFile::parse<ELF32LE>(); | |||||
1320 | template void LazyObjFile::parse<ELF32BE>(); | |||||
1321 | template void LazyObjFile::parse<ELF64LE>(); | |||||
1322 | template void LazyObjFile::parse<ELF64BE>(); | |||||
1323 | ||||||
1324 | template class elf::ELFFileBase<ELF32LE>; | |||||
1325 | template class elf::ELFFileBase<ELF32BE>; | |||||
1326 | template class elf::ELFFileBase<ELF64LE>; | |||||
1327 | template class elf::ELFFileBase<ELF64BE>; | |||||
1328 | ||||||
1329 | template class elf::ObjFile<ELF32LE>; | |||||
1330 | template class elf::ObjFile<ELF32BE>; | |||||
1331 | template class elf::ObjFile<ELF64LE>; | |||||
1332 | template class elf::ObjFile<ELF64BE>; | |||||
1333 | ||||||
1334 | template class elf::SharedFile<ELF32LE>; | |||||
1335 | template class elf::SharedFile<ELF32BE>; | |||||
1336 | template class elf::SharedFile<ELF64LE>; | |||||
1337 | template class elf::SharedFile<ELF64BE>; |
1 | //===- InputFiles.h ---------------------------------------------*- C++ -*-===// |
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 | #ifndef LLD_ELF_INPUT_FILES_H |
11 | #define LLD_ELF_INPUT_FILES_H |
12 | |
13 | #include "Config.h" |
14 | #include "lld/Common/ErrorHandler.h" |
15 | #include "lld/Common/LLVM.h" |
16 | #include "lld/Common/Reproduce.h" |
17 | #include "llvm/ADT/CachedHashString.h" |
18 | #include "llvm/ADT/DenseSet.h" |
19 | #include "llvm/ADT/STLExtras.h" |
20 | #include "llvm/DebugInfo/DWARF/DWARFDebugLine.h" |
21 | #include "llvm/IR/Comdat.h" |
22 | #include "llvm/Object/Archive.h" |
23 | #include "llvm/Object/ELF.h" |
24 | #include "llvm/Object/IRObjectFile.h" |
25 | #include "llvm/Support/Threading.h" |
26 | #include <map> |
27 | |
28 | namespace llvm { |
29 | class TarWriter; |
30 | struct DILineInfo; |
31 | namespace lto { |
32 | class InputFile; |
33 | } |
34 | } // namespace llvm |
35 | |
36 | namespace lld { |
37 | namespace elf { |
38 | class InputFile; |
39 | class InputSectionBase; |
40 | } |
41 | |
42 | // Returns "<internal>", "foo.a(bar.o)" or "baz.o". |
43 | std::string toString(const elf::InputFile *F); |
44 | |
45 | namespace elf { |
46 | |
47 | using llvm::object::Archive; |
48 | |
49 | class Symbol; |
50 | |
51 | // If -reproduce option is given, all input files are written |
52 | // to this tar archive. |
53 | extern llvm::TarWriter *Tar; |
54 | |
55 | // Opens a given file. |
56 | llvm::Optional<MemoryBufferRef> readFile(StringRef Path); |
57 | |
58 | // The root class of input files. |
59 | class InputFile { |
60 | public: |
61 | enum Kind { |
62 | ObjKind, |
63 | SharedKind, |
64 | LazyObjKind, |
65 | ArchiveKind, |
66 | BitcodeKind, |
67 | BinaryKind, |
68 | }; |
69 | |
70 | Kind kind() const { return FileKind; } |
71 | |
72 | bool isElf() const { |
73 | Kind K = kind(); |
74 | return K == ObjKind || K == SharedKind; |
75 | } |
76 | |
77 | StringRef getName() const { return MB.getBufferIdentifier(); } |
78 | MemoryBufferRef MB; |
79 | |
80 | // Returns sections. It is a runtime error to call this function |
81 | // on files that don't have the notion of sections. |
82 | ArrayRef<InputSectionBase *> getSections() const { |
83 | assert(FileKind == ObjKind || FileKind == BinaryKind)((FileKind == ObjKind || FileKind == BinaryKind) ? static_cast <void> (0) : __assert_fail ("FileKind == ObjKind || FileKind == BinaryKind" , "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.h" , 83, __PRETTY_FUNCTION__)); |
84 | return Sections; |
85 | } |
86 | |
87 | // Returns object file symbols. It is a runtime error to call this |
88 | // function on files of other types. |
89 | ArrayRef<Symbol *> getSymbols() { return getMutableSymbols(); } |
90 | |
91 | std::vector<Symbol *> &getMutableSymbols() { |
92 | assert(FileKind == BinaryKind || FileKind == ObjKind ||((FileKind == BinaryKind || FileKind == ObjKind || FileKind == BitcodeKind) ? static_cast<void> (0) : __assert_fail ( "FileKind == BinaryKind || FileKind == ObjKind || FileKind == BitcodeKind" , "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.h" , 93, __PRETTY_FUNCTION__)) |
93 | FileKind == BitcodeKind)((FileKind == BinaryKind || FileKind == ObjKind || FileKind == BitcodeKind) ? static_cast<void> (0) : __assert_fail ( "FileKind == BinaryKind || FileKind == ObjKind || FileKind == BitcodeKind" , "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/ELF/InputFiles.h" , 93, __PRETTY_FUNCTION__)); |
94 | return Symbols; |
95 | } |
96 | |
97 | // Filename of .a which contained this file. If this file was |
98 | // not in an archive file, it is the empty string. We use this |
99 | // string for creating error messages. |
100 | std::string ArchiveName; |
101 | |
102 | // If this is an architecture-specific file, the following members |
103 | // have ELF type (i.e. ELF{32,64}{LE,BE}) and target machine type. |
104 | ELFKind EKind = ELFNoneKind; |
105 | uint16_t EMachine = llvm::ELF::EM_NONE; |
106 | uint8_t OSABI = 0; |
107 | |
108 | // Cache for toString(). Only toString() should use this member. |
109 | mutable std::string ToStringCache; |
110 | |
111 | std::string getSrcMsg(const Symbol &Sym, InputSectionBase &Sec, |
112 | uint64_t Offset); |
113 | |
114 | // True if this is an argument for --just-symbols. Usually false. |
115 | bool JustSymbols = false; |
116 | |
117 | // GroupId is used for --warn-backrefs which is an optional error |
118 | // checking feature. All files within the same --{start,end}-group or |
119 | // --{start,end}-lib get the same group ID. Otherwise, each file gets a new |
120 | // group ID. For more info, see checkDependency() in SymbolTable.cpp. |
121 | uint32_t GroupId; |
122 | static bool IsInGroup; |
123 | static uint32_t NextGroupId; |
124 | |
125 | // Index of MIPS GOT built for this file. |
126 | llvm::Optional<size_t> MipsGotIndex; |
127 | |
128 | protected: |
129 | InputFile(Kind K, MemoryBufferRef M); |
130 | std::vector<InputSectionBase *> Sections; |
131 | std::vector<Symbol *> Symbols; |
132 | |
133 | private: |
134 | const Kind FileKind; |
135 | }; |
136 | |
137 | template <typename ELFT> class ELFFileBase : public InputFile { |
138 | public: |
139 | typedef typename ELFT::Shdr Elf_Shdr; |
140 | typedef typename ELFT::Sym Elf_Sym; |
141 | typedef typename ELFT::Word Elf_Word; |
142 | typedef typename ELFT::SymRange Elf_Sym_Range; |
143 | |
144 | ELFFileBase(Kind K, MemoryBufferRef M); |
145 | static bool classof(const InputFile *F) { return F->isElf(); } |
146 | |
147 | llvm::object::ELFFile<ELFT> getObj() const { |
148 | return check(llvm::object::ELFFile<ELFT>::create(MB.getBuffer())); |
149 | } |
150 | |
151 | StringRef getStringTable() const { return StringTable; } |
152 | |
153 | uint32_t getSectionIndex(const Elf_Sym &Sym) const; |
154 | |
155 | Elf_Sym_Range getGlobalELFSyms(); |
156 | Elf_Sym_Range getELFSyms() const { return ELFSyms; } |
157 | |
158 | protected: |
159 | ArrayRef<Elf_Sym> ELFSyms; |
160 | uint32_t FirstGlobal = 0; |
161 | ArrayRef<Elf_Word> SymtabSHNDX; |
162 | StringRef StringTable; |
163 | void initSymtab(ArrayRef<Elf_Shdr> Sections, const Elf_Shdr *Symtab); |
164 | }; |
165 | |
166 | // .o file. |
167 | template <class ELFT> class ObjFile : public ELFFileBase<ELFT> { |
168 | typedef ELFFileBase<ELFT> Base; |
169 | typedef typename ELFT::Rel Elf_Rel; |
170 | typedef typename ELFT::Rela Elf_Rela; |
171 | typedef typename ELFT::Sym Elf_Sym; |
172 | typedef typename ELFT::Shdr Elf_Shdr; |
173 | typedef typename ELFT::Word Elf_Word; |
174 | typedef typename ELFT::CGProfile Elf_CGProfile; |
175 | |
176 | StringRef getShtGroupSignature(ArrayRef<Elf_Shdr> Sections, |
177 | const Elf_Shdr &Sec); |
178 | ArrayRef<Elf_Word> getShtGroupEntries(const Elf_Shdr &Sec); |
179 | |
180 | public: |
181 | static bool classof(const InputFile *F) { return F->kind() == Base::ObjKind; } |
182 | |
183 | ArrayRef<Symbol *> getLocalSymbols(); |
184 | ArrayRef<Symbol *> getGlobalSymbols(); |
185 | |
186 | ObjFile(MemoryBufferRef M, StringRef ArchiveName); |
187 | void parse(llvm::DenseSet<llvm::CachedHashStringRef> &ComdatGroups); |
188 | |
189 | Symbol &getSymbol(uint32_t SymbolIndex) const { |
190 | if (SymbolIndex >= this->Symbols.size()) |
191 | fatal(toString(this) + ": invalid symbol index"); |
192 | return *this->Symbols[SymbolIndex]; |
193 | } |
194 | |
195 | template <typename RelT> Symbol &getRelocTargetSym(const RelT &Rel) const { |
196 | uint32_t SymIndex = Rel.getSymbol(Config->IsMips64EL); |
197 | return getSymbol(SymIndex); |
198 | } |
199 | |
200 | llvm::Optional<llvm::DILineInfo> getDILineInfo(InputSectionBase *, uint64_t); |
201 | llvm::Optional<std::pair<std::string, unsigned>> getVariableLoc(StringRef Name); |
202 | |
203 | // MIPS GP0 value defined by this file. This value represents the gp value |
204 | // used to create the relocatable object and required to support |
205 | // R_MIPS_GPREL16 / R_MIPS_GPREL32 relocations. |
206 | uint32_t MipsGp0 = 0; |
207 | |
208 | // Name of source file obtained from STT_FILE symbol value, |
209 | // or empty string if there is no such symbol in object file |
210 | // symbol table. |
211 | StringRef SourceFile; |
212 | |
213 | // True if the file defines functions compiled with |
214 | // -fsplit-stack. Usually false. |
215 | bool SplitStack = false; |
216 | |
217 | // True if the file defines functions compiled with -fsplit-stack, |
218 | // but had one or more functions with the no_split_stack attribute. |
219 | bool SomeNoSplitStack = false; |
220 | |
221 | // Pointer to this input file's .llvm_addrsig section, if it has one. |
222 | const Elf_Shdr *AddrsigSec = nullptr; |
223 | |
224 | // SHT_LLVM_CALL_GRAPH_PROFILE table |
225 | ArrayRef<Elf_CGProfile> CGProfile; |
226 | |
227 | private: |
228 | void |
229 | initializeSections(llvm::DenseSet<llvm::CachedHashStringRef> &ComdatGroups); |
230 | void initializeSymbols(); |
231 | void initializeJustSymbols(); |
232 | void initializeDwarf(); |
233 | InputSectionBase *getRelocTarget(const Elf_Shdr &Sec); |
234 | InputSectionBase *createInputSection(const Elf_Shdr &Sec); |
235 | StringRef getSectionName(const Elf_Shdr &Sec); |
236 | |
237 | bool shouldMerge(const Elf_Shdr &Sec); |
238 | Symbol *createSymbol(const Elf_Sym *Sym); |
239 | |
240 | // .shstrtab contents. |
241 | StringRef SectionStringTable; |
242 | |
243 | // Debugging information to retrieve source file and line for error |
244 | // reporting. Linker may find reasonable number of errors in a |
245 | // single object file, so we cache debugging information in order to |
246 | // parse it only once for each object file we link. |
247 | std::unique_ptr<llvm::DWARFContext> Dwarf; |
248 | std::vector<const llvm::DWARFDebugLine::LineTable *> LineTables; |
249 | struct VarLoc { |
250 | const llvm::DWARFDebugLine::LineTable *LT; |
251 | unsigned File; |
252 | unsigned Line; |
253 | }; |
254 | llvm::DenseMap<StringRef, VarLoc> VariableLoc; |
255 | llvm::once_flag InitDwarfLine; |
256 | }; |
257 | |
258 | // LazyObjFile is analogous to ArchiveFile in the sense that |
259 | // the file contains lazy symbols. The difference is that |
260 | // LazyObjFile wraps a single file instead of multiple files. |
261 | // |
262 | // This class is used for --start-lib and --end-lib options which |
263 | // instruct the linker to link object files between them with the |
264 | // archive file semantics. |
265 | class LazyObjFile : public InputFile { |
266 | public: |
267 | LazyObjFile(MemoryBufferRef M, StringRef ArchiveName, |
268 | uint64_t OffsetInArchive) |
269 | : InputFile(LazyObjKind, M), OffsetInArchive(OffsetInArchive) { |
270 | this->ArchiveName = ArchiveName; |
271 | } |
272 | |
273 | static bool classof(const InputFile *F) { return F->kind() == LazyObjKind; } |
274 | |
275 | template <class ELFT> void parse(); |
276 | MemoryBufferRef getBuffer(); |
277 | InputFile *fetch(); |
278 | bool AddedToLink = false; |
279 | |
280 | private: |
281 | uint64_t OffsetInArchive; |
282 | }; |
283 | |
284 | // An ArchiveFile object represents a .a file. |
285 | class ArchiveFile : public InputFile { |
286 | public: |
287 | explicit ArchiveFile(std::unique_ptr<Archive> &&File); |
288 | static bool classof(const InputFile *F) { return F->kind() == ArchiveKind; } |
289 | template <class ELFT> void parse(); |
290 | |
291 | // Pulls out an object file that contains a definition for Sym and |
292 | // returns it. If the same file was instantiated before, this |
293 | // function returns a nullptr (so we don't instantiate the same file |
294 | // more than once.) |
295 | InputFile *fetch(const Archive::Symbol &Sym); |
296 | |
297 | private: |
298 | std::unique_ptr<Archive> File; |
299 | llvm::DenseSet<uint64_t> Seen; |
300 | }; |
301 | |
302 | class BitcodeFile : public InputFile { |
303 | public: |
304 | BitcodeFile(MemoryBufferRef M, StringRef ArchiveName, |
305 | uint64_t OffsetInArchive); |
306 | static bool classof(const InputFile *F) { return F->kind() == BitcodeKind; } |
307 | template <class ELFT> |
308 | void parse(llvm::DenseSet<llvm::CachedHashStringRef> &ComdatGroups); |
309 | std::unique_ptr<llvm::lto::InputFile> Obj; |
310 | }; |
311 | |
312 | // .so file. |
313 | template <class ELFT> class SharedFile : public ELFFileBase<ELFT> { |
314 | typedef ELFFileBase<ELFT> Base; |
315 | typedef typename ELFT::Dyn Elf_Dyn; |
316 | typedef typename ELFT::Shdr Elf_Shdr; |
317 | typedef typename ELFT::Sym Elf_Sym; |
318 | typedef typename ELFT::SymRange Elf_Sym_Range; |
319 | typedef typename ELFT::Verdef Elf_Verdef; |
320 | typedef typename ELFT::Versym Elf_Versym; |
321 | |
322 | const Elf_Shdr *VersymSec = nullptr; |
323 | const Elf_Shdr *VerdefSec = nullptr; |
324 | |
325 | public: |
326 | std::vector<const Elf_Verdef *> Verdefs; |
327 | std::string SoName; |
328 | |
329 | static bool classof(const InputFile *F) { |
330 | return F->kind() == Base::SharedKind; |
331 | } |
332 | |
333 | SharedFile(MemoryBufferRef M, StringRef DefaultSoName); |
334 | |
335 | void parseSoName(); |
336 | void parseRest(); |
337 | uint32_t getAlignment(ArrayRef<Elf_Shdr> Sections, const Elf_Sym &Sym); |
338 | std::vector<const Elf_Verdef *> parseVerdefs(); |
339 | std::vector<uint32_t> parseVersyms(); |
340 | |
341 | struct NeededVer { |
342 | // The string table offset of the version name in the output file. |
343 | size_t StrTab; |
344 | |
345 | // The version identifier for this version name. |
346 | uint16_t Index; |
347 | }; |
348 | |
349 | // Mapping from Elf_Verdef data structures to information about Elf_Vernaux |
350 | // data structures in the output file. |
351 | std::map<const Elf_Verdef *, NeededVer> VerdefMap; |
352 | |
353 | // Used for --as-needed |
354 | bool IsNeeded; |
355 | }; |
356 | |
357 | class BinaryFile : public InputFile { |
358 | public: |
359 | explicit BinaryFile(MemoryBufferRef M) : InputFile(BinaryKind, M) {} |
360 | static bool classof(const InputFile *F) { return F->kind() == BinaryKind; } |
361 | void parse(); |
362 | }; |
363 | |
364 | InputFile *createObjectFile(MemoryBufferRef MB, StringRef ArchiveName = "", |
365 | uint64_t OffsetInArchive = 0); |
366 | InputFile *createSharedFile(MemoryBufferRef MB, StringRef DefaultSoName); |
367 | |
368 | inline bool isBitcode(MemoryBufferRef MB) { |
369 | return identify_magic(MB.getBuffer()) == llvm::file_magic::bitcode; |
370 | } |
371 | |
372 | std::string replaceThinLTOSuffix(StringRef Path); |
373 | |
374 | extern std::vector<BinaryFile *> BinaryFiles; |
375 | extern std::vector<BitcodeFile *> BitcodeFiles; |
376 | extern std::vector<LazyObjFile *> LazyObjFiles; |
377 | extern std::vector<InputFile *> ObjectFiles; |
378 | extern std::vector<InputFile *> SharedFiles; |
379 | |
380 | } // namespace elf |
381 | } // namespace lld |
382 | |
383 | #endif |
1 | //===- ELF.h - ELF object file implementation -------------------*- C++ -*-===// |
2 | // |
3 | // The LLVM Compiler Infrastructure |
4 | // |
5 | // This file is distributed under the University of Illinois Open Source |
6 | // License. See LICENSE.TXT for details. |
7 | // |
8 | //===----------------------------------------------------------------------===// |
9 | // |
10 | // This file declares the ELFFile template class. |
11 | // |
12 | //===----------------------------------------------------------------------===// |
13 | |
14 | #ifndef LLVM_OBJECT_ELF_H |
15 | #define LLVM_OBJECT_ELF_H |
16 | |
17 | #include "llvm/ADT/ArrayRef.h" |
18 | #include "llvm/ADT/SmallVector.h" |
19 | #include "llvm/ADT/StringRef.h" |
20 | #include "llvm/BinaryFormat/ELF.h" |
21 | #include "llvm/Object/ELFTypes.h" |
22 | #include "llvm/Object/Error.h" |
23 | #include "llvm/Support/Endian.h" |
24 | #include "llvm/Support/Error.h" |
25 | #include <cassert> |
26 | #include <cstddef> |
27 | #include <cstdint> |
28 | #include <limits> |
29 | #include <utility> |
30 | |
31 | namespace llvm { |
32 | namespace object { |
33 | |
34 | StringRef getELFRelocationTypeName(uint32_t Machine, uint32_t Type); |
35 | uint32_t getELFRelrRelocationType(uint32_t Machine); |
36 | StringRef getELFSectionTypeName(uint32_t Machine, uint32_t Type); |
37 | |
38 | // Subclasses of ELFFile may need this for template instantiation |
39 | inline std::pair<unsigned char, unsigned char> |
40 | getElfArchType(StringRef Object) { |
41 | if (Object.size() < ELF::EI_NIDENT) |
42 | return std::make_pair((uint8_t)ELF::ELFCLASSNONE, |
43 | (uint8_t)ELF::ELFDATANONE); |
44 | return std::make_pair((uint8_t)Object[ELF::EI_CLASS], |
45 | (uint8_t)Object[ELF::EI_DATA]); |
46 | } |
47 | |
48 | static inline Error createError(StringRef Err) { |
49 | return make_error<StringError>(Err, object_error::parse_failed); |
50 | } |
51 | |
52 | template <class ELFT> |
53 | class ELFFile { |
54 | public: |
55 | LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)using Elf_Addr = typename ELFT::Addr; using Elf_Off = typename ELFT::Off; using Elf_Half = typename ELFT::Half; using Elf_Word = typename ELFT::Word; using Elf_Sword = typename ELFT::Sword ; using Elf_Xword = typename ELFT::Xword; using Elf_Sxword = typename ELFT::Sxword; |
56 | using uintX_t = typename ELFT::uint; |
57 | using Elf_Ehdr = typename ELFT::Ehdr; |
58 | using Elf_Shdr = typename ELFT::Shdr; |
59 | using Elf_Sym = typename ELFT::Sym; |
60 | using Elf_Dyn = typename ELFT::Dyn; |
61 | using Elf_Phdr = typename ELFT::Phdr; |
62 | using Elf_Rel = typename ELFT::Rel; |
63 | using Elf_Rela = typename ELFT::Rela; |
64 | using Elf_Relr = typename ELFT::Relr; |
65 | using Elf_Verdef = typename ELFT::Verdef; |
66 | using Elf_Verdaux = typename ELFT::Verdaux; |
67 | using Elf_Verneed = typename ELFT::Verneed; |
68 | using Elf_Vernaux = typename ELFT::Vernaux; |
69 | using Elf_Versym = typename ELFT::Versym; |
70 | using Elf_Hash = typename ELFT::Hash; |
71 | using Elf_GnuHash = typename ELFT::GnuHash; |
72 | using Elf_Nhdr = typename ELFT::Nhdr; |
73 | using Elf_Note = typename ELFT::Note; |
74 | using Elf_Note_Iterator = typename ELFT::NoteIterator; |
75 | using Elf_Dyn_Range = typename ELFT::DynRange; |
76 | using Elf_Shdr_Range = typename ELFT::ShdrRange; |
77 | using Elf_Sym_Range = typename ELFT::SymRange; |
78 | using Elf_Rel_Range = typename ELFT::RelRange; |
79 | using Elf_Rela_Range = typename ELFT::RelaRange; |
80 | using Elf_Relr_Range = typename ELFT::RelrRange; |
81 | using Elf_Phdr_Range = typename ELFT::PhdrRange; |
82 | |
83 | const uint8_t *base() const { |
84 | return reinterpret_cast<const uint8_t *>(Buf.data()); |
85 | } |
86 | |
87 | size_t getBufSize() const { return Buf.size(); } |
88 | |
89 | private: |
90 | StringRef Buf; |
91 | |
92 | ELFFile(StringRef Object); |
93 | |
94 | public: |
95 | const Elf_Ehdr *getHeader() const { |
96 | return reinterpret_cast<const Elf_Ehdr *>(base()); |
97 | } |
98 | |
99 | template <typename T> |
100 | Expected<const T *> getEntry(uint32_t Section, uint32_t Entry) const; |
101 | template <typename T> |
102 | Expected<const T *> getEntry(const Elf_Shdr *Section, uint32_t Entry) const; |
103 | |
104 | Expected<StringRef> getStringTable(const Elf_Shdr *Section) const; |
105 | Expected<StringRef> getStringTableForSymtab(const Elf_Shdr &Section) const; |
106 | Expected<StringRef> getStringTableForSymtab(const Elf_Shdr &Section, |
107 | Elf_Shdr_Range Sections) const; |
108 | |
109 | Expected<ArrayRef<Elf_Word>> getSHNDXTable(const Elf_Shdr &Section) const; |
110 | Expected<ArrayRef<Elf_Word>> getSHNDXTable(const Elf_Shdr &Section, |
111 | Elf_Shdr_Range Sections) const; |
112 | |
113 | StringRef getRelocationTypeName(uint32_t Type) const; |
114 | void getRelocationTypeName(uint32_t Type, |
115 | SmallVectorImpl<char> &Result) const; |
116 | uint32_t getRelrRelocationType() const; |
117 | |
118 | const char *getDynamicTagAsString(unsigned Arch, uint64_t Type) const; |
119 | const char *getDynamicTagAsString(uint64_t Type) const; |
120 | |
121 | /// Get the symbol for a given relocation. |
122 | Expected<const Elf_Sym *> getRelocationSymbol(const Elf_Rel *Rel, |
123 | const Elf_Shdr *SymTab) const; |
124 | |
125 | static Expected<ELFFile> create(StringRef Object); |
126 | |
127 | bool isMipsELF64() const { |
128 | return getHeader()->e_machine == ELF::EM_MIPS && |
129 | getHeader()->getFileClass() == ELF::ELFCLASS64; |
130 | } |
131 | |
132 | bool isMips64EL() const { |
133 | return isMipsELF64() && |
134 | getHeader()->getDataEncoding() == ELF::ELFDATA2LSB; |
135 | } |
136 | |
137 | Expected<Elf_Shdr_Range> sections() const; |
138 | |
139 | Expected<Elf_Dyn_Range> dynamicEntries() const; |
140 | |
141 | Expected<const uint8_t *> toMappedAddr(uint64_t VAddr) const; |
142 | |
143 | Expected<Elf_Sym_Range> symbols(const Elf_Shdr *Sec) const { |
144 | if (!Sec) |
145 | return makeArrayRef<Elf_Sym>(nullptr, nullptr); |
146 | return getSectionContentsAsArray<Elf_Sym>(Sec); |
147 | } |
148 | |
149 | Expected<Elf_Rela_Range> relas(const Elf_Shdr *Sec) const { |
150 | return getSectionContentsAsArray<Elf_Rela>(Sec); |
151 | } |
152 | |
153 | Expected<Elf_Rel_Range> rels(const Elf_Shdr *Sec) const { |
154 | return getSectionContentsAsArray<Elf_Rel>(Sec); |
155 | } |
156 | |
157 | Expected<Elf_Relr_Range> relrs(const Elf_Shdr *Sec) const { |
158 | return getSectionContentsAsArray<Elf_Relr>(Sec); |
159 | } |
160 | |
161 | Expected<std::vector<Elf_Rela>> decode_relrs(Elf_Relr_Range relrs) const; |
162 | |
163 | Expected<std::vector<Elf_Rela>> android_relas(const Elf_Shdr *Sec) const; |
164 | |
165 | /// Iterate over program header table. |
166 | Expected<Elf_Phdr_Range> program_headers() const { |
167 | if (getHeader()->e_phnum && getHeader()->e_phentsize != sizeof(Elf_Phdr)) |
168 | return createError("invalid e_phentsize"); |
169 | if (getHeader()->e_phoff + |
170 | (getHeader()->e_phnum * getHeader()->e_phentsize) > |
171 | getBufSize()) |
172 | return createError("program headers longer than binary"); |
173 | auto *Begin = |
174 | reinterpret_cast<const Elf_Phdr *>(base() + getHeader()->e_phoff); |
175 | return makeArrayRef(Begin, Begin + getHeader()->e_phnum); |
176 | } |
177 | |
178 | /// Get an iterator over notes in a program header. |
179 | /// |
180 | /// The program header must be of type \c PT_NOTE. |
181 | /// |
182 | /// \param Phdr the program header to iterate over. |
183 | /// \param Err [out] an error to support fallible iteration, which should |
184 | /// be checked after iteration ends. |
185 | Elf_Note_Iterator notes_begin(const Elf_Phdr &Phdr, Error &Err) const { |
186 | if (Phdr.p_type != ELF::PT_NOTE) { |
187 | Err = createError("attempt to iterate notes of non-note program header"); |
188 | return Elf_Note_Iterator(Err); |
189 | } |
190 | if (Phdr.p_offset + Phdr.p_filesz > getBufSize()) { |
191 | Err = createError("invalid program header offset/size"); |
192 | return Elf_Note_Iterator(Err); |
193 | } |
194 | return Elf_Note_Iterator(base() + Phdr.p_offset, Phdr.p_filesz, Err); |
195 | } |
196 | |
197 | /// Get an iterator over notes in a section. |
198 | /// |
199 | /// The section must be of type \c SHT_NOTE. |
200 | /// |
201 | /// \param Shdr the section to iterate over. |
202 | /// \param Err [out] an error to support fallible iteration, which should |
203 | /// be checked after iteration ends. |
204 | Elf_Note_Iterator notes_begin(const Elf_Shdr &Shdr, Error &Err) const { |
205 | if (Shdr.sh_type != ELF::SHT_NOTE) { |
206 | Err = createError("attempt to iterate notes of non-note section"); |
207 | return Elf_Note_Iterator(Err); |
208 | } |
209 | if (Shdr.sh_offset + Shdr.sh_size > getBufSize()) { |
210 | Err = createError("invalid section offset/size"); |
211 | return Elf_Note_Iterator(Err); |
212 | } |
213 | return Elf_Note_Iterator(base() + Shdr.sh_offset, Shdr.sh_size, Err); |
214 | } |
215 | |
216 | /// Get the end iterator for notes. |
217 | Elf_Note_Iterator notes_end() const { |
218 | return Elf_Note_Iterator(); |
219 | } |
220 | |
221 | /// Get an iterator range over notes of a program header. |
222 | /// |
223 | /// The program header must be of type \c PT_NOTE. |
224 | /// |
225 | /// \param Phdr the program header to iterate over. |
226 | /// \param Err [out] an error to support fallible iteration, which should |
227 | /// be checked after iteration ends. |
228 | iterator_range<Elf_Note_Iterator> notes(const Elf_Phdr &Phdr, |
229 | Error &Err) const { |
230 | return make_range(notes_begin(Phdr, Err), notes_end()); |
231 | } |
232 | |
233 | /// Get an iterator range over notes of a section. |
234 | /// |
235 | /// The section must be of type \c SHT_NOTE. |
236 | /// |
237 | /// \param Shdr the section to iterate over. |
238 | /// \param Err [out] an error to support fallible iteration, which should |
239 | /// be checked after iteration ends. |
240 | iterator_range<Elf_Note_Iterator> notes(const Elf_Shdr &Shdr, |
241 | Error &Err) const { |
242 | return make_range(notes_begin(Shdr, Err), notes_end()); |
243 | } |
244 | |
245 | Expected<StringRef> getSectionStringTable(Elf_Shdr_Range Sections) const; |
246 | Expected<uint32_t> getSectionIndex(const Elf_Sym *Sym, Elf_Sym_Range Syms, |
247 | ArrayRef<Elf_Word> ShndxTable) const; |
248 | Expected<const Elf_Shdr *> getSection(const Elf_Sym *Sym, |
249 | const Elf_Shdr *SymTab, |
250 | ArrayRef<Elf_Word> ShndxTable) const; |
251 | Expected<const Elf_Shdr *> getSection(const Elf_Sym *Sym, |
252 | Elf_Sym_Range Symtab, |
253 | ArrayRef<Elf_Word> ShndxTable) const; |
254 | Expected<const Elf_Shdr *> getSection(uint32_t Index) const; |
255 | Expected<const Elf_Shdr *> getSection(const StringRef SectionName) const; |
256 | |
257 | Expected<const Elf_Sym *> getSymbol(const Elf_Shdr *Sec, |
258 | uint32_t Index) const; |
259 | |
260 | Expected<StringRef> getSectionName(const Elf_Shdr *Section) const; |
261 | Expected<StringRef> getSectionName(const Elf_Shdr *Section, |
262 | StringRef DotShstrtab) const; |
263 | template <typename T> |
264 | Expected<ArrayRef<T>> getSectionContentsAsArray(const Elf_Shdr *Sec) const; |
265 | Expected<ArrayRef<uint8_t>> getSectionContents(const Elf_Shdr *Sec) const; |
266 | }; |
267 | |
268 | using ELF32LEFile = ELFFile<ELF32LE>; |
269 | using ELF64LEFile = ELFFile<ELF64LE>; |
270 | using ELF32BEFile = ELFFile<ELF32BE>; |
271 | using ELF64BEFile = ELFFile<ELF64BE>; |
272 | |
273 | template <class ELFT> |
274 | inline Expected<const typename ELFT::Shdr *> |
275 | getSection(typename ELFT::ShdrRange Sections, uint32_t Index) { |
276 | if (Index >= Sections.size()) |
277 | return createError("invalid section index"); |
278 | return &Sections[Index]; |
279 | } |
280 | |
281 | template <class ELFT> |
282 | inline Expected<uint32_t> |
283 | getExtendedSymbolTableIndex(const typename ELFT::Sym *Sym, |
284 | const typename ELFT::Sym *FirstSym, |
285 | ArrayRef<typename ELFT::Word> ShndxTable) { |
286 | assert(Sym->st_shndx == ELF::SHN_XINDEX)((Sym->st_shndx == ELF::SHN_XINDEX) ? static_cast<void> (0) : __assert_fail ("Sym->st_shndx == ELF::SHN_XINDEX", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELF.h" , 286, __PRETTY_FUNCTION__)); |
287 | unsigned Index = Sym - FirstSym; |
288 | if (Index >= ShndxTable.size()) |
289 | return createError("index past the end of the symbol table"); |
290 | |
291 | // The size of the table was checked in getSHNDXTable. |
292 | return ShndxTable[Index]; |
293 | } |
294 | |
295 | template <class ELFT> |
296 | Expected<uint32_t> |
297 | ELFFile<ELFT>::getSectionIndex(const Elf_Sym *Sym, Elf_Sym_Range Syms, |
298 | ArrayRef<Elf_Word> ShndxTable) const { |
299 | uint32_t Index = Sym->st_shndx; |
300 | if (Index == ELF::SHN_XINDEX) { |
301 | auto ErrorOrIndex = getExtendedSymbolTableIndex<ELFT>( |
302 | Sym, Syms.begin(), ShndxTable); |
303 | if (!ErrorOrIndex) |
304 | return ErrorOrIndex.takeError(); |
305 | return *ErrorOrIndex; |
306 | } |
307 | if (Index == ELF::SHN_UNDEF || Index >= ELF::SHN_LORESERVE) |
308 | return 0; |
309 | return Index; |
310 | } |
311 | |
312 | template <class ELFT> |
313 | Expected<const typename ELFT::Shdr *> |
314 | ELFFile<ELFT>::getSection(const Elf_Sym *Sym, const Elf_Shdr *SymTab, |
315 | ArrayRef<Elf_Word> ShndxTable) const { |
316 | auto SymsOrErr = symbols(SymTab); |
317 | if (!SymsOrErr) |
318 | return SymsOrErr.takeError(); |
319 | return getSection(Sym, *SymsOrErr, ShndxTable); |
320 | } |
321 | |
322 | template <class ELFT> |
323 | Expected<const typename ELFT::Shdr *> |
324 | ELFFile<ELFT>::getSection(const Elf_Sym *Sym, Elf_Sym_Range Symbols, |
325 | ArrayRef<Elf_Word> ShndxTable) const { |
326 | auto IndexOrErr = getSectionIndex(Sym, Symbols, ShndxTable); |
327 | if (!IndexOrErr) |
328 | return IndexOrErr.takeError(); |
329 | uint32_t Index = *IndexOrErr; |
330 | if (Index == 0) |
331 | return nullptr; |
332 | return getSection(Index); |
333 | } |
334 | |
335 | template <class ELFT> |
336 | inline Expected<const typename ELFT::Sym *> |
337 | getSymbol(typename ELFT::SymRange Symbols, uint32_t Index) { |
338 | if (Index >= Symbols.size()) |
339 | return createError("invalid symbol index"); |
340 | return &Symbols[Index]; |
341 | } |
342 | |
343 | template <class ELFT> |
344 | Expected<const typename ELFT::Sym *> |
345 | ELFFile<ELFT>::getSymbol(const Elf_Shdr *Sec, uint32_t Index) const { |
346 | auto SymtabOrErr = symbols(Sec); |
347 | if (!SymtabOrErr) |
348 | return SymtabOrErr.takeError(); |
349 | return object::getSymbol<ELFT>(*SymtabOrErr, Index); |
350 | } |
351 | |
352 | template <class ELFT> |
353 | template <typename T> |
354 | Expected<ArrayRef<T>> |
355 | ELFFile<ELFT>::getSectionContentsAsArray(const Elf_Shdr *Sec) const { |
356 | if (Sec->sh_entsize != sizeof(T) && sizeof(T) != 1) |
357 | return createError("invalid sh_entsize"); |
358 | |
359 | uintX_t Offset = Sec->sh_offset; |
360 | uintX_t Size = Sec->sh_size; |
361 | |
362 | if (Size % sizeof(T)) |
363 | return createError("size is not a multiple of sh_entsize"); |
364 | if ((std::numeric_limits<uintX_t>::max() - Offset < Size) || |
365 | Offset + Size > Buf.size()) |
366 | return createError("invalid section offset"); |
367 | |
368 | if (Offset % alignof(T)) |
369 | return createError("unaligned data"); |
370 | |
371 | const T *Start = reinterpret_cast<const T *>(base() + Offset); |
372 | return makeArrayRef(Start, Size / sizeof(T)); |
373 | } |
374 | |
375 | template <class ELFT> |
376 | Expected<ArrayRef<uint8_t>> |
377 | ELFFile<ELFT>::getSectionContents(const Elf_Shdr *Sec) const { |
378 | return getSectionContentsAsArray<uint8_t>(Sec); |
379 | } |
380 | |
381 | template <class ELFT> |
382 | StringRef ELFFile<ELFT>::getRelocationTypeName(uint32_t Type) const { |
383 | return getELFRelocationTypeName(getHeader()->e_machine, Type); |
384 | } |
385 | |
386 | template <class ELFT> |
387 | void ELFFile<ELFT>::getRelocationTypeName(uint32_t Type, |
388 | SmallVectorImpl<char> &Result) const { |
389 | if (!isMipsELF64()) { |
390 | StringRef Name = getRelocationTypeName(Type); |
391 | Result.append(Name.begin(), Name.end()); |
392 | } else { |
393 | // The Mips N64 ABI allows up to three operations to be specified per |
394 | // relocation record. Unfortunately there's no easy way to test for the |
395 | // presence of N64 ELFs as they have no special flag that identifies them |
396 | // as being N64. We can safely assume at the moment that all Mips |
397 | // ELFCLASS64 ELFs are N64. New Mips64 ABIs should provide enough |
398 | // information to disambiguate between old vs new ABIs. |
399 | uint8_t Type1 = (Type >> 0) & 0xFF; |
400 | uint8_t Type2 = (Type >> 8) & 0xFF; |
401 | uint8_t Type3 = (Type >> 16) & 0xFF; |
402 | |
403 | // Concat all three relocation type names. |
404 | StringRef Name = getRelocationTypeName(Type1); |
405 | Result.append(Name.begin(), Name.end()); |
406 | |
407 | Name = getRelocationTypeName(Type2); |
408 | Result.append(1, '/'); |
409 | Result.append(Name.begin(), Name.end()); |
410 | |
411 | Name = getRelocationTypeName(Type3); |
412 | Result.append(1, '/'); |
413 | Result.append(Name.begin(), Name.end()); |
414 | } |
415 | } |
416 | |
417 | template <class ELFT> |
418 | uint32_t ELFFile<ELFT>::getRelrRelocationType() const { |
419 | return getELFRelrRelocationType(getHeader()->e_machine); |
420 | } |
421 | |
422 | template <class ELFT> |
423 | Expected<const typename ELFT::Sym *> |
424 | ELFFile<ELFT>::getRelocationSymbol(const Elf_Rel *Rel, |
425 | const Elf_Shdr *SymTab) const { |
426 | uint32_t Index = Rel->getSymbol(isMips64EL()); |
427 | if (Index == 0) |
428 | return nullptr; |
429 | return getEntry<Elf_Sym>(SymTab, Index); |
430 | } |
431 | |
432 | template <class ELFT> |
433 | Expected<StringRef> |
434 | ELFFile<ELFT>::getSectionStringTable(Elf_Shdr_Range Sections) const { |
435 | uint32_t Index = getHeader()->e_shstrndx; |
436 | if (Index == ELF::SHN_XINDEX) |
437 | Index = Sections[0].sh_link; |
438 | |
439 | if (!Index) // no section string table. |
440 | return ""; |
441 | if (Index >= Sections.size()) |
442 | return createError("invalid section index"); |
443 | return getStringTable(&Sections[Index]); |
444 | } |
445 | |
446 | template <class ELFT> ELFFile<ELFT>::ELFFile(StringRef Object) : Buf(Object) {} |
447 | |
448 | template <class ELFT> |
449 | Expected<ELFFile<ELFT>> ELFFile<ELFT>::create(StringRef Object) { |
450 | if (sizeof(Elf_Ehdr) > Object.size()) |
451 | return createError("Invalid buffer"); |
452 | return ELFFile(Object); |
453 | } |
454 | |
455 | template <class ELFT> |
456 | Expected<typename ELFT::ShdrRange> ELFFile<ELFT>::sections() const { |
457 | const uintX_t SectionTableOffset = getHeader()->e_shoff; |
458 | if (SectionTableOffset == 0) |
459 | return ArrayRef<Elf_Shdr>(); |
460 | |
461 | if (getHeader()->e_shentsize != sizeof(Elf_Shdr)) |
462 | return createError( |
463 | "invalid section header entry size (e_shentsize) in ELF header"); |
464 | |
465 | const uint64_t FileSize = Buf.size(); |
466 | |
467 | if (SectionTableOffset + sizeof(Elf_Shdr) > FileSize) |
468 | return createError("section header table goes past the end of the file"); |
469 | |
470 | // Invalid address alignment of section headers |
471 | if (SectionTableOffset & (alignof(Elf_Shdr) - 1)) |
472 | return createError("invalid alignment of section headers"); |
473 | |
474 | const Elf_Shdr *First = |
475 | reinterpret_cast<const Elf_Shdr *>(base() + SectionTableOffset); |
476 | |
477 | uintX_t NumSections = getHeader()->e_shnum; |
478 | if (NumSections == 0) |
479 | NumSections = First->sh_size; |
480 | |
481 | if (NumSections > UINT64_MAX(18446744073709551615UL) / sizeof(Elf_Shdr)) |
482 | return createError("section table goes past the end of file"); |
483 | |
484 | const uint64_t SectionTableSize = NumSections * sizeof(Elf_Shdr); |
485 | |
486 | // Section table goes past end of file! |
487 | if (SectionTableOffset + SectionTableSize > FileSize) |
488 | return createError("section table goes past the end of file"); |
489 | |
490 | return makeArrayRef(First, NumSections); |
491 | } |
492 | |
493 | template <class ELFT> |
494 | template <typename T> |
495 | Expected<const T *> ELFFile<ELFT>::getEntry(uint32_t Section, |
496 | uint32_t Entry) const { |
497 | auto SecOrErr = getSection(Section); |
498 | if (!SecOrErr) |
499 | return SecOrErr.takeError(); |
500 | return getEntry<T>(*SecOrErr, Entry); |
501 | } |
502 | |
503 | template <class ELFT> |
504 | template <typename T> |
505 | Expected<const T *> ELFFile<ELFT>::getEntry(const Elf_Shdr *Section, |
506 | uint32_t Entry) const { |
507 | if (sizeof(T) != Section->sh_entsize) |
508 | return createError("invalid sh_entsize"); |
509 | size_t Pos = Section->sh_offset + Entry * sizeof(T); |
510 | if (Pos + sizeof(T) > Buf.size()) |
511 | return createError("invalid section offset"); |
512 | return reinterpret_cast<const T *>(base() + Pos); |
513 | } |
514 | |
515 | template <class ELFT> |
516 | Expected<const typename ELFT::Shdr *> |
517 | ELFFile<ELFT>::getSection(uint32_t Index) const { |
518 | auto TableOrErr = sections(); |
519 | if (!TableOrErr) |
520 | return TableOrErr.takeError(); |
521 | return object::getSection<ELFT>(*TableOrErr, Index); |
522 | } |
523 | |
524 | template <class ELFT> |
525 | Expected<const typename ELFT::Shdr *> |
526 | ELFFile<ELFT>::getSection(const StringRef SectionName) const { |
527 | auto TableOrErr = sections(); |
528 | if (!TableOrErr) |
529 | return TableOrErr.takeError(); |
530 | for (auto &Sec : *TableOrErr) { |
531 | auto SecNameOrErr = getSectionName(&Sec); |
532 | if (!SecNameOrErr) |
533 | return SecNameOrErr.takeError(); |
534 | if (*SecNameOrErr == SectionName) |
535 | return &Sec; |
536 | } |
537 | return createError("invalid section name"); |
538 | } |
539 | |
540 | template <class ELFT> |
541 | Expected<StringRef> |
542 | ELFFile<ELFT>::getStringTable(const Elf_Shdr *Section) const { |
543 | if (Section->sh_type != ELF::SHT_STRTAB) |
544 | return createError("invalid sh_type for string table, expected SHT_STRTAB"); |
545 | auto V = getSectionContentsAsArray<char>(Section); |
546 | if (!V) |
547 | return V.takeError(); |
548 | ArrayRef<char> Data = *V; |
549 | if (Data.empty()) |
550 | return createError("empty string table"); |
551 | if (Data.back() != '\0') |
552 | return createError("string table non-null terminated"); |
553 | return StringRef(Data.begin(), Data.size()); |
554 | } |
555 | |
556 | template <class ELFT> |
557 | Expected<ArrayRef<typename ELFT::Word>> |
558 | ELFFile<ELFT>::getSHNDXTable(const Elf_Shdr &Section) const { |
559 | auto SectionsOrErr = sections(); |
560 | if (!SectionsOrErr) |
561 | return SectionsOrErr.takeError(); |
562 | return getSHNDXTable(Section, *SectionsOrErr); |
563 | } |
564 | |
565 | template <class ELFT> |
566 | Expected<ArrayRef<typename ELFT::Word>> |
567 | ELFFile<ELFT>::getSHNDXTable(const Elf_Shdr &Section, |
568 | Elf_Shdr_Range Sections) const { |
569 | assert(Section.sh_type == ELF::SHT_SYMTAB_SHNDX)((Section.sh_type == ELF::SHT_SYMTAB_SHNDX) ? static_cast< void> (0) : __assert_fail ("Section.sh_type == ELF::SHT_SYMTAB_SHNDX" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Object/ELF.h" , 569, __PRETTY_FUNCTION__)); |
570 | auto VOrErr = getSectionContentsAsArray<Elf_Word>(&Section); |
571 | if (!VOrErr) |
572 | return VOrErr.takeError(); |
573 | ArrayRef<Elf_Word> V = *VOrErr; |
574 | auto SymTableOrErr = object::getSection<ELFT>(Sections, Section.sh_link); |
575 | if (!SymTableOrErr) |
576 | return SymTableOrErr.takeError(); |
577 | const Elf_Shdr &SymTable = **SymTableOrErr; |
578 | if (SymTable.sh_type != ELF::SHT_SYMTAB && |
579 | SymTable.sh_type != ELF::SHT_DYNSYM) |
580 | return createError("invalid sh_type"); |
581 | if (V.size() != (SymTable.sh_size / sizeof(Elf_Sym))) |
582 | return createError("invalid section contents size"); |
583 | return V; |
584 | } |
585 | |
586 | template <class ELFT> |
587 | Expected<StringRef> |
588 | ELFFile<ELFT>::getStringTableForSymtab(const Elf_Shdr &Sec) const { |
589 | auto SectionsOrErr = sections(); |
590 | if (!SectionsOrErr) |
591 | return SectionsOrErr.takeError(); |
592 | return getStringTableForSymtab(Sec, *SectionsOrErr); |
593 | } |
594 | |
595 | template <class ELFT> |
596 | Expected<StringRef> |
597 | ELFFile<ELFT>::getStringTableForSymtab(const Elf_Shdr &Sec, |
598 | Elf_Shdr_Range Sections) const { |
599 | |
600 | if (Sec.sh_type != ELF::SHT_SYMTAB && Sec.sh_type != ELF::SHT_DYNSYM) |
601 | return createError( |
602 | "invalid sh_type for symbol table, expected SHT_SYMTAB or SHT_DYNSYM"); |
603 | auto SectionOrErr = object::getSection<ELFT>(Sections, Sec.sh_link); |
604 | if (!SectionOrErr) |
605 | return SectionOrErr.takeError(); |
606 | return getStringTable(*SectionOrErr); |
607 | } |
608 | |
609 | template <class ELFT> |
610 | Expected<StringRef> |
611 | ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section) const { |
612 | auto SectionsOrErr = sections(); |
613 | if (!SectionsOrErr) |
614 | return SectionsOrErr.takeError(); |
615 | auto Table = getSectionStringTable(*SectionsOrErr); |
616 | if (!Table) |
617 | return Table.takeError(); |
618 | return getSectionName(Section, *Table); |
619 | } |
620 | |
621 | template <class ELFT> |
622 | Expected<StringRef> ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section, |
623 | StringRef DotShstrtab) const { |
624 | uint32_t Offset = Section->sh_name; |
625 | if (Offset == 0) |
626 | return StringRef(); |
627 | if (Offset >= DotShstrtab.size()) |
628 | return createError("invalid string offset"); |
629 | return StringRef(DotShstrtab.data() + Offset); |
630 | } |
631 | |
632 | /// This function returns the hash value for a symbol in the .dynsym section |
633 | /// Name of the API remains consistent as specified in the libelf |
634 | /// REF : http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#hash |
635 | inline unsigned hashSysV(StringRef SymbolName) { |
636 | unsigned h = 0, g; |
637 | for (char C : SymbolName) { |
638 | h = (h << 4) + C; |
639 | g = h & 0xf0000000L; |
640 | if (g != 0) |
641 | h ^= g >> 24; |
642 | h &= ~g; |
643 | } |
644 | return h; |
645 | } |
646 | |
647 | } // end namespace object |
648 | } // end namespace llvm |
649 | |
650 | #endif // LLVM_OBJECT_ELF_H |
1 | //===- llvm/Support/Error.h - Recoverable error handling --------*- C++ -*-===// | |||
2 | // | |||
3 | // The LLVM Compiler Infrastructure | |||
4 | // | |||
5 | // This file is distributed under the University of Illinois Open Source | |||
6 | // License. See LICENSE.TXT for details. | |||
7 | // | |||
8 | //===----------------------------------------------------------------------===// | |||
9 | // | |||
10 | // This file defines an API used to report recoverable errors. | |||
11 | // | |||
12 | //===----------------------------------------------------------------------===// | |||
13 | ||||
14 | #ifndef LLVM_SUPPORT_ERROR_H | |||
15 | #define LLVM_SUPPORT_ERROR_H | |||
16 | ||||
17 | #include "llvm-c/Error.h" | |||
18 | #include "llvm/ADT/STLExtras.h" | |||
19 | #include "llvm/ADT/SmallVector.h" | |||
20 | #include "llvm/ADT/StringExtras.h" | |||
21 | #include "llvm/ADT/Twine.h" | |||
22 | #include "llvm/Config/abi-breaking.h" | |||
23 | #include "llvm/Support/AlignOf.h" | |||
24 | #include "llvm/Support/Compiler.h" | |||
25 | #include "llvm/Support/Debug.h" | |||
26 | #include "llvm/Support/ErrorHandling.h" | |||
27 | #include "llvm/Support/ErrorOr.h" | |||
28 | #include "llvm/Support/Format.h" | |||
29 | #include "llvm/Support/raw_ostream.h" | |||
30 | #include <algorithm> | |||
31 | #include <cassert> | |||
32 | #include <cstdint> | |||
33 | #include <cstdlib> | |||
34 | #include <functional> | |||
35 | #include <memory> | |||
36 | #include <new> | |||
37 | #include <string> | |||
38 | #include <system_error> | |||
39 | #include <type_traits> | |||
40 | #include <utility> | |||
41 | #include <vector> | |||
42 | ||||
43 | namespace llvm { | |||
44 | ||||
45 | class ErrorSuccess; | |||
46 | ||||
47 | /// Base class for error info classes. Do not extend this directly: Extend | |||
48 | /// the ErrorInfo template subclass instead. | |||
49 | class ErrorInfoBase { | |||
50 | public: | |||
51 | virtual ~ErrorInfoBase() = default; | |||
52 | ||||
53 | /// Print an error message to an output stream. | |||
54 | virtual void log(raw_ostream &OS) const = 0; | |||
55 | ||||
56 | /// Return the error message as a string. | |||
57 | virtual std::string message() const { | |||
58 | std::string Msg; | |||
59 | raw_string_ostream OS(Msg); | |||
60 | log(OS); | |||
61 | return OS.str(); | |||
62 | } | |||
63 | ||||
64 | /// Convert this error to a std::error_code. | |||
65 | /// | |||
66 | /// This is a temporary crutch to enable interaction with code still | |||
67 | /// using std::error_code. It will be removed in the future. | |||
68 | virtual std::error_code convertToErrorCode() const = 0; | |||
69 | ||||
70 | // Returns the class ID for this type. | |||
71 | static const void *classID() { return &ID; } | |||
72 | ||||
73 | // Returns the class ID for the dynamic type of this ErrorInfoBase instance. | |||
74 | virtual const void *dynamicClassID() const = 0; | |||
75 | ||||
76 | // Check whether this instance is a subclass of the class identified by | |||
77 | // ClassID. | |||
78 | virtual bool isA(const void *const ClassID) const { | |||
79 | return ClassID == classID(); | |||
80 | } | |||
81 | ||||
82 | // Check whether this instance is a subclass of ErrorInfoT. | |||
83 | template <typename ErrorInfoT> bool isA() const { | |||
84 | return isA(ErrorInfoT::classID()); | |||
85 | } | |||
86 | ||||
87 | private: | |||
88 | virtual void anchor(); | |||
89 | ||||
90 | static char ID; | |||
91 | }; | |||
92 | ||||
93 | /// Lightweight error class with error context and mandatory checking. | |||
94 | /// | |||
95 | /// Instances of this class wrap a ErrorInfoBase pointer. Failure states | |||
96 | /// are represented by setting the pointer to a ErrorInfoBase subclass | |||
97 | /// instance containing information describing the failure. Success is | |||
98 | /// represented by a null pointer value. | |||
99 | /// | |||
100 | /// Instances of Error also contains a 'Checked' flag, which must be set | |||
101 | /// before the destructor is called, otherwise the destructor will trigger a | |||
102 | /// runtime error. This enforces at runtime the requirement that all Error | |||
103 | /// instances be checked or returned to the caller. | |||
104 | /// | |||
105 | /// There are two ways to set the checked flag, depending on what state the | |||
106 | /// Error instance is in. For Error instances indicating success, it | |||
107 | /// is sufficient to invoke the boolean conversion operator. E.g.: | |||
108 | /// | |||
109 | /// @code{.cpp} | |||
110 | /// Error foo(<...>); | |||
111 | /// | |||
112 | /// if (auto E = foo(<...>)) | |||
113 | /// return E; // <- Return E if it is in the error state. | |||
114 | /// // We have verified that E was in the success state. It can now be safely | |||
115 | /// // destroyed. | |||
116 | /// @endcode | |||
117 | /// | |||
118 | /// A success value *can not* be dropped. For example, just calling 'foo(<...>)' | |||
119 | /// without testing the return value will raise a runtime error, even if foo | |||
120 | /// returns success. | |||
121 | /// | |||
122 | /// For Error instances representing failure, you must use either the | |||
123 | /// handleErrors or handleAllErrors function with a typed handler. E.g.: | |||
124 | /// | |||
125 | /// @code{.cpp} | |||
126 | /// class MyErrorInfo : public ErrorInfo<MyErrorInfo> { | |||
127 | /// // Custom error info. | |||
128 | /// }; | |||
129 | /// | |||
130 | /// Error foo(<...>) { return make_error<MyErrorInfo>(...); } | |||
131 | /// | |||
132 | /// auto E = foo(<...>); // <- foo returns failure with MyErrorInfo. | |||
133 | /// auto NewE = | |||
134 | /// handleErrors(E, | |||
135 | /// [](const MyErrorInfo &M) { | |||
136 | /// // Deal with the error. | |||
137 | /// }, | |||
138 | /// [](std::unique_ptr<OtherError> M) -> Error { | |||
139 | /// if (canHandle(*M)) { | |||
140 | /// // handle error. | |||
141 | /// return Error::success(); | |||
142 | /// } | |||
143 | /// // Couldn't handle this error instance. Pass it up the stack. | |||
144 | /// return Error(std::move(M)); | |||
145 | /// ); | |||
146 | /// // Note - we must check or return NewE in case any of the handlers | |||
147 | /// // returned a new error. | |||
148 | /// @endcode | |||
149 | /// | |||
150 | /// The handleAllErrors function is identical to handleErrors, except | |||
151 | /// that it has a void return type, and requires all errors to be handled and | |||
152 | /// no new errors be returned. It prevents errors (assuming they can all be | |||
153 | /// handled) from having to be bubbled all the way to the top-level. | |||
154 | /// | |||
155 | /// *All* Error instances must be checked before destruction, even if | |||
156 | /// they're moved-assigned or constructed from Success values that have already | |||
157 | /// been checked. This enforces checking through all levels of the call stack. | |||
158 | class LLVM_NODISCARD[[clang::warn_unused_result]] Error { | |||
159 | // Both ErrorList and FileError need to be able to yank ErrorInfoBase | |||
160 | // pointers out of this class to add to the error list. | |||
161 | friend class ErrorList; | |||
162 | friend class FileError; | |||
163 | ||||
164 | // handleErrors needs to be able to set the Checked flag. | |||
165 | template <typename... HandlerTs> | |||
166 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); | |||
167 | ||||
168 | // Expected<T> needs to be able to steal the payload when constructed from an | |||
169 | // error. | |||
170 | template <typename T> friend class Expected; | |||
171 | ||||
172 | // wrap needs to be able to steal the payload. | |||
173 | friend LLVMErrorRef wrap(Error); | |||
174 | ||||
175 | protected: | |||
176 | /// Create a success value. Prefer using 'Error::success()' for readability | |||
177 | Error() { | |||
178 | setPtr(nullptr); | |||
179 | setChecked(false); | |||
180 | } | |||
181 | ||||
182 | public: | |||
183 | /// Create a success value. | |||
184 | static ErrorSuccess success(); | |||
185 | ||||
186 | // Errors are not copy-constructable. | |||
187 | Error(const Error &Other) = delete; | |||
188 | ||||
189 | /// Move-construct an error value. The newly constructed error is considered | |||
190 | /// unchecked, even if the source error had been checked. The original error | |||
191 | /// becomes a checked Success value, regardless of its original state. | |||
192 | Error(Error &&Other) { | |||
193 | setChecked(true); | |||
194 | *this = std::move(Other); | |||
195 | } | |||
196 | ||||
197 | /// Create an error value. Prefer using the 'make_error' function, but | |||
198 | /// this constructor can be useful when "re-throwing" errors from handlers. | |||
199 | Error(std::unique_ptr<ErrorInfoBase> Payload) { | |||
200 | setPtr(Payload.release()); | |||
201 | setChecked(false); | |||
| ||||
202 | } | |||
203 | ||||
204 | // Errors are not copy-assignable. | |||
205 | Error &operator=(const Error &Other) = delete; | |||
206 | ||||
207 | /// Move-assign an error value. The current error must represent success, you | |||
208 | /// you cannot overwrite an unhandled error. The current error is then | |||
209 | /// considered unchecked. The source error becomes a checked success value, | |||
210 | /// regardless of its original state. | |||
211 | Error &operator=(Error &&Other) { | |||
212 | // Don't allow overwriting of unchecked values. | |||
213 | assertIsChecked(); | |||
214 | setPtr(Other.getPtr()); | |||
215 | ||||
216 | // This Error is unchecked, even if the source error was checked. | |||
217 | setChecked(false); | |||
218 | ||||
219 | // Null out Other's payload and set its checked bit. | |||
220 | Other.setPtr(nullptr); | |||
221 | Other.setChecked(true); | |||
222 | ||||
223 | return *this; | |||
224 | } | |||
225 | ||||
226 | /// Destroy a Error. Fails with a call to abort() if the error is | |||
227 | /// unchecked. | |||
228 | ~Error() { | |||
229 | assertIsChecked(); | |||
230 | delete getPtr(); | |||
231 | } | |||
232 | ||||
233 | /// Bool conversion. Returns true if this Error is in a failure state, | |||
234 | /// and false if it is in an accept state. If the error is in a Success state | |||
235 | /// it will be considered checked. | |||
236 | explicit operator bool() { | |||
237 | setChecked(getPtr() == nullptr); | |||
238 | return getPtr() != nullptr; | |||
239 | } | |||
240 | ||||
241 | /// Check whether one error is a subclass of another. | |||
242 | template <typename ErrT> bool isA() const { | |||
243 | return getPtr() && getPtr()->isA(ErrT::classID()); | |||
244 | } | |||
245 | ||||
246 | /// Returns the dynamic class id of this error, or null if this is a success | |||
247 | /// value. | |||
248 | const void* dynamicClassID() const { | |||
249 | if (!getPtr()) | |||
250 | return nullptr; | |||
251 | return getPtr()->dynamicClassID(); | |||
252 | } | |||
253 | ||||
254 | private: | |||
255 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
256 | // assertIsChecked() happens very frequently, but under normal circumstances | |||
257 | // is supposed to be a no-op. So we want it to be inlined, but having a bunch | |||
258 | // of debug prints can cause the function to be too large for inlining. So | |||
259 | // it's important that we define this function out of line so that it can't be | |||
260 | // inlined. | |||
261 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) | |||
262 | void fatalUncheckedError() const; | |||
263 | #endif | |||
264 | ||||
265 | void assertIsChecked() { | |||
266 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
267 | if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false)) | |||
268 | fatalUncheckedError(); | |||
269 | #endif | |||
270 | } | |||
271 | ||||
272 | ErrorInfoBase *getPtr() const { | |||
273 | return reinterpret_cast<ErrorInfoBase*>( | |||
274 | reinterpret_cast<uintptr_t>(Payload) & | |||
275 | ~static_cast<uintptr_t>(0x1)); | |||
276 | } | |||
277 | ||||
278 | void setPtr(ErrorInfoBase *EI) { | |||
279 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
280 | Payload = reinterpret_cast<ErrorInfoBase*>( | |||
281 | (reinterpret_cast<uintptr_t>(EI) & | |||
282 | ~static_cast<uintptr_t>(0x1)) | | |||
283 | (reinterpret_cast<uintptr_t>(Payload) & 0x1)); | |||
284 | #else | |||
285 | Payload = EI; | |||
286 | #endif | |||
287 | } | |||
288 | ||||
289 | bool getChecked() const { | |||
290 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
291 | return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0; | |||
292 | #else | |||
293 | return true; | |||
294 | #endif | |||
295 | } | |||
296 | ||||
297 | void setChecked(bool V) { | |||
298 | Payload = reinterpret_cast<ErrorInfoBase*>( | |||
299 | (reinterpret_cast<uintptr_t>(Payload) & | |||
300 | ~static_cast<uintptr_t>(0x1)) | | |||
301 | (V ? 0 : 1)); | |||
302 | } | |||
303 | ||||
304 | std::unique_ptr<ErrorInfoBase> takePayload() { | |||
305 | std::unique_ptr<ErrorInfoBase> Tmp(getPtr()); | |||
306 | setPtr(nullptr); | |||
307 | setChecked(true); | |||
308 | return Tmp; | |||
309 | } | |||
310 | ||||
311 | friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) { | |||
312 | if (auto P = E.getPtr()) | |||
313 | P->log(OS); | |||
314 | else | |||
315 | OS << "success"; | |||
316 | return OS; | |||
317 | } | |||
318 | ||||
319 | ErrorInfoBase *Payload = nullptr; | |||
320 | }; | |||
321 | ||||
322 | /// Subclass of Error for the sole purpose of identifying the success path in | |||
323 | /// the type system. This allows to catch invalid conversion to Expected<T> at | |||
324 | /// compile time. | |||
325 | class ErrorSuccess final : public Error {}; | |||
326 | ||||
327 | inline ErrorSuccess Error::success() { return ErrorSuccess(); } | |||
328 | ||||
329 | /// Make a Error instance representing failure using the given error info | |||
330 | /// type. | |||
331 | template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) { | |||
332 | return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...)); | |||
333 | } | |||
334 | ||||
335 | /// Base class for user error types. Users should declare their error types | |||
336 | /// like: | |||
337 | /// | |||
338 | /// class MyError : public ErrorInfo<MyError> { | |||
339 | /// .... | |||
340 | /// }; | |||
341 | /// | |||
342 | /// This class provides an implementation of the ErrorInfoBase::kind | |||
343 | /// method, which is used by the Error RTTI system. | |||
344 | template <typename ThisErrT, typename ParentErrT = ErrorInfoBase> | |||
345 | class ErrorInfo : public ParentErrT { | |||
346 | public: | |||
347 | using ParentErrT::ParentErrT; // inherit constructors | |||
348 | ||||
349 | static const void *classID() { return &ThisErrT::ID; } | |||
350 | ||||
351 | const void *dynamicClassID() const override { return &ThisErrT::ID; } | |||
352 | ||||
353 | bool isA(const void *const ClassID) const override { | |||
354 | return ClassID == classID() || ParentErrT::isA(ClassID); | |||
355 | } | |||
356 | }; | |||
357 | ||||
358 | /// Special ErrorInfo subclass representing a list of ErrorInfos. | |||
359 | /// Instances of this class are constructed by joinError. | |||
360 | class ErrorList final : public ErrorInfo<ErrorList> { | |||
361 | // handleErrors needs to be able to iterate the payload list of an | |||
362 | // ErrorList. | |||
363 | template <typename... HandlerTs> | |||
364 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); | |||
365 | ||||
366 | // joinErrors is implemented in terms of join. | |||
367 | friend Error joinErrors(Error, Error); | |||
368 | ||||
369 | public: | |||
370 | void log(raw_ostream &OS) const override { | |||
371 | OS << "Multiple errors:\n"; | |||
372 | for (auto &ErrPayload : Payloads) { | |||
373 | ErrPayload->log(OS); | |||
374 | OS << "\n"; | |||
375 | } | |||
376 | } | |||
377 | ||||
378 | std::error_code convertToErrorCode() const override; | |||
379 | ||||
380 | // Used by ErrorInfo::classID. | |||
381 | static char ID; | |||
382 | ||||
383 | private: | |||
384 | ErrorList(std::unique_ptr<ErrorInfoBase> Payload1, | |||
385 | std::unique_ptr<ErrorInfoBase> Payload2) { | |||
386 | assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2-> isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors" ) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 387, __PRETTY_FUNCTION__)) | |||
387 | "ErrorList constructor payloads should be singleton errors")((!Payload1->isA<ErrorList>() && !Payload2-> isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors" ) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 387, __PRETTY_FUNCTION__)); | |||
388 | Payloads.push_back(std::move(Payload1)); | |||
389 | Payloads.push_back(std::move(Payload2)); | |||
390 | } | |||
391 | ||||
392 | static Error join(Error E1, Error E2) { | |||
393 | if (!E1) | |||
394 | return E2; | |||
395 | if (!E2) | |||
396 | return E1; | |||
397 | if (E1.isA<ErrorList>()) { | |||
398 | auto &E1List = static_cast<ErrorList &>(*E1.getPtr()); | |||
399 | if (E2.isA<ErrorList>()) { | |||
400 | auto E2Payload = E2.takePayload(); | |||
401 | auto &E2List = static_cast<ErrorList &>(*E2Payload); | |||
402 | for (auto &Payload : E2List.Payloads) | |||
403 | E1List.Payloads.push_back(std::move(Payload)); | |||
404 | } else | |||
405 | E1List.Payloads.push_back(E2.takePayload()); | |||
406 | ||||
407 | return E1; | |||
408 | } | |||
409 | if (E2.isA<ErrorList>()) { | |||
410 | auto &E2List = static_cast<ErrorList &>(*E2.getPtr()); | |||
411 | E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload()); | |||
412 | return E2; | |||
413 | } | |||
414 | return Error(std::unique_ptr<ErrorList>( | |||
415 | new ErrorList(E1.takePayload(), E2.takePayload()))); | |||
416 | } | |||
417 | ||||
418 | std::vector<std::unique_ptr<ErrorInfoBase>> Payloads; | |||
419 | }; | |||
420 | ||||
421 | /// Concatenate errors. The resulting Error is unchecked, and contains the | |||
422 | /// ErrorInfo(s), if any, contained in E1, followed by the | |||
423 | /// ErrorInfo(s), if any, contained in E2. | |||
424 | inline Error joinErrors(Error E1, Error E2) { | |||
425 | return ErrorList::join(std::move(E1), std::move(E2)); | |||
426 | } | |||
427 | ||||
428 | /// Tagged union holding either a T or a Error. | |||
429 | /// | |||
430 | /// This class parallels ErrorOr, but replaces error_code with Error. Since | |||
431 | /// Error cannot be copied, this class replaces getError() with | |||
432 | /// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the | |||
433 | /// error class type. | |||
434 | template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected { | |||
435 | template <class T1> friend class ExpectedAsOutParameter; | |||
436 | template <class OtherT> friend class Expected; | |||
437 | ||||
438 | static const bool isRef = std::is_reference<T>::value; | |||
439 | ||||
440 | using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>; | |||
441 | ||||
442 | using error_type = std::unique_ptr<ErrorInfoBase>; | |||
443 | ||||
444 | public: | |||
445 | using storage_type = typename std::conditional<isRef, wrap, T>::type; | |||
446 | using value_type = T; | |||
447 | ||||
448 | private: | |||
449 | using reference = typename std::remove_reference<T>::type &; | |||
450 | using const_reference = const typename std::remove_reference<T>::type &; | |||
451 | using pointer = typename std::remove_reference<T>::type *; | |||
452 | using const_pointer = const typename std::remove_reference<T>::type *; | |||
453 | ||||
454 | public: | |||
455 | /// Create an Expected<T> error value from the given Error. | |||
456 | Expected(Error Err) | |||
457 | : HasError(true) | |||
458 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
459 | // Expected is unchecked upon construction in Debug builds. | |||
460 | , Unchecked(true) | |||
461 | #endif | |||
462 | { | |||
463 | assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value." ) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 463, __PRETTY_FUNCTION__)); | |||
464 | new (getErrorStorage()) error_type(Err.takePayload()); | |||
465 | } | |||
466 | ||||
467 | /// Forbid to convert from Error::success() implicitly, this avoids having | |||
468 | /// Expected<T> foo() { return Error::success(); } which compiles otherwise | |||
469 | /// but triggers the assertion above. | |||
470 | Expected(ErrorSuccess) = delete; | |||
471 | ||||
472 | /// Create an Expected<T> success value from the given OtherT value, which | |||
473 | /// must be convertible to T. | |||
474 | template <typename OtherT> | |||
475 | Expected(OtherT &&Val, | |||
476 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type | |||
477 | * = nullptr) | |||
478 | : HasError(false) | |||
479 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
480 | // Expected is unchecked upon construction in Debug builds. | |||
481 | , Unchecked(true) | |||
482 | #endif | |||
483 | { | |||
484 | new (getStorage()) storage_type(std::forward<OtherT>(Val)); | |||
485 | } | |||
486 | ||||
487 | /// Move construct an Expected<T> value. | |||
488 | Expected(Expected &&Other) { moveConstruct(std::move(Other)); } | |||
489 | ||||
490 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT | |||
491 | /// must be convertible to T. | |||
492 | template <class OtherT> | |||
493 | Expected(Expected<OtherT> &&Other, | |||
494 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type | |||
495 | * = nullptr) { | |||
496 | moveConstruct(std::move(Other)); | |||
497 | } | |||
498 | ||||
499 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT | |||
500 | /// isn't convertible to T. | |||
501 | template <class OtherT> | |||
502 | explicit Expected( | |||
503 | Expected<OtherT> &&Other, | |||
504 | typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * = | |||
505 | nullptr) { | |||
506 | moveConstruct(std::move(Other)); | |||
507 | } | |||
508 | ||||
509 | /// Move-assign from another Expected<T>. | |||
510 | Expected &operator=(Expected &&Other) { | |||
511 | moveAssign(std::move(Other)); | |||
512 | return *this; | |||
513 | } | |||
514 | ||||
515 | /// Destroy an Expected<T>. | |||
516 | ~Expected() { | |||
517 | assertIsChecked(); | |||
518 | if (!HasError) | |||
519 | getStorage()->~storage_type(); | |||
520 | else | |||
521 | getErrorStorage()->~error_type(); | |||
522 | } | |||
523 | ||||
524 | /// Return false if there is an error. | |||
525 | explicit operator bool() { | |||
526 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
527 | Unchecked = HasError; | |||
528 | #endif | |||
529 | return !HasError; | |||
530 | } | |||
531 | ||||
532 | /// Returns a reference to the stored T value. | |||
533 | reference get() { | |||
534 | assertIsChecked(); | |||
535 | return *getStorage(); | |||
536 | } | |||
537 | ||||
538 | /// Returns a const reference to the stored T value. | |||
539 | const_reference get() const { | |||
540 | assertIsChecked(); | |||
541 | return const_cast<Expected<T> *>(this)->get(); | |||
542 | } | |||
543 | ||||
544 | /// Check that this Expected<T> is an error of type ErrT. | |||
545 | template <typename ErrT> bool errorIsA() const { | |||
546 | return HasError && (*getErrorStorage())->template isA<ErrT>(); | |||
547 | } | |||
548 | ||||
549 | /// Take ownership of the stored error. | |||
550 | /// After calling this the Expected<T> is in an indeterminate state that can | |||
551 | /// only be safely destructed. No further calls (beside the destructor) should | |||
552 | /// be made on the Expected<T> vaule. | |||
553 | Error takeError() { | |||
554 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
555 | Unchecked = false; | |||
556 | #endif | |||
557 | return HasError ? Error(std::move(*getErrorStorage())) : Error::success(); | |||
558 | } | |||
559 | ||||
560 | /// Returns a pointer to the stored T value. | |||
561 | pointer operator->() { | |||
562 | assertIsChecked(); | |||
563 | return toPointer(getStorage()); | |||
564 | } | |||
565 | ||||
566 | /// Returns a const pointer to the stored T value. | |||
567 | const_pointer operator->() const { | |||
568 | assertIsChecked(); | |||
569 | return toPointer(getStorage()); | |||
570 | } | |||
571 | ||||
572 | /// Returns a reference to the stored T value. | |||
573 | reference operator*() { | |||
574 | assertIsChecked(); | |||
575 | return *getStorage(); | |||
576 | } | |||
577 | ||||
578 | /// Returns a const reference to the stored T value. | |||
579 | const_reference operator*() const { | |||
580 | assertIsChecked(); | |||
581 | return *getStorage(); | |||
582 | } | |||
583 | ||||
584 | private: | |||
585 | template <class T1> | |||
586 | static bool compareThisIfSameType(const T1 &a, const T1 &b) { | |||
587 | return &a == &b; | |||
588 | } | |||
589 | ||||
590 | template <class T1, class T2> | |||
591 | static bool compareThisIfSameType(const T1 &a, const T2 &b) { | |||
592 | return false; | |||
593 | } | |||
594 | ||||
595 | template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) { | |||
596 | HasError = Other.HasError; | |||
597 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
598 | Unchecked = true; | |||
599 | Other.Unchecked = false; | |||
600 | #endif | |||
601 | ||||
602 | if (!HasError) | |||
603 | new (getStorage()) storage_type(std::move(*Other.getStorage())); | |||
604 | else | |||
605 | new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage())); | |||
606 | } | |||
607 | ||||
608 | template <class OtherT> void moveAssign(Expected<OtherT> &&Other) { | |||
609 | assertIsChecked(); | |||
610 | ||||
611 | if (compareThisIfSameType(*this, Other)) | |||
612 | return; | |||
613 | ||||
614 | this->~Expected(); | |||
615 | new (this) Expected(std::move(Other)); | |||
616 | } | |||
617 | ||||
618 | pointer toPointer(pointer Val) { return Val; } | |||
619 | ||||
620 | const_pointer toPointer(const_pointer Val) const { return Val; } | |||
621 | ||||
622 | pointer toPointer(wrap *Val) { return &Val->get(); } | |||
623 | ||||
624 | const_pointer toPointer(const wrap *Val) const { return &Val->get(); } | |||
625 | ||||
626 | storage_type *getStorage() { | |||
627 | assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!" ) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 627, __PRETTY_FUNCTION__)); | |||
628 | return reinterpret_cast<storage_type *>(TStorage.buffer); | |||
629 | } | |||
630 | ||||
631 | const storage_type *getStorage() const { | |||
632 | assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!" ) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 632, __PRETTY_FUNCTION__)); | |||
633 | return reinterpret_cast<const storage_type *>(TStorage.buffer); | |||
634 | } | |||
635 | ||||
636 | error_type *getErrorStorage() { | |||
637 | assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!" ) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 637, __PRETTY_FUNCTION__)); | |||
638 | return reinterpret_cast<error_type *>(ErrorStorage.buffer); | |||
639 | } | |||
640 | ||||
641 | const error_type *getErrorStorage() const { | |||
642 | assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!" ) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 642, __PRETTY_FUNCTION__)); | |||
643 | return reinterpret_cast<const error_type *>(ErrorStorage.buffer); | |||
644 | } | |||
645 | ||||
646 | // Used by ExpectedAsOutParameter to reset the checked flag. | |||
647 | void setUnchecked() { | |||
648 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
649 | Unchecked = true; | |||
650 | #endif | |||
651 | } | |||
652 | ||||
653 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
654 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) | |||
655 | LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline)) | |||
656 | void fatalUncheckedExpected() const { | |||
657 | dbgs() << "Expected<T> must be checked before access or destruction.\n"; | |||
658 | if (HasError) { | |||
659 | dbgs() << "Unchecked Expected<T> contained error:\n"; | |||
660 | (*getErrorStorage())->log(dbgs()); | |||
661 | } else | |||
662 | dbgs() << "Expected<T> value was in success state. (Note: Expected<T> " | |||
663 | "values in success mode must still be checked prior to being " | |||
664 | "destroyed).\n"; | |||
665 | abort(); | |||
666 | } | |||
667 | #endif | |||
668 | ||||
669 | void assertIsChecked() { | |||
670 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
671 | if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false)) | |||
672 | fatalUncheckedExpected(); | |||
673 | #endif | |||
674 | } | |||
675 | ||||
676 | union { | |||
677 | AlignedCharArrayUnion<storage_type> TStorage; | |||
678 | AlignedCharArrayUnion<error_type> ErrorStorage; | |||
679 | }; | |||
680 | bool HasError : 1; | |||
681 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
682 | bool Unchecked : 1; | |||
683 | #endif | |||
684 | }; | |||
685 | ||||
686 | /// Report a serious error, calling any installed error handler. See | |||
687 | /// ErrorHandling.h. | |||
688 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err, | |||
689 | bool gen_crash_diag = true); | |||
690 | ||||
691 | /// Report a fatal error if Err is a failure value. | |||
692 | /// | |||
693 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
694 | /// is known that the Error will always be a success value. E.g. | |||
695 | /// | |||
696 | /// @code{.cpp} | |||
697 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
698 | /// // true. If DoFallibleOperation is false then foo always returns | |||
699 | /// // Error::success(). | |||
700 | /// Error foo(bool DoFallibleOperation); | |||
701 | /// | |||
702 | /// cantFail(foo(false)); | |||
703 | /// @endcode | |||
704 | inline void cantFail(Error Err, const char *Msg = nullptr) { | |||
705 | if (Err) { | |||
706 | if (!Msg) | |||
707 | Msg = "Failure value returned from cantFail wrapped call"; | |||
708 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 708); | |||
709 | } | |||
710 | } | |||
711 | ||||
712 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and | |||
713 | /// returns the contained value. | |||
714 | /// | |||
715 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
716 | /// is known that the Error will always be a success value. E.g. | |||
717 | /// | |||
718 | /// @code{.cpp} | |||
719 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
720 | /// // true. If DoFallibleOperation is false then foo always returns an int. | |||
721 | /// Expected<int> foo(bool DoFallibleOperation); | |||
722 | /// | |||
723 | /// int X = cantFail(foo(false)); | |||
724 | /// @endcode | |||
725 | template <typename T> | |||
726 | T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) { | |||
727 | if (ValOrErr) | |||
728 | return std::move(*ValOrErr); | |||
729 | else { | |||
730 | if (!Msg) | |||
731 | Msg = "Failure value returned from cantFail wrapped call"; | |||
732 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 732); | |||
733 | } | |||
734 | } | |||
735 | ||||
736 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and | |||
737 | /// returns the contained reference. | |||
738 | /// | |||
739 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
740 | /// is known that the Error will always be a success value. E.g. | |||
741 | /// | |||
742 | /// @code{.cpp} | |||
743 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
744 | /// // true. If DoFallibleOperation is false then foo always returns a Bar&. | |||
745 | /// Expected<Bar&> foo(bool DoFallibleOperation); | |||
746 | /// | |||
747 | /// Bar &X = cantFail(foo(false)); | |||
748 | /// @endcode | |||
749 | template <typename T> | |||
750 | T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) { | |||
751 | if (ValOrErr) | |||
752 | return *ValOrErr; | |||
753 | else { | |||
754 | if (!Msg) | |||
755 | Msg = "Failure value returned from cantFail wrapped call"; | |||
756 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 756); | |||
757 | } | |||
758 | } | |||
759 | ||||
760 | /// Helper for testing applicability of, and applying, handlers for | |||
761 | /// ErrorInfo types. | |||
762 | template <typename HandlerT> | |||
763 | class ErrorHandlerTraits | |||
764 | : public ErrorHandlerTraits<decltype( | |||
765 | &std::remove_reference<HandlerT>::type::operator())> {}; | |||
766 | ||||
767 | // Specialization functions of the form 'Error (const ErrT&)'. | |||
768 | template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> { | |||
769 | public: | |||
770 | static bool appliesTo(const ErrorInfoBase &E) { | |||
771 | return E.template isA<ErrT>(); | |||
772 | } | |||
773 | ||||
774 | template <typename HandlerT> | |||
775 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
776 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 776, __PRETTY_FUNCTION__)); | |||
777 | return H(static_cast<ErrT &>(*E)); | |||
778 | } | |||
779 | }; | |||
780 | ||||
781 | // Specialization functions of the form 'void (const ErrT&)'. | |||
782 | template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> { | |||
783 | public: | |||
784 | static bool appliesTo(const ErrorInfoBase &E) { | |||
785 | return E.template isA<ErrT>(); | |||
786 | } | |||
787 | ||||
788 | template <typename HandlerT> | |||
789 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
790 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 790, __PRETTY_FUNCTION__)); | |||
791 | H(static_cast<ErrT &>(*E)); | |||
792 | return Error::success(); | |||
793 | } | |||
794 | }; | |||
795 | ||||
796 | /// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'. | |||
797 | template <typename ErrT> | |||
798 | class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> { | |||
799 | public: | |||
800 | static bool appliesTo(const ErrorInfoBase &E) { | |||
801 | return E.template isA<ErrT>(); | |||
802 | } | |||
803 | ||||
804 | template <typename HandlerT> | |||
805 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
806 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 806, __PRETTY_FUNCTION__)); | |||
807 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); | |||
808 | return H(std::move(SubE)); | |||
809 | } | |||
810 | }; | |||
811 | ||||
812 | /// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'. | |||
813 | template <typename ErrT> | |||
814 | class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> { | |||
815 | public: | |||
816 | static bool appliesTo(const ErrorInfoBase &E) { | |||
817 | return E.template isA<ErrT>(); | |||
818 | } | |||
819 | ||||
820 | template <typename HandlerT> | |||
821 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
822 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 822, __PRETTY_FUNCTION__)); | |||
823 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); | |||
824 | H(std::move(SubE)); | |||
825 | return Error::success(); | |||
826 | } | |||
827 | }; | |||
828 | ||||
829 | // Specialization for member functions of the form 'RetT (const ErrT&)'. | |||
830 | template <typename C, typename RetT, typename ErrT> | |||
831 | class ErrorHandlerTraits<RetT (C::*)(ErrT &)> | |||
832 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
833 | ||||
834 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. | |||
835 | template <typename C, typename RetT, typename ErrT> | |||
836 | class ErrorHandlerTraits<RetT (C::*)(ErrT &) const> | |||
837 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
838 | ||||
839 | // Specialization for member functions of the form 'RetT (const ErrT&)'. | |||
840 | template <typename C, typename RetT, typename ErrT> | |||
841 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &)> | |||
842 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
843 | ||||
844 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. | |||
845 | template <typename C, typename RetT, typename ErrT> | |||
846 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const> | |||
847 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
848 | ||||
849 | /// Specialization for member functions of the form | |||
850 | /// 'RetT (std::unique_ptr<ErrT>)'. | |||
851 | template <typename C, typename RetT, typename ErrT> | |||
852 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)> | |||
853 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; | |||
854 | ||||
855 | /// Specialization for member functions of the form | |||
856 | /// 'RetT (std::unique_ptr<ErrT>) const'. | |||
857 | template <typename C, typename RetT, typename ErrT> | |||
858 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const> | |||
859 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; | |||
860 | ||||
861 | inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) { | |||
862 | return Error(std::move(Payload)); | |||
863 | } | |||
864 | ||||
865 | template <typename HandlerT, typename... HandlerTs> | |||
866 | Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload, | |||
867 | HandlerT &&Handler, HandlerTs &&... Handlers) { | |||
868 | if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload)) | |||
869 | return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler), | |||
870 | std::move(Payload)); | |||
871 | return handleErrorImpl(std::move(Payload), | |||
872 | std::forward<HandlerTs>(Handlers)...); | |||
873 | } | |||
874 | ||||
875 | /// Pass the ErrorInfo(s) contained in E to their respective handlers. Any | |||
876 | /// unhandled errors (or Errors returned by handlers) are re-concatenated and | |||
877 | /// returned. | |||
878 | /// Because this function returns an error, its result must also be checked | |||
879 | /// or returned. If you intend to handle all errors use handleAllErrors | |||
880 | /// (which returns void, and will abort() on unhandled errors) instead. | |||
881 | template <typename... HandlerTs> | |||
882 | Error handleErrors(Error E, HandlerTs &&... Hs) { | |||
883 | if (!E) | |||
884 | return Error::success(); | |||
885 | ||||
886 | std::unique_ptr<ErrorInfoBase> Payload = E.takePayload(); | |||
887 | ||||
888 | if (Payload->isA<ErrorList>()) { | |||
889 | ErrorList &List = static_cast<ErrorList &>(*Payload); | |||
890 | Error R; | |||
891 | for (auto &P : List.Payloads) | |||
892 | R = ErrorList::join( | |||
893 | std::move(R), | |||
894 | handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...)); | |||
895 | return R; | |||
896 | } | |||
897 | ||||
898 | return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...); | |||
899 | } | |||
900 | ||||
901 | /// Behaves the same as handleErrors, except that by contract all errors | |||
902 | /// *must* be handled by the given handlers (i.e. there must be no remaining | |||
903 | /// errors after running the handlers, or llvm_unreachable is called). | |||
904 | template <typename... HandlerTs> | |||
905 | void handleAllErrors(Error E, HandlerTs &&... Handlers) { | |||
906 | cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...)); | |||
907 | } | |||
908 | ||||
909 | /// Check that E is a non-error, then drop it. | |||
910 | /// If E is an error, llvm_unreachable will be called. | |||
911 | inline void handleAllErrors(Error E) { | |||
912 | cantFail(std::move(E)); | |||
913 | } | |||
914 | ||||
915 | /// Handle any errors (if present) in an Expected<T>, then try a recovery path. | |||
916 | /// | |||
917 | /// If the incoming value is a success value it is returned unmodified. If it | |||
918 | /// is a failure value then it the contained error is passed to handleErrors. | |||
919 | /// If handleErrors is able to handle the error then the RecoveryPath functor | |||
920 | /// is called to supply the final result. If handleErrors is not able to | |||
921 | /// handle all errors then the unhandled errors are returned. | |||
922 | /// | |||
923 | /// This utility enables the follow pattern: | |||
924 | /// | |||
925 | /// @code{.cpp} | |||
926 | /// enum FooStrategy { Aggressive, Conservative }; | |||
927 | /// Expected<Foo> foo(FooStrategy S); | |||
928 | /// | |||
929 | /// auto ResultOrErr = | |||
930 | /// handleExpected( | |||
931 | /// foo(Aggressive), | |||
932 | /// []() { return foo(Conservative); }, | |||
933 | /// [](AggressiveStrategyError&) { | |||
934 | /// // Implicitly conusme this - we'll recover by using a conservative | |||
935 | /// // strategy. | |||
936 | /// }); | |||
937 | /// | |||
938 | /// @endcode | |||
939 | template <typename T, typename RecoveryFtor, typename... HandlerTs> | |||
940 | Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath, | |||
941 | HandlerTs &&... Handlers) { | |||
942 | if (ValOrErr) | |||
943 | return ValOrErr; | |||
944 | ||||
945 | if (auto Err = handleErrors(ValOrErr.takeError(), | |||
946 | std::forward<HandlerTs>(Handlers)...)) | |||
947 | return std::move(Err); | |||
948 | ||||
949 | return RecoveryPath(); | |||
950 | } | |||
951 | ||||
952 | /// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner | |||
953 | /// will be printed before the first one is logged. A newline will be printed | |||
954 | /// after each error. | |||
955 | /// | |||
956 | /// This is useful in the base level of your program to allow clean termination | |||
957 | /// (allowing clean deallocation of resources, etc.), while reporting error | |||
958 | /// information to the user. | |||
959 | void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner); | |||
960 | ||||
961 | /// Write all error messages (if any) in E to a string. The newline character | |||
962 | /// is used to separate error messages. | |||
963 | inline std::string toString(Error E) { | |||
964 | SmallVector<std::string, 2> Errors; | |||
965 | handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) { | |||
966 | Errors.push_back(EI.message()); | |||
967 | }); | |||
968 | return join(Errors.begin(), Errors.end(), "\n"); | |||
969 | } | |||
970 | ||||
971 | /// Consume a Error without doing anything. This method should be used | |||
972 | /// only where an error can be considered a reasonable and expected return | |||
973 | /// value. | |||
974 | /// | |||
975 | /// Uses of this method are potentially indicative of design problems: If it's | |||
976 | /// legitimate to do nothing while processing an "error", the error-producer | |||
977 | /// might be more clearly refactored to return an Optional<T>. | |||
978 | inline void consumeError(Error Err) { | |||
979 | handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {}); | |||
980 | } | |||
981 | ||||
982 | /// Helper for converting an Error to a bool. | |||
983 | /// | |||
984 | /// This method returns true if Err is in an error state, or false if it is | |||
985 | /// in a success state. Puts Err in a checked state in both cases (unlike | |||
986 | /// Error::operator bool(), which only does this for success states). | |||
987 | inline bool errorToBool(Error Err) { | |||
988 | bool IsError = static_cast<bool>(Err); | |||
989 | if (IsError) | |||
990 | consumeError(std::move(Err)); | |||
991 | return IsError; | |||
992 | } | |||
993 | ||||
994 | /// Helper for Errors used as out-parameters. | |||
995 | /// | |||
996 | /// This helper is for use with the Error-as-out-parameter idiom, where an error | |||
997 | /// is passed to a function or method by reference, rather than being returned. | |||
998 | /// In such cases it is helpful to set the checked bit on entry to the function | |||
999 | /// so that the error can be written to (unchecked Errors abort on assignment) | |||
1000 | /// and clear the checked bit on exit so that clients cannot accidentally forget | |||
1001 | /// to check the result. This helper performs these actions automatically using | |||
1002 | /// RAII: | |||
1003 | /// | |||
1004 | /// @code{.cpp} | |||
1005 | /// Result foo(Error &Err) { | |||
1006 | /// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set | |||
1007 | /// // <body of foo> | |||
1008 | /// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed. | |||
1009 | /// } | |||
1010 | /// @endcode | |||
1011 | /// | |||
1012 | /// ErrorAsOutParameter takes an Error* rather than Error& so that it can be | |||
1013 | /// used with optional Errors (Error pointers that are allowed to be null). If | |||
1014 | /// ErrorAsOutParameter took an Error reference, an instance would have to be | |||
1015 | /// created inside every condition that verified that Error was non-null. By | |||
1016 | /// taking an Error pointer we can just create one instance at the top of the | |||
1017 | /// function. | |||
1018 | class ErrorAsOutParameter { | |||
1019 | public: | |||
1020 | ErrorAsOutParameter(Error *Err) : Err(Err) { | |||
1021 | // Raise the checked bit if Err is success. | |||
1022 | if (Err) | |||
1023 | (void)!!*Err; | |||
1024 | } | |||
1025 | ||||
1026 | ~ErrorAsOutParameter() { | |||
1027 | // Clear the checked bit. | |||
1028 | if (Err && !*Err) | |||
1029 | *Err = Error::success(); | |||
1030 | } | |||
1031 | ||||
1032 | private: | |||
1033 | Error *Err; | |||
1034 | }; | |||
1035 | ||||
1036 | /// Helper for Expected<T>s used as out-parameters. | |||
1037 | /// | |||
1038 | /// See ErrorAsOutParameter. | |||
1039 | template <typename T> | |||
1040 | class ExpectedAsOutParameter { | |||
1041 | public: | |||
1042 | ExpectedAsOutParameter(Expected<T> *ValOrErr) | |||
1043 | : ValOrErr(ValOrErr) { | |||
1044 | if (ValOrErr) | |||
1045 | (void)!!*ValOrErr; | |||
1046 | } | |||
1047 | ||||
1048 | ~ExpectedAsOutParameter() { | |||
1049 | if (ValOrErr) | |||
1050 | ValOrErr->setUnchecked(); | |||
1051 | } | |||
1052 | ||||
1053 | private: | |||
1054 | Expected<T> *ValOrErr; | |||
1055 | }; | |||
1056 | ||||
1057 | /// This class wraps a std::error_code in a Error. | |||
1058 | /// | |||
1059 | /// This is useful if you're writing an interface that returns a Error | |||
1060 | /// (or Expected) and you want to call code that still returns | |||
1061 | /// std::error_codes. | |||
1062 | class ECError : public ErrorInfo<ECError> { | |||
1063 | friend Error errorCodeToError(std::error_code); | |||
1064 | ||||
1065 | public: | |||
1066 | void setErrorCode(std::error_code EC) { this->EC = EC; } | |||
1067 | std::error_code convertToErrorCode() const override { return EC; } | |||
1068 | void log(raw_ostream &OS) const override { OS << EC.message(); } | |||
1069 | ||||
1070 | // Used by ErrorInfo::classID. | |||
1071 | static char ID; | |||
1072 | ||||
1073 | protected: | |||
1074 | ECError() = default; | |||
1075 | ECError(std::error_code EC) : EC(EC) {} | |||
1076 | ||||
1077 | std::error_code EC; | |||
1078 | }; | |||
1079 | ||||
1080 | /// The value returned by this function can be returned from convertToErrorCode | |||
1081 | /// for Error values where no sensible translation to std::error_code exists. | |||
1082 | /// It should only be used in this situation, and should never be used where a | |||
1083 | /// sensible conversion to std::error_code is available, as attempts to convert | |||
1084 | /// to/from this error will result in a fatal error. (i.e. it is a programmatic | |||
1085 | ///error to try to convert such a value). | |||
1086 | std::error_code inconvertibleErrorCode(); | |||
1087 | ||||
1088 | /// Helper for converting an std::error_code to a Error. | |||
1089 | Error errorCodeToError(std::error_code EC); | |||
1090 | ||||
1091 | /// Helper for converting an ECError to a std::error_code. | |||
1092 | /// | |||
1093 | /// This method requires that Err be Error() or an ECError, otherwise it | |||
1094 | /// will trigger a call to abort(). | |||
1095 | std::error_code errorToErrorCode(Error Err); | |||
1096 | ||||
1097 | /// Convert an ErrorOr<T> to an Expected<T>. | |||
1098 | template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) { | |||
1099 | if (auto EC = EO.getError()) | |||
1100 | return errorCodeToError(EC); | |||
1101 | return std::move(*EO); | |||
1102 | } | |||
1103 | ||||
1104 | /// Convert an Expected<T> to an ErrorOr<T>. | |||
1105 | template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) { | |||
1106 | if (auto Err = E.takeError()) | |||
1107 | return errorToErrorCode(std::move(Err)); | |||
1108 | return std::move(*E); | |||
1109 | } | |||
1110 | ||||
1111 | /// This class wraps a string in an Error. | |||
1112 | /// | |||
1113 | /// StringError is useful in cases where the client is not expected to be able | |||
1114 | /// to consume the specific error message programmatically (for example, if the | |||
1115 | /// error message is to be presented to the user). | |||
1116 | /// | |||
1117 | /// StringError can also be used when additional information is to be printed | |||
1118 | /// along with a error_code message. Depending on the constructor called, this | |||
1119 | /// class can either display: | |||
1120 | /// 1. the error_code message (ECError behavior) | |||
1121 | /// 2. a string | |||
1122 | /// 3. the error_code message and a string | |||
1123 | /// | |||
1124 | /// These behaviors are useful when subtyping is required; for example, when a | |||
1125 | /// specific library needs an explicit error type. In the example below, | |||
1126 | /// PDBError is derived from StringError: | |||
1127 | /// | |||
1128 | /// @code{.cpp} | |||
1129 | /// Expected<int> foo() { | |||
1130 | /// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading, | |||
1131 | /// "Additional information"); | |||
1132 | /// } | |||
1133 | /// @endcode | |||
1134 | /// | |||
1135 | class StringError : public ErrorInfo<StringError> { | |||
1136 | public: | |||
1137 | static char ID; | |||
1138 | ||||
1139 | // Prints EC + S and converts to EC | |||
1140 | StringError(std::error_code EC, const Twine &S = Twine()); | |||
1141 | ||||
1142 | // Prints S and converts to EC | |||
1143 | StringError(const Twine &S, std::error_code EC); | |||
1144 | ||||
1145 | void log(raw_ostream &OS) const override; | |||
1146 | std::error_code convertToErrorCode() const override; | |||
1147 | ||||
1148 | const std::string &getMessage() const { return Msg; } | |||
1149 | ||||
1150 | private: | |||
1151 | std::string Msg; | |||
1152 | std::error_code EC; | |||
1153 | const bool PrintMsgOnly = false; | |||
1154 | }; | |||
1155 | ||||
1156 | /// Create formatted StringError object. | |||
1157 | template <typename... Ts> | |||
1158 | Error createStringError(std::error_code EC, char const *Fmt, | |||
1159 | const Ts &... Vals) { | |||
1160 | std::string Buffer; | |||
1161 | raw_string_ostream Stream(Buffer); | |||
1162 | Stream << format(Fmt, Vals...); | |||
1163 | return make_error<StringError>(Stream.str(), EC); | |||
1164 | } | |||
1165 | ||||
1166 | Error createStringError(std::error_code EC, char const *Msg); | |||
1167 | ||||
1168 | /// This class wraps a filename and another Error. | |||
1169 | /// | |||
1170 | /// In some cases, an error needs to live along a 'source' name, in order to | |||
1171 | /// show more detailed information to the user. | |||
1172 | class FileError final : public ErrorInfo<FileError> { | |||
1173 | ||||
1174 | friend Error createFileError(std::string, Error); | |||
1175 | ||||
1176 | public: | |||
1177 | void log(raw_ostream &OS) const override { | |||
1178 | assert(Err && !FileName.empty() && "Trying to log after takeError().")((Err && !FileName.empty() && "Trying to log after takeError()." ) ? static_cast<void> (0) : __assert_fail ("Err && !FileName.empty() && \"Trying to log after takeError().\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1178, __PRETTY_FUNCTION__)); | |||
1179 | OS << "'" << FileName << "': "; | |||
1180 | Err->log(OS); | |||
1181 | } | |||
1182 | ||||
1183 | Error takeError() { return Error(std::move(Err)); } | |||
1184 | ||||
1185 | std::error_code convertToErrorCode() const override; | |||
1186 | ||||
1187 | // Used by ErrorInfo::classID. | |||
1188 | static char ID; | |||
1189 | ||||
1190 | private: | |||
1191 | FileError(std::string F, std::unique_ptr<ErrorInfoBase> E) { | |||
1192 | assert(E && "Cannot create FileError from Error success value.")((E && "Cannot create FileError from Error success value." ) ? static_cast<void> (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1192, __PRETTY_FUNCTION__)); | |||
1193 | assert(!F.empty() &&((!F.empty() && "The file name provided to FileError must not be empty." ) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1194, __PRETTY_FUNCTION__)) | |||
1194 | "The file name provided to FileError must not be empty.")((!F.empty() && "The file name provided to FileError must not be empty." ) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1194, __PRETTY_FUNCTION__)); | |||
1195 | FileName = F; | |||
1196 | Err = std::move(E); | |||
1197 | } | |||
1198 | ||||
1199 | static Error build(std::string F, Error E) { | |||
1200 | return Error(std::unique_ptr<FileError>(new FileError(F, E.takePayload()))); | |||
1201 | } | |||
1202 | ||||
1203 | std::string FileName; | |||
1204 | std::unique_ptr<ErrorInfoBase> Err; | |||
1205 | }; | |||
1206 | ||||
1207 | /// Concatenate a source file path and/or name with an Error. The resulting | |||
1208 | /// Error is unchecked. | |||
1209 | inline Error createFileError(std::string F, Error E) { | |||
1210 | return FileError::build(F, std::move(E)); | |||
1211 | } | |||
1212 | ||||
1213 | Error createFileError(std::string F, ErrorSuccess) = delete; | |||
1214 | ||||
1215 | /// Helper for check-and-exit error handling. | |||
1216 | /// | |||
1217 | /// For tool use only. NOT FOR USE IN LIBRARY CODE. | |||
1218 | /// | |||
1219 | class ExitOnError { | |||
1220 | public: | |||
1221 | /// Create an error on exit helper. | |||
1222 | ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1) | |||
1223 | : Banner(std::move(Banner)), | |||
1224 | GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {} | |||
1225 | ||||
1226 | /// Set the banner string for any errors caught by operator(). | |||
1227 | void setBanner(std::string Banner) { this->Banner = std::move(Banner); } | |||
1228 | ||||
1229 | /// Set the exit-code mapper function. | |||
1230 | void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) { | |||
1231 | this->GetExitCode = std::move(GetExitCode); | |||
1232 | } | |||
1233 | ||||
1234 | /// Check Err. If it's in a failure state log the error(s) and exit. | |||
1235 | void operator()(Error Err) const { checkError(std::move(Err)); } | |||
1236 | ||||
1237 | /// Check E. If it's in a success state then return the contained value. If | |||
1238 | /// it's in a failure state log the error(s) and exit. | |||
1239 | template <typename T> T operator()(Expected<T> &&E) const { | |||
1240 | checkError(E.takeError()); | |||
1241 | return std::move(*E); | |||
1242 | } | |||
1243 | ||||
1244 | /// Check E. If it's in a success state then return the contained reference. If | |||
1245 | /// it's in a failure state log the error(s) and exit. | |||
1246 | template <typename T> T& operator()(Expected<T&> &&E) const { | |||
1247 | checkError(E.takeError()); | |||
1248 | return *E; | |||
1249 | } | |||
1250 | ||||
1251 | private: | |||
1252 | void checkError(Error Err) const { | |||
1253 | if (Err) { | |||
1254 | int ExitCode = GetExitCode(Err); | |||
1255 | logAllUnhandledErrors(std::move(Err), errs(), Banner); | |||
1256 | exit(ExitCode); | |||
1257 | } | |||
1258 | } | |||
1259 | ||||
1260 | std::string Banner; | |||
1261 | std::function<int(const Error &)> GetExitCode; | |||
1262 | }; | |||
1263 | ||||
1264 | /// Conversion from Error to LLVMErrorRef for C error bindings. | |||
1265 | inline LLVMErrorRef wrap(Error Err) { | |||
1266 | return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release()); | |||
1267 | } | |||
1268 | ||||
1269 | /// Conversion from LLVMErrorRef to Error for C error bindings. | |||
1270 | inline Error unwrap(LLVMErrorRef ErrRef) { | |||
1271 | return Error(std::unique_ptr<ErrorInfoBase>( | |||
1272 | reinterpret_cast<ErrorInfoBase *>(ErrRef))); | |||
1273 | } | |||
1274 | ||||
1275 | } // end namespace llvm | |||
1276 | ||||
1277 | #endif // LLVM_SUPPORT_ERROR_H |
1 | //===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===// |
2 | // |
3 | // The LLVM Compiler Infrastructure |
4 | // |
5 | // This file is distributed under the University of Illinois Open Source |
6 | // License. See LICENSE.TXT for details. |
7 | // |
8 | //===----------------------------------------------------------------------===// |
9 | // |
10 | // This file contains some templates that are useful if you are working with the |
11 | // STL at all. |
12 | // |
13 | // No library is required when using these functions. |
14 | // |
15 | //===----------------------------------------------------------------------===// |
16 | |
17 | #ifndef LLVM_ADT_STLEXTRAS_H |
18 | #define LLVM_ADT_STLEXTRAS_H |
19 | |
20 | #include "llvm/ADT/Optional.h" |
21 | #include "llvm/ADT/SmallVector.h" |
22 | #include "llvm/ADT/iterator.h" |
23 | #include "llvm/ADT/iterator_range.h" |
24 | #include "llvm/Config/abi-breaking.h" |
25 | #include "llvm/Support/ErrorHandling.h" |
26 | #include <algorithm> |
27 | #include <cassert> |
28 | #include <cstddef> |
29 | #include <cstdint> |
30 | #include <cstdlib> |
31 | #include <functional> |
32 | #include <initializer_list> |
33 | #include <iterator> |
34 | #include <limits> |
35 | #include <memory> |
36 | #include <tuple> |
37 | #include <type_traits> |
38 | #include <utility> |
39 | |
40 | #ifdef EXPENSIVE_CHECKS |
41 | #include <random> // for std::mt19937 |
42 | #endif |
43 | |
44 | namespace llvm { |
45 | |
46 | // Only used by compiler if both template types are the same. Useful when |
47 | // using SFINAE to test for the existence of member functions. |
48 | template <typename T, T> struct SameType; |
49 | |
50 | namespace detail { |
51 | |
52 | template <typename RangeT> |
53 | using IterOfRange = decltype(std::begin(std::declval<RangeT &>())); |
54 | |
55 | template <typename RangeT> |
56 | using ValueOfRange = typename std::remove_reference<decltype( |
57 | *std::begin(std::declval<RangeT &>()))>::type; |
58 | |
59 | } // end namespace detail |
60 | |
61 | //===----------------------------------------------------------------------===// |
62 | // Extra additions to <type_traits> |
63 | //===----------------------------------------------------------------------===// |
64 | |
65 | template <typename T> |
66 | struct negation : std::integral_constant<bool, !bool(T::value)> {}; |
67 | |
68 | template <typename...> struct conjunction : std::true_type {}; |
69 | template <typename B1> struct conjunction<B1> : B1 {}; |
70 | template <typename B1, typename... Bn> |
71 | struct conjunction<B1, Bn...> |
72 | : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {}; |
73 | |
74 | //===----------------------------------------------------------------------===// |
75 | // Extra additions to <functional> |
76 | //===----------------------------------------------------------------------===// |
77 | |
78 | template <class Ty> struct identity { |
79 | using argument_type = Ty; |
80 | |
81 | Ty &operator()(Ty &self) const { |
82 | return self; |
83 | } |
84 | const Ty &operator()(const Ty &self) const { |
85 | return self; |
86 | } |
87 | }; |
88 | |
89 | template <class Ty> struct less_ptr { |
90 | bool operator()(const Ty* left, const Ty* right) const { |
91 | return *left < *right; |
92 | } |
93 | }; |
94 | |
95 | template <class Ty> struct greater_ptr { |
96 | bool operator()(const Ty* left, const Ty* right) const { |
97 | return *right < *left; |
98 | } |
99 | }; |
100 | |
101 | /// An efficient, type-erasing, non-owning reference to a callable. This is |
102 | /// intended for use as the type of a function parameter that is not used |
103 | /// after the function in question returns. |
104 | /// |
105 | /// This class does not own the callable, so it is not in general safe to store |
106 | /// a function_ref. |
107 | template<typename Fn> class function_ref; |
108 | |
109 | template<typename Ret, typename ...Params> |
110 | class function_ref<Ret(Params...)> { |
111 | Ret (*callback)(intptr_t callable, Params ...params) = nullptr; |
112 | intptr_t callable; |
113 | |
114 | template<typename Callable> |
115 | static Ret callback_fn(intptr_t callable, Params ...params) { |
116 | return (*reinterpret_cast<Callable*>(callable))( |
117 | std::forward<Params>(params)...); |
118 | } |
119 | |
120 | public: |
121 | function_ref() = default; |
122 | function_ref(std::nullptr_t) {} |
123 | |
124 | template <typename Callable> |
125 | function_ref(Callable &&callable, |
126 | typename std::enable_if< |
127 | !std::is_same<typename std::remove_reference<Callable>::type, |
128 | function_ref>::value>::type * = nullptr) |
129 | : callback(callback_fn<typename std::remove_reference<Callable>::type>), |
130 | callable(reinterpret_cast<intptr_t>(&callable)) {} |
131 | |
132 | Ret operator()(Params ...params) const { |
133 | return callback(callable, std::forward<Params>(params)...); |
134 | } |
135 | |
136 | operator bool() const { return callback; } |
137 | }; |
138 | |
139 | // deleter - Very very very simple method that is used to invoke operator |
140 | // delete on something. It is used like this: |
141 | // |
142 | // for_each(V.begin(), B.end(), deleter<Interval>); |
143 | template <class T> |
144 | inline void deleter(T *Ptr) { |
145 | delete Ptr; |
146 | } |
147 | |
148 | //===----------------------------------------------------------------------===// |
149 | // Extra additions to <iterator> |
150 | //===----------------------------------------------------------------------===// |
151 | |
152 | namespace adl_detail { |
153 | |
154 | using std::begin; |
155 | |
156 | template <typename ContainerTy> |
157 | auto adl_begin(ContainerTy &&container) |
158 | -> decltype(begin(std::forward<ContainerTy>(container))) { |
159 | return begin(std::forward<ContainerTy>(container)); |
160 | } |
161 | |
162 | using std::end; |
163 | |
164 | template <typename ContainerTy> |
165 | auto adl_end(ContainerTy &&container) |
166 | -> decltype(end(std::forward<ContainerTy>(container))) { |
167 | return end(std::forward<ContainerTy>(container)); |
168 | } |
169 | |
170 | using std::swap; |
171 | |
172 | template <typename T> |
173 | void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(), |
174 | std::declval<T>()))) { |
175 | swap(std::forward<T>(lhs), std::forward<T>(rhs)); |
176 | } |
177 | |
178 | } // end namespace adl_detail |
179 | |
180 | template <typename ContainerTy> |
181 | auto adl_begin(ContainerTy &&container) |
182 | -> decltype(adl_detail::adl_begin(std::forward<ContainerTy>(container))) { |
183 | return adl_detail::adl_begin(std::forward<ContainerTy>(container)); |
184 | } |
185 | |
186 | template <typename ContainerTy> |
187 | auto adl_end(ContainerTy &&container) |
188 | -> decltype(adl_detail::adl_end(std::forward<ContainerTy>(container))) { |
189 | return adl_detail::adl_end(std::forward<ContainerTy>(container)); |
190 | } |
191 | |
192 | template <typename T> |
193 | void adl_swap(T &&lhs, T &&rhs) noexcept( |
194 | noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) { |
195 | adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs)); |
196 | } |
197 | |
198 | // mapped_iterator - This is a simple iterator adapter that causes a function to |
199 | // be applied whenever operator* is invoked on the iterator. |
200 | |
201 | template <typename ItTy, typename FuncTy, |
202 | typename FuncReturnTy = |
203 | decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))> |
204 | class mapped_iterator |
205 | : public iterator_adaptor_base< |
206 | mapped_iterator<ItTy, FuncTy>, ItTy, |
207 | typename std::iterator_traits<ItTy>::iterator_category, |
208 | typename std::remove_reference<FuncReturnTy>::type> { |
209 | public: |
210 | mapped_iterator(ItTy U, FuncTy F) |
211 | : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {} |
212 | |
213 | ItTy getCurrent() { return this->I; } |
214 | |
215 | FuncReturnTy operator*() { return F(*this->I); } |
216 | |
217 | private: |
218 | FuncTy F; |
219 | }; |
220 | |
221 | // map_iterator - Provide a convenient way to create mapped_iterators, just like |
222 | // make_pair is useful for creating pairs... |
223 | template <class ItTy, class FuncTy> |
224 | inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) { |
225 | return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F)); |
226 | } |
227 | |
228 | /// Helper to determine if type T has a member called rbegin(). |
229 | template <typename Ty> class has_rbegin_impl { |
230 | using yes = char[1]; |
231 | using no = char[2]; |
232 | |
233 | template <typename Inner> |
234 | static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr); |
235 | |
236 | template <typename> |
237 | static no& test(...); |
238 | |
239 | public: |
240 | static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes); |
241 | }; |
242 | |
243 | /// Metafunction to determine if T& or T has a member called rbegin(). |
244 | template <typename Ty> |
245 | struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> { |
246 | }; |
247 | |
248 | // Returns an iterator_range over the given container which iterates in reverse. |
249 | // Note that the container must have rbegin()/rend() methods for this to work. |
250 | template <typename ContainerTy> |
251 | auto reverse(ContainerTy &&C, |
252 | typename std::enable_if<has_rbegin<ContainerTy>::value>::type * = |
253 | nullptr) -> decltype(make_range(C.rbegin(), C.rend())) { |
254 | return make_range(C.rbegin(), C.rend()); |
255 | } |
256 | |
257 | // Returns a std::reverse_iterator wrapped around the given iterator. |
258 | template <typename IteratorTy> |
259 | std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) { |
260 | return std::reverse_iterator<IteratorTy>(It); |
261 | } |
262 | |
263 | // Returns an iterator_range over the given container which iterates in reverse. |
264 | // Note that the container must have begin()/end() methods which return |
265 | // bidirectional iterators for this to work. |
266 | template <typename ContainerTy> |
267 | auto reverse( |
268 | ContainerTy &&C, |
269 | typename std::enable_if<!has_rbegin<ContainerTy>::value>::type * = nullptr) |
270 | -> decltype(make_range(llvm::make_reverse_iterator(std::end(C)), |
271 | llvm::make_reverse_iterator(std::begin(C)))) { |
272 | return make_range(llvm::make_reverse_iterator(std::end(C)), |
273 | llvm::make_reverse_iterator(std::begin(C))); |
274 | } |
275 | |
276 | /// An iterator adaptor that filters the elements of given inner iterators. |
277 | /// |
278 | /// The predicate parameter should be a callable object that accepts the wrapped |
279 | /// iterator's reference type and returns a bool. When incrementing or |
280 | /// decrementing the iterator, it will call the predicate on each element and |
281 | /// skip any where it returns false. |
282 | /// |
283 | /// \code |
284 | /// int A[] = { 1, 2, 3, 4 }; |
285 | /// auto R = make_filter_range(A, [](int N) { return N % 2 == 1; }); |
286 | /// // R contains { 1, 3 }. |
287 | /// \endcode |
288 | /// |
289 | /// Note: filter_iterator_base implements support for forward iteration. |
290 | /// filter_iterator_impl exists to provide support for bidirectional iteration, |
291 | /// conditional on whether the wrapped iterator supports it. |
292 | template <typename WrappedIteratorT, typename PredicateT, typename IterTag> |
293 | class filter_iterator_base |
294 | : public iterator_adaptor_base< |
295 | filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, |
296 | WrappedIteratorT, |
297 | typename std::common_type< |
298 | IterTag, typename std::iterator_traits< |
299 | WrappedIteratorT>::iterator_category>::type> { |
300 | using BaseT = iterator_adaptor_base< |
301 | filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, |
302 | WrappedIteratorT, |
303 | typename std::common_type< |
304 | IterTag, typename std::iterator_traits< |
305 | WrappedIteratorT>::iterator_category>::type>; |
306 | |
307 | protected: |
308 | WrappedIteratorT End; |
309 | PredicateT Pred; |
310 | |
311 | void findNextValid() { |
312 | while (this->I != End && !Pred(*this->I)) |
313 | BaseT::operator++(); |
314 | } |
315 | |
316 | // Construct the iterator. The begin iterator needs to know where the end |
317 | // is, so that it can properly stop when it gets there. The end iterator only |
318 | // needs the predicate to support bidirectional iteration. |
319 | filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End, |
320 | PredicateT Pred) |
321 | : BaseT(Begin), End(End), Pred(Pred) { |
322 | findNextValid(); |
323 | } |
324 | |
325 | public: |
326 | using BaseT::operator++; |
327 | |
328 | filter_iterator_base &operator++() { |
329 | BaseT::operator++(); |
330 | findNextValid(); |
331 | return *this; |
332 | } |
333 | }; |
334 | |
335 | /// Specialization of filter_iterator_base for forward iteration only. |
336 | template <typename WrappedIteratorT, typename PredicateT, |
337 | typename IterTag = std::forward_iterator_tag> |
338 | class filter_iterator_impl |
339 | : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> { |
340 | using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>; |
341 | |
342 | public: |
343 | filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, |
344 | PredicateT Pred) |
345 | : BaseT(Begin, End, Pred) {} |
346 | }; |
347 | |
348 | /// Specialization of filter_iterator_base for bidirectional iteration. |
349 | template <typename WrappedIteratorT, typename PredicateT> |
350 | class filter_iterator_impl<WrappedIteratorT, PredicateT, |
351 | std::bidirectional_iterator_tag> |
352 | : public filter_iterator_base<WrappedIteratorT, PredicateT, |
353 | std::bidirectional_iterator_tag> { |
354 | using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, |
355 | std::bidirectional_iterator_tag>; |
356 | void findPrevValid() { |
357 | while (!this->Pred(*this->I)) |
358 | BaseT::operator--(); |
359 | } |
360 | |
361 | public: |
362 | using BaseT::operator--; |
363 | |
364 | filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, |
365 | PredicateT Pred) |
366 | : BaseT(Begin, End, Pred) {} |
367 | |
368 | filter_iterator_impl &operator--() { |
369 | BaseT::operator--(); |
370 | findPrevValid(); |
371 | return *this; |
372 | } |
373 | }; |
374 | |
375 | namespace detail { |
376 | |
377 | template <bool is_bidirectional> struct fwd_or_bidi_tag_impl { |
378 | using type = std::forward_iterator_tag; |
379 | }; |
380 | |
381 | template <> struct fwd_or_bidi_tag_impl<true> { |
382 | using type = std::bidirectional_iterator_tag; |
383 | }; |
384 | |
385 | /// Helper which sets its type member to forward_iterator_tag if the category |
386 | /// of \p IterT does not derive from bidirectional_iterator_tag, and to |
387 | /// bidirectional_iterator_tag otherwise. |
388 | template <typename IterT> struct fwd_or_bidi_tag { |
389 | using type = typename fwd_or_bidi_tag_impl<std::is_base_of< |
390 | std::bidirectional_iterator_tag, |
391 | typename std::iterator_traits<IterT>::iterator_category>::value>::type; |
392 | }; |
393 | |
394 | } // namespace detail |
395 | |
396 | /// Defines filter_iterator to a suitable specialization of |
397 | /// filter_iterator_impl, based on the underlying iterator's category. |
398 | template <typename WrappedIteratorT, typename PredicateT> |
399 | using filter_iterator = filter_iterator_impl< |
400 | WrappedIteratorT, PredicateT, |
401 | typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>; |
402 | |
403 | /// Convenience function that takes a range of elements and a predicate, |
404 | /// and return a new filter_iterator range. |
405 | /// |
406 | /// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the |
407 | /// lifetime of that temporary is not kept by the returned range object, and the |
408 | /// temporary is going to be dropped on the floor after the make_iterator_range |
409 | /// full expression that contains this function call. |
410 | template <typename RangeT, typename PredicateT> |
411 | iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>> |
412 | make_filter_range(RangeT &&Range, PredicateT Pred) { |
413 | using FilterIteratorT = |
414 | filter_iterator<detail::IterOfRange<RangeT>, PredicateT>; |
415 | return make_range( |
416 | FilterIteratorT(std::begin(std::forward<RangeT>(Range)), |
417 | std::end(std::forward<RangeT>(Range)), Pred), |
418 | FilterIteratorT(std::end(std::forward<RangeT>(Range)), |
419 | std::end(std::forward<RangeT>(Range)), Pred)); |
420 | } |
421 | |
422 | /// A pseudo-iterator adaptor that is designed to implement "early increment" |
423 | /// style loops. |
424 | /// |
425 | /// This is *not a normal iterator* and should almost never be used directly. It |
426 | /// is intended primarily to be used with range based for loops and some range |
427 | /// algorithms. |
428 | /// |
429 | /// The iterator isn't quite an `OutputIterator` or an `InputIterator` but |
430 | /// somewhere between them. The constraints of these iterators are: |
431 | /// |
432 | /// - On construction or after being incremented, it is comparable and |
433 | /// dereferencable. It is *not* incrementable. |
434 | /// - After being dereferenced, it is neither comparable nor dereferencable, it |
435 | /// is only incrementable. |
436 | /// |
437 | /// This means you can only dereference the iterator once, and you can only |
438 | /// increment it once between dereferences. |
439 | template <typename WrappedIteratorT> |
440 | class early_inc_iterator_impl |
441 | : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, |
442 | WrappedIteratorT, std::input_iterator_tag> { |
443 | using BaseT = |
444 | iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, |
445 | WrappedIteratorT, std::input_iterator_tag>; |
446 | |
447 | using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer; |
448 | |
449 | protected: |
450 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
451 | bool IsEarlyIncremented = false; |
452 | #endif |
453 | |
454 | public: |
455 | early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {} |
456 | |
457 | using BaseT::operator*; |
458 | typename BaseT::reference operator*() { |
459 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
460 | assert(!IsEarlyIncremented && "Cannot dereference twice!")((!IsEarlyIncremented && "Cannot dereference twice!") ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot dereference twice!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 460, __PRETTY_FUNCTION__)); |
461 | IsEarlyIncremented = true; |
462 | #endif |
463 | return *(this->I)++; |
464 | } |
465 | |
466 | using BaseT::operator++; |
467 | early_inc_iterator_impl &operator++() { |
468 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
469 | assert(IsEarlyIncremented && "Cannot increment before dereferencing!")((IsEarlyIncremented && "Cannot increment before dereferencing!" ) ? static_cast<void> (0) : __assert_fail ("IsEarlyIncremented && \"Cannot increment before dereferencing!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 469, __PRETTY_FUNCTION__)); |
470 | IsEarlyIncremented = false; |
471 | #endif |
472 | return *this; |
473 | } |
474 | |
475 | using BaseT::operator==; |
476 | bool operator==(const early_inc_iterator_impl &RHS) const { |
477 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
478 | assert(!IsEarlyIncremented && "Cannot compare after dereferencing!")((!IsEarlyIncremented && "Cannot compare after dereferencing!" ) ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot compare after dereferencing!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 478, __PRETTY_FUNCTION__)); |
479 | #endif |
480 | return BaseT::operator==(RHS); |
481 | } |
482 | }; |
483 | |
484 | /// Make a range that does early increment to allow mutation of the underlying |
485 | /// range without disrupting iteration. |
486 | /// |
487 | /// The underlying iterator will be incremented immediately after it is |
488 | /// dereferenced, allowing deletion of the current node or insertion of nodes to |
489 | /// not disrupt iteration provided they do not invalidate the *next* iterator -- |
490 | /// the current iterator can be invalidated. |
491 | /// |
492 | /// This requires a very exact pattern of use that is only really suitable to |
493 | /// range based for loops and other range algorithms that explicitly guarantee |
494 | /// to dereference exactly once each element, and to increment exactly once each |
495 | /// element. |
496 | template <typename RangeT> |
497 | iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>> |
498 | make_early_inc_range(RangeT &&Range) { |
499 | using EarlyIncIteratorT = |
500 | early_inc_iterator_impl<detail::IterOfRange<RangeT>>; |
501 | return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))), |
502 | EarlyIncIteratorT(std::end(std::forward<RangeT>(Range)))); |
503 | } |
504 | |
505 | // forward declarations required by zip_shortest/zip_first |
506 | template <typename R, typename UnaryPredicate> |
507 | bool all_of(R &&range, UnaryPredicate P); |
508 | |
509 | template <size_t... I> struct index_sequence; |
510 | |
511 | template <class... Ts> struct index_sequence_for; |
512 | |
513 | namespace detail { |
514 | |
515 | using std::declval; |
516 | |
517 | // We have to alias this since inlining the actual type at the usage site |
518 | // in the parameter list of iterator_facade_base<> below ICEs MSVC 2017. |
519 | template<typename... Iters> struct ZipTupleType { |
520 | using type = std::tuple<decltype(*declval<Iters>())...>; |
521 | }; |
522 | |
523 | template <typename ZipType, typename... Iters> |
524 | using zip_traits = iterator_facade_base< |
525 | ZipType, typename std::common_type<std::bidirectional_iterator_tag, |
526 | typename std::iterator_traits< |
527 | Iters>::iterator_category...>::type, |
528 | // ^ TODO: Implement random access methods. |
529 | typename ZipTupleType<Iters...>::type, |
530 | typename std::iterator_traits<typename std::tuple_element< |
531 | 0, std::tuple<Iters...>>::type>::difference_type, |
532 | // ^ FIXME: This follows boost::make_zip_iterator's assumption that all |
533 | // inner iterators have the same difference_type. It would fail if, for |
534 | // instance, the second field's difference_type were non-numeric while the |
535 | // first is. |
536 | typename ZipTupleType<Iters...>::type *, |
537 | typename ZipTupleType<Iters...>::type>; |
538 | |
539 | template <typename ZipType, typename... Iters> |
540 | struct zip_common : public zip_traits<ZipType, Iters...> { |
541 | using Base = zip_traits<ZipType, Iters...>; |
542 | using value_type = typename Base::value_type; |
543 | |
544 | std::tuple<Iters...> iterators; |
545 | |
546 | protected: |
547 | template <size_t... Ns> value_type deref(index_sequence<Ns...>) const { |
548 | return value_type(*std::get<Ns>(iterators)...); |
549 | } |
550 | |
551 | template <size_t... Ns> |
552 | decltype(iterators) tup_inc(index_sequence<Ns...>) const { |
553 | return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...); |
554 | } |
555 | |
556 | template <size_t... Ns> |
557 | decltype(iterators) tup_dec(index_sequence<Ns...>) const { |
558 | return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...); |
559 | } |
560 | |
561 | public: |
562 | zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {} |
563 | |
564 | value_type operator*() { return deref(index_sequence_for<Iters...>{}); } |
565 | |
566 | const value_type operator*() const { |
567 | return deref(index_sequence_for<Iters...>{}); |
568 | } |
569 | |
570 | ZipType &operator++() { |
571 | iterators = tup_inc(index_sequence_for<Iters...>{}); |
572 | return *reinterpret_cast<ZipType *>(this); |
573 | } |
574 | |
575 | ZipType &operator--() { |
576 | static_assert(Base::IsBidirectional, |
577 | "All inner iterators must be at least bidirectional."); |
578 | iterators = tup_dec(index_sequence_for<Iters...>{}); |
579 | return *reinterpret_cast<ZipType *>(this); |
580 | } |
581 | }; |
582 | |
583 | template <typename... Iters> |
584 | struct zip_first : public zip_common<zip_first<Iters...>, Iters...> { |
585 | using Base = zip_common<zip_first<Iters...>, Iters...>; |
586 | |
587 | bool operator==(const zip_first<Iters...> &other) const { |
588 | return std::get<0>(this->iterators) == std::get<0>(other.iterators); |
589 | } |
590 | |
591 | zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} |
592 | }; |
593 | |
594 | template <typename... Iters> |
595 | class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> { |
596 | template <size_t... Ns> |
597 | bool test(const zip_shortest<Iters...> &other, index_sequence<Ns...>) const { |
598 | return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) != |
599 | std::get<Ns>(other.iterators)...}, |
600 | identity<bool>{}); |
601 | } |
602 | |
603 | public: |
604 | using Base = zip_common<zip_shortest<Iters...>, Iters...>; |
605 | |
606 | zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} |
607 | |
608 | bool operator==(const zip_shortest<Iters...> &other) const { |
609 | return !test(other, index_sequence_for<Iters...>{}); |
610 | } |
611 | }; |
612 | |
613 | template <template <typename...> class ItType, typename... Args> class zippy { |
614 | public: |
615 | using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>; |
616 | using iterator_category = typename iterator::iterator_category; |
617 | using value_type = typename iterator::value_type; |
618 | using difference_type = typename iterator::difference_type; |
619 | using pointer = typename iterator::pointer; |
620 | using reference = typename iterator::reference; |
621 | |
622 | private: |
623 | std::tuple<Args...> ts; |
624 | |
625 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const { |
626 | return iterator(std::begin(std::get<Ns>(ts))...); |
627 | } |
628 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const { |
629 | return iterator(std::end(std::get<Ns>(ts))...); |
630 | } |
631 | |
632 | public: |
633 | zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {} |
634 | |
635 | iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); } |
636 | iterator end() const { return end_impl(index_sequence_for<Args...>{}); } |
637 | }; |
638 | |
639 | } // end namespace detail |
640 | |
641 | /// zip iterator for two or more iteratable types. |
642 | template <typename T, typename U, typename... Args> |
643 | detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u, |
644 | Args &&... args) { |
645 | return detail::zippy<detail::zip_shortest, T, U, Args...>( |
646 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
647 | } |
648 | |
649 | /// zip iterator that, for the sake of efficiency, assumes the first iteratee to |
650 | /// be the shortest. |
651 | template <typename T, typename U, typename... Args> |
652 | detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u, |
653 | Args &&... args) { |
654 | return detail::zippy<detail::zip_first, T, U, Args...>( |
655 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
656 | } |
657 | |
658 | /// Iterator wrapper that concatenates sequences together. |
659 | /// |
660 | /// This can concatenate different iterators, even with different types, into |
661 | /// a single iterator provided the value types of all the concatenated |
662 | /// iterators expose `reference` and `pointer` types that can be converted to |
663 | /// `ValueT &` and `ValueT *` respectively. It doesn't support more |
664 | /// interesting/customized pointer or reference types. |
665 | /// |
666 | /// Currently this only supports forward or higher iterator categories as |
667 | /// inputs and always exposes a forward iterator interface. |
668 | template <typename ValueT, typename... IterTs> |
669 | class concat_iterator |
670 | : public iterator_facade_base<concat_iterator<ValueT, IterTs...>, |
671 | std::forward_iterator_tag, ValueT> { |
672 | using BaseT = typename concat_iterator::iterator_facade_base; |
673 | |
674 | /// We store both the current and end iterators for each concatenated |
675 | /// sequence in a tuple of pairs. |
676 | /// |
677 | /// Note that something like iterator_range seems nice at first here, but the |
678 | /// range properties are of little benefit and end up getting in the way |
679 | /// because we need to do mutation on the current iterators. |
680 | std::tuple<IterTs...> Begins; |
681 | std::tuple<IterTs...> Ends; |
682 | |
683 | /// Attempts to increment a specific iterator. |
684 | /// |
685 | /// Returns true if it was able to increment the iterator. Returns false if |
686 | /// the iterator is already at the end iterator. |
687 | template <size_t Index> bool incrementHelper() { |
688 | auto &Begin = std::get<Index>(Begins); |
689 | auto &End = std::get<Index>(Ends); |
690 | if (Begin == End) |
691 | return false; |
692 | |
693 | ++Begin; |
694 | return true; |
695 | } |
696 | |
697 | /// Increments the first non-end iterator. |
698 | /// |
699 | /// It is an error to call this with all iterators at the end. |
700 | template <size_t... Ns> void increment(index_sequence<Ns...>) { |
701 | // Build a sequence of functions to increment each iterator if possible. |
702 | bool (concat_iterator::*IncrementHelperFns[])() = { |
703 | &concat_iterator::incrementHelper<Ns>...}; |
704 | |
705 | // Loop over them, and stop as soon as we succeed at incrementing one. |
706 | for (auto &IncrementHelperFn : IncrementHelperFns) |
707 | if ((this->*IncrementHelperFn)()) |
708 | return; |
709 | |
710 | llvm_unreachable("Attempted to increment an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to increment an end concat iterator!" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 710); |
711 | } |
712 | |
713 | /// Returns null if the specified iterator is at the end. Otherwise, |
714 | /// dereferences the iterator and returns the address of the resulting |
715 | /// reference. |
716 | template <size_t Index> ValueT *getHelper() const { |
717 | auto &Begin = std::get<Index>(Begins); |
718 | auto &End = std::get<Index>(Ends); |
719 | if (Begin == End) |
720 | return nullptr; |
721 | |
722 | return &*Begin; |
723 | } |
724 | |
725 | /// Finds the first non-end iterator, dereferences, and returns the resulting |
726 | /// reference. |
727 | /// |
728 | /// It is an error to call this with all iterators at the end. |
729 | template <size_t... Ns> ValueT &get(index_sequence<Ns...>) const { |
730 | // Build a sequence of functions to get from iterator if possible. |
731 | ValueT *(concat_iterator::*GetHelperFns[])() const = { |
732 | &concat_iterator::getHelper<Ns>...}; |
733 | |
734 | // Loop over them, and return the first result we find. |
735 | for (auto &GetHelperFn : GetHelperFns) |
736 | if (ValueT *P = (this->*GetHelperFn)()) |
737 | return *P; |
738 | |
739 | llvm_unreachable("Attempted to get a pointer from an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to get a pointer from an end concat iterator!" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 739); |
740 | } |
741 | |
742 | public: |
743 | /// Constructs an iterator from a squence of ranges. |
744 | /// |
745 | /// We need the full range to know how to switch between each of the |
746 | /// iterators. |
747 | template <typename... RangeTs> |
748 | explicit concat_iterator(RangeTs &&... Ranges) |
749 | : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {} |
750 | |
751 | using BaseT::operator++; |
752 | |
753 | concat_iterator &operator++() { |
754 | increment(index_sequence_for<IterTs...>()); |
755 | return *this; |
756 | } |
757 | |
758 | ValueT &operator*() const { return get(index_sequence_for<IterTs...>()); } |
759 | |
760 | bool operator==(const concat_iterator &RHS) const { |
761 | return Begins == RHS.Begins && Ends == RHS.Ends; |
762 | } |
763 | }; |
764 | |
765 | namespace detail { |
766 | |
767 | /// Helper to store a sequence of ranges being concatenated and access them. |
768 | /// |
769 | /// This is designed to facilitate providing actual storage when temporaries |
770 | /// are passed into the constructor such that we can use it as part of range |
771 | /// based for loops. |
772 | template <typename ValueT, typename... RangeTs> class concat_range { |
773 | public: |
774 | using iterator = |
775 | concat_iterator<ValueT, |
776 | decltype(std::begin(std::declval<RangeTs &>()))...>; |
777 | |
778 | private: |
779 | std::tuple<RangeTs...> Ranges; |
780 | |
781 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) { |
782 | return iterator(std::get<Ns>(Ranges)...); |
783 | } |
784 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) { |
785 | return iterator(make_range(std::end(std::get<Ns>(Ranges)), |
786 | std::end(std::get<Ns>(Ranges)))...); |
787 | } |
788 | |
789 | public: |
790 | concat_range(RangeTs &&... Ranges) |
791 | : Ranges(std::forward<RangeTs>(Ranges)...) {} |
792 | |
793 | iterator begin() { return begin_impl(index_sequence_for<RangeTs...>{}); } |
794 | iterator end() { return end_impl(index_sequence_for<RangeTs...>{}); } |
795 | }; |
796 | |
797 | } // end namespace detail |
798 | |
799 | /// Concatenated range across two or more ranges. |
800 | /// |
801 | /// The desired value type must be explicitly specified. |
802 | template <typename ValueT, typename... RangeTs> |
803 | detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) { |
804 | static_assert(sizeof...(RangeTs) > 1, |
805 | "Need more than one range to concatenate!"); |
806 | return detail::concat_range<ValueT, RangeTs...>( |
807 | std::forward<RangeTs>(Ranges)...); |
808 | } |
809 | |
810 | //===----------------------------------------------------------------------===// |
811 | // Extra additions to <utility> |
812 | //===----------------------------------------------------------------------===// |
813 | |
814 | /// Function object to check whether the first component of a std::pair |
815 | /// compares less than the first component of another std::pair. |
816 | struct less_first { |
817 | template <typename T> bool operator()(const T &lhs, const T &rhs) const { |
818 | return lhs.first < rhs.first; |
819 | } |
820 | }; |
821 | |
822 | /// Function object to check whether the second component of a std::pair |
823 | /// compares less than the second component of another std::pair. |
824 | struct less_second { |
825 | template <typename T> bool operator()(const T &lhs, const T &rhs) const { |
826 | return lhs.second < rhs.second; |
827 | } |
828 | }; |
829 | |
830 | /// \brief Function object to apply a binary function to the first component of |
831 | /// a std::pair. |
832 | template<typename FuncTy> |
833 | struct on_first { |
834 | FuncTy func; |
835 | |
836 | template <typename T> |
837 | auto operator()(const T &lhs, const T &rhs) const |
838 | -> decltype(func(lhs.first, rhs.first)) { |
839 | return func(lhs.first, rhs.first); |
840 | } |
841 | }; |
842 | |
843 | // A subset of N3658. More stuff can be added as-needed. |
844 | |
845 | /// Represents a compile-time sequence of integers. |
846 | template <class T, T... I> struct integer_sequence { |
847 | using value_type = T; |
848 | |
849 | static constexpr size_t size() { return sizeof...(I); } |
850 | }; |
851 | |
852 | /// Alias for the common case of a sequence of size_ts. |
853 | template <size_t... I> |
854 | struct index_sequence : integer_sequence<std::size_t, I...> {}; |
855 | |
856 | template <std::size_t N, std::size_t... I> |
857 | struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {}; |
858 | template <std::size_t... I> |
859 | struct build_index_impl<0, I...> : index_sequence<I...> {}; |
860 | |
861 | /// Creates a compile-time integer sequence for a parameter pack. |
862 | template <class... Ts> |
863 | struct index_sequence_for : build_index_impl<sizeof...(Ts)> {}; |
864 | |
865 | /// Utility type to build an inheritance chain that makes it easy to rank |
866 | /// overload candidates. |
867 | template <int N> struct rank : rank<N - 1> {}; |
868 | template <> struct rank<0> {}; |
869 | |
870 | /// traits class for checking whether type T is one of any of the given |
871 | /// types in the variadic list. |
872 | template <typename T, typename... Ts> struct is_one_of { |
873 | static const bool value = false; |
874 | }; |
875 | |
876 | template <typename T, typename U, typename... Ts> |
877 | struct is_one_of<T, U, Ts...> { |
878 | static const bool value = |
879 | std::is_same<T, U>::value || is_one_of<T, Ts...>::value; |
880 | }; |
881 | |
882 | /// traits class for checking whether type T is a base class for all |
883 | /// the given types in the variadic list. |
884 | template <typename T, typename... Ts> struct are_base_of { |
885 | static const bool value = true; |
886 | }; |
887 | |
888 | template <typename T, typename U, typename... Ts> |
889 | struct are_base_of<T, U, Ts...> { |
890 | static const bool value = |
891 | std::is_base_of<T, U>::value && are_base_of<T, Ts...>::value; |
892 | }; |
893 | |
894 | //===----------------------------------------------------------------------===// |
895 | // Extra additions for arrays |
896 | //===----------------------------------------------------------------------===// |
897 | |
898 | /// Find the length of an array. |
899 | template <class T, std::size_t N> |
900 | constexpr inline size_t array_lengthof(T (&)[N]) { |
901 | return N; |
902 | } |
903 | |
904 | /// Adapt std::less<T> for array_pod_sort. |
905 | template<typename T> |
906 | inline int array_pod_sort_comparator(const void *P1, const void *P2) { |
907 | if (std::less<T>()(*reinterpret_cast<const T*>(P1), |
908 | *reinterpret_cast<const T*>(P2))) |
909 | return -1; |
910 | if (std::less<T>()(*reinterpret_cast<const T*>(P2), |
911 | *reinterpret_cast<const T*>(P1))) |
912 | return 1; |
913 | return 0; |
914 | } |
915 | |
916 | /// get_array_pod_sort_comparator - This is an internal helper function used to |
917 | /// get type deduction of T right. |
918 | template<typename T> |
919 | inline int (*get_array_pod_sort_comparator(const T &)) |
920 | (const void*, const void*) { |
921 | return array_pod_sort_comparator<T>; |
922 | } |
923 | |
924 | /// array_pod_sort - This sorts an array with the specified start and end |
925 | /// extent. This is just like std::sort, except that it calls qsort instead of |
926 | /// using an inlined template. qsort is slightly slower than std::sort, but |
927 | /// most sorts are not performance critical in LLVM and std::sort has to be |
928 | /// template instantiated for each type, leading to significant measured code |
929 | /// bloat. This function should generally be used instead of std::sort where |
930 | /// possible. |
931 | /// |
932 | /// This function assumes that you have simple POD-like types that can be |
933 | /// compared with std::less and can be moved with memcpy. If this isn't true, |
934 | /// you should use std::sort. |
935 | /// |
936 | /// NOTE: If qsort_r were portable, we could allow a custom comparator and |
937 | /// default to std::less. |
938 | template<class IteratorTy> |
939 | inline void array_pod_sort(IteratorTy Start, IteratorTy End) { |
940 | // Don't inefficiently call qsort with one element or trigger undefined |
941 | // behavior with an empty sequence. |
942 | auto NElts = End - Start; |
943 | if (NElts <= 1) return; |
944 | #ifdef EXPENSIVE_CHECKS |
945 | std::mt19937 Generator(std::random_device{}()); |
946 | std::shuffle(Start, End, Generator); |
947 | #endif |
948 | qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start)); |
949 | } |
950 | |
951 | template <class IteratorTy> |
952 | inline void array_pod_sort( |
953 | IteratorTy Start, IteratorTy End, |
954 | int (*Compare)( |
955 | const typename std::iterator_traits<IteratorTy>::value_type *, |
956 | const typename std::iterator_traits<IteratorTy>::value_type *)) { |
957 | // Don't inefficiently call qsort with one element or trigger undefined |
958 | // behavior with an empty sequence. |
959 | auto NElts = End - Start; |
960 | if (NElts <= 1) return; |
961 | #ifdef EXPENSIVE_CHECKS |
962 | std::mt19937 Generator(std::random_device{}()); |
963 | std::shuffle(Start, End, Generator); |
964 | #endif |
965 | qsort(&*Start, NElts, sizeof(*Start), |
966 | reinterpret_cast<int (*)(const void *, const void *)>(Compare)); |
967 | } |
968 | |
969 | // Provide wrappers to std::sort which shuffle the elements before sorting |
970 | // to help uncover non-deterministic behavior (PR35135). |
971 | template <typename IteratorTy> |
972 | inline void sort(IteratorTy Start, IteratorTy End) { |
973 | #ifdef EXPENSIVE_CHECKS |
974 | std::mt19937 Generator(std::random_device{}()); |
975 | std::shuffle(Start, End, Generator); |
976 | #endif |
977 | std::sort(Start, End); |
978 | } |
979 | |
980 | template <typename Container> inline void sort(Container &&C) { |
981 | llvm::sort(adl_begin(C), adl_end(C)); |
982 | } |
983 | |
984 | template <typename IteratorTy, typename Compare> |
985 | inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) { |
986 | #ifdef EXPENSIVE_CHECKS |
987 | std::mt19937 Generator(std::random_device{}()); |
988 | std::shuffle(Start, End, Generator); |
989 | #endif |
990 | std::sort(Start, End, Comp); |
991 | } |
992 | |
993 | template <typename Container, typename Compare> |
994 | inline void sort(Container &&C, Compare Comp) { |
995 | llvm::sort(adl_begin(C), adl_end(C), Comp); |
996 | } |
997 | |
998 | //===----------------------------------------------------------------------===// |
999 | // Extra additions to <algorithm> |
1000 | //===----------------------------------------------------------------------===// |
1001 | |
1002 | /// For a container of pointers, deletes the pointers and then clears the |
1003 | /// container. |
1004 | template<typename Container> |
1005 | void DeleteContainerPointers(Container &C) { |
1006 | for (auto V : C) |
1007 | delete V; |
1008 | C.clear(); |
1009 | } |
1010 | |
1011 | /// In a container of pairs (usually a map) whose second element is a pointer, |
1012 | /// deletes the second elements and then clears the container. |
1013 | template<typename Container> |
1014 | void DeleteContainerSeconds(Container &C) { |
1015 | for (auto &V : C) |
1016 | delete V.second; |
1017 | C.clear(); |
1018 | } |
1019 | |
1020 | /// Get the size of a range. This is a wrapper function around std::distance |
1021 | /// which is only enabled when the operation is O(1). |
1022 | template <typename R> |
1023 | auto size(R &&Range, typename std::enable_if< |
1024 | std::is_same<typename std::iterator_traits<decltype( |
1025 | Range.begin())>::iterator_category, |
1026 | std::random_access_iterator_tag>::value, |
1027 | void>::type * = nullptr) |
1028 | -> decltype(std::distance(Range.begin(), Range.end())) { |
1029 | return std::distance(Range.begin(), Range.end()); |
1030 | } |
1031 | |
1032 | /// Provide wrappers to std::for_each which take ranges instead of having to |
1033 | /// pass begin/end explicitly. |
1034 | template <typename R, typename UnaryPredicate> |
1035 | UnaryPredicate for_each(R &&Range, UnaryPredicate P) { |
1036 | return std::for_each(adl_begin(Range), adl_end(Range), P); |
1037 | } |
1038 | |
1039 | /// Provide wrappers to std::all_of which take ranges instead of having to pass |
1040 | /// begin/end explicitly. |
1041 | template <typename R, typename UnaryPredicate> |
1042 | bool all_of(R &&Range, UnaryPredicate P) { |
1043 | return std::all_of(adl_begin(Range), adl_end(Range), P); |
1044 | } |
1045 | |
1046 | /// Provide wrappers to std::any_of which take ranges instead of having to pass |
1047 | /// begin/end explicitly. |
1048 | template <typename R, typename UnaryPredicate> |
1049 | bool any_of(R &&Range, UnaryPredicate P) { |
1050 | return std::any_of(adl_begin(Range), adl_end(Range), P); |
1051 | } |
1052 | |
1053 | /// Provide wrappers to std::none_of which take ranges instead of having to pass |
1054 | /// begin/end explicitly. |
1055 | template <typename R, typename UnaryPredicate> |
1056 | bool none_of(R &&Range, UnaryPredicate P) { |
1057 | return std::none_of(adl_begin(Range), adl_end(Range), P); |
1058 | } |
1059 | |
1060 | /// Provide wrappers to std::find which take ranges instead of having to pass |
1061 | /// begin/end explicitly. |
1062 | template <typename R, typename T> |
1063 | auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range)) { |
1064 | return std::find(adl_begin(Range), adl_end(Range), Val); |
1065 | } |
1066 | |
1067 | /// Provide wrappers to std::find_if which take ranges instead of having to pass |
1068 | /// begin/end explicitly. |
1069 | template <typename R, typename UnaryPredicate> |
1070 | auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1071 | return std::find_if(adl_begin(Range), adl_end(Range), P); |
1072 | } |
1073 | |
1074 | template <typename R, typename UnaryPredicate> |
1075 | auto find_if_not(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1076 | return std::find_if_not(adl_begin(Range), adl_end(Range), P); |
1077 | } |
1078 | |
1079 | /// Provide wrappers to std::remove_if which take ranges instead of having to |
1080 | /// pass begin/end explicitly. |
1081 | template <typename R, typename UnaryPredicate> |
1082 | auto remove_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1083 | return std::remove_if(adl_begin(Range), adl_end(Range), P); |
1084 | } |
1085 | |
1086 | /// Provide wrappers to std::copy_if which take ranges instead of having to |
1087 | /// pass begin/end explicitly. |
1088 | template <typename R, typename OutputIt, typename UnaryPredicate> |
1089 | OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) { |
1090 | return std::copy_if(adl_begin(Range), adl_end(Range), Out, P); |
1091 | } |
1092 | |
1093 | template <typename R, typename OutputIt> |
1094 | OutputIt copy(R &&Range, OutputIt Out) { |
1095 | return std::copy(adl_begin(Range), adl_end(Range), Out); |
1096 | } |
1097 | |
1098 | /// Wrapper function around std::find to detect if an element exists |
1099 | /// in a container. |
1100 | template <typename R, typename E> |
1101 | bool is_contained(R &&Range, const E &Element) { |
1102 | return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range); |
1103 | } |
1104 | |
1105 | /// Wrapper function around std::count to count the number of times an element |
1106 | /// \p Element occurs in the given range \p Range. |
1107 | template <typename R, typename E> |
1108 | auto count(R &&Range, const E &Element) -> |
1109 | typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type { |
1110 | return std::count(adl_begin(Range), adl_end(Range), Element); |
1111 | } |
1112 | |
1113 | /// Wrapper function around std::count_if to count the number of times an |
1114 | /// element satisfying a given predicate occurs in a range. |
1115 | template <typename R, typename UnaryPredicate> |
1116 | auto count_if(R &&Range, UnaryPredicate P) -> |
1117 | typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type { |
1118 | return std::count_if(adl_begin(Range), adl_end(Range), P); |
1119 | } |
1120 | |
1121 | /// Wrapper function around std::transform to apply a function to a range and |
1122 | /// store the result elsewhere. |
1123 | template <typename R, typename OutputIt, typename UnaryPredicate> |
1124 | OutputIt transform(R &&Range, OutputIt d_first, UnaryPredicate P) { |
1125 | return std::transform(adl_begin(Range), adl_end(Range), d_first, P); |
1126 | } |
1127 | |
1128 | /// Provide wrappers to std::partition which take ranges instead of having to |
1129 | /// pass begin/end explicitly. |
1130 | template <typename R, typename UnaryPredicate> |
1131 | auto partition(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1132 | return std::partition(adl_begin(Range), adl_end(Range), P); |
1133 | } |
1134 | |
1135 | /// Provide wrappers to std::lower_bound which take ranges instead of having to |
1136 | /// pass begin/end explicitly. |
1137 | template <typename R, typename ForwardIt> |
1138 | auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) { |
1139 | return std::lower_bound(adl_begin(Range), adl_end(Range), I); |
1140 | } |
1141 | |
1142 | template <typename R, typename ForwardIt, typename Compare> |
1143 | auto lower_bound(R &&Range, ForwardIt I, Compare C) |
1144 | -> decltype(adl_begin(Range)) { |
1145 | return std::lower_bound(adl_begin(Range), adl_end(Range), I, C); |
1146 | } |
1147 | |
1148 | /// Provide wrappers to std::upper_bound which take ranges instead of having to |
1149 | /// pass begin/end explicitly. |
1150 | template <typename R, typename ForwardIt> |
1151 | auto upper_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) { |
1152 | return std::upper_bound(adl_begin(Range), adl_end(Range), I); |
1153 | } |
1154 | |
1155 | template <typename R, typename ForwardIt, typename Compare> |
1156 | auto upper_bound(R &&Range, ForwardIt I, Compare C) |
1157 | -> decltype(adl_begin(Range)) { |
1158 | return std::upper_bound(adl_begin(Range), adl_end(Range), I, C); |
1159 | } |
1160 | /// Wrapper function around std::equal to detect if all elements |
1161 | /// in a container are same. |
1162 | template <typename R> |
1163 | bool is_splat(R &&Range) { |
1164 | size_t range_size = size(Range); |
1165 | return range_size != 0 && (range_size == 1 || |
1166 | std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range))); |
1167 | } |
1168 | |
1169 | /// Given a range of type R, iterate the entire range and return a |
1170 | /// SmallVector with elements of the vector. This is useful, for example, |
1171 | /// when you want to iterate a range and then sort the results. |
1172 | template <unsigned Size, typename R> |
1173 | SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size> |
1174 | to_vector(R &&Range) { |
1175 | return {adl_begin(Range), adl_end(Range)}; |
1176 | } |
1177 | |
1178 | /// Provide a container algorithm similar to C++ Library Fundamentals v2's |
1179 | /// `erase_if` which is equivalent to: |
1180 | /// |
1181 | /// C.erase(remove_if(C, pred), C.end()); |
1182 | /// |
1183 | /// This version works for any container with an erase method call accepting |
1184 | /// two iterators. |
1185 | template <typename Container, typename UnaryPredicate> |
1186 | void erase_if(Container &C, UnaryPredicate P) { |
1187 | C.erase(remove_if(C, P), C.end()); |
1188 | } |
1189 | |
1190 | //===----------------------------------------------------------------------===// |
1191 | // Extra additions to <memory> |
1192 | //===----------------------------------------------------------------------===// |
1193 | |
1194 | // Implement make_unique according to N3656. |
1195 | |
1196 | /// Constructs a `new T()` with the given args and returns a |
1197 | /// `unique_ptr<T>` which owns the object. |
1198 | /// |
1199 | /// Example: |
1200 | /// |
1201 | /// auto p = make_unique<int>(); |
1202 | /// auto p = make_unique<std::tuple<int, int>>(0, 1); |
1203 | template <class T, class... Args> |
1204 | typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type |
1205 | make_unique(Args &&... args) { |
1206 | return std::unique_ptr<T>(new T(std::forward<Args>(args)...)); |
1207 | } |
1208 | |
1209 | /// Constructs a `new T[n]` with the given args and returns a |
1210 | /// `unique_ptr<T[]>` which owns the object. |
1211 | /// |
1212 | /// \param n size of the new array. |
1213 | /// |
1214 | /// Example: |
1215 | /// |
1216 | /// auto p = make_unique<int[]>(2); // value-initializes the array with 0's. |
1217 | template <class T> |
1218 | typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0, |
1219 | std::unique_ptr<T>>::type |
1220 | make_unique(size_t n) { |
1221 | return std::unique_ptr<T>(new typename std::remove_extent<T>::type[n]()); |
1222 | } |
1223 | |
1224 | /// This function isn't used and is only here to provide better compile errors. |
1225 | template <class T, class... Args> |
1226 | typename std::enable_if<std::extent<T>::value != 0>::type |
1227 | make_unique(Args &&...) = delete; |
1228 | |
1229 | struct FreeDeleter { |
1230 | void operator()(void* v) { |
1231 | ::free(v); |
1232 | } |
1233 | }; |
1234 | |
1235 | template<typename First, typename Second> |
1236 | struct pair_hash { |
1237 | size_t operator()(const std::pair<First, Second> &P) const { |
1238 | return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second); |
1239 | } |
1240 | }; |
1241 | |
1242 | /// A functor like C++14's std::less<void> in its absence. |
1243 | struct less { |
1244 | template <typename A, typename B> bool operator()(A &&a, B &&b) const { |
1245 | return std::forward<A>(a) < std::forward<B>(b); |
1246 | } |
1247 | }; |
1248 | |
1249 | /// A functor like C++14's std::equal<void> in its absence. |
1250 | struct equal { |
1251 | template <typename A, typename B> bool operator()(A &&a, B &&b) const { |
1252 | return std::forward<A>(a) == std::forward<B>(b); |
1253 | } |
1254 | }; |
1255 | |
1256 | /// Binary functor that adapts to any other binary functor after dereferencing |
1257 | /// operands. |
1258 | template <typename T> struct deref { |
1259 | T func; |
1260 | |
1261 | // Could be further improved to cope with non-derivable functors and |
1262 | // non-binary functors (should be a variadic template member function |
1263 | // operator()). |
1264 | template <typename A, typename B> |
1265 | auto operator()(A &lhs, B &rhs) const -> decltype(func(*lhs, *rhs)) { |
1266 | assert(lhs)((lhs) ? static_cast<void> (0) : __assert_fail ("lhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 1266, __PRETTY_FUNCTION__)); |
1267 | assert(rhs)((rhs) ? static_cast<void> (0) : __assert_fail ("rhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 1267, __PRETTY_FUNCTION__)); |
1268 | return func(*lhs, *rhs); |
1269 | } |
1270 | }; |
1271 | |
1272 | namespace detail { |
1273 | |
1274 | template <typename R> class enumerator_iter; |
1275 | |
1276 | template <typename R> struct result_pair { |
1277 | friend class enumerator_iter<R>; |
1278 | |
1279 | result_pair() = default; |
1280 | result_pair(std::size_t Index, IterOfRange<R> Iter) |
1281 | : Index(Index), Iter(Iter) {} |
1282 | |
1283 | result_pair<R> &operator=(const result_pair<R> &Other) { |
1284 | Index = Other.Index; |
1285 | Iter = Other.Iter; |
1286 | return *this; |
1287 | } |
1288 | |
1289 | std::size_t index() const { return Index; } |
1290 | const ValueOfRange<R> &value() const { return *Iter; } |
1291 | ValueOfRange<R> &value() { return *Iter; } |
1292 | |
1293 | private: |
1294 | std::size_t Index = std::numeric_limits<std::size_t>::max(); |
1295 | IterOfRange<R> Iter; |
1296 | }; |
1297 | |
1298 | template <typename R> |
1299 | class enumerator_iter |
1300 | : public iterator_facade_base< |
1301 | enumerator_iter<R>, std::forward_iterator_tag, result_pair<R>, |
1302 | typename std::iterator_traits<IterOfRange<R>>::difference_type, |
1303 | typename std::iterator_traits<IterOfRange<R>>::pointer, |
1304 | typename std::iterator_traits<IterOfRange<R>>::reference> { |
1305 | using result_type = result_pair<R>; |
1306 | |
1307 | public: |
1308 | explicit enumerator_iter(IterOfRange<R> EndIter) |
1309 | : Result(std::numeric_limits<size_t>::max(), EndIter) {} |
1310 | |
1311 | enumerator_iter(std::size_t Index, IterOfRange<R> Iter) |
1312 | : Result(Index, Iter) {} |
1313 | |
1314 | result_type &operator*() { return Result; } |
1315 | const result_type &operator*() const { return Result; } |
1316 | |
1317 | enumerator_iter<R> &operator++() { |
1318 | assert(Result.Index != std::numeric_limits<size_t>::max())((Result.Index != std::numeric_limits<size_t>::max()) ? static_cast<void> (0) : __assert_fail ("Result.Index != std::numeric_limits<size_t>::max()" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 1318, __PRETTY_FUNCTION__)); |
1319 | ++Result.Iter; |
1320 | ++Result.Index; |
1321 | return *this; |
1322 | } |
1323 | |
1324 | bool operator==(const enumerator_iter<R> &RHS) const { |
1325 | // Don't compare indices here, only iterators. It's possible for an end |
1326 | // iterator to have different indices depending on whether it was created |
1327 | // by calling std::end() versus incrementing a valid iterator. |
1328 | return Result.Iter == RHS.Result.Iter; |
1329 | } |
1330 | |
1331 | enumerator_iter<R> &operator=(const enumerator_iter<R> &Other) { |
1332 | Result = Other.Result; |
1333 | return *this; |
1334 | } |
1335 | |
1336 | private: |
1337 | result_type Result; |
1338 | }; |
1339 | |
1340 | template <typename R> class enumerator { |
1341 | public: |
1342 | explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {} |
1343 | |
1344 | enumerator_iter<R> begin() { |
1345 | return enumerator_iter<R>(0, std::begin(TheRange)); |
1346 | } |
1347 | |
1348 | enumerator_iter<R> end() { |
1349 | return enumerator_iter<R>(std::end(TheRange)); |
1350 | } |
1351 | |
1352 | private: |
1353 | R TheRange; |
1354 | }; |
1355 | |
1356 | } // end namespace detail |
1357 | |
1358 | /// Given an input range, returns a new range whose values are are pair (A,B) |
1359 | /// such that A is the 0-based index of the item in the sequence, and B is |
1360 | /// the value from the original sequence. Example: |
1361 | /// |
1362 | /// std::vector<char> Items = {'A', 'B', 'C', 'D'}; |
1363 | /// for (auto X : enumerate(Items)) { |
1364 | /// printf("Item %d - %c\n", X.index(), X.value()); |
1365 | /// } |
1366 | /// |
1367 | /// Output: |
1368 | /// Item 0 - A |
1369 | /// Item 1 - B |
1370 | /// Item 2 - C |
1371 | /// Item 3 - D |
1372 | /// |
1373 | template <typename R> detail::enumerator<R> enumerate(R &&TheRange) { |
1374 | return detail::enumerator<R>(std::forward<R>(TheRange)); |
1375 | } |
1376 | |
1377 | namespace detail { |
1378 | |
1379 | template <typename F, typename Tuple, std::size_t... I> |
1380 | auto apply_tuple_impl(F &&f, Tuple &&t, index_sequence<I...>) |
1381 | -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...)) { |
1382 | return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...); |
1383 | } |
1384 | |
1385 | } // end namespace detail |
1386 | |
1387 | /// Given an input tuple (a1, a2, ..., an), pass the arguments of the |
1388 | /// tuple variadically to f as if by calling f(a1, a2, ..., an) and |
1389 | /// return the result. |
1390 | template <typename F, typename Tuple> |
1391 | auto apply_tuple(F &&f, Tuple &&t) -> decltype(detail::apply_tuple_impl( |
1392 | std::forward<F>(f), std::forward<Tuple>(t), |
1393 | build_index_impl< |
1394 | std::tuple_size<typename std::decay<Tuple>::type>::value>{})) { |
1395 | using Indices = build_index_impl< |
1396 | std::tuple_size<typename std::decay<Tuple>::type>::value>; |
1397 | |
1398 | return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t), |
1399 | Indices{}); |
1400 | } |
1401 | |
1402 | } // end namespace llvm |
1403 | |
1404 | #endif // LLVM_ADT_STLEXTRAS_H |