Bug Summary

File:include/llvm/Support/Error.h
Warning:line 201, column 5
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name MachONormalizedFileFromAtoms.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -mrelocation-model pic -pic-level 2 -mthread-model posix -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-8/lib/clang/8.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/lld/lib/ReaderWriter/MachO -I /build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO -I /build/llvm-toolchain-snapshot-8~svn345461/tools/lld/include -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/lld/include -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/include -I /build/llvm-toolchain-snapshot-8~svn345461/include -I /build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/. -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/8.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-8/lib/clang/8.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/tools/lld/lib/ReaderWriter/MachO -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-10-27-211344-32123-1 -x c++ /build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp -faddrsig

/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp

1//===- lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.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///
11/// \file Converts from in-memory Atoms to in-memory normalized mach-o.
12///
13/// +------------+
14/// | normalized |
15/// +------------+
16/// ^
17/// |
18/// |
19/// +-------+
20/// | Atoms |
21/// +-------+
22
23#include "ArchHandler.h"
24#include "DebugInfo.h"
25#include "MachONormalizedFile.h"
26#include "MachONormalizedFileBinaryUtils.h"
27#include "lld/Common/LLVM.h"
28#include "lld/Core/Error.h"
29#include "llvm/ADT/StringRef.h"
30#include "llvm/ADT/StringSwitch.h"
31#include "llvm/BinaryFormat/MachO.h"
32#include "llvm/Support/Casting.h"
33#include "llvm/Support/Debug.h"
34#include "llvm/Support/ErrorHandling.h"
35#include "llvm/Support/Format.h"
36#include <map>
37#include <system_error>
38#include <unordered_set>
39
40using llvm::StringRef;
41using llvm::isa;
42using namespace llvm::MachO;
43using namespace lld::mach_o::normalized;
44using namespace lld;
45
46namespace {
47
48struct AtomInfo {
49 const DefinedAtom *atom;
50 uint64_t offsetInSection;
51};
52
53struct SectionInfo {
54 SectionInfo(StringRef seg, StringRef sect, SectionType type,
55 const MachOLinkingContext &ctxt, uint32_t attr,
56 bool relocsToDefinedCanBeImplicit);
57
58 StringRef segmentName;
59 StringRef sectionName;
60 SectionType type;
61 uint32_t attributes;
62 uint64_t address;
63 uint64_t size;
64 uint16_t alignment;
65
66 /// If this is set, the any relocs in this section which point to defined
67 /// addresses can be implicitly generated. This is the case for the
68 /// __eh_frame section where references to the function can be implicit if the
69 /// function is defined.
70 bool relocsToDefinedCanBeImplicit;
71
72
73 std::vector<AtomInfo> atomsAndOffsets;
74 uint32_t normalizedSectionIndex;
75 uint32_t finalSectionIndex;
76};
77
78SectionInfo::SectionInfo(StringRef sg, StringRef sct, SectionType t,
79 const MachOLinkingContext &ctxt, uint32_t attrs,
80 bool relocsToDefinedCanBeImplicit)
81 : segmentName(sg), sectionName(sct), type(t), attributes(attrs),
82 address(0), size(0), alignment(1),
83 relocsToDefinedCanBeImplicit(relocsToDefinedCanBeImplicit),
84 normalizedSectionIndex(0), finalSectionIndex(0) {
85 uint16_t align = 1;
86 if (ctxt.sectionAligned(segmentName, sectionName, align)) {
87 alignment = align;
88 }
89}
90
91struct SegmentInfo {
92 SegmentInfo(StringRef name);
93
94 StringRef name;
95 uint64_t address;
96 uint64_t size;
97 uint32_t init_access;
98 uint32_t max_access;
99 std::vector<SectionInfo*> sections;
100 uint32_t normalizedSegmentIndex;
101};
102
103SegmentInfo::SegmentInfo(StringRef n)
104 : name(n), address(0), size(0), init_access(0), max_access(0),
105 normalizedSegmentIndex(0) {
106}
107
108class Util {
109public:
110 Util(const MachOLinkingContext &ctxt)
111 : _ctx(ctxt), _archHandler(ctxt.archHandler()), _entryAtom(nullptr),
112 _hasTLVDescriptors(false), _subsectionsViaSymbols(true) {}
113 ~Util();
114
115 void processDefinedAtoms(const lld::File &atomFile);
116 void processAtomAttributes(const DefinedAtom *atom);
117 void assignAtomToSection(const DefinedAtom *atom);
118 void organizeSections();
119 void assignAddressesToSections(const NormalizedFile &file);
120 uint32_t fileFlags();
121 void copySegmentInfo(NormalizedFile &file);
122 void copySectionInfo(NormalizedFile &file);
123 void updateSectionInfo(NormalizedFile &file);
124 void buildAtomToAddressMap();
125 llvm::Error synthesizeDebugNotes(NormalizedFile &file);
126 llvm::Error addSymbols(const lld::File &atomFile, NormalizedFile &file);
127 void addIndirectSymbols(const lld::File &atomFile, NormalizedFile &file);
128 void addRebaseAndBindingInfo(const lld::File &, NormalizedFile &file);
129 void addExportInfo(const lld::File &, NormalizedFile &file);
130 void addSectionRelocs(const lld::File &, NormalizedFile &file);
131 void addFunctionStarts(const lld::File &, NormalizedFile &file);
132 void buildDataInCodeArray(const lld::File &, NormalizedFile &file);
133 void addDependentDylibs(const lld::File &, NormalizedFile &file);
134 void copyEntryPointAddress(NormalizedFile &file);
135 void copySectionContent(NormalizedFile &file);
136
137 bool allSourceFilesHaveMinVersions() const {
138 return _allSourceFilesHaveMinVersions;
139 }
140
141 uint32_t minVersion() const {
142 return _minVersion;
143 }
144
145 LoadCommandType minVersionCommandType() const {
146 return _minVersionCommandType;
147 }
148
149private:
150 typedef std::map<DefinedAtom::ContentType, SectionInfo*> TypeToSection;
151 typedef llvm::DenseMap<const Atom*, uint64_t> AtomToAddress;
152
153 struct DylibInfo { int ordinal; bool hasWeak; bool hasNonWeak; };
154 typedef llvm::StringMap<DylibInfo> DylibPathToInfo;
155
156 SectionInfo *sectionForAtom(const DefinedAtom*);
157 SectionInfo *getRelocatableSection(DefinedAtom::ContentType type);
158 SectionInfo *getFinalSection(DefinedAtom::ContentType type);
159 void appendAtom(SectionInfo *sect, const DefinedAtom *atom);
160 SegmentInfo *segmentForName(StringRef segName);
161 void layoutSectionsInSegment(SegmentInfo *seg, uint64_t &addr);
162 void layoutSectionsInTextSegment(size_t, SegmentInfo *, uint64_t &);
163 void copySectionContent(SectionInfo *si, ContentBytes &content);
164 uint16_t descBits(const DefinedAtom* atom);
165 int dylibOrdinal(const SharedLibraryAtom *sa);
166 void segIndexForSection(const SectionInfo *sect,
167 uint8_t &segmentIndex, uint64_t &segmentStartAddr);
168 const Atom *targetOfLazyPointer(const DefinedAtom *lpAtom);
169 const Atom *targetOfStub(const DefinedAtom *stubAtom);
170 llvm::Error getSymbolTableRegion(const DefinedAtom* atom,
171 bool &inGlobalsRegion,
172 SymbolScope &symbolScope);
173 void appendSection(SectionInfo *si, NormalizedFile &file);
174 uint32_t sectionIndexForAtom(const Atom *atom);
175 void fixLazyReferenceImm(const DefinedAtom *atom, uint32_t offset,
176 NormalizedFile &file);
177
178 typedef llvm::DenseMap<const Atom*, uint32_t> AtomToIndex;
179 struct AtomAndIndex { const Atom *atom; uint32_t index; SymbolScope scope; };
180 struct AtomSorter {
181 bool operator()(const AtomAndIndex &left, const AtomAndIndex &right);
182 };
183 struct SegmentSorter {
184 bool operator()(const SegmentInfo *left, const SegmentInfo *right);
185 static unsigned weight(const SegmentInfo *);
186 };
187 struct TextSectionSorter {
188 bool operator()(const SectionInfo *left, const SectionInfo *right);
189 static unsigned weight(const SectionInfo *);
190 };
191
192 const MachOLinkingContext &_ctx;
193 mach_o::ArchHandler &_archHandler;
194 llvm::BumpPtrAllocator _allocator;
195 std::vector<SectionInfo*> _sectionInfos;
196 std::vector<SegmentInfo*> _segmentInfos;
197 TypeToSection _sectionMap;
198 std::vector<SectionInfo*> _customSections;
199 AtomToAddress _atomToAddress;
200 DylibPathToInfo _dylibInfo;
201 const DefinedAtom *_entryAtom;
202 AtomToIndex _atomToSymbolIndex;
203 std::vector<const Atom *> _machHeaderAliasAtoms;
204 bool _hasTLVDescriptors;
205 bool _subsectionsViaSymbols;
206 bool _allSourceFilesHaveMinVersions = true;
207 LoadCommandType _minVersionCommandType = (LoadCommandType)0;
208 uint32_t _minVersion = 0;
209 std::vector<lld::mach_o::Stab> _stabs;
210};
211
212Util::~Util() {
213 // The SectionInfo structs are BumpPtr allocated, but atomsAndOffsets needs
214 // to be deleted.
215 for (SectionInfo *si : _sectionInfos) {
216 // clear() destroys vector elements, but does not deallocate.
217 // Instead use swap() to deallocate vector buffer.
218 std::vector<AtomInfo> empty;
219 si->atomsAndOffsets.swap(empty);
220 }
221 // The SegmentInfo structs are BumpPtr allocated, but sections needs
222 // to be deleted.
223 for (SegmentInfo *sgi : _segmentInfos) {
224 std::vector<SectionInfo*> empty2;
225 sgi->sections.swap(empty2);
226 }
227}
228
229SectionInfo *Util::getRelocatableSection(DefinedAtom::ContentType type) {
230 StringRef segmentName;
231 StringRef sectionName;
232 SectionType sectionType;
233 SectionAttr sectionAttrs;
234 bool relocsToDefinedCanBeImplicit;
235
236 // Use same table used by when parsing .o files.
237 relocatableSectionInfoForContentType(type, segmentName, sectionName,
238 sectionType, sectionAttrs,
239 relocsToDefinedCanBeImplicit);
240 // If we already have a SectionInfo with this name, re-use it.
241 // This can happen if two ContentType map to the same mach-o section.
242 for (auto sect : _sectionMap) {
243 if (sect.second->sectionName.equals(sectionName) &&
244 sect.second->segmentName.equals(segmentName)) {
245 return sect.second;
246 }
247 }
248 // Otherwise allocate new SectionInfo object.
249 auto *sect = new (_allocator)
250 SectionInfo(segmentName, sectionName, sectionType, _ctx, sectionAttrs,
251 relocsToDefinedCanBeImplicit);
252 _sectionInfos.push_back(sect);
253 _sectionMap[type] = sect;
254 return sect;
255}
256
257#define ENTRY(seg, sect, type, atomType) \
258 {seg, sect, type, DefinedAtom::atomType }
259
260struct MachOFinalSectionFromAtomType {
261 StringRef segmentName;
262 StringRef sectionName;
263 SectionType sectionType;
264 DefinedAtom::ContentType atomType;
265};
266
267const MachOFinalSectionFromAtomType sectsToAtomType[] = {
268 ENTRY("__TEXT", "__text", S_REGULAR, typeCode),
269 ENTRY("__TEXT", "__text", S_REGULAR, typeMachHeader),
270 ENTRY("__TEXT", "__cstring", S_CSTRING_LITERALS, typeCString),
271 ENTRY("__TEXT", "__ustring", S_REGULAR, typeUTF16String),
272 ENTRY("__TEXT", "__const", S_REGULAR, typeConstant),
273 ENTRY("__TEXT", "__const", S_4BYTE_LITERALS, typeLiteral4),
274 ENTRY("__TEXT", "__const", S_8BYTE_LITERALS, typeLiteral8),
275 ENTRY("__TEXT", "__const", S_16BYTE_LITERALS, typeLiteral16),
276 ENTRY("__TEXT", "__stubs", S_SYMBOL_STUBS, typeStub),
277 ENTRY("__TEXT", "__stub_helper", S_REGULAR, typeStubHelper),
278 ENTRY("__TEXT", "__gcc_except_tab", S_REGULAR, typeLSDA),
279 ENTRY("__TEXT", "__eh_frame", S_COALESCED, typeCFI),
280 ENTRY("__TEXT", "__unwind_info", S_REGULAR, typeProcessedUnwindInfo),
281 ENTRY("__DATA", "__data", S_REGULAR, typeData),
282 ENTRY("__DATA", "__const", S_REGULAR, typeConstData),
283 ENTRY("__DATA", "__cfstring", S_REGULAR, typeCFString),
284 ENTRY("__DATA", "__la_symbol_ptr", S_LAZY_SYMBOL_POINTERS,
285 typeLazyPointer),
286 ENTRY("__DATA", "__mod_init_func", S_MOD_INIT_FUNC_POINTERS,
287 typeInitializerPtr),
288 ENTRY("__DATA", "__mod_term_func", S_MOD_TERM_FUNC_POINTERS,
289 typeTerminatorPtr),
290 ENTRY("__DATA", "__got", S_NON_LAZY_SYMBOL_POINTERS,
291 typeGOT),
292 ENTRY("__DATA", "__nl_symbol_ptr", S_NON_LAZY_SYMBOL_POINTERS,
293 typeNonLazyPointer),
294 ENTRY("__DATA", "__thread_vars", S_THREAD_LOCAL_VARIABLES,
295 typeThunkTLV),
296 ENTRY("__DATA", "__thread_data", S_THREAD_LOCAL_REGULAR,
297 typeTLVInitialData),
298 ENTRY("__DATA", "__thread_ptrs", S_THREAD_LOCAL_VARIABLE_POINTERS,
299 typeTLVInitializerPtr),
300 ENTRY("__DATA", "__thread_bss", S_THREAD_LOCAL_ZEROFILL,
301 typeTLVInitialZeroFill),
302 ENTRY("__DATA", "__bss", S_ZEROFILL, typeZeroFill),
303 ENTRY("__DATA", "__interposing", S_INTERPOSING, typeInterposingTuples),
304};
305#undef ENTRY
306
307SectionInfo *Util::getFinalSection(DefinedAtom::ContentType atomType) {
308 for (auto &p : sectsToAtomType) {
309 if (p.atomType != atomType)
310 continue;
311 SectionAttr sectionAttrs = 0;
312 switch (atomType) {
313 case DefinedAtom::typeMachHeader:
314 case DefinedAtom::typeCode:
315 case DefinedAtom::typeStub:
316 case DefinedAtom::typeStubHelper:
317 sectionAttrs = S_ATTR_PURE_INSTRUCTIONS | S_ATTR_SOME_INSTRUCTIONS;
318 break;
319 case DefinedAtom::typeThunkTLV:
320 _hasTLVDescriptors = true;
321 break;
322 default:
323 break;
324 }
325 // If we already have a SectionInfo with this name, re-use it.
326 // This can happen if two ContentType map to the same mach-o section.
327 for (auto sect : _sectionMap) {
328 if (sect.second->sectionName.equals(p.sectionName) &&
329 sect.second->segmentName.equals(p.segmentName)) {
330 return sect.second;
331 }
332 }
333 // Otherwise allocate new SectionInfo object.
334 auto *sect = new (_allocator) SectionInfo(
335 p.segmentName, p.sectionName, p.sectionType, _ctx, sectionAttrs,
336 /* relocsToDefinedCanBeImplicit */ false);
337 _sectionInfos.push_back(sect);
338 _sectionMap[atomType] = sect;
339 return sect;
340 }
341 llvm_unreachable("content type not yet supported")::llvm::llvm_unreachable_internal("content type not yet supported"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 341)
;
342}
343
344SectionInfo *Util::sectionForAtom(const DefinedAtom *atom) {
345 if (atom->sectionChoice() == DefinedAtom::sectionBasedOnContent) {
346 // Section for this atom is derived from content type.
347 DefinedAtom::ContentType type = atom->contentType();
348 auto pos = _sectionMap.find(type);
349 if ( pos != _sectionMap.end() )
350 return pos->second;
351 bool rMode = (_ctx.outputMachOType() == llvm::MachO::MH_OBJECT);
352 return rMode ? getRelocatableSection(type) : getFinalSection(type);
353 } else {
354 // This atom needs to be in a custom section.
355 StringRef customName = atom->customSectionName();
356 // Look to see if we have already allocated the needed custom section.
357 for(SectionInfo *sect : _customSections) {
358 const DefinedAtom *firstAtom = sect->atomsAndOffsets.front().atom;
359 if (firstAtom->customSectionName().equals(customName)) {
360 return sect;
361 }
362 }
363 // Not found, so need to create a new custom section.
364 size_t seperatorIndex = customName.find('/');
365 assert(seperatorIndex != StringRef::npos)((seperatorIndex != StringRef::npos) ? static_cast<void>
(0) : __assert_fail ("seperatorIndex != StringRef::npos", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 365, __PRETTY_FUNCTION__))
;
366 StringRef segName = customName.slice(0, seperatorIndex);
367 StringRef sectName = customName.drop_front(seperatorIndex + 1);
368 auto *sect =
369 new (_allocator) SectionInfo(segName, sectName, S_REGULAR, _ctx,
370 0, /* relocsToDefinedCanBeImplicit */ false);
371 _customSections.push_back(sect);
372 _sectionInfos.push_back(sect);
373 return sect;
374 }
375}
376
377void Util::appendAtom(SectionInfo *sect, const DefinedAtom *atom) {
378 // Figure out offset for atom in this section given alignment constraints.
379 uint64_t offset = sect->size;
380 DefinedAtom::Alignment atomAlign = atom->alignment();
381 uint64_t align = atomAlign.value;
382 uint64_t requiredModulus = atomAlign.modulus;
383 uint64_t currentModulus = (offset % align);
384 if ( currentModulus != requiredModulus ) {
385 if ( requiredModulus > currentModulus )
386 offset += requiredModulus-currentModulus;
387 else
388 offset += align+requiredModulus-currentModulus;
389 }
390 // Record max alignment of any atom in this section.
391 if (align > sect->alignment)
392 sect->alignment = atomAlign.value;
393 // Assign atom to this section with this offset.
394 AtomInfo ai = {atom, offset};
395 sect->atomsAndOffsets.push_back(ai);
396 // Update section size to include this atom.
397 sect->size = offset + atom->size();
398}
399
400void Util::processDefinedAtoms(const lld::File &atomFile) {
401 for (const DefinedAtom *atom : atomFile.defined()) {
402 processAtomAttributes(atom);
403 assignAtomToSection(atom);
404 }
405}
406
407void Util::processAtomAttributes(const DefinedAtom *atom) {
408 if (auto *machoFile = dyn_cast<mach_o::MachOFile>(&atom->file())) {
409 // If the file doesn't use subsections via symbols, then make sure we don't
410 // add that flag to the final output file if we have a relocatable file.
411 if (!machoFile->subsectionsViaSymbols())
412 _subsectionsViaSymbols = false;
413
414 // All the source files must have min versions for us to output an object
415 // file with a min version.
416 if (auto v = machoFile->minVersion())
417 _minVersion = std::max(_minVersion, v);
418 else
419 _allSourceFilesHaveMinVersions = false;
420
421 // If we don't have a platform load command, but one of the source files
422 // does, then take the one from the file.
423 if (!_minVersionCommandType)
424 if (auto v = machoFile->minVersionLoadCommandKind())
425 _minVersionCommandType = v;
426 }
427}
428
429void Util::assignAtomToSection(const DefinedAtom *atom) {
430 if (atom->contentType() == DefinedAtom::typeMachHeader) {
431 _machHeaderAliasAtoms.push_back(atom);
432 // Assign atom to this section with this offset.
433 AtomInfo ai = {atom, 0};
434 sectionForAtom(atom)->atomsAndOffsets.push_back(ai);
435 } else if (atom->contentType() == DefinedAtom::typeDSOHandle)
436 _machHeaderAliasAtoms.push_back(atom);
437 else
438 appendAtom(sectionForAtom(atom), atom);
439}
440
441SegmentInfo *Util::segmentForName(StringRef segName) {
442 for (SegmentInfo *si : _segmentInfos) {
443 if ( si->name.equals(segName) )
444 return si;
445 }
446 auto *info = new (_allocator) SegmentInfo(segName);
447
448 // Set the initial segment protection.
449 if (segName.equals("__TEXT"))
450 info->init_access = VM_PROT_READ | VM_PROT_EXECUTE;
451 else if (segName.equals("__PAGEZERO"))
452 info->init_access = 0;
453 else if (segName.equals("__LINKEDIT"))
454 info->init_access = VM_PROT_READ;
455 else {
456 // All others default to read-write
457 info->init_access = VM_PROT_READ | VM_PROT_WRITE;
458 }
459
460 // Set max segment protection
461 // Note, its overkill to use a switch statement here, but makes it so much
462 // easier to use switch coverage to catch new cases.
463 switch (_ctx.os()) {
464 case lld::MachOLinkingContext::OS::unknown:
465 case lld::MachOLinkingContext::OS::macOSX:
466 case lld::MachOLinkingContext::OS::iOS_simulator:
467 if (segName.equals("__PAGEZERO")) {
468 info->max_access = 0;
469 break;
470 }
471 // All others default to all
472 info->max_access = VM_PROT_READ | VM_PROT_WRITE | VM_PROT_EXECUTE;
473 break;
474 case lld::MachOLinkingContext::OS::iOS:
475 // iPhoneOS always uses same protection for max and initial
476 info->max_access = info->init_access;
477 break;
478 }
479 _segmentInfos.push_back(info);
480 return info;
481}
482
483unsigned Util::SegmentSorter::weight(const SegmentInfo *seg) {
484 return llvm::StringSwitch<unsigned>(seg->name)
485 .Case("__PAGEZERO", 1)
486 .Case("__TEXT", 2)
487 .Case("__DATA", 3)
488 .Default(100);
489}
490
491bool Util::SegmentSorter::operator()(const SegmentInfo *left,
492 const SegmentInfo *right) {
493 return (weight(left) < weight(right));
494}
495
496unsigned Util::TextSectionSorter::weight(const SectionInfo *sect) {
497 return llvm::StringSwitch<unsigned>(sect->sectionName)
498 .Case("__text", 1)
499 .Case("__stubs", 2)
500 .Case("__stub_helper", 3)
501 .Case("__const", 4)
502 .Case("__cstring", 5)
503 .Case("__unwind_info", 98)
504 .Case("__eh_frame", 99)
505 .Default(10);
506}
507
508bool Util::TextSectionSorter::operator()(const SectionInfo *left,
509 const SectionInfo *right) {
510 return (weight(left) < weight(right));
511}
512
513void Util::organizeSections() {
514 // NOTE!: Keep this in sync with assignAddressesToSections.
515 switch (_ctx.outputMachOType()) {
516 case llvm::MachO::MH_EXECUTE:
517 // Main executables, need a zero-page segment
518 segmentForName("__PAGEZERO");
519 // Fall into next case.
520 LLVM_FALLTHROUGH[[clang::fallthrough]];
521 case llvm::MachO::MH_DYLIB:
522 case llvm::MachO::MH_BUNDLE:
523 // All dynamic code needs TEXT segment to hold the load commands.
524 segmentForName("__TEXT");
525 break;
526 default:
527 break;
528 }
529 segmentForName("__LINKEDIT");
530
531 // Group sections into segments.
532 for (SectionInfo *si : _sectionInfos) {
533 SegmentInfo *seg = segmentForName(si->segmentName);
534 seg->sections.push_back(si);
535 }
536 // Sort segments.
537 std::sort(_segmentInfos.begin(), _segmentInfos.end(), SegmentSorter());
538
539 // Sort sections within segments.
540 for (SegmentInfo *seg : _segmentInfos) {
541 if (seg->name.equals("__TEXT")) {
542 std::sort(seg->sections.begin(), seg->sections.end(),
543 TextSectionSorter());
544 }
545 }
546
547 // Record final section indexes.
548 uint32_t segmentIndex = 0;
549 uint32_t sectionIndex = 1;
550 for (SegmentInfo *seg : _segmentInfos) {
551 seg->normalizedSegmentIndex = segmentIndex++;
552 for (SectionInfo *sect : seg->sections)
553 sect->finalSectionIndex = sectionIndex++;
554 }
555}
556
557void Util::layoutSectionsInSegment(SegmentInfo *seg, uint64_t &addr) {
558 seg->address = addr;
559 for (SectionInfo *sect : seg->sections) {
560 sect->address = llvm::alignTo(addr, sect->alignment);
561 addr = sect->address + sect->size;
562 }
563 seg->size = llvm::alignTo(addr - seg->address, _ctx.pageSize());
564}
565
566// __TEXT segment lays out backwards so padding is at front after load commands.
567void Util::layoutSectionsInTextSegment(size_t hlcSize, SegmentInfo *seg,
568 uint64_t &addr) {
569 seg->address = addr;
570 // Walks sections starting at end to calculate padding for start.
571 int64_t taddr = 0;
572 for (auto it = seg->sections.rbegin(); it != seg->sections.rend(); ++it) {
573 SectionInfo *sect = *it;
574 taddr -= sect->size;
575 taddr = taddr & (0 - sect->alignment);
576 }
577 int64_t padding = taddr - hlcSize;
578 while (padding < 0)
579 padding += _ctx.pageSize();
580 // Start assigning section address starting at padded offset.
581 addr += (padding + hlcSize);
582 for (SectionInfo *sect : seg->sections) {
583 sect->address = llvm::alignTo(addr, sect->alignment);
584 addr = sect->address + sect->size;
585 }
586 seg->size = llvm::alignTo(addr - seg->address, _ctx.pageSize());
587}
588
589void Util::assignAddressesToSections(const NormalizedFile &file) {
590 // NOTE!: Keep this in sync with organizeSections.
591 size_t hlcSize = headerAndLoadCommandsSize(file);
592 uint64_t address = 0;
593 for (SegmentInfo *seg : _segmentInfos) {
594 if (seg->name.equals("__PAGEZERO")) {
595 seg->size = _ctx.pageZeroSize();
596 address += seg->size;
597 }
598 else if (seg->name.equals("__TEXT")) {
599 // _ctx.baseAddress() == 0 implies it was either unspecified or
600 // pageZeroSize is also 0. In either case resetting address is safe.
601 address = _ctx.baseAddress() ? _ctx.baseAddress() : address;
602 layoutSectionsInTextSegment(hlcSize, seg, address);
603 } else
604 layoutSectionsInSegment(seg, address);
605
606 address = llvm::alignTo(address, _ctx.pageSize());
607 }
608 DEBUG_WITH_TYPE("WriterMachO-norm",do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
609 llvm::dbgs() << "assignAddressesToSections()\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
610 for (SegmentInfo *sgi : _segmentInfos) {do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
611 llvm::dbgs() << " address=" << llvm::format("0x%08llX", sgi->address)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
612 << ", size=" << llvm::format("0x%08llX", sgi->size)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
613 << ", segment-name='" << sgi->namedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
614 << "'\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
615 for (SectionInfo *si : sgi->sections) {do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
616 llvm::dbgs()<< " addr=" << llvm::format("0x%08llX", si->address)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
617 << ", size=" << llvm::format("0x%08llX", si->size)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
618 << ", section-name='" << si->sectionNamedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
619 << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
620 }do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
621 }do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
622 )do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-norm")) { llvm::dbgs() << "assignAddressesToSections()\n"
; for (SegmentInfo *sgi : _segmentInfos) { llvm::dbgs() <<
" address=" << llvm::format("0x%08llX", sgi->address
) << ", size=" << llvm::format("0x%08llX", sgi->
size) << ", segment-name='" << sgi->name <<
"'\n"; for (SectionInfo *si : sgi->sections) { llvm::dbgs
()<< " addr=" << llvm::format("0x%08llX", si
->address) << ", size=" << llvm::format("0x%08llX"
, si->size) << ", section-name='" << si->sectionName
<< "\n"; } }; } } while (false)
;
623}
624
625void Util::copySegmentInfo(NormalizedFile &file) {
626 for (SegmentInfo *sgi : _segmentInfos) {
627 Segment seg;
628 seg.name = sgi->name;
629 seg.address = sgi->address;
630 seg.size = sgi->size;
631 seg.init_access = sgi->init_access;
632 seg.max_access = sgi->max_access;
633 file.segments.push_back(seg);
634 }
635}
636
637void Util::appendSection(SectionInfo *si, NormalizedFile &file) {
638 // Add new empty section to end of file.sections.
639 Section temp;
640 file.sections.push_back(std::move(temp));
641 Section* normSect = &file.sections.back();
642 // Copy fields to normalized section.
643 normSect->segmentName = si->segmentName;
644 normSect->sectionName = si->sectionName;
645 normSect->type = si->type;
646 normSect->attributes = si->attributes;
647 normSect->address = si->address;
648 normSect->alignment = si->alignment;
649 // Record where normalized section is.
650 si->normalizedSectionIndex = file.sections.size()-1;
651}
652
653void Util::copySectionContent(NormalizedFile &file) {
654 const bool r = (_ctx.outputMachOType() == llvm::MachO::MH_OBJECT);
655
656 // Utility function for ArchHandler to find address of atom in output file.
657 auto addrForAtom = [&] (const Atom &atom) -> uint64_t {
658 auto pos = _atomToAddress.find(&atom);
659 assert(pos != _atomToAddress.end())((pos != _atomToAddress.end()) ? static_cast<void> (0) :
__assert_fail ("pos != _atomToAddress.end()", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 659, __PRETTY_FUNCTION__))
;
660 return pos->second;
661 };
662
663 auto sectionAddrForAtom = [&] (const Atom &atom) -> uint64_t {
664 for (const SectionInfo *sectInfo : _sectionInfos)
665 for (const AtomInfo &atomInfo : sectInfo->atomsAndOffsets)
666 if (atomInfo.atom == &atom)
667 return sectInfo->address;
668 llvm_unreachable("atom not assigned to section")::llvm::llvm_unreachable_internal("atom not assigned to section"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 668)
;
669 };
670
671 for (SectionInfo *si : _sectionInfos) {
672 Section *normSect = &file.sections[si->normalizedSectionIndex];
673 if (isZeroFillSection(si->type)) {
674 const uint8_t *empty = nullptr;
675 normSect->content = llvm::makeArrayRef(empty, si->size);
676 continue;
677 }
678 // Copy content from atoms to content buffer for section.
679 llvm::MutableArrayRef<uint8_t> sectionContent;
680 if (si->size) {
681 uint8_t *sectContent = file.ownedAllocations.Allocate<uint8_t>(si->size);
682 sectionContent = llvm::MutableArrayRef<uint8_t>(sectContent, si->size);
683 normSect->content = sectionContent;
684 }
685 for (AtomInfo &ai : si->atomsAndOffsets) {
686 if (!ai.atom->size()) {
687 assert(ai.atom->begin() == ai.atom->end() &&((ai.atom->begin() == ai.atom->end() && "Cannot have references without content"
) ? static_cast<void> (0) : __assert_fail ("ai.atom->begin() == ai.atom->end() && \"Cannot have references without content\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 688, __PRETTY_FUNCTION__))
688 "Cannot have references without content")((ai.atom->begin() == ai.atom->end() && "Cannot have references without content"
) ? static_cast<void> (0) : __assert_fail ("ai.atom->begin() == ai.atom->end() && \"Cannot have references without content\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 688, __PRETTY_FUNCTION__))
;
689 continue;
690 }
691 auto atomContent = sectionContent.slice(ai.offsetInSection,
692 ai.atom->size());
693 _archHandler.generateAtomContent(*ai.atom, r, addrForAtom,
694 sectionAddrForAtom, _ctx.baseAddress(),
695 atomContent);
696 }
697 }
698}
699
700void Util::copySectionInfo(NormalizedFile &file) {
701 file.sections.reserve(_sectionInfos.size());
702 // Write sections grouped by segment.
703 for (SegmentInfo *sgi : _segmentInfos) {
704 for (SectionInfo *si : sgi->sections) {
705 appendSection(si, file);
706 }
707 }
708}
709
710void Util::updateSectionInfo(NormalizedFile &file) {
711 file.sections.reserve(_sectionInfos.size());
712 // sections grouped by segment.
713 for (SegmentInfo *sgi : _segmentInfos) {
714 Segment *normSeg = &file.segments[sgi->normalizedSegmentIndex];
715 normSeg->address = sgi->address;
716 normSeg->size = sgi->size;
717 for (SectionInfo *si : sgi->sections) {
718 Section *normSect = &file.sections[si->normalizedSectionIndex];
719 normSect->address = si->address;
720 }
721 }
722}
723
724void Util::copyEntryPointAddress(NormalizedFile &nFile) {
725 if (!_entryAtom) {
726 nFile.entryAddress = 0;
727 return;
728 }
729
730 if (_ctx.outputTypeHasEntry()) {
731 if (_archHandler.isThumbFunction(*_entryAtom))
732 nFile.entryAddress = (_atomToAddress[_entryAtom] | 1);
733 else
734 nFile.entryAddress = _atomToAddress[_entryAtom];
735 }
736}
737
738void Util::buildAtomToAddressMap() {
739 DEBUG_WITH_TYPE("WriterMachO-address", llvm::dbgs()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << "assign atom addresses:\n"
; } } while (false)
740 << "assign atom addresses:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << "assign atom addresses:\n"
; } } while (false)
;
741 const bool lookForEntry = _ctx.outputTypeHasEntry();
742 for (SectionInfo *sect : _sectionInfos) {
743 for (const AtomInfo &info : sect->atomsAndOffsets) {
744 _atomToAddress[info.atom] = sect->address + info.offsetInSection;
745 if (lookForEntry && (info.atom->contentType() == DefinedAtom::typeCode) &&
746 (info.atom->size() != 0) &&
747 info.atom->name() == _ctx.entrySymbolName()) {
748 _entryAtom = info.atom;
749 }
750 DEBUG_WITH_TYPE("WriterMachO-address", llvm::dbgs()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
751 << " address="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
752 << llvm::format("0x%016X", _atomToAddress[info.atom])do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
753 << llvm::format(" 0x%09lX", info.atom)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
754 << ", file=#"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
755 << info.atom->file().ordinal()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
756 << ", atom=#"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
757 << info.atom->ordinal()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
758 << ", name="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
759 << info.atom->name()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
760 << ", type="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
761 << info.atom->contentType()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
762 << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[info.atom]) <<
llvm::format(" 0x%09lX", info.atom) << ", file=#" <<
info.atom->file().ordinal() << ", atom=#" << info
.atom->ordinal() << ", name=" << info.atom->
name() << ", type=" << info.atom->contentType(
) << "\n"; } } while (false)
;
763 }
764 }
765 DEBUG_WITH_TYPE("WriterMachO-address", llvm::dbgs()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << "assign header alias atom addresses:\n"
; } } while (false)
766 << "assign header alias atom addresses:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << "assign header alias atom addresses:\n"
; } } while (false)
;
767 for (const Atom *atom : _machHeaderAliasAtoms) {
768 _atomToAddress[atom] = _ctx.baseAddress();
769#ifndef NDEBUG
770 if (auto *definedAtom = dyn_cast<DefinedAtom>(atom)) {
771 DEBUG_WITH_TYPE("WriterMachO-address", llvm::dbgs()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
772 << " address="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
773 << llvm::format("0x%016X", _atomToAddress[atom])do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
774 << llvm::format(" 0x%09lX", atom)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
775 << ", file=#"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
776 << definedAtom->file().ordinal()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
777 << ", atom=#"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
778 << definedAtom->ordinal()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
779 << ", name="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
780 << definedAtom->name()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
781 << ", type="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
782 << definedAtom->contentType()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
783 << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
llvm::format(" 0x%09lX", atom) << ", file=#" <<
definedAtom->file().ordinal() << ", atom=#" <<
definedAtom->ordinal() << ", name=" << definedAtom
->name() << ", type=" << definedAtom->contentType
() << "\n"; } } while (false)
;
784 } else {
785 DEBUG_WITH_TYPE("WriterMachO-address", llvm::dbgs()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
" atom=" << atom << " name=" << atom->name
() << "\n"; } } while (false)
786 << " address="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
" atom=" << atom << " name=" << atom->name
() << "\n"; } } while (false)
787 << llvm::format("0x%016X", _atomToAddress[atom])do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
" atom=" << atom << " name=" << atom->name
() << "\n"; } } while (false)
788 << " atom=" << atomdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
" atom=" << atom << " name=" << atom->name
() << "\n"; } } while (false)
789 << " name=" << atom->name() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("WriterMachO-address")) { llvm::dbgs() << " address="
<< llvm::format("0x%016X", _atomToAddress[atom]) <<
" atom=" << atom << " name=" << atom->name
() << "\n"; } } while (false)
;
790 }
791#endif
792 }
793}
794
795llvm::Error Util::synthesizeDebugNotes(NormalizedFile &file) {
796
797 // Bail out early if we don't need to generate a debug map.
798 if (_ctx.debugInfoMode() == MachOLinkingContext::DebugInfoMode::noDebugMap)
799 return llvm::Error::success();
800
801 std::vector<const DefinedAtom*> atomsNeedingDebugNotes;
802 std::set<const mach_o::MachOFile*> filesWithStabs;
803 bool objFileHasDwarf = false;
804 const File *objFile = nullptr;
805
806 for (SectionInfo *sect : _sectionInfos) {
807 for (const AtomInfo &info : sect->atomsAndOffsets) {
808 if (const DefinedAtom *atom = dyn_cast<DefinedAtom>(info.atom)) {
809
810 // FIXME: No stabs/debug-notes for symbols that wouldn't be in the
811 // symbol table.
812 // FIXME: No stabs/debug-notes for kernel dtrace probes.
813
814 if (atom->contentType() == DefinedAtom::typeCFI ||
815 atom->contentType() == DefinedAtom::typeCString)
816 continue;
817
818 // Whenever we encounter a new file, update the 'objfileHasDwarf' flag.
819 if (&info.atom->file() != objFile) {
820 objFileHasDwarf = false;
821 if (const mach_o::MachOFile *atomFile =
822 dyn_cast<mach_o::MachOFile>(&info.atom->file())) {
823 if (atomFile->debugInfo()) {
824 if (isa<mach_o::DwarfDebugInfo>(atomFile->debugInfo()))
825 objFileHasDwarf = true;
826 else if (isa<mach_o::StabsDebugInfo>(atomFile->debugInfo()))
827 filesWithStabs.insert(atomFile);
828 }
829 }
830 }
831
832 // If this atom is from a file that needs dwarf, add it to the list.
833 if (objFileHasDwarf)
834 atomsNeedingDebugNotes.push_back(info.atom);
835 }
836 }
837 }
838
839 // Sort atoms needing debug notes by file ordinal, then atom ordinal.
840 std::sort(atomsNeedingDebugNotes.begin(), atomsNeedingDebugNotes.end(),
841 [](const DefinedAtom *lhs, const DefinedAtom *rhs) {
842 if (lhs->file().ordinal() != rhs->file().ordinal())
843 return (lhs->file().ordinal() < rhs->file().ordinal());
844 return (lhs->ordinal() < rhs->ordinal());
845 });
846
847 // FIXME: Handle <rdar://problem/17689030>: Add -add_ast_path option to \
848 // linker which add N_AST stab entry to output
849 // See OutputFile::synthesizeDebugNotes in ObjectFile.cpp in ld64.
850
851 StringRef oldFileName = "";
852 StringRef oldDirPath = "";
853 bool wroteStartSO = false;
854 std::unordered_set<std::string> seenFiles;
855 for (const DefinedAtom *atom : atomsNeedingDebugNotes) {
856 const auto &atomFile = cast<mach_o::MachOFile>(atom->file());
857 assert(dyn_cast_or_null<lld::mach_o::DwarfDebugInfo>(atomFile.debugInfo())((dyn_cast_or_null<lld::mach_o::DwarfDebugInfo>(atomFile
.debugInfo()) && "file for atom needing debug notes does not contain dwarf"
) ? static_cast<void> (0) : __assert_fail ("dyn_cast_or_null<lld::mach_o::DwarfDebugInfo>(atomFile.debugInfo()) && \"file for atom needing debug notes does not contain dwarf\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 858, __PRETTY_FUNCTION__))
858 && "file for atom needing debug notes does not contain dwarf")((dyn_cast_or_null<lld::mach_o::DwarfDebugInfo>(atomFile
.debugInfo()) && "file for atom needing debug notes does not contain dwarf"
) ? static_cast<void> (0) : __assert_fail ("dyn_cast_or_null<lld::mach_o::DwarfDebugInfo>(atomFile.debugInfo()) && \"file for atom needing debug notes does not contain dwarf\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 858, __PRETTY_FUNCTION__))
;
859 auto &dwarf = cast<lld::mach_o::DwarfDebugInfo>(*atomFile.debugInfo());
860
861 auto &tu = dwarf.translationUnitSource();
862 StringRef newFileName = tu.name;
863 StringRef newDirPath = tu.path;
864
865 // Add an SO whenever the TU source file changes.
866 if (newFileName != oldFileName || newDirPath != oldDirPath) {
867 // Translation unit change, emit ending SO
868 if (oldFileName != "")
869 _stabs.push_back(mach_o::Stab(nullptr, N_SO, 1, 0, 0, ""));
870
871 oldFileName = newFileName;
872 oldDirPath = newDirPath;
873
874 // If newDirPath doesn't end with a '/' we need to add one:
875 if (newDirPath.back() != '/') {
876 char *p =
877 file.ownedAllocations.Allocate<char>(newDirPath.size() + 2);
878 memcpy(p, newDirPath.data(), newDirPath.size());
879 p[newDirPath.size()] = '/';
880 p[newDirPath.size() + 1] = '\0';
881 newDirPath = p;
882 }
883
884 // New translation unit, emit start SOs:
885 _stabs.push_back(mach_o::Stab(nullptr, N_SO, 0, 0, 0, newDirPath));
886 _stabs.push_back(mach_o::Stab(nullptr, N_SO, 0, 0, 0, newFileName));
887
888 // Synthesize OSO for start of file.
889 char *fullPath = nullptr;
890 {
891 SmallString<1024> pathBuf(atomFile.path());
892 if (auto EC = llvm::sys::fs::make_absolute(pathBuf))
893 return llvm::errorCodeToError(EC);
894 fullPath = file.ownedAllocations.Allocate<char>(pathBuf.size() + 1);
895 memcpy(fullPath, pathBuf.c_str(), pathBuf.size() + 1);
896 }
897
898 // Get mod time.
899 uint32_t modTime = 0;
900 llvm::sys::fs::file_status stat;
901 if (!llvm::sys::fs::status(fullPath, stat))
902 if (llvm::sys::fs::exists(stat))
903 modTime = llvm::sys::toTimeT(stat.getLastModificationTime());
904
905 _stabs.push_back(mach_o::Stab(nullptr, N_OSO, _ctx.getCPUSubType(), 1,
906 modTime, fullPath));
907 // <rdar://problem/6337329> linker should put cpusubtype in n_sect field
908 // of nlist entry for N_OSO debug note entries.
909 wroteStartSO = true;
910 }
911
912 if (atom->contentType() == DefinedAtom::typeCode) {
913 // Synthesize BNSYM and start FUN stabs.
914 _stabs.push_back(mach_o::Stab(atom, N_BNSYM, 1, 0, 0, ""));
915 _stabs.push_back(mach_o::Stab(atom, N_FUN, 1, 0, 0, atom->name()));
916 // Synthesize any SOL stabs needed
917 // FIXME: add SOL stabs.
918 _stabs.push_back(mach_o::Stab(nullptr, N_FUN, 0, 0,
919 atom->rawContent().size(), ""));
920 _stabs.push_back(mach_o::Stab(nullptr, N_ENSYM, 1, 0,
921 atom->rawContent().size(), ""));
922 } else {
923 if (atom->scope() == Atom::scopeTranslationUnit)
924 _stabs.push_back(mach_o::Stab(atom, N_STSYM, 1, 0, 0, atom->name()));
925 else
926 _stabs.push_back(mach_o::Stab(nullptr, N_GSYM, 1, 0, 0, atom->name()));
927 }
928 }
929
930 // Emit ending SO if necessary.
931 if (wroteStartSO)
932 _stabs.push_back(mach_o::Stab(nullptr, N_SO, 1, 0, 0, ""));
933
934 // Copy any stabs from .o file.
935 for (const auto *objFile : filesWithStabs) {
936 const auto &stabsList =
937 cast<mach_o::StabsDebugInfo>(objFile->debugInfo())->stabs();
938 for (auto &stab : stabsList) {
939 // FIXME: Drop stabs whose atoms have been dead-stripped.
940 _stabs.push_back(stab);
941 }
942 }
943
944 return llvm::Error::success();
945}
946
947uint16_t Util::descBits(const DefinedAtom* atom) {
948 uint16_t desc = 0;
949 switch (atom->merge()) {
950 case lld::DefinedAtom::mergeNo:
951 case lld::DefinedAtom::mergeAsTentative:
952 break;
953 case lld::DefinedAtom::mergeAsWeak:
954 case lld::DefinedAtom::mergeAsWeakAndAddressUsed:
955 desc |= N_WEAK_DEF;
956 break;
957 case lld::DefinedAtom::mergeSameNameAndSize:
958 case lld::DefinedAtom::mergeByLargestSection:
959 case lld::DefinedAtom::mergeByContent:
960 llvm_unreachable("Unsupported DefinedAtom::merge()")::llvm::llvm_unreachable_internal("Unsupported DefinedAtom::merge()"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 960)
;
961 break;
962 }
963 if (atom->contentType() == lld::DefinedAtom::typeResolver)
964 desc |= N_SYMBOL_RESOLVER;
965 if (atom->contentType() == lld::DefinedAtom::typeMachHeader)
966 desc |= REFERENCED_DYNAMICALLY;
967 if (_archHandler.isThumbFunction(*atom))
968 desc |= N_ARM_THUMB_DEF;
969 if (atom->deadStrip() == DefinedAtom::deadStripNever &&
970 _ctx.outputMachOType() == llvm::MachO::MH_OBJECT) {
971 if ((atom->contentType() != DefinedAtom::typeInitializerPtr)
972 && (atom->contentType() != DefinedAtom::typeTerminatorPtr))
973 desc |= N_NO_DEAD_STRIP;
974 }
975 return desc;
976}
977
978bool Util::AtomSorter::operator()(const AtomAndIndex &left,
979 const AtomAndIndex &right) {
980 return (left.atom->name().compare(right.atom->name()) < 0);
981}
982
983llvm::Error Util::getSymbolTableRegion(const DefinedAtom* atom,
984 bool &inGlobalsRegion,
985 SymbolScope &scope) {
986 bool rMode = (_ctx.outputMachOType() == llvm::MachO::MH_OBJECT);
10
Assuming the condition is false
987 switch (atom->scope()) {
11
Control jumps to 'case scopeLinkageUnit:' at line 992
988 case Atom::scopeTranslationUnit:
989 scope = 0;
990 inGlobalsRegion = false;
991 return llvm::Error::success();
992 case Atom::scopeLinkageUnit:
993 if ((_ctx.exportMode() == MachOLinkingContext::ExportMode::whiteList) &&
12
Assuming the condition is true
13
Assuming the condition is true
14
Taking true branch
994 _ctx.exportSymbolNamed(atom->name())) {
995 return llvm::make_error<GenericError>(
15
Calling 'make_error<lld::GenericError, llvm::Twine>'
996 Twine("cannot export hidden symbol ") + atom->name());
997 }
998 if (rMode) {
999 if (_ctx.keepPrivateExterns()) {
1000 // -keep_private_externs means keep in globals region as N_PEXT.
1001 scope = N_PEXT | N_EXT;
1002 inGlobalsRegion = true;
1003 return llvm::Error::success();
1004 }
1005 }
1006 // scopeLinkageUnit symbols are no longer global once linked.
1007 scope = N_PEXT;
1008 inGlobalsRegion = false;
1009 return llvm::Error::success();
1010 case Atom::scopeGlobal:
1011 if (_ctx.exportRestrictMode()) {
1012 if (_ctx.exportSymbolNamed(atom->name())) {
1013 scope = N_EXT;
1014 inGlobalsRegion = true;
1015 return llvm::Error::success();
1016 } else {
1017 scope = N_PEXT;
1018 inGlobalsRegion = false;
1019 return llvm::Error::success();
1020 }
1021 } else {
1022 scope = N_EXT;
1023 inGlobalsRegion = true;
1024 return llvm::Error::success();
1025 }
1026 break;
1027 }
1028 llvm_unreachable("atom->scope() unknown enum value")::llvm::llvm_unreachable_internal("atom->scope() unknown enum value"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 1028)
;
1029}
1030
1031
1032
1033llvm::Error Util::addSymbols(const lld::File &atomFile,
1034 NormalizedFile &file) {
1035 bool rMode = (_ctx.outputMachOType() == llvm::MachO::MH_OBJECT);
6
Assuming the condition is false
1036 // Mach-O symbol table has four regions: stabs, locals, globals, undefs.
1037
1038 // Add all stabs.
1039 for (auto &stab : _stabs) {
1040 Symbol sym;
1041 sym.type = static_cast<NListType>(stab.type);
1042 sym.scope = 0;
1043 sym.sect = stab.other;
1044 sym.desc = stab.desc;
1045 if (stab.atom)
1046 sym.value = _atomToAddress[stab.atom];
1047 else
1048 sym.value = stab.value;
1049 sym.name = stab.str;
1050 file.stabsSymbols.push_back(sym);
1051 }
1052
1053 // Add all local (non-global) symbols in address order
1054 std::vector<AtomAndIndex> globals;
1055 globals.reserve(512);
1056 for (SectionInfo *sect : _sectionInfos) {
1057 for (const AtomInfo &info : sect->atomsAndOffsets) {
1058 const DefinedAtom *atom = info.atom;
1059 if (!atom->name().empty()) {
7
Assuming the condition is true
8
Taking true branch
1060 SymbolScope symbolScope;
1061 bool inGlobalsRegion;
1062 if (auto ec = getSymbolTableRegion(atom, inGlobalsRegion, symbolScope)){
9
Calling 'Util::getSymbolTableRegion'
1063 return ec;
1064 }
1065 if (inGlobalsRegion) {
1066 AtomAndIndex ai = { atom, sect->finalSectionIndex, symbolScope };
1067 globals.push_back(ai);
1068 } else {
1069 Symbol sym;
1070 sym.name = atom->name();
1071 sym.type = N_SECT;
1072 sym.scope = symbolScope;
1073 sym.sect = sect->finalSectionIndex;
1074 sym.desc = descBits(atom);
1075 sym.value = _atomToAddress[atom];
1076 _atomToSymbolIndex[atom] = file.localSymbols.size();
1077 file.localSymbols.push_back(sym);
1078 }
1079 } else if (rMode && _archHandler.needsLocalSymbolInRelocatableFile(atom)){
1080 // Create 'Lxxx' labels for anonymous atoms if archHandler says so.
1081 static unsigned tempNum = 1;
1082 char tmpName[16];
1083 sprintf(tmpName, "L%04u", tempNum++);
1084 StringRef tempRef(tmpName);
1085 Symbol sym;
1086 sym.name = tempRef.copy(file.ownedAllocations);
1087 sym.type = N_SECT;
1088 sym.scope = 0;
1089 sym.sect = sect->finalSectionIndex;
1090 sym.desc = 0;
1091 sym.value = _atomToAddress[atom];
1092 _atomToSymbolIndex[atom] = file.localSymbols.size();
1093 file.localSymbols.push_back(sym);
1094 }
1095 }
1096 }
1097
1098 // Sort global symbol alphabetically, then add to symbol table.
1099 std::sort(globals.begin(), globals.end(), AtomSorter());
1100 const uint32_t globalStartIndex = file.localSymbols.size();
1101 for (AtomAndIndex &ai : globals) {
1102 Symbol sym;
1103 sym.name = ai.atom->name();
1104 sym.type = N_SECT;
1105 sym.scope = ai.scope;
1106 sym.sect = ai.index;
1107 sym.desc = descBits(static_cast<const DefinedAtom*>(ai.atom));
1108 sym.value = _atomToAddress[ai.atom];
1109 _atomToSymbolIndex[ai.atom] = globalStartIndex + file.globalSymbols.size();
1110 file.globalSymbols.push_back(sym);
1111 }
1112
1113 // Sort undefined symbol alphabetically, then add to symbol table.
1114 std::vector<AtomAndIndex> undefs;
1115 undefs.reserve(128);
1116 for (const UndefinedAtom *atom : atomFile.undefined()) {
1117 AtomAndIndex ai = { atom, 0, N_EXT };
1118 undefs.push_back(ai);
1119 }
1120 for (const SharedLibraryAtom *atom : atomFile.sharedLibrary()) {
1121 AtomAndIndex ai = { atom, 0, N_EXT };
1122 undefs.push_back(ai);
1123 }
1124 std::sort(undefs.begin(), undefs.end(), AtomSorter());
1125 const uint32_t start = file.globalSymbols.size() + file.localSymbols.size();
1126 for (AtomAndIndex &ai : undefs) {
1127 Symbol sym;
1128 uint16_t desc = 0;
1129 if (!rMode) {
1130 uint8_t ordinal = 0;
1131 if (!_ctx.useFlatNamespace())
1132 ordinal = dylibOrdinal(dyn_cast<SharedLibraryAtom>(ai.atom));
1133 llvm::MachO::SET_LIBRARY_ORDINAL(desc, ordinal);
1134 }
1135 sym.name = ai.atom->name();
1136 sym.type = N_UNDF;
1137 sym.scope = ai.scope;
1138 sym.sect = 0;
1139 sym.desc = desc;
1140 sym.value = 0;
1141 _atomToSymbolIndex[ai.atom] = file.undefinedSymbols.size() + start;
1142 file.undefinedSymbols.push_back(sym);
1143 }
1144
1145 return llvm::Error::success();
1146}
1147
1148const Atom *Util::targetOfLazyPointer(const DefinedAtom *lpAtom) {
1149 for (const Reference *ref : *lpAtom) {
1150 if (_archHandler.isLazyPointer(*ref)) {
1151 return ref->target();
1152 }
1153 }
1154 return nullptr;
1155}
1156
1157const Atom *Util::targetOfStub(const DefinedAtom *stubAtom) {
1158 for (const Reference *ref : *stubAtom) {
1159 if (const Atom *ta = ref->target()) {
1160 if (const DefinedAtom *lpAtom = dyn_cast<DefinedAtom>(ta)) {
1161 const Atom *target = targetOfLazyPointer(lpAtom);
1162 if (target)
1163 return target;
1164 }
1165 }
1166 }
1167 return nullptr;
1168}
1169
1170void Util::addIndirectSymbols(const lld::File &atomFile, NormalizedFile &file) {
1171 for (SectionInfo *si : _sectionInfos) {
1172 Section &normSect = file.sections[si->normalizedSectionIndex];
1173 switch (si->type) {
1174 case llvm::MachO::S_NON_LAZY_SYMBOL_POINTERS:
1175 for (const AtomInfo &info : si->atomsAndOffsets) {
1176 bool foundTarget = false;
1177 for (const Reference *ref : *info.atom) {
1178 const Atom *target = ref->target();
1179 if (target) {
1180 if (isa<const SharedLibraryAtom>(target)) {
1181 uint32_t index = _atomToSymbolIndex[target];
1182 normSect.indirectSymbols.push_back(index);
1183 foundTarget = true;
1184 } else {
1185 normSect.indirectSymbols.push_back(
1186 llvm::MachO::INDIRECT_SYMBOL_LOCAL);
1187 }
1188 }
1189 }
1190 if (!foundTarget) {
1191 normSect.indirectSymbols.push_back(
1192 llvm::MachO::INDIRECT_SYMBOL_ABS);
1193 }
1194 }
1195 break;
1196 case llvm::MachO::S_LAZY_SYMBOL_POINTERS:
1197 for (const AtomInfo &info : si->atomsAndOffsets) {
1198 const Atom *target = targetOfLazyPointer(info.atom);
1199 if (target) {
1200 uint32_t index = _atomToSymbolIndex[target];
1201 normSect.indirectSymbols.push_back(index);
1202 }
1203 }
1204 break;
1205 case llvm::MachO::S_SYMBOL_STUBS:
1206 for (const AtomInfo &info : si->atomsAndOffsets) {
1207 const Atom *target = targetOfStub(info.atom);
1208 if (target) {
1209 uint32_t index = _atomToSymbolIndex[target];
1210 normSect.indirectSymbols.push_back(index);
1211 }
1212 }
1213 break;
1214 default:
1215 break;
1216 }
1217 }
1218}
1219
1220void Util::addDependentDylibs(const lld::File &atomFile,
1221 NormalizedFile &nFile) {
1222 // Scan all imported symbols and build up list of dylibs they are from.
1223 int ordinal = 1;
1224 for (const auto *dylib : _ctx.allDylibs()) {
1225 DylibPathToInfo::iterator pos = _dylibInfo.find(dylib->installName());
1226 if (pos == _dylibInfo.end()) {
1227 DylibInfo info;
1228 bool flatNamespaceAtom = dylib == _ctx.flatNamespaceFile();
1229
1230 // If we're in -flat_namespace mode (or this atom came from the flat
1231 // namespace file under -undefined dynamic_lookup) then use the flat
1232 // lookup ordinal.
1233 if (flatNamespaceAtom || _ctx.useFlatNamespace())
1234 info.ordinal = BIND_SPECIAL_DYLIB_FLAT_LOOKUP;
1235 else
1236 info.ordinal = ordinal++;
1237 info.hasWeak = false;
1238 info.hasNonWeak = !info.hasWeak;
1239 _dylibInfo[dylib->installName()] = info;
1240
1241 // Unless this was a flat_namespace atom, record the source dylib.
1242 if (!flatNamespaceAtom) {
1243 DependentDylib depInfo;
1244 depInfo.path = dylib->installName();
1245 depInfo.kind = llvm::MachO::LC_LOAD_DYLIB;
1246 depInfo.currentVersion = _ctx.dylibCurrentVersion(dylib->path());
1247 depInfo.compatVersion = _ctx.dylibCompatVersion(dylib->path());
1248 nFile.dependentDylibs.push_back(depInfo);
1249 }
1250 } else {
1251 pos->second.hasWeak = false;
1252 pos->second.hasNonWeak = !pos->second.hasWeak;
1253 }
1254 }
1255 // Automatically weak link dylib in which all symbols are weak (canBeNull).
1256 for (DependentDylib &dep : nFile.dependentDylibs) {
1257 DylibInfo &info = _dylibInfo[dep.path];
1258 if (info.hasWeak && !info.hasNonWeak)
1259 dep.kind = llvm::MachO::LC_LOAD_WEAK_DYLIB;
1260 else if (_ctx.isUpwardDylib(dep.path))
1261 dep.kind = llvm::MachO::LC_LOAD_UPWARD_DYLIB;
1262 }
1263}
1264
1265int Util::dylibOrdinal(const SharedLibraryAtom *sa) {
1266 return _dylibInfo[sa->loadName()].ordinal;
1267}
1268
1269void Util::segIndexForSection(const SectionInfo *sect, uint8_t &segmentIndex,
1270 uint64_t &segmentStartAddr) {
1271 segmentIndex = 0;
1272 for (const SegmentInfo *seg : _segmentInfos) {
1273 if ((seg->address <= sect->address)
1274 && (seg->address+seg->size >= sect->address+sect->size)) {
1275 segmentStartAddr = seg->address;
1276 return;
1277 }
1278 ++segmentIndex;
1279 }
1280 llvm_unreachable("section not in any segment")::llvm::llvm_unreachable_internal("section not in any segment"
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 1280)
;
1281}
1282
1283uint32_t Util::sectionIndexForAtom(const Atom *atom) {
1284 uint64_t address = _atomToAddress[atom];
1285 for (const SectionInfo *si : _sectionInfos) {
1286 if ((si->address <= address) && (address < si->address+si->size))
1287 return si->finalSectionIndex;
1288 }
1289 llvm_unreachable("atom not in any section")::llvm::llvm_unreachable_internal("atom not in any section", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 1289)
;
1290}
1291
1292void Util::addSectionRelocs(const lld::File &, NormalizedFile &file) {
1293 if (_ctx.outputMachOType() != llvm::MachO::MH_OBJECT)
1294 return;
1295
1296 // Utility function for ArchHandler to find symbol index for an atom.
1297 auto symIndexForAtom = [&] (const Atom &atom) -> uint32_t {
1298 auto pos = _atomToSymbolIndex.find(&atom);
1299 assert(pos != _atomToSymbolIndex.end())((pos != _atomToSymbolIndex.end()) ? static_cast<void> (
0) : __assert_fail ("pos != _atomToSymbolIndex.end()", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 1299, __PRETTY_FUNCTION__))
;
1300 return pos->second;
1301 };
1302
1303 // Utility function for ArchHandler to find section index for an atom.
1304 auto sectIndexForAtom = [&] (const Atom &atom) -> uint32_t {
1305 return sectionIndexForAtom(&atom);
1306 };
1307
1308 // Utility function for ArchHandler to find address of atom in output file.
1309 auto addressForAtom = [&] (const Atom &atom) -> uint64_t {
1310 auto pos = _atomToAddress.find(&atom);
1311 assert(pos != _atomToAddress.end())((pos != _atomToAddress.end()) ? static_cast<void> (0) :
__assert_fail ("pos != _atomToAddress.end()", "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 1311, __PRETTY_FUNCTION__))
;
1312 return pos->second;
1313 };
1314
1315 for (SectionInfo *si : _sectionInfos) {
1316 Section &normSect = file.sections[si->normalizedSectionIndex];
1317 for (const AtomInfo &info : si->atomsAndOffsets) {
1318 const DefinedAtom *atom = info.atom;
1319 for (const Reference *ref : *atom) {
1320 // Skip emitting relocs for sections which are always able to be
1321 // implicitly regenerated and where the relocation targets an address
1322 // which is defined.
1323 if (si->relocsToDefinedCanBeImplicit && isa<DefinedAtom>(ref->target()))
1324 continue;
1325 _archHandler.appendSectionRelocations(*atom, info.offsetInSection, *ref,
1326 symIndexForAtom,
1327 sectIndexForAtom,
1328 addressForAtom,
1329 normSect.relocations);
1330 }
1331 }
1332 }
1333}
1334
1335void Util::addFunctionStarts(const lld::File &, NormalizedFile &file) {
1336 if (!_ctx.generateFunctionStartsLoadCommand())
1337 return;
1338 file.functionStarts.reserve(8192);
1339 // Delta compress function starts, starting with the mach header symbol.
1340 const uint64_t badAddress = ~0ULL;
1341 uint64_t addr = badAddress;
1342 for (SectionInfo *si : _sectionInfos) {
1343 for (const AtomInfo &info : si->atomsAndOffsets) {
1344 auto type = info.atom->contentType();
1345 if (type == DefinedAtom::typeMachHeader) {
1346 addr = _atomToAddress[info.atom];
1347 continue;
1348 }
1349 if (type != DefinedAtom::typeCode)
1350 continue;
1351 assert(addr != badAddress && "Missing mach header symbol")((addr != badAddress && "Missing mach header symbol")
? static_cast<void> (0) : __assert_fail ("addr != badAddress && \"Missing mach header symbol\""
, "/build/llvm-toolchain-snapshot-8~svn345461/tools/lld/lib/ReaderWriter/MachO/MachONormalizedFileFromAtoms.cpp"
, 1351, __PRETTY_FUNCTION__))
;
1352 // Skip atoms which have 0 size. This is so that LC_FUNCTION_STARTS
1353 // can't spill in to the next section.
1354 if (!info.atom->size())
1355 continue;
1356 uint64_t nextAddr = _atomToAddress[info.atom];
1357 if (_archHandler.isThumbFunction(*info.atom))
1358 nextAddr |= 1;
1359 uint64_t delta = nextAddr - addr;
1360 if (delta) {
1361 ByteBuffer buffer;
1362 buffer.append_uleb128(delta);
1363 file.functionStarts.insert(file.functionStarts.end(), buffer.bytes(),
1364 buffer.bytes() + buffer.size());
1365 }
1366 addr = nextAddr;
1367 }
1368 }
1369
1370 // Null terminate, and pad to pointer size for this arch.
1371 file.functionStarts.push_back(0);
1372
1373 auto size = file.functionStarts.size();
1374 for (unsigned i = size, e = llvm::alignTo(size, _ctx.is64Bit() ? 8 : 4);
1375 i != e; ++i)
1376 file.functionStarts.push_back(0);
1377}
1378
1379void Util::buildDataInCodeArray(const lld::File &, NormalizedFile &file) {
1380 if (!_ctx.generateDataInCodeLoadCommand())
1381 return;
1382 for (SectionInfo *si : _sectionInfos) {
1383 for (const AtomInfo &info : si->atomsAndOffsets) {
1384 // Atoms that contain data-in-code have "transition" references
1385 // which mark a point where the embedded data starts of ends.
1386 // This needs to be converted to the mach-o format which is an array
1387 // of data-in-code ranges.
1388 uint32_t startOffset = 0;
1389 DataRegionType mode = DataRegionType(0);
1390 for (const Reference *ref : *info.atom) {
1391 if (ref->kindNamespace() != Reference::KindNamespace::mach_o)
1392 continue;
1393 if (_archHandler.isDataInCodeTransition(ref->kindValue())) {
1394 DataRegionType nextMode = (DataRegionType)ref->addend();
1395 if (mode != nextMode) {
1396 if (mode != 0) {
1397 // Found end data range, so make range entry.
1398 DataInCode entry;
1399 entry.offset = si->address + info.offsetInSection + startOffset;
1400 entry.length = ref->offsetInAtom() - startOffset;
1401 entry.kind = mode;
1402 file.dataInCode.push_back(entry);
1403 }
1404 }
1405 mode = nextMode;
1406 startOffset = ref->offsetInAtom();
1407 }
1408 }
1409 if (mode != 0) {
1410 // Function ends with data (no end transition).
1411 DataInCode entry;
1412 entry.offset = si->address + info.offsetInSection + startOffset;
1413 entry.length = info.atom->size() - startOffset;
1414 entry.kind = mode;
1415 file.dataInCode.push_back(entry);
1416 }
1417 }
1418 }
1419}
1420
1421void Util::addRebaseAndBindingInfo(const lld::File &atomFile,
1422 NormalizedFile &nFile) {
1423 if (_ctx.outputMachOType() == llvm::MachO::MH_OBJECT)
1424 return;
1425
1426 uint8_t segmentIndex;
1427 uint64_t segmentStartAddr;
1428 uint32_t offsetInBindInfo = 0;
1429
1430 for (SectionInfo *sect : _sectionInfos) {
1431 segIndexForSection(sect, segmentIndex, segmentStartAddr);
1432 for (const AtomInfo &info : sect->atomsAndOffsets) {
1433 const DefinedAtom *atom = info.atom;
1434 for (const Reference *ref : *atom) {
1435 uint64_t segmentOffset = _atomToAddress[atom] + ref->offsetInAtom()
1436 - segmentStartAddr;
1437 const Atom* targ = ref->target();
1438 if (_archHandler.isPointer(*ref)) {
1439 // A pointer to a DefinedAtom requires rebasing.
1440 if (isa<DefinedAtom>(targ)) {
1441 RebaseLocation rebase;
1442 rebase.segIndex = segmentIndex;
1443 rebase.segOffset = segmentOffset;
1444 rebase.kind = llvm::MachO::REBASE_TYPE_POINTER;
1445 nFile.rebasingInfo.push_back(rebase);
1446 }
1447 // A pointer to an SharedLibraryAtom requires binding.
1448 if (const SharedLibraryAtom *sa = dyn_cast<SharedLibraryAtom>(targ)) {
1449 BindLocation bind;
1450 bind.segIndex = segmentIndex;
1451 bind.segOffset = segmentOffset;
1452 bind.kind = llvm::MachO::BIND_TYPE_POINTER;
1453 bind.canBeNull = sa->canBeNullAtRuntime();
1454 bind.ordinal = dylibOrdinal(sa);
1455 bind.symbolName = targ->name();
1456 bind.addend = ref->addend();
1457 nFile.bindingInfo.push_back(bind);
1458 }
1459 }
1460 else if (_archHandler.isLazyPointer(*ref)) {
1461 BindLocation bind;
1462 if (const SharedLibraryAtom *sa = dyn_cast<SharedLibraryAtom>(targ)) {
1463 bind.ordinal = dylibOrdinal(sa);
1464 } else {
1465 bind.ordinal = llvm::MachO::BIND_SPECIAL_DYLIB_SELF;
1466 }
1467 bind.segIndex = segmentIndex;
1468 bind.segOffset = segmentOffset;
1469 bind.kind = llvm::MachO::BIND_TYPE_POINTER;
1470 bind.canBeNull = false; //sa->canBeNullAtRuntime();
1471 bind.symbolName = targ->name();
1472 bind.addend = ref->addend();
1473 nFile.lazyBindingInfo.push_back(bind);
1474
1475 // Now that we know the segmentOffset and the ordinal attribute,
1476 // we can fix the helper's code
1477
1478 fixLazyReferenceImm(atom, offsetInBindInfo, nFile);
1479
1480 // 5 bytes for opcodes + variable sizes (target name + \0 and offset
1481 // encode's size)
1482 offsetInBindInfo +=
1483 6 + targ->name().size() + llvm::getULEB128Size(bind.segOffset);
1484 if (bind.ordinal > BIND_IMMEDIATE_MASK)
1485 offsetInBindInfo += llvm::getULEB128Size(bind.ordinal);
1486 }
1487 }
1488 }
1489 }
1490}
1491
1492void Util::fixLazyReferenceImm(const DefinedAtom *atom, uint32_t offset,
1493 NormalizedFile &file) {
1494 for (const auto &ref : *atom) {
1495 const DefinedAtom *da = dyn_cast<DefinedAtom>(ref->target());
1496 if (da == nullptr)
1497 return;
1498
1499 const Reference *helperRef = nullptr;
1500 for (const Reference *hr : *da) {
1501 if (hr->kindValue() == _archHandler.lazyImmediateLocationKind()) {
1502 helperRef = hr;
1503 break;
1504 }
1505 }
1506 if (helperRef == nullptr)
1507 continue;
1508
1509 // TODO: maybe get the fixed atom content from _archHandler ?
1510 for (SectionInfo *sectInfo : _sectionInfos) {
1511 for (const AtomInfo &atomInfo : sectInfo->atomsAndOffsets) {
1512 if (atomInfo.atom == helperRef->target()) {
1513 auto sectionContent =
1514 file.sections[sectInfo->normalizedSectionIndex].content;
1515 uint8_t *rawb =
1516 file.ownedAllocations.Allocate<uint8_t>(sectionContent.size());
1517 llvm::MutableArrayRef<uint8_t> newContent{rawb,
1518 sectionContent.size()};
1519 std::copy(sectionContent.begin(), sectionContent.end(),
1520 newContent.begin());
1521 llvm::support::ulittle32_t *loc =
1522 reinterpret_cast<llvm::support::ulittle32_t *>(
1523 &newContent[atomInfo.offsetInSection +
1524 helperRef->offsetInAtom()]);
1525 *loc = offset;
1526 file.sections[sectInfo->normalizedSectionIndex].content = newContent;
1527 }
1528 }
1529 }
1530 }
1531}
1532
1533void Util::addExportInfo(const lld::File &atomFile, NormalizedFile &nFile) {
1534 if (_ctx.outputMachOType() == llvm::MachO::MH_OBJECT)
1535 return;
1536
1537 for (SectionInfo *sect : _sectionInfos) {
1538 for (const AtomInfo &info : sect->atomsAndOffsets) {
1539 const DefinedAtom *atom = info.atom;
1540 if (atom->scope() != Atom::scopeGlobal)
1541 continue;
1542 if (_ctx.exportRestrictMode()) {
1543 if (!_ctx.exportSymbolNamed(atom->name()))
1544 continue;
1545 }
1546 Export exprt;
1547 exprt.name = atom->name();
1548 exprt.offset = _atomToAddress[atom] - _ctx.baseAddress();
1549 exprt.kind = EXPORT_SYMBOL_FLAGS_KIND_REGULAR;
1550 if (atom->merge() == DefinedAtom::mergeAsWeak)
1551 exprt.flags = EXPORT_SYMBOL_FLAGS_WEAK_DEFINITION;
1552 else
1553 exprt.flags = 0;
1554 exprt.otherOffset = 0;
1555 exprt.otherName = StringRef();
1556 nFile.exportInfo.push_back(exprt);
1557 }
1558 }
1559}
1560
1561uint32_t Util::fileFlags() {
1562 // FIXME: these need to determined at runtime.
1563 if (_ctx.outputMachOType() == MH_OBJECT) {
1564 return _subsectionsViaSymbols ? MH_SUBSECTIONS_VIA_SYMBOLS : 0;
1565 } else {
1566 uint32_t flags = MH_DYLDLINK;
1567 if (!_ctx.useFlatNamespace())
1568 flags |= MH_TWOLEVEL | MH_NOUNDEFS;
1569 if ((_ctx.outputMachOType() == MH_EXECUTE) && _ctx.PIE())
1570 flags |= MH_PIE;
1571 if (_hasTLVDescriptors)
1572 flags |= (MH_PIE | MH_HAS_TLV_DESCRIPTORS);
1573 return flags;
1574 }
1575}
1576
1577} // end anonymous namespace
1578
1579namespace lld {
1580namespace mach_o {
1581namespace normalized {
1582
1583/// Convert a set of Atoms into a normalized mach-o file.
1584llvm::Expected<std::unique_ptr<NormalizedFile>>
1585normalizedFromAtoms(const lld::File &atomFile,
1586 const MachOLinkingContext &context) {
1587 // The util object buffers info until the normalized file can be made.
1588 Util util(context);
1589 util.processDefinedAtoms(atomFile);
1590 util.organizeSections();
1591
1592 std::unique_ptr<NormalizedFile> f(new NormalizedFile());
1593 NormalizedFile &normFile = *f.get();
1594 normFile.arch = context.arch();
1595 normFile.fileType = context.outputMachOType();
1596 normFile.flags = util.fileFlags();
1597 normFile.stackSize = context.stackSize();
1598 normFile.installName = context.installName();
1599 normFile.currentVersion = context.currentVersion();
1600 normFile.compatVersion = context.compatibilityVersion();
1601 normFile.os = context.os();
1602
1603 // If we are emitting an object file, then the min version is the maximum
1604 // of the min's of all the source files and the cmdline.
1605 if (normFile.fileType == llvm::MachO::MH_OBJECT)
1
Assuming the condition is false
2
Taking false branch
1606 normFile.minOSverson = std::max(context.osMinVersion(), util.minVersion());
1607 else
1608 normFile.minOSverson = context.osMinVersion();
1609
1610 normFile.minOSVersionKind = util.minVersionCommandType();
1611
1612 normFile.sdkVersion = context.sdkVersion();
1613 normFile.sourceVersion = context.sourceVersion();
1614
1615 if (context.generateVersionLoadCommand() &&
3
Assuming the condition is false
1616 context.os() != MachOLinkingContext::OS::unknown)
1617 normFile.hasMinVersionLoadCommand = true;
1618 else if (normFile.fileType == llvm::MachO::MH_OBJECT &&
1619 util.allSourceFilesHaveMinVersions() &&
1620 ((normFile.os != MachOLinkingContext::OS::unknown) ||
1621 util.minVersionCommandType())) {
1622 // If we emit an object file, then it should contain a min version load
1623 // command if all of the source files also contained min version commands.
1624 // Also, we either need to have a platform, or found a platform from the
1625 // source object files.
1626 normFile.hasMinVersionLoadCommand = true;
1627 }
1628 normFile.generateDataInCodeLoadCommand =
1629 context.generateDataInCodeLoadCommand();
1630 normFile.pageSize = context.pageSize();
1631 normFile.rpaths = context.rpaths();
1632 util.addDependentDylibs(atomFile, normFile);
1633 util.copySegmentInfo(normFile);
1634 util.copySectionInfo(normFile);
1635 util.assignAddressesToSections(normFile);
1636 util.buildAtomToAddressMap();
1637 if (auto err = util.synthesizeDebugNotes(normFile))
4
Taking false branch
1638 return std::move(err);
1639 util.updateSectionInfo(normFile);
1640 util.copySectionContent(normFile);
1641 if (auto ec = util.addSymbols(atomFile, normFile)) {
5
Calling 'Util::addSymbols'
1642 return std::move(ec);
1643 }
1644 util.addIndirectSymbols(atomFile, normFile);
1645 util.addRebaseAndBindingInfo(atomFile, normFile);
1646 util.addExportInfo(atomFile, normFile);
1647 util.addSectionRelocs(atomFile, normFile);
1648 util.addFunctionStarts(atomFile, normFile);
1649 util.buildDataInCodeArray(atomFile, normFile);
1650 util.copyEntryPointAddress(normFile);
1651
1652 return std::move(f);
1653}
1654
1655} // namespace normalized
1656} // namespace mach_o
1657} // namespace lld

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.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
43namespace llvm {
44
45class ErrorSuccess;
46
47/// Base class for error info classes. Do not extend this directly: Extend
48/// the ErrorInfo template subclass instead.
49class ErrorInfoBase {
50public:
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
87private:
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.
158class 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
175protected:
176 /// Create a success value. Prefer using 'Error::success()' for readability
177 Error() {
178 setPtr(nullptr);
179 setChecked(false);
180 }
181
182public:
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);
20
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'
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
254private:
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.
325class ErrorSuccess final : public Error {};
326
327inline ErrorSuccess Error::success() { return ErrorSuccess(); }
328
329/// Make a Error instance representing failure using the given error info
330/// type.
331template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
332 return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
16
Calling 'make_unique<lld::GenericError, llvm::Twine>'
18
Returned allocated memory
19
Calling constructor for 'Error'
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.
344template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
345class ErrorInfo : public ParentErrT {
346public:
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.
360class 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
369public:
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
383private:
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.
424inline 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.
434template <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
444public:
445 using storage_type = typename std::conditional<isRef, wrap, T>::type;
446 using value_type = T;
447
448private:
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
454public:
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
584private:
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.
688LLVM_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
704inline 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
725template <typename T>
726T 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
749template <typename T>
750T& 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.
762template <typename HandlerT>
763class ErrorHandlerTraits
764 : public ErrorHandlerTraits<decltype(
765 &std::remove_reference<HandlerT>::type::operator())> {};
766
767// Specialization functions of the form 'Error (const ErrT&)'.
768template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
769public:
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&)'.
782template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
783public:
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>)'.
797template <typename ErrT>
798class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
799public:
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>)'.
813template <typename ErrT>
814class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
815public:
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&)'.
830template <typename C, typename RetT, typename ErrT>
831class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
832 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
833
834// Specialization for member functions of the form 'RetT (const ErrT&) const'.
835template <typename C, typename RetT, typename ErrT>
836class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
837 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
838
839// Specialization for member functions of the form 'RetT (const ErrT&)'.
840template <typename C, typename RetT, typename ErrT>
841class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
842 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
843
844// Specialization for member functions of the form 'RetT (const ErrT&) const'.
845template <typename C, typename RetT, typename ErrT>
846class 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>)'.
851template <typename C, typename RetT, typename ErrT>
852class 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'.
857template <typename C, typename RetT, typename ErrT>
858class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
859 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
860
861inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
862 return Error(std::move(Payload));
863}
864
865template <typename HandlerT, typename... HandlerTs>
866Error 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.
881template <typename... HandlerTs>
882Error 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).
904template <typename... HandlerTs>
905void 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.
911inline 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
939template <typename T, typename RecoveryFtor, typename... HandlerTs>
940Expected<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.
959void 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.
963inline 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>.
978inline 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).
987inline 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.
1018class ErrorAsOutParameter {
1019public:
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
1032private:
1033 Error *Err;
1034};
1035
1036/// Helper for Expected<T>s used as out-parameters.
1037///
1038/// See ErrorAsOutParameter.
1039template <typename T>
1040class ExpectedAsOutParameter {
1041public:
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
1053private:
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.
1062class ECError : public ErrorInfo<ECError> {
1063 friend Error errorCodeToError(std::error_code);
1064
1065public:
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
1073protected:
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).
1086std::error_code inconvertibleErrorCode();
1087
1088/// Helper for converting an std::error_code to a Error.
1089Error 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().
1095std::error_code errorToErrorCode(Error Err);
1096
1097/// Convert an ErrorOr<T> to an Expected<T>.
1098template <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>.
1105template <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///
1135class StringError : public ErrorInfo<StringError> {
1136public:
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
1150private:
1151 std::string Msg;
1152 std::error_code EC;
1153 const bool PrintMsgOnly = false;
1154};
1155
1156/// Create formatted StringError object.
1157template <typename... Ts>
1158Error 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
1166Error 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.
1172class FileError final : public ErrorInfo<FileError> {
1173
1174 friend Error createFileError(std::string, Error);
1175
1176public:
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
1190private:
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.
1209inline Error createFileError(std::string F, Error E) {
1210 return FileError::build(F, std::move(E));
1211}
1212
1213Error 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///
1219class ExitOnError {
1220public:
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
1251private:
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.
1265inline LLVMErrorRef wrap(Error Err) {
1266 return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1267}
1268
1269/// Conversion from LLVMErrorRef to Error for C error bindings.
1270inline 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

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.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
44namespace 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.
48template <typename T, T> struct SameType;
49
50namespace detail {
51
52template <typename RangeT>
53using IterOfRange = decltype(std::begin(std::declval<RangeT &>()));
54
55template <typename RangeT>
56using 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
65template <typename T>
66struct negation : std::integral_constant<bool, !bool(T::value)> {};
67
68template <typename...> struct conjunction : std::true_type {};
69template <typename B1> struct conjunction<B1> : B1 {};
70template <typename B1, typename... Bn>
71struct conjunction<B1, Bn...>
72 : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
73
74//===----------------------------------------------------------------------===//
75// Extra additions to <functional>
76//===----------------------------------------------------------------------===//
77
78template <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
89template <class Ty> struct less_ptr {
90 bool operator()(const Ty* left, const Ty* right) const {
91 return *left < *right;
92 }
93};
94
95template <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.
107template<typename Fn> class function_ref;
108
109template<typename Ret, typename ...Params>
110class 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
120public:
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>);
143template <class T>
144inline void deleter(T *Ptr) {
145 delete Ptr;
146}
147
148//===----------------------------------------------------------------------===//
149// Extra additions to <iterator>
150//===----------------------------------------------------------------------===//
151
152namespace adl_detail {
153
154using std::begin;
155
156template <typename ContainerTy>
157auto adl_begin(ContainerTy &&container)
158 -> decltype(begin(std::forward<ContainerTy>(container))) {
159 return begin(std::forward<ContainerTy>(container));
160}
161
162using std::end;
163
164template <typename ContainerTy>
165auto adl_end(ContainerTy &&container)
166 -> decltype(end(std::forward<ContainerTy>(container))) {
167 return end(std::forward<ContainerTy>(container));
168}
169
170using std::swap;
171
172template <typename T>
173void 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
180template <typename ContainerTy>
181auto 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
186template <typename ContainerTy>
187auto 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
192template <typename T>
193void 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
201template <typename ItTy, typename FuncTy,
202 typename FuncReturnTy =
203 decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))>
204class 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> {
209public:
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
217private:
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...
223template <class ItTy, class FuncTy>
224inline 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().
229template <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
239public:
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().
244template <typename Ty>
245struct 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.
250template <typename ContainerTy>
251auto 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.
258template <typename IteratorTy>
259std::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.
266template <typename ContainerTy>
267auto 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.
292template <typename WrappedIteratorT, typename PredicateT, typename IterTag>
293class 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
307protected:
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
325public:
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.
336template <typename WrappedIteratorT, typename PredicateT,
337 typename IterTag = std::forward_iterator_tag>
338class filter_iterator_impl
339 : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> {
340 using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>;
341
342public:
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.
349template <typename WrappedIteratorT, typename PredicateT>
350class 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
361public:
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
375namespace detail {
376
377template <bool is_bidirectional> struct fwd_or_bidi_tag_impl {
378 using type = std::forward_iterator_tag;
379};
380
381template <> 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.
388template <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.
398template <typename WrappedIteratorT, typename PredicateT>
399using 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.
410template <typename RangeT, typename PredicateT>
411iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>>
412make_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.
439template <typename WrappedIteratorT>
440class 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
449protected:
450#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
451 bool IsEarlyIncremented = false;
452#endif
453
454public:
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.
496template <typename RangeT>
497iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>>
498make_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
506template <typename R, typename UnaryPredicate>
507bool all_of(R &&range, UnaryPredicate P);
508
509template <size_t... I> struct index_sequence;
510
511template <class... Ts> struct index_sequence_for;
512
513namespace detail {
514
515using 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.
519template<typename... Iters> struct ZipTupleType {
520 using type = std::tuple<decltype(*declval<Iters>())...>;
521};
522
523template <typename ZipType, typename... Iters>
524using 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
539template <typename ZipType, typename... Iters>
540struct 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
546protected:
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
561public:
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
583template <typename... Iters>
584struct 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
594template <typename... Iters>
595class 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
603public:
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
613template <template <typename...> class ItType, typename... Args> class zippy {
614public:
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
622private:
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
632public:
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.
642template <typename T, typename U, typename... Args>
643detail::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.
651template <typename T, typename U, typename... Args>
652detail::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.
668template <typename ValueT, typename... IterTs>
669class 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
742public:
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
765namespace 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.
772template <typename ValueT, typename... RangeTs> class concat_range {
773public:
774 using iterator =
775 concat_iterator<ValueT,
776 decltype(std::begin(std::declval<RangeTs &>()))...>;
777
778private:
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
789public:
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.
802template <typename ValueT, typename... RangeTs>
803detail::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.
816struct 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.
824struct 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.
832template<typename FuncTy>
833struct 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.
846template <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.
853template <size_t... I>
854struct index_sequence : integer_sequence<std::size_t, I...> {};
855
856template <std::size_t N, std::size_t... I>
857struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {};
858template <std::size_t... I>
859struct build_index_impl<0, I...> : index_sequence<I...> {};
860
861/// Creates a compile-time integer sequence for a parameter pack.
862template <class... Ts>
863struct 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.
867template <int N> struct rank : rank<N - 1> {};
868template <> 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.
872template <typename T, typename... Ts> struct is_one_of {
873 static const bool value = false;
874};
875
876template <typename T, typename U, typename... Ts>
877struct 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.
884template <typename T, typename... Ts> struct are_base_of {
885 static const bool value = true;
886};
887
888template <typename T, typename U, typename... Ts>
889struct 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.
899template <class T, std::size_t N>
900constexpr inline size_t array_lengthof(T (&)[N]) {
901 return N;
902}
903
904/// Adapt std::less<T> for array_pod_sort.
905template<typename T>
906inline 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.
918template<typename T>
919inline 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.
938template<class IteratorTy>
939inline 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
951template <class IteratorTy>
952inline 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).
971template <typename IteratorTy>
972inline 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
980template <typename Container> inline void sort(Container &&C) {
981 llvm::sort(adl_begin(C), adl_end(C));
982}
983
984template <typename IteratorTy, typename Compare>
985inline 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
993template <typename Container, typename Compare>
994inline 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.
1004template<typename Container>
1005void 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.
1013template<typename Container>
1014void 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).
1022template <typename R>
1023auto 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.
1034template <typename R, typename UnaryPredicate>
1035UnaryPredicate 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.
1041template <typename R, typename UnaryPredicate>
1042bool 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.
1048template <typename R, typename UnaryPredicate>
1049bool 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.
1055template <typename R, typename UnaryPredicate>
1056bool 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.
1062template <typename R, typename T>
1063auto 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.
1069template <typename R, typename UnaryPredicate>
1070auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1071 return std::find_if(adl_begin(Range), adl_end(Range), P);
1072}
1073
1074template <typename R, typename UnaryPredicate>
1075auto 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.
1081template <typename R, typename UnaryPredicate>
1082auto 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.
1088template <typename R, typename OutputIt, typename UnaryPredicate>
1089OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) {
1090 return std::copy_if(adl_begin(Range), adl_end(Range), Out, P);
1091}
1092
1093template <typename R, typename OutputIt>
1094OutputIt 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.
1100template <typename R, typename E>
1101bool 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.
1107template <typename R, typename E>
1108auto 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.
1115template <typename R, typename UnaryPredicate>
1116auto 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.
1123template <typename R, typename OutputIt, typename UnaryPredicate>
1124OutputIt 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.
1130template <typename R, typename UnaryPredicate>
1131auto 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.
1137template <typename R, typename ForwardIt>
1138auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) {
1139 return std::lower_bound(adl_begin(Range), adl_end(Range), I);
1140}
1141
1142template <typename R, typename ForwardIt, typename Compare>
1143auto 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.
1150template <typename R, typename ForwardIt>
1151auto upper_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) {
1152 return std::upper_bound(adl_begin(Range), adl_end(Range), I);
1153}
1154
1155template <typename R, typename ForwardIt, typename Compare>
1156auto 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.
1162template <typename R>
1163bool 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.
1172template <unsigned Size, typename R>
1173SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size>
1174to_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.
1185template <typename Container, typename UnaryPredicate>
1186void 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);
1203template <class T, class... Args>
1204typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
1205make_unique(Args &&... args) {
1206 return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
17
Memory is allocated
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.
1217template <class T>
1218typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0,
1219 std::unique_ptr<T>>::type
1220make_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.
1225template <class T, class... Args>
1226typename std::enable_if<std::extent<T>::value != 0>::type
1227make_unique(Args &&...) = delete;
1228
1229struct FreeDeleter {
1230 void operator()(void* v) {
1231 ::free(v);
1232 }
1233};
1234
1235template<typename First, typename Second>
1236struct 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.
1243struct 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.
1250struct 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.
1258template <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
1272namespace detail {
1273
1274template <typename R> class enumerator_iter;
1275
1276template <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
1293private:
1294 std::size_t Index = std::numeric_limits<std::size_t>::max();
1295 IterOfRange<R> Iter;
1296};
1297
1298template <typename R>
1299class 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
1307public:
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
1336private:
1337 result_type Result;
1338};
1339
1340template <typename R> class enumerator {
1341public:
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
1352private:
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///
1373template <typename R> detail::enumerator<R> enumerate(R &&TheRange) {
1374 return detail::enumerator<R>(std::forward<R>(TheRange));
1375}
1376
1377namespace detail {
1378
1379template <typename F, typename Tuple, std::size_t... I>
1380auto 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.
1390template <typename F, typename Tuple>
1391auto 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