File: | include/llvm/Support/Error.h |
Warning: | line 201, column 5 Potential leak of memory pointed to by 'Payload._M_t._M_head_impl' |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | //===- DbiStream.cpp - PDB Dbi Stream (Stream 3) Access -------------------===// | |||
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 | #include "llvm/DebugInfo/PDB/Native/DbiStream.h" | |||
11 | #include "llvm/ADT/StringRef.h" | |||
12 | #include "llvm/DebugInfo/MSF/MappedBlockStream.h" | |||
13 | #include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptor.h" | |||
14 | #include "llvm/DebugInfo/PDB/Native/ISectionContribVisitor.h" | |||
15 | #include "llvm/DebugInfo/PDB/Native/PDBFile.h" | |||
16 | #include "llvm/DebugInfo/PDB/Native/RawConstants.h" | |||
17 | #include "llvm/DebugInfo/PDB/Native/RawError.h" | |||
18 | #include "llvm/DebugInfo/PDB/Native/RawTypes.h" | |||
19 | #include "llvm/DebugInfo/PDB/PDBTypes.h" | |||
20 | #include "llvm/Object/COFF.h" | |||
21 | #include "llvm/Support/BinaryStreamArray.h" | |||
22 | #include "llvm/Support/BinaryStreamReader.h" | |||
23 | #include "llvm/Support/Error.h" | |||
24 | #include <algorithm> | |||
25 | #include <cstddef> | |||
26 | #include <cstdint> | |||
27 | ||||
28 | using namespace llvm; | |||
29 | using namespace llvm::codeview; | |||
30 | using namespace llvm::msf; | |||
31 | using namespace llvm::pdb; | |||
32 | using namespace llvm::support; | |||
33 | ||||
34 | template <typename ContribType> | |||
35 | static Error loadSectionContribs(FixedStreamArray<ContribType> &Output, | |||
36 | BinaryStreamReader &Reader) { | |||
37 | if (Reader.bytesRemaining() % sizeof(ContribType) != 0) | |||
38 | return make_error<RawError>( | |||
39 | raw_error_code::corrupt_file, | |||
40 | "Invalid number of bytes of section contributions"); | |||
41 | ||||
42 | uint32_t Count = Reader.bytesRemaining() / sizeof(ContribType); | |||
43 | if (auto EC = Reader.readArray(Output, Count)) | |||
44 | return EC; | |||
45 | return Error::success(); | |||
46 | } | |||
47 | ||||
48 | DbiStream::DbiStream(std::unique_ptr<BinaryStream> Stream) | |||
49 | : Stream(std::move(Stream)), Header(nullptr) {} | |||
50 | ||||
51 | DbiStream::~DbiStream() = default; | |||
52 | ||||
53 | Error DbiStream::reload(PDBFile *Pdb) { | |||
54 | BinaryStreamReader Reader(*Stream); | |||
55 | ||||
56 | if (Stream->getLength() < sizeof(DbiStreamHeader)) | |||
| ||||
57 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
58 | "DBI Stream does not contain a header."); | |||
59 | if (auto EC = Reader.readObject(Header)) | |||
60 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
61 | "DBI Stream does not contain a header."); | |||
62 | ||||
63 | if (Header->VersionSignature != -1) | |||
64 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
65 | "Invalid DBI version signature."); | |||
66 | ||||
67 | // Require at least version 7, which should be present in all PDBs | |||
68 | // produced in the last decade and allows us to avoid having to | |||
69 | // special case all kinds of complicated arcane formats. | |||
70 | if (Header->VersionHeader < PdbDbiV70) | |||
71 | return make_error<RawError>(raw_error_code::feature_unsupported, | |||
72 | "Unsupported DBI version."); | |||
73 | ||||
74 | if (Stream->getLength() != | |||
75 | sizeof(DbiStreamHeader) + Header->ModiSubstreamSize + | |||
76 | Header->SecContrSubstreamSize + Header->SectionMapSize + | |||
77 | Header->FileInfoSize + Header->TypeServerSize + | |||
78 | Header->OptionalDbgHdrSize + Header->ECSubstreamSize) | |||
79 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
80 | "DBI Length does not equal sum of substreams."); | |||
81 | ||||
82 | // Only certain substreams are guaranteed to be aligned. Validate | |||
83 | // them here. | |||
84 | if (Header->ModiSubstreamSize % sizeof(uint32_t) != 0) | |||
85 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
86 | "DBI MODI substream not aligned."); | |||
87 | if (Header->SecContrSubstreamSize % sizeof(uint32_t) != 0) | |||
88 | return make_error<RawError>( | |||
89 | raw_error_code::corrupt_file, | |||
90 | "DBI section contribution substream not aligned."); | |||
91 | if (Header->SectionMapSize % sizeof(uint32_t) != 0) | |||
92 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
93 | "DBI section map substream not aligned."); | |||
94 | if (Header->FileInfoSize % sizeof(uint32_t) != 0) | |||
95 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
96 | "DBI file info substream not aligned."); | |||
97 | if (Header->TypeServerSize % sizeof(uint32_t) != 0) | |||
98 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
99 | "DBI type server substream not aligned."); | |||
100 | ||||
101 | if (auto EC = Reader.readSubstream(ModiSubstream, Header->ModiSubstreamSize)) | |||
102 | return EC; | |||
103 | ||||
104 | if (auto EC = Reader.readSubstream(SecContrSubstream, | |||
105 | Header->SecContrSubstreamSize)) | |||
106 | return EC; | |||
107 | if (auto EC = Reader.readSubstream(SecMapSubstream, Header->SectionMapSize)) | |||
108 | return EC; | |||
109 | if (auto EC = Reader.readSubstream(FileInfoSubstream, Header->FileInfoSize)) | |||
110 | return EC; | |||
111 | if (auto EC = | |||
112 | Reader.readSubstream(TypeServerMapSubstream, Header->TypeServerSize)) | |||
113 | return EC; | |||
114 | if (auto EC = Reader.readSubstream(ECSubstream, Header->ECSubstreamSize)) | |||
115 | return EC; | |||
116 | if (auto EC = Reader.readArray( | |||
117 | DbgStreams, Header->OptionalDbgHdrSize / sizeof(ulittle16_t))) | |||
118 | return EC; | |||
119 | ||||
120 | if (auto EC = Modules.initialize(ModiSubstream.StreamData, | |||
121 | FileInfoSubstream.StreamData)) | |||
122 | return EC; | |||
123 | ||||
124 | if (auto EC = initializeSectionContributionData()) | |||
125 | return EC; | |||
126 | if (auto EC = initializeSectionHeadersData(Pdb)) | |||
127 | return EC; | |||
128 | if (auto EC = initializeSectionMapData()) | |||
129 | return EC; | |||
130 | if (auto EC = initializeFpoRecords(Pdb)) | |||
131 | return EC; | |||
132 | ||||
133 | if (Reader.bytesRemaining() > 0) | |||
134 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
135 | "Found unexpected bytes in DBI Stream."); | |||
136 | ||||
137 | if (!ECSubstream.empty()) { | |||
138 | BinaryStreamReader ECReader(ECSubstream.StreamData); | |||
139 | if (auto EC = ECNames.reload(ECReader)) | |||
140 | return EC; | |||
141 | } | |||
142 | ||||
143 | return Error::success(); | |||
144 | } | |||
145 | ||||
146 | PdbRaw_DbiVer DbiStream::getDbiVersion() const { | |||
147 | uint32_t Value = Header->VersionHeader; | |||
148 | return static_cast<PdbRaw_DbiVer>(Value); | |||
149 | } | |||
150 | ||||
151 | uint32_t DbiStream::getAge() const { return Header->Age; } | |||
152 | ||||
153 | uint16_t DbiStream::getPublicSymbolStreamIndex() const { | |||
154 | return Header->PublicSymbolStreamIndex; | |||
155 | } | |||
156 | ||||
157 | uint16_t DbiStream::getGlobalSymbolStreamIndex() const { | |||
158 | return Header->GlobalSymbolStreamIndex; | |||
159 | } | |||
160 | ||||
161 | uint16_t DbiStream::getFlags() const { return Header->Flags; } | |||
162 | ||||
163 | bool DbiStream::isIncrementallyLinked() const { | |||
164 | return (Header->Flags & DbiFlags::FlagIncrementalMask) != 0; | |||
165 | } | |||
166 | ||||
167 | bool DbiStream::hasCTypes() const { | |||
168 | return (Header->Flags & DbiFlags::FlagHasCTypesMask) != 0; | |||
169 | } | |||
170 | ||||
171 | bool DbiStream::isStripped() const { | |||
172 | return (Header->Flags & DbiFlags::FlagStrippedMask) != 0; | |||
173 | } | |||
174 | ||||
175 | uint16_t DbiStream::getBuildNumber() const { return Header->BuildNumber; } | |||
176 | ||||
177 | uint16_t DbiStream::getBuildMajorVersion() const { | |||
178 | return (Header->BuildNumber & DbiBuildNo::BuildMajorMask) >> | |||
179 | DbiBuildNo::BuildMajorShift; | |||
180 | } | |||
181 | ||||
182 | uint16_t DbiStream::getBuildMinorVersion() const { | |||
183 | return (Header->BuildNumber & DbiBuildNo::BuildMinorMask) >> | |||
184 | DbiBuildNo::BuildMinorShift; | |||
185 | } | |||
186 | ||||
187 | uint16_t DbiStream::getPdbDllRbld() const { return Header->PdbDllRbld; } | |||
188 | ||||
189 | uint32_t DbiStream::getPdbDllVersion() const { return Header->PdbDllVersion; } | |||
190 | ||||
191 | uint32_t DbiStream::getSymRecordStreamIndex() const { | |||
192 | return Header->SymRecordStreamIndex; | |||
193 | } | |||
194 | ||||
195 | PDB_Machine DbiStream::getMachineType() const { | |||
196 | uint16_t Machine = Header->MachineType; | |||
197 | return static_cast<PDB_Machine>(Machine); | |||
198 | } | |||
199 | ||||
200 | FixedStreamArray<object::coff_section> DbiStream::getSectionHeaders() const { | |||
201 | return SectionHeaders; | |||
202 | } | |||
203 | ||||
204 | FixedStreamArray<object::FpoData> DbiStream::getFpoRecords() { | |||
205 | return FpoRecords; | |||
206 | } | |||
207 | ||||
208 | const DbiModuleList &DbiStream::modules() const { return Modules; } | |||
209 | ||||
210 | FixedStreamArray<SecMapEntry> DbiStream::getSectionMap() const { | |||
211 | return SectionMap; | |||
212 | } | |||
213 | ||||
214 | void DbiStream::visitSectionContributions( | |||
215 | ISectionContribVisitor &Visitor) const { | |||
216 | if (!SectionContribs.empty()) { | |||
217 | assert(SectionContribVersion == DbiSecContribVer60)((SectionContribVersion == DbiSecContribVer60) ? static_cast< void> (0) : __assert_fail ("SectionContribVersion == DbiSecContribVer60" , "/build/llvm-toolchain-snapshot-8~svn350071/lib/DebugInfo/PDB/Native/DbiStream.cpp" , 217, __PRETTY_FUNCTION__)); | |||
218 | for (auto &SC : SectionContribs) | |||
219 | Visitor.visit(SC); | |||
220 | } else if (!SectionContribs2.empty()) { | |||
221 | assert(SectionContribVersion == DbiSecContribV2)((SectionContribVersion == DbiSecContribV2) ? static_cast< void> (0) : __assert_fail ("SectionContribVersion == DbiSecContribV2" , "/build/llvm-toolchain-snapshot-8~svn350071/lib/DebugInfo/PDB/Native/DbiStream.cpp" , 221, __PRETTY_FUNCTION__)); | |||
222 | for (auto &SC : SectionContribs2) | |||
223 | Visitor.visit(SC); | |||
224 | } | |||
225 | } | |||
226 | ||||
227 | Expected<StringRef> DbiStream::getECName(uint32_t NI) const { | |||
228 | return ECNames.getStringForID(NI); | |||
229 | } | |||
230 | ||||
231 | Error DbiStream::initializeSectionContributionData() { | |||
232 | if (SecContrSubstream.empty()) | |||
233 | return Error::success(); | |||
234 | ||||
235 | BinaryStreamReader SCReader(SecContrSubstream.StreamData); | |||
236 | if (auto EC = SCReader.readEnum(SectionContribVersion)) | |||
237 | return EC; | |||
238 | ||||
239 | if (SectionContribVersion == DbiSecContribVer60) | |||
240 | return loadSectionContribs<SectionContrib>(SectionContribs, SCReader); | |||
241 | if (SectionContribVersion == DbiSecContribV2) | |||
242 | return loadSectionContribs<SectionContrib2>(SectionContribs2, SCReader); | |||
243 | ||||
244 | return make_error<RawError>(raw_error_code::feature_unsupported, | |||
245 | "Unsupported DBI Section Contribution version"); | |||
246 | } | |||
247 | ||||
248 | // Initializes this->SectionHeaders. | |||
249 | Error DbiStream::initializeSectionHeadersData(PDBFile *Pdb) { | |||
250 | if (!Pdb) | |||
251 | return Error::success(); | |||
252 | ||||
253 | if (DbgStreams.size() == 0) | |||
254 | return Error::success(); | |||
255 | ||||
256 | uint32_t StreamNum = getDebugStreamIndex(DbgHeaderType::SectionHdr); | |||
257 | if (StreamNum == kInvalidStreamIndex) | |||
258 | return Error::success(); | |||
259 | ||||
260 | if (StreamNum >= Pdb->getNumStreams()) | |||
261 | return make_error<RawError>(raw_error_code::no_stream); | |||
262 | ||||
263 | auto SHS = MappedBlockStream::createIndexedStream( | |||
264 | Pdb->getMsfLayout(), Pdb->getMsfBuffer(), StreamNum, Pdb->getAllocator()); | |||
265 | ||||
266 | size_t StreamLen = SHS->getLength(); | |||
267 | if (StreamLen % sizeof(object::coff_section)) | |||
268 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
269 | "Corrupted section header stream."); | |||
270 | ||||
271 | size_t NumSections = StreamLen / sizeof(object::coff_section); | |||
272 | BinaryStreamReader Reader(*SHS); | |||
273 | if (auto EC = Reader.readArray(SectionHeaders, NumSections)) | |||
274 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
275 | "Could not read a bitmap."); | |||
276 | ||||
277 | SectionHeaderStream = std::move(SHS); | |||
278 | return Error::success(); | |||
279 | } | |||
280 | ||||
281 | // Initializes this->Fpos. | |||
282 | Error DbiStream::initializeFpoRecords(PDBFile *Pdb) { | |||
283 | if (!Pdb) | |||
284 | return Error::success(); | |||
285 | ||||
286 | if (DbgStreams.size() == 0) | |||
287 | return Error::success(); | |||
288 | ||||
289 | uint32_t StreamNum = getDebugStreamIndex(DbgHeaderType::NewFPO); | |||
290 | ||||
291 | // This means there is no FPO data. | |||
292 | if (StreamNum == kInvalidStreamIndex) | |||
293 | return Error::success(); | |||
294 | ||||
295 | if (StreamNum >= Pdb->getNumStreams()) | |||
296 | return make_error<RawError>(raw_error_code::no_stream); | |||
297 | ||||
298 | auto FS = MappedBlockStream::createIndexedStream( | |||
299 | Pdb->getMsfLayout(), Pdb->getMsfBuffer(), StreamNum, Pdb->getAllocator()); | |||
300 | ||||
301 | size_t StreamLen = FS->getLength(); | |||
302 | if (StreamLen % sizeof(object::FpoData)) | |||
303 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
304 | "Corrupted New FPO stream."); | |||
305 | ||||
306 | size_t NumRecords = StreamLen / sizeof(object::FpoData); | |||
307 | BinaryStreamReader Reader(*FS); | |||
308 | if (auto EC = Reader.readArray(FpoRecords, NumRecords)) | |||
309 | return make_error<RawError>(raw_error_code::corrupt_file, | |||
310 | "Corrupted New FPO stream."); | |||
311 | FpoStream = std::move(FS); | |||
312 | return Error::success(); | |||
313 | } | |||
314 | ||||
315 | BinarySubstreamRef DbiStream::getSectionContributionData() const { | |||
316 | return SecContrSubstream; | |||
317 | } | |||
318 | ||||
319 | BinarySubstreamRef DbiStream::getSecMapSubstreamData() const { | |||
320 | return SecMapSubstream; | |||
321 | } | |||
322 | ||||
323 | BinarySubstreamRef DbiStream::getModiSubstreamData() const { | |||
324 | return ModiSubstream; | |||
325 | } | |||
326 | ||||
327 | BinarySubstreamRef DbiStream::getFileInfoSubstreamData() const { | |||
328 | return FileInfoSubstream; | |||
329 | } | |||
330 | ||||
331 | BinarySubstreamRef DbiStream::getTypeServerMapSubstreamData() const { | |||
332 | return TypeServerMapSubstream; | |||
333 | } | |||
334 | ||||
335 | BinarySubstreamRef DbiStream::getECSubstreamData() const { return ECSubstream; } | |||
336 | ||||
337 | Error DbiStream::initializeSectionMapData() { | |||
338 | if (SecMapSubstream.empty()) | |||
339 | return Error::success(); | |||
340 | ||||
341 | BinaryStreamReader SMReader(SecMapSubstream.StreamData); | |||
342 | const SecMapHeader *Header; | |||
343 | if (auto EC = SMReader.readObject(Header)) | |||
344 | return EC; | |||
345 | if (auto EC = SMReader.readArray(SectionMap, Header->SecCount)) | |||
346 | return EC; | |||
347 | return Error::success(); | |||
348 | } | |||
349 | ||||
350 | uint32_t DbiStream::getDebugStreamIndex(DbgHeaderType Type) const { | |||
351 | uint16_t T = static_cast<uint16_t>(Type); | |||
352 | if (T >= DbgStreams.size()) | |||
353 | return kInvalidStreamIndex; | |||
354 | return DbgStreams[T]; | |||
355 | } |
1 | //===- BinaryStreamReader.h - Reads objects from a binary stream *- 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 | #ifndef LLVM_SUPPORT_BINARYSTREAMREADER_H |
11 | #define LLVM_SUPPORT_BINARYSTREAMREADER_H |
12 | |
13 | #include "llvm/ADT/ArrayRef.h" |
14 | #include "llvm/ADT/STLExtras.h" |
15 | #include "llvm/Support/BinaryStreamArray.h" |
16 | #include "llvm/Support/BinaryStreamRef.h" |
17 | #include "llvm/Support/ConvertUTF.h" |
18 | #include "llvm/Support/Endian.h" |
19 | #include "llvm/Support/Error.h" |
20 | #include "llvm/Support/type_traits.h" |
21 | |
22 | #include <string> |
23 | #include <type_traits> |
24 | |
25 | namespace llvm { |
26 | |
27 | /// Provides read only access to a subclass of `BinaryStream`. Provides |
28 | /// bounds checking and helpers for writing certain common data types such as |
29 | /// null-terminated strings, integers in various flavors of endianness, etc. |
30 | /// Can be subclassed to provide reading of custom datatypes, although no |
31 | /// are overridable. |
32 | class BinaryStreamReader { |
33 | public: |
34 | BinaryStreamReader() = default; |
35 | explicit BinaryStreamReader(BinaryStreamRef Ref); |
36 | explicit BinaryStreamReader(BinaryStream &Stream); |
37 | explicit BinaryStreamReader(ArrayRef<uint8_t> Data, |
38 | llvm::support::endianness Endian); |
39 | explicit BinaryStreamReader(StringRef Data, llvm::support::endianness Endian); |
40 | |
41 | BinaryStreamReader(const BinaryStreamReader &Other) |
42 | : Stream(Other.Stream), Offset(Other.Offset) {} |
43 | |
44 | BinaryStreamReader &operator=(const BinaryStreamReader &Other) { |
45 | Stream = Other.Stream; |
46 | Offset = Other.Offset; |
47 | return *this; |
48 | } |
49 | |
50 | virtual ~BinaryStreamReader() {} |
51 | |
52 | /// Read as much as possible from the underlying string at the current offset |
53 | /// without invoking a copy, and set \p Buffer to the resulting data slice. |
54 | /// Updates the stream's offset to point after the newly read data. |
55 | /// |
56 | /// \returns a success error code if the data was successfully read, otherwise |
57 | /// returns an appropriate error code. |
58 | Error readLongestContiguousChunk(ArrayRef<uint8_t> &Buffer); |
59 | |
60 | /// Read \p Size bytes from the underlying stream at the current offset and |
61 | /// and set \p Buffer to the resulting data slice. Whether a copy occurs |
62 | /// depends on the implementation of the underlying stream. Updates the |
63 | /// stream's offset to point after the newly read data. |
64 | /// |
65 | /// \returns a success error code if the data was successfully read, otherwise |
66 | /// returns an appropriate error code. |
67 | Error readBytes(ArrayRef<uint8_t> &Buffer, uint32_t Size); |
68 | |
69 | /// Read an integer of the specified endianness into \p Dest and update the |
70 | /// stream's offset. The data is always copied from the stream's underlying |
71 | /// buffer into \p Dest. Updates the stream's offset to point after the newly |
72 | /// read data. |
73 | /// |
74 | /// \returns a success error code if the data was successfully read, otherwise |
75 | /// returns an appropriate error code. |
76 | template <typename T> Error readInteger(T &Dest) { |
77 | static_assert(std::is_integral<T>::value, |
78 | "Cannot call readInteger with non-integral value!"); |
79 | |
80 | ArrayRef<uint8_t> Bytes; |
81 | if (auto EC = readBytes(Bytes, sizeof(T))) |
82 | return EC; |
83 | |
84 | Dest = llvm::support::endian::read<T, llvm::support::unaligned>( |
85 | Bytes.data(), Stream.getEndian()); |
86 | return Error::success(); |
87 | } |
88 | |
89 | /// Similar to readInteger. |
90 | template <typename T> Error readEnum(T &Dest) { |
91 | static_assert(std::is_enum<T>::value, |
92 | "Cannot call readEnum with non-enum value!"); |
93 | typename std::underlying_type<T>::type N; |
94 | if (auto EC = readInteger(N)) |
95 | return EC; |
96 | Dest = static_cast<T>(N); |
97 | return Error::success(); |
98 | } |
99 | |
100 | /// Read a null terminated string from \p Dest. Whether a copy occurs depends |
101 | /// on the implementation of the underlying stream. Updates the stream's |
102 | /// offset to point after the newly read data. |
103 | /// |
104 | /// \returns a success error code if the data was successfully read, otherwise |
105 | /// returns an appropriate error code. |
106 | Error readCString(StringRef &Dest); |
107 | |
108 | /// Similar to readCString, however read a null-terminated UTF16 string |
109 | /// instead. |
110 | /// |
111 | /// \returns a success error code if the data was successfully read, otherwise |
112 | /// returns an appropriate error code. |
113 | Error readWideString(ArrayRef<UTF16> &Dest); |
114 | |
115 | /// Read a \p Length byte string into \p Dest. Whether a copy occurs depends |
116 | /// on the implementation of the underlying stream. Updates the stream's |
117 | /// offset to point after the newly read data. |
118 | /// |
119 | /// \returns a success error code if the data was successfully read, otherwise |
120 | /// returns an appropriate error code. |
121 | Error readFixedString(StringRef &Dest, uint32_t Length); |
122 | |
123 | /// Read the entire remainder of the underlying stream into \p Ref. This is |
124 | /// equivalent to calling getUnderlyingStream().slice(Offset). Updates the |
125 | /// stream's offset to point to the end of the stream. Never causes a copy. |
126 | /// |
127 | /// \returns a success error code if the data was successfully read, otherwise |
128 | /// returns an appropriate error code. |
129 | Error readStreamRef(BinaryStreamRef &Ref); |
130 | |
131 | /// Read \p Length bytes from the underlying stream into \p Ref. This is |
132 | /// equivalent to calling getUnderlyingStream().slice(Offset, Length). |
133 | /// Updates the stream's offset to point after the newly read object. Never |
134 | /// causes a copy. |
135 | /// |
136 | /// \returns a success error code if the data was successfully read, otherwise |
137 | /// returns an appropriate error code. |
138 | Error readStreamRef(BinaryStreamRef &Ref, uint32_t Length); |
139 | |
140 | /// Read \p Length bytes from the underlying stream into \p Stream. This is |
141 | /// equivalent to calling getUnderlyingStream().slice(Offset, Length). |
142 | /// Updates the stream's offset to point after the newly read object. Never |
143 | /// causes a copy. |
144 | /// |
145 | /// \returns a success error code if the data was successfully read, otherwise |
146 | /// returns an appropriate error code. |
147 | Error readSubstream(BinarySubstreamRef &Stream, uint32_t Size); |
148 | |
149 | /// Get a pointer to an object of type T from the underlying stream, as if by |
150 | /// memcpy, and store the result into \p Dest. It is up to the caller to |
151 | /// ensure that objects of type T can be safely treated in this manner. |
152 | /// Updates the stream's offset to point after the newly read object. Whether |
153 | /// a copy occurs depends upon the implementation of the underlying |
154 | /// stream. |
155 | /// |
156 | /// \returns a success error code if the data was successfully read, otherwise |
157 | /// returns an appropriate error code. |
158 | template <typename T> Error readObject(const T *&Dest) { |
159 | ArrayRef<uint8_t> Buffer; |
160 | if (auto EC = readBytes(Buffer, sizeof(T))) |
161 | return EC; |
162 | Dest = reinterpret_cast<const T *>(Buffer.data()); |
163 | return Error::success(); |
164 | } |
165 | |
166 | /// Get a reference to a \p NumElements element array of objects of type T |
167 | /// from the underlying stream as if by memcpy, and store the resulting array |
168 | /// slice into \p array. It is up to the caller to ensure that objects of |
169 | /// type T can be safely treated in this manner. Updates the stream's offset |
170 | /// to point after the newly read object. Whether a copy occurs depends upon |
171 | /// the implementation of the underlying stream. |
172 | /// |
173 | /// \returns a success error code if the data was successfully read, otherwise |
174 | /// returns an appropriate error code. |
175 | template <typename T> |
176 | Error readArray(ArrayRef<T> &Array, uint32_t NumElements) { |
177 | ArrayRef<uint8_t> Bytes; |
178 | if (NumElements == 0) { |
179 | Array = ArrayRef<T>(); |
180 | return Error::success(); |
181 | } |
182 | |
183 | if (NumElements > UINT32_MAX(4294967295U) / sizeof(T)) |
184 | return make_error<BinaryStreamError>( |
185 | stream_error_code::invalid_array_size); |
186 | |
187 | if (auto EC = readBytes(Bytes, NumElements * sizeof(T))) |
188 | return EC; |
189 | |
190 | assert(alignmentAdjustment(Bytes.data(), alignof(T)) == 0 &&((alignmentAdjustment(Bytes.data(), alignof(T)) == 0 && "Reading at invalid alignment!") ? static_cast<void> ( 0) : __assert_fail ("alignmentAdjustment(Bytes.data(), alignof(T)) == 0 && \"Reading at invalid alignment!\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/BinaryStreamReader.h" , 191, __PRETTY_FUNCTION__)) |
191 | "Reading at invalid alignment!")((alignmentAdjustment(Bytes.data(), alignof(T)) == 0 && "Reading at invalid alignment!") ? static_cast<void> ( 0) : __assert_fail ("alignmentAdjustment(Bytes.data(), alignof(T)) == 0 && \"Reading at invalid alignment!\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/BinaryStreamReader.h" , 191, __PRETTY_FUNCTION__)); |
192 | |
193 | Array = ArrayRef<T>(reinterpret_cast<const T *>(Bytes.data()), NumElements); |
194 | return Error::success(); |
195 | } |
196 | |
197 | /// Read a VarStreamArray of size \p Size bytes and store the result into |
198 | /// \p Array. Updates the stream's offset to point after the newly read |
199 | /// array. Never causes a copy (although iterating the elements of the |
200 | /// VarStreamArray may, depending upon the implementation of the underlying |
201 | /// stream). |
202 | /// |
203 | /// \returns a success error code if the data was successfully read, otherwise |
204 | /// returns an appropriate error code. |
205 | template <typename T, typename U> |
206 | Error readArray(VarStreamArray<T, U> &Array, uint32_t Size, |
207 | uint32_t Skew = 0) { |
208 | BinaryStreamRef S; |
209 | if (auto EC = readStreamRef(S, Size)) |
210 | return EC; |
211 | Array.setUnderlyingStream(S, Skew); |
212 | return Error::success(); |
213 | } |
214 | |
215 | /// Read a FixedStreamArray of \p NumItems elements and store the result into |
216 | /// \p Array. Updates the stream's offset to point after the newly read |
217 | /// array. Never causes a copy (although iterating the elements of the |
218 | /// FixedStreamArray may, depending upon the implementation of the underlying |
219 | /// stream). |
220 | /// |
221 | /// \returns a success error code if the data was successfully read, otherwise |
222 | /// returns an appropriate error code. |
223 | template <typename T> |
224 | Error readArray(FixedStreamArray<T> &Array, uint32_t NumItems) { |
225 | if (NumItems == 0) { |
226 | Array = FixedStreamArray<T>(); |
227 | return Error::success(); |
228 | } |
229 | |
230 | if (NumItems > UINT32_MAX(4294967295U) / sizeof(T)) |
231 | return make_error<BinaryStreamError>( |
232 | stream_error_code::invalid_array_size); |
233 | |
234 | BinaryStreamRef View; |
235 | if (auto EC = readStreamRef(View, NumItems * sizeof(T))) |
236 | return EC; |
237 | |
238 | Array = FixedStreamArray<T>(View); |
239 | return Error::success(); |
240 | } |
241 | |
242 | bool empty() const { return bytesRemaining() == 0; } |
243 | void setOffset(uint32_t Off) { Offset = Off; } |
244 | uint32_t getOffset() const { return Offset; } |
245 | uint32_t getLength() const { return Stream.getLength(); } |
246 | uint32_t bytesRemaining() const { return getLength() - getOffset(); } |
247 | |
248 | /// Advance the stream's offset by \p Amount bytes. |
249 | /// |
250 | /// \returns a success error code if at least \p Amount bytes remain in the |
251 | /// stream, otherwise returns an appropriate error code. |
252 | Error skip(uint32_t Amount); |
253 | |
254 | /// Examine the next byte of the underlying stream without advancing the |
255 | /// stream's offset. If the stream is empty the behavior is undefined. |
256 | /// |
257 | /// \returns the next byte in the stream. |
258 | uint8_t peek() const; |
259 | |
260 | Error padToAlignment(uint32_t Align); |
261 | |
262 | std::pair<BinaryStreamReader, BinaryStreamReader> |
263 | split(uint32_t Offset) const; |
264 | |
265 | private: |
266 | BinaryStreamRef Stream; |
267 | uint32_t Offset = 0; |
268 | }; |
269 | } // namespace llvm |
270 | |
271 | #endif // LLVM_SUPPORT_BINARYSTREAMREADER_H |
1 | //===- llvm/Support/Error.h - Recoverable error handling --------*- C++ -*-===// | |||
2 | // | |||
3 | // The LLVM Compiler Infrastructure | |||
4 | // | |||
5 | // This file is distributed under the University of Illinois Open Source | |||
6 | // License. See LICENSE.TXT for details. | |||
7 | // | |||
8 | //===----------------------------------------------------------------------===// | |||
9 | // | |||
10 | // This file defines an API used to report recoverable errors. | |||
11 | // | |||
12 | //===----------------------------------------------------------------------===// | |||
13 | ||||
14 | #ifndef LLVM_SUPPORT_ERROR_H | |||
15 | #define LLVM_SUPPORT_ERROR_H | |||
16 | ||||
17 | #include "llvm-c/Error.h" | |||
18 | #include "llvm/ADT/STLExtras.h" | |||
19 | #include "llvm/ADT/SmallVector.h" | |||
20 | #include "llvm/ADT/StringExtras.h" | |||
21 | #include "llvm/ADT/Twine.h" | |||
22 | #include "llvm/Config/abi-breaking.h" | |||
23 | #include "llvm/Support/AlignOf.h" | |||
24 | #include "llvm/Support/Compiler.h" | |||
25 | #include "llvm/Support/Debug.h" | |||
26 | #include "llvm/Support/ErrorHandling.h" | |||
27 | #include "llvm/Support/ErrorOr.h" | |||
28 | #include "llvm/Support/Format.h" | |||
29 | #include "llvm/Support/raw_ostream.h" | |||
30 | #include <algorithm> | |||
31 | #include <cassert> | |||
32 | #include <cstdint> | |||
33 | #include <cstdlib> | |||
34 | #include <functional> | |||
35 | #include <memory> | |||
36 | #include <new> | |||
37 | #include <string> | |||
38 | #include <system_error> | |||
39 | #include <type_traits> | |||
40 | #include <utility> | |||
41 | #include <vector> | |||
42 | ||||
43 | namespace llvm { | |||
44 | ||||
45 | class ErrorSuccess; | |||
46 | ||||
47 | /// Base class for error info classes. Do not extend this directly: Extend | |||
48 | /// the ErrorInfo template subclass instead. | |||
49 | class ErrorInfoBase { | |||
50 | public: | |||
51 | virtual ~ErrorInfoBase() = default; | |||
52 | ||||
53 | /// Print an error message to an output stream. | |||
54 | virtual void log(raw_ostream &OS) const = 0; | |||
55 | ||||
56 | /// Return the error message as a string. | |||
57 | virtual std::string message() const { | |||
58 | std::string Msg; | |||
59 | raw_string_ostream OS(Msg); | |||
60 | log(OS); | |||
61 | return OS.str(); | |||
62 | } | |||
63 | ||||
64 | /// Convert this error to a std::error_code. | |||
65 | /// | |||
66 | /// This is a temporary crutch to enable interaction with code still | |||
67 | /// using std::error_code. It will be removed in the future. | |||
68 | virtual std::error_code convertToErrorCode() const = 0; | |||
69 | ||||
70 | // Returns the class ID for this type. | |||
71 | static const void *classID() { return &ID; } | |||
72 | ||||
73 | // Returns the class ID for the dynamic type of this ErrorInfoBase instance. | |||
74 | virtual const void *dynamicClassID() const = 0; | |||
75 | ||||
76 | // Check whether this instance is a subclass of the class identified by | |||
77 | // ClassID. | |||
78 | virtual bool isA(const void *const ClassID) const { | |||
79 | return ClassID == classID(); | |||
80 | } | |||
81 | ||||
82 | // Check whether this instance is a subclass of ErrorInfoT. | |||
83 | template <typename ErrorInfoT> bool isA() const { | |||
84 | return isA(ErrorInfoT::classID()); | |||
85 | } | |||
86 | ||||
87 | private: | |||
88 | virtual void anchor(); | |||
89 | ||||
90 | static char ID; | |||
91 | }; | |||
92 | ||||
93 | /// Lightweight error class with error context and mandatory checking. | |||
94 | /// | |||
95 | /// Instances of this class wrap a ErrorInfoBase pointer. Failure states | |||
96 | /// are represented by setting the pointer to a ErrorInfoBase subclass | |||
97 | /// instance containing information describing the failure. Success is | |||
98 | /// represented by a null pointer value. | |||
99 | /// | |||
100 | /// Instances of Error also contains a 'Checked' flag, which must be set | |||
101 | /// before the destructor is called, otherwise the destructor will trigger a | |||
102 | /// runtime error. This enforces at runtime the requirement that all Error | |||
103 | /// instances be checked or returned to the caller. | |||
104 | /// | |||
105 | /// There are two ways to set the checked flag, depending on what state the | |||
106 | /// Error instance is in. For Error instances indicating success, it | |||
107 | /// is sufficient to invoke the boolean conversion operator. E.g.: | |||
108 | /// | |||
109 | /// @code{.cpp} | |||
110 | /// Error foo(<...>); | |||
111 | /// | |||
112 | /// if (auto E = foo(<...>)) | |||
113 | /// return E; // <- Return E if it is in the error state. | |||
114 | /// // We have verified that E was in the success state. It can now be safely | |||
115 | /// // destroyed. | |||
116 | /// @endcode | |||
117 | /// | |||
118 | /// A success value *can not* be dropped. For example, just calling 'foo(<...>)' | |||
119 | /// without testing the return value will raise a runtime error, even if foo | |||
120 | /// returns success. | |||
121 | /// | |||
122 | /// For Error instances representing failure, you must use either the | |||
123 | /// handleErrors or handleAllErrors function with a typed handler. E.g.: | |||
124 | /// | |||
125 | /// @code{.cpp} | |||
126 | /// class MyErrorInfo : public ErrorInfo<MyErrorInfo> { | |||
127 | /// // Custom error info. | |||
128 | /// }; | |||
129 | /// | |||
130 | /// Error foo(<...>) { return make_error<MyErrorInfo>(...); } | |||
131 | /// | |||
132 | /// auto E = foo(<...>); // <- foo returns failure with MyErrorInfo. | |||
133 | /// auto NewE = | |||
134 | /// handleErrors(E, | |||
135 | /// [](const MyErrorInfo &M) { | |||
136 | /// // Deal with the error. | |||
137 | /// }, | |||
138 | /// [](std::unique_ptr<OtherError> M) -> Error { | |||
139 | /// if (canHandle(*M)) { | |||
140 | /// // handle error. | |||
141 | /// return Error::success(); | |||
142 | /// } | |||
143 | /// // Couldn't handle this error instance. Pass it up the stack. | |||
144 | /// return Error(std::move(M)); | |||
145 | /// ); | |||
146 | /// // Note - we must check or return NewE in case any of the handlers | |||
147 | /// // returned a new error. | |||
148 | /// @endcode | |||
149 | /// | |||
150 | /// The handleAllErrors function is identical to handleErrors, except | |||
151 | /// that it has a void return type, and requires all errors to be handled and | |||
152 | /// no new errors be returned. It prevents errors (assuming they can all be | |||
153 | /// handled) from having to be bubbled all the way to the top-level. | |||
154 | /// | |||
155 | /// *All* Error instances must be checked before destruction, even if | |||
156 | /// they're moved-assigned or constructed from Success values that have already | |||
157 | /// been checked. This enforces checking through all levels of the call stack. | |||
158 | class LLVM_NODISCARD[[clang::warn_unused_result]] Error { | |||
159 | // Both ErrorList and FileError need to be able to yank ErrorInfoBase | |||
160 | // pointers out of this class to add to the error list. | |||
161 | friend class ErrorList; | |||
162 | friend class FileError; | |||
163 | ||||
164 | // handleErrors needs to be able to set the Checked flag. | |||
165 | template <typename... HandlerTs> | |||
166 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); | |||
167 | ||||
168 | // Expected<T> needs to be able to steal the payload when constructed from an | |||
169 | // error. | |||
170 | template <typename T> friend class Expected; | |||
171 | ||||
172 | // wrap needs to be able to steal the payload. | |||
173 | friend LLVMErrorRef wrap(Error); | |||
174 | ||||
175 | protected: | |||
176 | /// Create a success value. Prefer using 'Error::success()' for readability | |||
177 | Error() { | |||
178 | setPtr(nullptr); | |||
179 | setChecked(false); | |||
180 | } | |||
181 | ||||
182 | public: | |||
183 | /// Create a success value. | |||
184 | static ErrorSuccess success(); | |||
185 | ||||
186 | // Errors are not copy-constructable. | |||
187 | Error(const Error &Other) = delete; | |||
188 | ||||
189 | /// Move-construct an error value. The newly constructed error is considered | |||
190 | /// unchecked, even if the source error had been checked. The original error | |||
191 | /// becomes a checked Success value, regardless of its original state. | |||
192 | Error(Error &&Other) { | |||
193 | setChecked(true); | |||
194 | *this = std::move(Other); | |||
195 | } | |||
196 | ||||
197 | /// Create an error value. Prefer using the 'make_error' function, but | |||
198 | /// this constructor can be useful when "re-throwing" errors from handlers. | |||
199 | Error(std::unique_ptr<ErrorInfoBase> Payload) { | |||
200 | setPtr(Payload.release()); | |||
201 | setChecked(false); | |||
| ||||
202 | } | |||
203 | ||||
204 | // Errors are not copy-assignable. | |||
205 | Error &operator=(const Error &Other) = delete; | |||
206 | ||||
207 | /// Move-assign an error value. The current error must represent success, you | |||
208 | /// you cannot overwrite an unhandled error. The current error is then | |||
209 | /// considered unchecked. The source error becomes a checked success value, | |||
210 | /// regardless of its original state. | |||
211 | Error &operator=(Error &&Other) { | |||
212 | // Don't allow overwriting of unchecked values. | |||
213 | assertIsChecked(); | |||
214 | setPtr(Other.getPtr()); | |||
215 | ||||
216 | // This Error is unchecked, even if the source error was checked. | |||
217 | setChecked(false); | |||
218 | ||||
219 | // Null out Other's payload and set its checked bit. | |||
220 | Other.setPtr(nullptr); | |||
221 | Other.setChecked(true); | |||
222 | ||||
223 | return *this; | |||
224 | } | |||
225 | ||||
226 | /// Destroy a Error. Fails with a call to abort() if the error is | |||
227 | /// unchecked. | |||
228 | ~Error() { | |||
229 | assertIsChecked(); | |||
230 | delete getPtr(); | |||
231 | } | |||
232 | ||||
233 | /// Bool conversion. Returns true if this Error is in a failure state, | |||
234 | /// and false if it is in an accept state. If the error is in a Success state | |||
235 | /// it will be considered checked. | |||
236 | explicit operator bool() { | |||
237 | setChecked(getPtr() == nullptr); | |||
238 | return getPtr() != nullptr; | |||
239 | } | |||
240 | ||||
241 | /// Check whether one error is a subclass of another. | |||
242 | template <typename ErrT> bool isA() const { | |||
243 | return getPtr() && getPtr()->isA(ErrT::classID()); | |||
244 | } | |||
245 | ||||
246 | /// Returns the dynamic class id of this error, or null if this is a success | |||
247 | /// value. | |||
248 | const void* dynamicClassID() const { | |||
249 | if (!getPtr()) | |||
250 | return nullptr; | |||
251 | return getPtr()->dynamicClassID(); | |||
252 | } | |||
253 | ||||
254 | private: | |||
255 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
256 | // assertIsChecked() happens very frequently, but under normal circumstances | |||
257 | // is supposed to be a no-op. So we want it to be inlined, but having a bunch | |||
258 | // of debug prints can cause the function to be too large for inlining. So | |||
259 | // it's important that we define this function out of line so that it can't be | |||
260 | // inlined. | |||
261 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) | |||
262 | void fatalUncheckedError() const; | |||
263 | #endif | |||
264 | ||||
265 | void assertIsChecked() { | |||
266 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
267 | if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false)) | |||
268 | fatalUncheckedError(); | |||
269 | #endif | |||
270 | } | |||
271 | ||||
272 | ErrorInfoBase *getPtr() const { | |||
273 | return reinterpret_cast<ErrorInfoBase*>( | |||
274 | reinterpret_cast<uintptr_t>(Payload) & | |||
275 | ~static_cast<uintptr_t>(0x1)); | |||
276 | } | |||
277 | ||||
278 | void setPtr(ErrorInfoBase *EI) { | |||
279 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
280 | Payload = reinterpret_cast<ErrorInfoBase*>( | |||
281 | (reinterpret_cast<uintptr_t>(EI) & | |||
282 | ~static_cast<uintptr_t>(0x1)) | | |||
283 | (reinterpret_cast<uintptr_t>(Payload) & 0x1)); | |||
284 | #else | |||
285 | Payload = EI; | |||
286 | #endif | |||
287 | } | |||
288 | ||||
289 | bool getChecked() const { | |||
290 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
291 | return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0; | |||
292 | #else | |||
293 | return true; | |||
294 | #endif | |||
295 | } | |||
296 | ||||
297 | void setChecked(bool V) { | |||
298 | Payload = reinterpret_cast<ErrorInfoBase*>( | |||
299 | (reinterpret_cast<uintptr_t>(Payload) & | |||
300 | ~static_cast<uintptr_t>(0x1)) | | |||
301 | (V ? 0 : 1)); | |||
302 | } | |||
303 | ||||
304 | std::unique_ptr<ErrorInfoBase> takePayload() { | |||
305 | std::unique_ptr<ErrorInfoBase> Tmp(getPtr()); | |||
306 | setPtr(nullptr); | |||
307 | setChecked(true); | |||
308 | return Tmp; | |||
309 | } | |||
310 | ||||
311 | friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) { | |||
312 | if (auto P = E.getPtr()) | |||
313 | P->log(OS); | |||
314 | else | |||
315 | OS << "success"; | |||
316 | return OS; | |||
317 | } | |||
318 | ||||
319 | ErrorInfoBase *Payload = nullptr; | |||
320 | }; | |||
321 | ||||
322 | /// Subclass of Error for the sole purpose of identifying the success path in | |||
323 | /// the type system. This allows to catch invalid conversion to Expected<T> at | |||
324 | /// compile time. | |||
325 | class ErrorSuccess final : public Error {}; | |||
326 | ||||
327 | inline ErrorSuccess Error::success() { return ErrorSuccess(); } | |||
328 | ||||
329 | /// Make a Error instance representing failure using the given error info | |||
330 | /// type. | |||
331 | template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) { | |||
332 | return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...)); | |||
333 | } | |||
334 | ||||
335 | /// Base class for user error types. Users should declare their error types | |||
336 | /// like: | |||
337 | /// | |||
338 | /// class MyError : public ErrorInfo<MyError> { | |||
339 | /// .... | |||
340 | /// }; | |||
341 | /// | |||
342 | /// This class provides an implementation of the ErrorInfoBase::kind | |||
343 | /// method, which is used by the Error RTTI system. | |||
344 | template <typename ThisErrT, typename ParentErrT = ErrorInfoBase> | |||
345 | class ErrorInfo : public ParentErrT { | |||
346 | public: | |||
347 | using ParentErrT::ParentErrT; // inherit constructors | |||
348 | ||||
349 | static const void *classID() { return &ThisErrT::ID; } | |||
350 | ||||
351 | const void *dynamicClassID() const override { return &ThisErrT::ID; } | |||
352 | ||||
353 | bool isA(const void *const ClassID) const override { | |||
354 | return ClassID == classID() || ParentErrT::isA(ClassID); | |||
355 | } | |||
356 | }; | |||
357 | ||||
358 | /// Special ErrorInfo subclass representing a list of ErrorInfos. | |||
359 | /// Instances of this class are constructed by joinError. | |||
360 | class ErrorList final : public ErrorInfo<ErrorList> { | |||
361 | // handleErrors needs to be able to iterate the payload list of an | |||
362 | // ErrorList. | |||
363 | template <typename... HandlerTs> | |||
364 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); | |||
365 | ||||
366 | // joinErrors is implemented in terms of join. | |||
367 | friend Error joinErrors(Error, Error); | |||
368 | ||||
369 | public: | |||
370 | void log(raw_ostream &OS) const override { | |||
371 | OS << "Multiple errors:\n"; | |||
372 | for (auto &ErrPayload : Payloads) { | |||
373 | ErrPayload->log(OS); | |||
374 | OS << "\n"; | |||
375 | } | |||
376 | } | |||
377 | ||||
378 | std::error_code convertToErrorCode() const override; | |||
379 | ||||
380 | // Used by ErrorInfo::classID. | |||
381 | static char ID; | |||
382 | ||||
383 | private: | |||
384 | ErrorList(std::unique_ptr<ErrorInfoBase> Payload1, | |||
385 | std::unique_ptr<ErrorInfoBase> Payload2) { | |||
386 | assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2-> isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors" ) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\"" , "/build/llvm-toolchain-snapshot-8~svn350071/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~svn350071/include/llvm/Support/Error.h" , 387, __PRETTY_FUNCTION__)); | |||
388 | Payloads.push_back(std::move(Payload1)); | |||
389 | Payloads.push_back(std::move(Payload2)); | |||
390 | } | |||
391 | ||||
392 | static Error join(Error E1, Error E2) { | |||
393 | if (!E1) | |||
394 | return E2; | |||
395 | if (!E2) | |||
396 | return E1; | |||
397 | if (E1.isA<ErrorList>()) { | |||
398 | auto &E1List = static_cast<ErrorList &>(*E1.getPtr()); | |||
399 | if (E2.isA<ErrorList>()) { | |||
400 | auto E2Payload = E2.takePayload(); | |||
401 | auto &E2List = static_cast<ErrorList &>(*E2Payload); | |||
402 | for (auto &Payload : E2List.Payloads) | |||
403 | E1List.Payloads.push_back(std::move(Payload)); | |||
404 | } else | |||
405 | E1List.Payloads.push_back(E2.takePayload()); | |||
406 | ||||
407 | return E1; | |||
408 | } | |||
409 | if (E2.isA<ErrorList>()) { | |||
410 | auto &E2List = static_cast<ErrorList &>(*E2.getPtr()); | |||
411 | E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload()); | |||
412 | return E2; | |||
413 | } | |||
414 | return Error(std::unique_ptr<ErrorList>( | |||
415 | new ErrorList(E1.takePayload(), E2.takePayload()))); | |||
416 | } | |||
417 | ||||
418 | std::vector<std::unique_ptr<ErrorInfoBase>> Payloads; | |||
419 | }; | |||
420 | ||||
421 | /// Concatenate errors. The resulting Error is unchecked, and contains the | |||
422 | /// ErrorInfo(s), if any, contained in E1, followed by the | |||
423 | /// ErrorInfo(s), if any, contained in E2. | |||
424 | inline Error joinErrors(Error E1, Error E2) { | |||
425 | return ErrorList::join(std::move(E1), std::move(E2)); | |||
426 | } | |||
427 | ||||
428 | /// Tagged union holding either a T or a Error. | |||
429 | /// | |||
430 | /// This class parallels ErrorOr, but replaces error_code with Error. Since | |||
431 | /// Error cannot be copied, this class replaces getError() with | |||
432 | /// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the | |||
433 | /// error class type. | |||
434 | template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected { | |||
435 | template <class T1> friend class ExpectedAsOutParameter; | |||
436 | template <class OtherT> friend class Expected; | |||
437 | ||||
438 | static const bool isRef = std::is_reference<T>::value; | |||
439 | ||||
440 | using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>; | |||
441 | ||||
442 | using error_type = std::unique_ptr<ErrorInfoBase>; | |||
443 | ||||
444 | public: | |||
445 | using storage_type = typename std::conditional<isRef, wrap, T>::type; | |||
446 | using value_type = T; | |||
447 | ||||
448 | private: | |||
449 | using reference = typename std::remove_reference<T>::type &; | |||
450 | using const_reference = const typename std::remove_reference<T>::type &; | |||
451 | using pointer = typename std::remove_reference<T>::type *; | |||
452 | using const_pointer = const typename std::remove_reference<T>::type *; | |||
453 | ||||
454 | public: | |||
455 | /// Create an Expected<T> error value from the given Error. | |||
456 | Expected(Error Err) | |||
457 | : HasError(true) | |||
458 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
459 | // Expected is unchecked upon construction in Debug builds. | |||
460 | , Unchecked(true) | |||
461 | #endif | |||
462 | { | |||
463 | assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value." ) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 463, __PRETTY_FUNCTION__)); | |||
464 | new (getErrorStorage()) error_type(Err.takePayload()); | |||
465 | } | |||
466 | ||||
467 | /// Forbid to convert from Error::success() implicitly, this avoids having | |||
468 | /// Expected<T> foo() { return Error::success(); } which compiles otherwise | |||
469 | /// but triggers the assertion above. | |||
470 | Expected(ErrorSuccess) = delete; | |||
471 | ||||
472 | /// Create an Expected<T> success value from the given OtherT value, which | |||
473 | /// must be convertible to T. | |||
474 | template <typename OtherT> | |||
475 | Expected(OtherT &&Val, | |||
476 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type | |||
477 | * = nullptr) | |||
478 | : HasError(false) | |||
479 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
480 | // Expected is unchecked upon construction in Debug builds. | |||
481 | , Unchecked(true) | |||
482 | #endif | |||
483 | { | |||
484 | new (getStorage()) storage_type(std::forward<OtherT>(Val)); | |||
485 | } | |||
486 | ||||
487 | /// Move construct an Expected<T> value. | |||
488 | Expected(Expected &&Other) { moveConstruct(std::move(Other)); } | |||
489 | ||||
490 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT | |||
491 | /// must be convertible to T. | |||
492 | template <class OtherT> | |||
493 | Expected(Expected<OtherT> &&Other, | |||
494 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type | |||
495 | * = nullptr) { | |||
496 | moveConstruct(std::move(Other)); | |||
497 | } | |||
498 | ||||
499 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT | |||
500 | /// isn't convertible to T. | |||
501 | template <class OtherT> | |||
502 | explicit Expected( | |||
503 | Expected<OtherT> &&Other, | |||
504 | typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * = | |||
505 | nullptr) { | |||
506 | moveConstruct(std::move(Other)); | |||
507 | } | |||
508 | ||||
509 | /// Move-assign from another Expected<T>. | |||
510 | Expected &operator=(Expected &&Other) { | |||
511 | moveAssign(std::move(Other)); | |||
512 | return *this; | |||
513 | } | |||
514 | ||||
515 | /// Destroy an Expected<T>. | |||
516 | ~Expected() { | |||
517 | assertIsChecked(); | |||
518 | if (!HasError) | |||
519 | getStorage()->~storage_type(); | |||
520 | else | |||
521 | getErrorStorage()->~error_type(); | |||
522 | } | |||
523 | ||||
524 | /// Return false if there is an error. | |||
525 | explicit operator bool() { | |||
526 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
527 | Unchecked = HasError; | |||
528 | #endif | |||
529 | return !HasError; | |||
530 | } | |||
531 | ||||
532 | /// Returns a reference to the stored T value. | |||
533 | reference get() { | |||
534 | assertIsChecked(); | |||
535 | return *getStorage(); | |||
536 | } | |||
537 | ||||
538 | /// Returns a const reference to the stored T value. | |||
539 | const_reference get() const { | |||
540 | assertIsChecked(); | |||
541 | return const_cast<Expected<T> *>(this)->get(); | |||
542 | } | |||
543 | ||||
544 | /// Check that this Expected<T> is an error of type ErrT. | |||
545 | template <typename ErrT> bool errorIsA() const { | |||
546 | return HasError && (*getErrorStorage())->template isA<ErrT>(); | |||
547 | } | |||
548 | ||||
549 | /// Take ownership of the stored error. | |||
550 | /// After calling this the Expected<T> is in an indeterminate state that can | |||
551 | /// only be safely destructed. No further calls (beside the destructor) should | |||
552 | /// be made on the Expected<T> vaule. | |||
553 | Error takeError() { | |||
554 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
555 | Unchecked = false; | |||
556 | #endif | |||
557 | return HasError ? Error(std::move(*getErrorStorage())) : Error::success(); | |||
558 | } | |||
559 | ||||
560 | /// Returns a pointer to the stored T value. | |||
561 | pointer operator->() { | |||
562 | assertIsChecked(); | |||
563 | return toPointer(getStorage()); | |||
564 | } | |||
565 | ||||
566 | /// Returns a const pointer to the stored T value. | |||
567 | const_pointer operator->() const { | |||
568 | assertIsChecked(); | |||
569 | return toPointer(getStorage()); | |||
570 | } | |||
571 | ||||
572 | /// Returns a reference to the stored T value. | |||
573 | reference operator*() { | |||
574 | assertIsChecked(); | |||
575 | return *getStorage(); | |||
576 | } | |||
577 | ||||
578 | /// Returns a const reference to the stored T value. | |||
579 | const_reference operator*() const { | |||
580 | assertIsChecked(); | |||
581 | return *getStorage(); | |||
582 | } | |||
583 | ||||
584 | private: | |||
585 | template <class T1> | |||
586 | static bool compareThisIfSameType(const T1 &a, const T1 &b) { | |||
587 | return &a == &b; | |||
588 | } | |||
589 | ||||
590 | template <class T1, class T2> | |||
591 | static bool compareThisIfSameType(const T1 &a, const T2 &b) { | |||
592 | return false; | |||
593 | } | |||
594 | ||||
595 | template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) { | |||
596 | HasError = Other.HasError; | |||
597 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
598 | Unchecked = true; | |||
599 | Other.Unchecked = false; | |||
600 | #endif | |||
601 | ||||
602 | if (!HasError) | |||
603 | new (getStorage()) storage_type(std::move(*Other.getStorage())); | |||
604 | else | |||
605 | new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage())); | |||
606 | } | |||
607 | ||||
608 | template <class OtherT> void moveAssign(Expected<OtherT> &&Other) { | |||
609 | assertIsChecked(); | |||
610 | ||||
611 | if (compareThisIfSameType(*this, Other)) | |||
612 | return; | |||
613 | ||||
614 | this->~Expected(); | |||
615 | new (this) Expected(std::move(Other)); | |||
616 | } | |||
617 | ||||
618 | pointer toPointer(pointer Val) { return Val; } | |||
619 | ||||
620 | const_pointer toPointer(const_pointer Val) const { return Val; } | |||
621 | ||||
622 | pointer toPointer(wrap *Val) { return &Val->get(); } | |||
623 | ||||
624 | const_pointer toPointer(const wrap *Val) const { return &Val->get(); } | |||
625 | ||||
626 | storage_type *getStorage() { | |||
627 | assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!" ) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\"" , "/build/llvm-toolchain-snapshot-8~svn350071/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~svn350071/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~svn350071/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~svn350071/include/llvm/Support/Error.h" , 642, __PRETTY_FUNCTION__)); | |||
643 | return reinterpret_cast<const error_type *>(ErrorStorage.buffer); | |||
644 | } | |||
645 | ||||
646 | // Used by ExpectedAsOutParameter to reset the checked flag. | |||
647 | void setUnchecked() { | |||
648 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
649 | Unchecked = true; | |||
650 | #endif | |||
651 | } | |||
652 | ||||
653 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
654 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) | |||
655 | LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline)) | |||
656 | void fatalUncheckedExpected() const { | |||
657 | dbgs() << "Expected<T> must be checked before access or destruction.\n"; | |||
658 | if (HasError) { | |||
659 | dbgs() << "Unchecked Expected<T> contained error:\n"; | |||
660 | (*getErrorStorage())->log(dbgs()); | |||
661 | } else | |||
662 | dbgs() << "Expected<T> value was in success state. (Note: Expected<T> " | |||
663 | "values in success mode must still be checked prior to being " | |||
664 | "destroyed).\n"; | |||
665 | abort(); | |||
666 | } | |||
667 | #endif | |||
668 | ||||
669 | void assertIsChecked() { | |||
670 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
671 | if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false)) | |||
672 | fatalUncheckedExpected(); | |||
673 | #endif | |||
674 | } | |||
675 | ||||
676 | union { | |||
677 | AlignedCharArrayUnion<storage_type> TStorage; | |||
678 | AlignedCharArrayUnion<error_type> ErrorStorage; | |||
679 | }; | |||
680 | bool HasError : 1; | |||
681 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
682 | bool Unchecked : 1; | |||
683 | #endif | |||
684 | }; | |||
685 | ||||
686 | /// Report a serious error, calling any installed error handler. See | |||
687 | /// ErrorHandling.h. | |||
688 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err, | |||
689 | bool gen_crash_diag = true); | |||
690 | ||||
691 | /// Report a fatal error if Err is a failure value. | |||
692 | /// | |||
693 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
694 | /// is known that the Error will always be a success value. E.g. | |||
695 | /// | |||
696 | /// @code{.cpp} | |||
697 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
698 | /// // true. If DoFallibleOperation is false then foo always returns | |||
699 | /// // Error::success(). | |||
700 | /// Error foo(bool DoFallibleOperation); | |||
701 | /// | |||
702 | /// cantFail(foo(false)); | |||
703 | /// @endcode | |||
704 | inline void cantFail(Error Err, const char *Msg = nullptr) { | |||
705 | if (Err) { | |||
706 | if (!Msg) | |||
707 | Msg = "Failure value returned from cantFail wrapped call"; | |||
708 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 708); | |||
709 | } | |||
710 | } | |||
711 | ||||
712 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and | |||
713 | /// returns the contained value. | |||
714 | /// | |||
715 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
716 | /// is known that the Error will always be a success value. E.g. | |||
717 | /// | |||
718 | /// @code{.cpp} | |||
719 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
720 | /// // true. If DoFallibleOperation is false then foo always returns an int. | |||
721 | /// Expected<int> foo(bool DoFallibleOperation); | |||
722 | /// | |||
723 | /// int X = cantFail(foo(false)); | |||
724 | /// @endcode | |||
725 | template <typename T> | |||
726 | T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) { | |||
727 | if (ValOrErr) | |||
728 | return std::move(*ValOrErr); | |||
729 | else { | |||
730 | if (!Msg) | |||
731 | Msg = "Failure value returned from cantFail wrapped call"; | |||
732 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 732); | |||
733 | } | |||
734 | } | |||
735 | ||||
736 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and | |||
737 | /// returns the contained reference. | |||
738 | /// | |||
739 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
740 | /// is known that the Error will always be a success value. E.g. | |||
741 | /// | |||
742 | /// @code{.cpp} | |||
743 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
744 | /// // true. If DoFallibleOperation is false then foo always returns a Bar&. | |||
745 | /// Expected<Bar&> foo(bool DoFallibleOperation); | |||
746 | /// | |||
747 | /// Bar &X = cantFail(foo(false)); | |||
748 | /// @endcode | |||
749 | template <typename T> | |||
750 | T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) { | |||
751 | if (ValOrErr) | |||
752 | return *ValOrErr; | |||
753 | else { | |||
754 | if (!Msg) | |||
755 | Msg = "Failure value returned from cantFail wrapped call"; | |||
756 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 756); | |||
757 | } | |||
758 | } | |||
759 | ||||
760 | /// Helper for testing applicability of, and applying, handlers for | |||
761 | /// ErrorInfo types. | |||
762 | template <typename HandlerT> | |||
763 | class ErrorHandlerTraits | |||
764 | : public ErrorHandlerTraits<decltype( | |||
765 | &std::remove_reference<HandlerT>::type::operator())> {}; | |||
766 | ||||
767 | // Specialization functions of the form 'Error (const ErrT&)'. | |||
768 | template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> { | |||
769 | public: | |||
770 | static bool appliesTo(const ErrorInfoBase &E) { | |||
771 | return E.template isA<ErrT>(); | |||
772 | } | |||
773 | ||||
774 | template <typename HandlerT> | |||
775 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
776 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 776, __PRETTY_FUNCTION__)); | |||
777 | return H(static_cast<ErrT &>(*E)); | |||
778 | } | |||
779 | }; | |||
780 | ||||
781 | // Specialization functions of the form 'void (const ErrT&)'. | |||
782 | template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> { | |||
783 | public: | |||
784 | static bool appliesTo(const ErrorInfoBase &E) { | |||
785 | return E.template isA<ErrT>(); | |||
786 | } | |||
787 | ||||
788 | template <typename HandlerT> | |||
789 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
790 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 790, __PRETTY_FUNCTION__)); | |||
791 | H(static_cast<ErrT &>(*E)); | |||
792 | return Error::success(); | |||
793 | } | |||
794 | }; | |||
795 | ||||
796 | /// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'. | |||
797 | template <typename ErrT> | |||
798 | class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> { | |||
799 | public: | |||
800 | static bool appliesTo(const ErrorInfoBase &E) { | |||
801 | return E.template isA<ErrT>(); | |||
802 | } | |||
803 | ||||
804 | template <typename HandlerT> | |||
805 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
806 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 806, __PRETTY_FUNCTION__)); | |||
807 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); | |||
808 | return H(std::move(SubE)); | |||
809 | } | |||
810 | }; | |||
811 | ||||
812 | /// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'. | |||
813 | template <typename ErrT> | |||
814 | class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> { | |||
815 | public: | |||
816 | static bool appliesTo(const ErrorInfoBase &E) { | |||
817 | return E.template isA<ErrT>(); | |||
818 | } | |||
819 | ||||
820 | template <typename HandlerT> | |||
821 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
822 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/Error.h" , 822, __PRETTY_FUNCTION__)); | |||
823 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); | |||
824 | H(std::move(SubE)); | |||
825 | return Error::success(); | |||
826 | } | |||
827 | }; | |||
828 | ||||
829 | // Specialization for member functions of the form 'RetT (const ErrT&)'. | |||
830 | template <typename C, typename RetT, typename ErrT> | |||
831 | class ErrorHandlerTraits<RetT (C::*)(ErrT &)> | |||
832 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
833 | ||||
834 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. | |||
835 | template <typename C, typename RetT, typename ErrT> | |||
836 | class ErrorHandlerTraits<RetT (C::*)(ErrT &) const> | |||
837 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
838 | ||||
839 | // Specialization for member functions of the form 'RetT (const ErrT&)'. | |||
840 | template <typename C, typename RetT, typename ErrT> | |||
841 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &)> | |||
842 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
843 | ||||
844 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. | |||
845 | template <typename C, typename RetT, typename ErrT> | |||
846 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const> | |||
847 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
848 | ||||
849 | /// Specialization for member functions of the form | |||
850 | /// 'RetT (std::unique_ptr<ErrT>)'. | |||
851 | template <typename C, typename RetT, typename ErrT> | |||
852 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)> | |||
853 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; | |||
854 | ||||
855 | /// Specialization for member functions of the form | |||
856 | /// 'RetT (std::unique_ptr<ErrT>) const'. | |||
857 | template <typename C, typename RetT, typename ErrT> | |||
858 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const> | |||
859 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; | |||
860 | ||||
861 | inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) { | |||
862 | return Error(std::move(Payload)); | |||
863 | } | |||
864 | ||||
865 | template <typename HandlerT, typename... HandlerTs> | |||
866 | Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload, | |||
867 | HandlerT &&Handler, HandlerTs &&... Handlers) { | |||
868 | if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload)) | |||
869 | return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler), | |||
870 | std::move(Payload)); | |||
871 | return handleErrorImpl(std::move(Payload), | |||
872 | std::forward<HandlerTs>(Handlers)...); | |||
873 | } | |||
874 | ||||
875 | /// Pass the ErrorInfo(s) contained in E to their respective handlers. Any | |||
876 | /// unhandled errors (or Errors returned by handlers) are re-concatenated and | |||
877 | /// returned. | |||
878 | /// Because this function returns an error, its result must also be checked | |||
879 | /// or returned. If you intend to handle all errors use handleAllErrors | |||
880 | /// (which returns void, and will abort() on unhandled errors) instead. | |||
881 | template <typename... HandlerTs> | |||
882 | Error handleErrors(Error E, HandlerTs &&... Hs) { | |||
883 | if (!E) | |||
884 | return Error::success(); | |||
885 | ||||
886 | std::unique_ptr<ErrorInfoBase> Payload = E.takePayload(); | |||
887 | ||||
888 | if (Payload->isA<ErrorList>()) { | |||
889 | ErrorList &List = static_cast<ErrorList &>(*Payload); | |||
890 | Error R; | |||
891 | for (auto &P : List.Payloads) | |||
892 | R = ErrorList::join( | |||
893 | std::move(R), | |||
894 | handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...)); | |||
895 | return R; | |||
896 | } | |||
897 | ||||
898 | return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...); | |||
899 | } | |||
900 | ||||
901 | /// Behaves the same as handleErrors, except that by contract all errors | |||
902 | /// *must* be handled by the given handlers (i.e. there must be no remaining | |||
903 | /// errors after running the handlers, or llvm_unreachable is called). | |||
904 | template <typename... HandlerTs> | |||
905 | void handleAllErrors(Error E, HandlerTs &&... Handlers) { | |||
906 | cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...)); | |||
907 | } | |||
908 | ||||
909 | /// Check that E is a non-error, then drop it. | |||
910 | /// If E is an error, llvm_unreachable will be called. | |||
911 | inline void handleAllErrors(Error E) { | |||
912 | cantFail(std::move(E)); | |||
913 | } | |||
914 | ||||
915 | /// Handle any errors (if present) in an Expected<T>, then try a recovery path. | |||
916 | /// | |||
917 | /// If the incoming value is a success value it is returned unmodified. If it | |||
918 | /// is a failure value then it the contained error is passed to handleErrors. | |||
919 | /// If handleErrors is able to handle the error then the RecoveryPath functor | |||
920 | /// is called to supply the final result. If handleErrors is not able to | |||
921 | /// handle all errors then the unhandled errors are returned. | |||
922 | /// | |||
923 | /// This utility enables the follow pattern: | |||
924 | /// | |||
925 | /// @code{.cpp} | |||
926 | /// enum FooStrategy { Aggressive, Conservative }; | |||
927 | /// Expected<Foo> foo(FooStrategy S); | |||
928 | /// | |||
929 | /// auto ResultOrErr = | |||
930 | /// handleExpected( | |||
931 | /// foo(Aggressive), | |||
932 | /// []() { return foo(Conservative); }, | |||
933 | /// [](AggressiveStrategyError&) { | |||
934 | /// // Implicitly conusme this - we'll recover by using a conservative | |||
935 | /// // strategy. | |||
936 | /// }); | |||
937 | /// | |||
938 | /// @endcode | |||
939 | template <typename T, typename RecoveryFtor, typename... HandlerTs> | |||
940 | Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath, | |||
941 | HandlerTs &&... Handlers) { | |||
942 | if (ValOrErr) | |||
943 | return ValOrErr; | |||
944 | ||||
945 | if (auto Err = handleErrors(ValOrErr.takeError(), | |||
946 | std::forward<HandlerTs>(Handlers)...)) | |||
947 | return std::move(Err); | |||
948 | ||||
949 | return RecoveryPath(); | |||
950 | } | |||
951 | ||||
952 | /// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner | |||
953 | /// will be printed before the first one is logged. A newline will be printed | |||
954 | /// after each error. | |||
955 | /// | |||
956 | /// This function is compatible with the helpers from Support/WithColor.h. You | |||
957 | /// can pass any of them as the OS. Please consider using them instead of | |||
958 | /// including 'error: ' in the ErrorBanner. | |||
959 | /// | |||
960 | /// This is useful in the base level of your program to allow clean termination | |||
961 | /// (allowing clean deallocation of resources, etc.), while reporting error | |||
962 | /// information to the user. | |||
963 | void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {}); | |||
964 | ||||
965 | /// Write all error messages (if any) in E to a string. The newline character | |||
966 | /// is used to separate error messages. | |||
967 | inline std::string toString(Error E) { | |||
968 | SmallVector<std::string, 2> Errors; | |||
969 | handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) { | |||
970 | Errors.push_back(EI.message()); | |||
971 | }); | |||
972 | return join(Errors.begin(), Errors.end(), "\n"); | |||
973 | } | |||
974 | ||||
975 | /// Consume a Error without doing anything. This method should be used | |||
976 | /// only where an error can be considered a reasonable and expected return | |||
977 | /// value. | |||
978 | /// | |||
979 | /// Uses of this method are potentially indicative of design problems: If it's | |||
980 | /// legitimate to do nothing while processing an "error", the error-producer | |||
981 | /// might be more clearly refactored to return an Optional<T>. | |||
982 | inline void consumeError(Error Err) { | |||
983 | handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {}); | |||
984 | } | |||
985 | ||||
986 | /// Helper for converting an Error to a bool. | |||
987 | /// | |||
988 | /// This method returns true if Err is in an error state, or false if it is | |||
989 | /// in a success state. Puts Err in a checked state in both cases (unlike | |||
990 | /// Error::operator bool(), which only does this for success states). | |||
991 | inline bool errorToBool(Error Err) { | |||
992 | bool IsError = static_cast<bool>(Err); | |||
993 | if (IsError) | |||
994 | consumeError(std::move(Err)); | |||
995 | return IsError; | |||
996 | } | |||
997 | ||||
998 | /// Helper for Errors used as out-parameters. | |||
999 | /// | |||
1000 | /// This helper is for use with the Error-as-out-parameter idiom, where an error | |||
1001 | /// is passed to a function or method by reference, rather than being returned. | |||
1002 | /// In such cases it is helpful to set the checked bit on entry to the function | |||
1003 | /// so that the error can be written to (unchecked Errors abort on assignment) | |||
1004 | /// and clear the checked bit on exit so that clients cannot accidentally forget | |||
1005 | /// to check the result. This helper performs these actions automatically using | |||
1006 | /// RAII: | |||
1007 | /// | |||
1008 | /// @code{.cpp} | |||
1009 | /// Result foo(Error &Err) { | |||
1010 | /// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set | |||
1011 | /// // <body of foo> | |||
1012 | /// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed. | |||
1013 | /// } | |||
1014 | /// @endcode | |||
1015 | /// | |||
1016 | /// ErrorAsOutParameter takes an Error* rather than Error& so that it can be | |||
1017 | /// used with optional Errors (Error pointers that are allowed to be null). If | |||
1018 | /// ErrorAsOutParameter took an Error reference, an instance would have to be | |||
1019 | /// created inside every condition that verified that Error was non-null. By | |||
1020 | /// taking an Error pointer we can just create one instance at the top of the | |||
1021 | /// function. | |||
1022 | class ErrorAsOutParameter { | |||
1023 | public: | |||
1024 | ErrorAsOutParameter(Error *Err) : Err(Err) { | |||
1025 | // Raise the checked bit if Err is success. | |||
1026 | if (Err) | |||
1027 | (void)!!*Err; | |||
1028 | } | |||
1029 | ||||
1030 | ~ErrorAsOutParameter() { | |||
1031 | // Clear the checked bit. | |||
1032 | if (Err && !*Err) | |||
1033 | *Err = Error::success(); | |||
1034 | } | |||
1035 | ||||
1036 | private: | |||
1037 | Error *Err; | |||
1038 | }; | |||
1039 | ||||
1040 | /// Helper for Expected<T>s used as out-parameters. | |||
1041 | /// | |||
1042 | /// See ErrorAsOutParameter. | |||
1043 | template <typename T> | |||
1044 | class ExpectedAsOutParameter { | |||
1045 | public: | |||
1046 | ExpectedAsOutParameter(Expected<T> *ValOrErr) | |||
1047 | : ValOrErr(ValOrErr) { | |||
1048 | if (ValOrErr) | |||
1049 | (void)!!*ValOrErr; | |||
1050 | } | |||
1051 | ||||
1052 | ~ExpectedAsOutParameter() { | |||
1053 | if (ValOrErr) | |||
1054 | ValOrErr->setUnchecked(); | |||
1055 | } | |||
1056 | ||||
1057 | private: | |||
1058 | Expected<T> *ValOrErr; | |||
1059 | }; | |||
1060 | ||||
1061 | /// This class wraps a std::error_code in a Error. | |||
1062 | /// | |||
1063 | /// This is useful if you're writing an interface that returns a Error | |||
1064 | /// (or Expected) and you want to call code that still returns | |||
1065 | /// std::error_codes. | |||
1066 | class ECError : public ErrorInfo<ECError> { | |||
1067 | friend Error errorCodeToError(std::error_code); | |||
1068 | ||||
1069 | public: | |||
1070 | void setErrorCode(std::error_code EC) { this->EC = EC; } | |||
1071 | std::error_code convertToErrorCode() const override { return EC; } | |||
1072 | void log(raw_ostream &OS) const override { OS << EC.message(); } | |||
1073 | ||||
1074 | // Used by ErrorInfo::classID. | |||
1075 | static char ID; | |||
1076 | ||||
1077 | protected: | |||
1078 | ECError() = default; | |||
1079 | ECError(std::error_code EC) : EC(EC) {} | |||
1080 | ||||
1081 | std::error_code EC; | |||
1082 | }; | |||
1083 | ||||
1084 | /// The value returned by this function can be returned from convertToErrorCode | |||
1085 | /// for Error values where no sensible translation to std::error_code exists. | |||
1086 | /// It should only be used in this situation, and should never be used where a | |||
1087 | /// sensible conversion to std::error_code is available, as attempts to convert | |||
1088 | /// to/from this error will result in a fatal error. (i.e. it is a programmatic | |||
1089 | ///error to try to convert such a value). | |||
1090 | std::error_code inconvertibleErrorCode(); | |||
1091 | ||||
1092 | /// Helper for converting an std::error_code to a Error. | |||
1093 | Error errorCodeToError(std::error_code EC); | |||
1094 | ||||
1095 | /// Helper for converting an ECError to a std::error_code. | |||
1096 | /// | |||
1097 | /// This method requires that Err be Error() or an ECError, otherwise it | |||
1098 | /// will trigger a call to abort(). | |||
1099 | std::error_code errorToErrorCode(Error Err); | |||
1100 | ||||
1101 | /// Convert an ErrorOr<T> to an Expected<T>. | |||
1102 | template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) { | |||
1103 | if (auto EC = EO.getError()) | |||
1104 | return errorCodeToError(EC); | |||
1105 | return std::move(*EO); | |||
1106 | } | |||
1107 | ||||
1108 | /// Convert an Expected<T> to an ErrorOr<T>. | |||
1109 | template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) { | |||
1110 | if (auto Err = E.takeError()) | |||
1111 | return errorToErrorCode(std::move(Err)); | |||
1112 | return std::move(*E); | |||
1113 | } | |||
1114 | ||||
1115 | /// This class wraps a string in an Error. | |||
1116 | /// | |||
1117 | /// StringError is useful in cases where the client is not expected to be able | |||
1118 | /// to consume the specific error message programmatically (for example, if the | |||
1119 | /// error message is to be presented to the user). | |||
1120 | /// | |||
1121 | /// StringError can also be used when additional information is to be printed | |||
1122 | /// along with a error_code message. Depending on the constructor called, this | |||
1123 | /// class can either display: | |||
1124 | /// 1. the error_code message (ECError behavior) | |||
1125 | /// 2. a string | |||
1126 | /// 3. the error_code message and a string | |||
1127 | /// | |||
1128 | /// These behaviors are useful when subtyping is required; for example, when a | |||
1129 | /// specific library needs an explicit error type. In the example below, | |||
1130 | /// PDBError is derived from StringError: | |||
1131 | /// | |||
1132 | /// @code{.cpp} | |||
1133 | /// Expected<int> foo() { | |||
1134 | /// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading, | |||
1135 | /// "Additional information"); | |||
1136 | /// } | |||
1137 | /// @endcode | |||
1138 | /// | |||
1139 | class StringError : public ErrorInfo<StringError> { | |||
1140 | public: | |||
1141 | static char ID; | |||
1142 | ||||
1143 | // Prints EC + S and converts to EC | |||
1144 | StringError(std::error_code EC, const Twine &S = Twine()); | |||
1145 | ||||
1146 | // Prints S and converts to EC | |||
1147 | StringError(const Twine &S, std::error_code EC); | |||
1148 | ||||
1149 | void log(raw_ostream &OS) const override; | |||
1150 | std::error_code convertToErrorCode() const override; | |||
1151 | ||||
1152 | const std::string &getMessage() const { return Msg; } | |||
1153 | ||||
1154 | private: | |||
1155 | std::string Msg; | |||
1156 | std::error_code EC; | |||
1157 | const bool PrintMsgOnly = false; | |||
1158 | }; | |||
1159 | ||||
1160 | /// Create formatted StringError object. | |||
1161 | template <typename... Ts> | |||
1162 | Error createStringError(std::error_code EC, char const *Fmt, | |||
1163 | const Ts &... Vals) { | |||
1164 | std::string Buffer; | |||
1165 | raw_string_ostream Stream(Buffer); | |||
1166 | Stream << format(Fmt, Vals...); | |||
1167 | return make_error<StringError>(Stream.str(), EC); | |||
1168 | } | |||
1169 | ||||
1170 | Error createStringError(std::error_code EC, char const *Msg); | |||
1171 | ||||
1172 | /// This class wraps a filename and another Error. | |||
1173 | /// | |||
1174 | /// In some cases, an error needs to live along a 'source' name, in order to | |||
1175 | /// show more detailed information to the user. | |||
1176 | class FileError final : public ErrorInfo<FileError> { | |||
1177 | ||||
1178 | friend Error createFileError(std::string, Error); | |||
1179 | ||||
1180 | public: | |||
1181 | void log(raw_ostream &OS) const override { | |||
1182 | 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~svn350071/include/llvm/Support/Error.h" , 1182, __PRETTY_FUNCTION__)); | |||
1183 | OS << "'" << FileName << "': "; | |||
1184 | Err->log(OS); | |||
1185 | } | |||
1186 | ||||
1187 | Error takeError() { return Error(std::move(Err)); } | |||
1188 | ||||
1189 | std::error_code convertToErrorCode() const override; | |||
1190 | ||||
1191 | // Used by ErrorInfo::classID. | |||
1192 | static char ID; | |||
1193 | ||||
1194 | private: | |||
1195 | FileError(std::string F, std::unique_ptr<ErrorInfoBase> E) { | |||
1196 | 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~svn350071/include/llvm/Support/Error.h" , 1196, __PRETTY_FUNCTION__)); | |||
1197 | 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~svn350071/include/llvm/Support/Error.h" , 1198, __PRETTY_FUNCTION__)) | |||
1198 | "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~svn350071/include/llvm/Support/Error.h" , 1198, __PRETTY_FUNCTION__)); | |||
1199 | FileName = F; | |||
1200 | Err = std::move(E); | |||
1201 | } | |||
1202 | ||||
1203 | static Error build(std::string F, Error E) { | |||
1204 | return Error(std::unique_ptr<FileError>(new FileError(F, E.takePayload()))); | |||
1205 | } | |||
1206 | ||||
1207 | std::string FileName; | |||
1208 | std::unique_ptr<ErrorInfoBase> Err; | |||
1209 | }; | |||
1210 | ||||
1211 | /// Concatenate a source file path and/or name with an Error. The resulting | |||
1212 | /// Error is unchecked. | |||
1213 | inline Error createFileError(std::string F, Error E) { | |||
1214 | return FileError::build(F, std::move(E)); | |||
1215 | } | |||
1216 | ||||
1217 | Error createFileError(std::string F, ErrorSuccess) = delete; | |||
1218 | ||||
1219 | /// Helper for check-and-exit error handling. | |||
1220 | /// | |||
1221 | /// For tool use only. NOT FOR USE IN LIBRARY CODE. | |||
1222 | /// | |||
1223 | class ExitOnError { | |||
1224 | public: | |||
1225 | /// Create an error on exit helper. | |||
1226 | ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1) | |||
1227 | : Banner(std::move(Banner)), | |||
1228 | GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {} | |||
1229 | ||||
1230 | /// Set the banner string for any errors caught by operator(). | |||
1231 | void setBanner(std::string Banner) { this->Banner = std::move(Banner); } | |||
1232 | ||||
1233 | /// Set the exit-code mapper function. | |||
1234 | void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) { | |||
1235 | this->GetExitCode = std::move(GetExitCode); | |||
1236 | } | |||
1237 | ||||
1238 | /// Check Err. If it's in a failure state log the error(s) and exit. | |||
1239 | void operator()(Error Err) const { checkError(std::move(Err)); } | |||
1240 | ||||
1241 | /// Check E. If it's in a success state then return the contained value. If | |||
1242 | /// it's in a failure state log the error(s) and exit. | |||
1243 | template <typename T> T operator()(Expected<T> &&E) const { | |||
1244 | checkError(E.takeError()); | |||
1245 | return std::move(*E); | |||
1246 | } | |||
1247 | ||||
1248 | /// Check E. If it's in a success state then return the contained reference. If | |||
1249 | /// it's in a failure state log the error(s) and exit. | |||
1250 | template <typename T> T& operator()(Expected<T&> &&E) const { | |||
1251 | checkError(E.takeError()); | |||
1252 | return *E; | |||
1253 | } | |||
1254 | ||||
1255 | private: | |||
1256 | void checkError(Error Err) const { | |||
1257 | if (Err) { | |||
1258 | int ExitCode = GetExitCode(Err); | |||
1259 | logAllUnhandledErrors(std::move(Err), errs(), Banner); | |||
1260 | exit(ExitCode); | |||
1261 | } | |||
1262 | } | |||
1263 | ||||
1264 | std::string Banner; | |||
1265 | std::function<int(const Error &)> GetExitCode; | |||
1266 | }; | |||
1267 | ||||
1268 | /// Conversion from Error to LLVMErrorRef for C error bindings. | |||
1269 | inline LLVMErrorRef wrap(Error Err) { | |||
1270 | return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release()); | |||
1271 | } | |||
1272 | ||||
1273 | /// Conversion from LLVMErrorRef to Error for C error bindings. | |||
1274 | inline Error unwrap(LLVMErrorRef ErrRef) { | |||
1275 | return Error(std::unique_ptr<ErrorInfoBase>( | |||
1276 | reinterpret_cast<ErrorInfoBase *>(ErrRef))); | |||
1277 | } | |||
1278 | ||||
1279 | } // end namespace llvm | |||
1280 | ||||
1281 | #endif // LLVM_SUPPORT_ERROR_H |
1 | //===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===// |
2 | // |
3 | // The LLVM Compiler Infrastructure |
4 | // |
5 | // This file is distributed under the University of Illinois Open Source |
6 | // License. See LICENSE.TXT for details. |
7 | // |
8 | //===----------------------------------------------------------------------===// |
9 | // |
10 | // This file contains some templates that are useful if you are working with the |
11 | // STL at all. |
12 | // |
13 | // No library is required when using these functions. |
14 | // |
15 | //===----------------------------------------------------------------------===// |
16 | |
17 | #ifndef LLVM_ADT_STLEXTRAS_H |
18 | #define LLVM_ADT_STLEXTRAS_H |
19 | |
20 | #include "llvm/ADT/Optional.h" |
21 | #include "llvm/ADT/SmallVector.h" |
22 | #include "llvm/ADT/iterator.h" |
23 | #include "llvm/ADT/iterator_range.h" |
24 | #include "llvm/Config/abi-breaking.h" |
25 | #include "llvm/Support/ErrorHandling.h" |
26 | #include <algorithm> |
27 | #include <cassert> |
28 | #include <cstddef> |
29 | #include <cstdint> |
30 | #include <cstdlib> |
31 | #include <functional> |
32 | #include <initializer_list> |
33 | #include <iterator> |
34 | #include <limits> |
35 | #include <memory> |
36 | #include <tuple> |
37 | #include <type_traits> |
38 | #include <utility> |
39 | |
40 | #ifdef EXPENSIVE_CHECKS |
41 | #include <random> // for std::mt19937 |
42 | #endif |
43 | |
44 | namespace llvm { |
45 | |
46 | // Only used by compiler if both template types are the same. Useful when |
47 | // using SFINAE to test for the existence of member functions. |
48 | template <typename T, T> struct SameType; |
49 | |
50 | namespace detail { |
51 | |
52 | template <typename RangeT> |
53 | using IterOfRange = decltype(std::begin(std::declval<RangeT &>())); |
54 | |
55 | template <typename RangeT> |
56 | using ValueOfRange = typename std::remove_reference<decltype( |
57 | *std::begin(std::declval<RangeT &>()))>::type; |
58 | |
59 | } // end namespace detail |
60 | |
61 | //===----------------------------------------------------------------------===// |
62 | // Extra additions to <type_traits> |
63 | //===----------------------------------------------------------------------===// |
64 | |
65 | template <typename T> |
66 | struct negation : std::integral_constant<bool, !bool(T::value)> {}; |
67 | |
68 | template <typename...> struct conjunction : std::true_type {}; |
69 | template <typename B1> struct conjunction<B1> : B1 {}; |
70 | template <typename B1, typename... Bn> |
71 | struct conjunction<B1, Bn...> |
72 | : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {}; |
73 | |
74 | template <typename T> struct make_const_ptr { |
75 | using type = |
76 | typename std::add_pointer<typename std::add_const<T>::type>::type; |
77 | }; |
78 | //===----------------------------------------------------------------------===// |
79 | // Extra additions to <functional> |
80 | //===----------------------------------------------------------------------===// |
81 | |
82 | template <class Ty> struct identity { |
83 | using argument_type = Ty; |
84 | |
85 | Ty &operator()(Ty &self) const { |
86 | return self; |
87 | } |
88 | const Ty &operator()(const Ty &self) const { |
89 | return self; |
90 | } |
91 | }; |
92 | |
93 | template <class Ty> struct less_ptr { |
94 | bool operator()(const Ty* left, const Ty* right) const { |
95 | return *left < *right; |
96 | } |
97 | }; |
98 | |
99 | template <class Ty> struct greater_ptr { |
100 | bool operator()(const Ty* left, const Ty* right) const { |
101 | return *right < *left; |
102 | } |
103 | }; |
104 | |
105 | /// An efficient, type-erasing, non-owning reference to a callable. This is |
106 | /// intended for use as the type of a function parameter that is not used |
107 | /// after the function in question returns. |
108 | /// |
109 | /// This class does not own the callable, so it is not in general safe to store |
110 | /// a function_ref. |
111 | template<typename Fn> class function_ref; |
112 | |
113 | template<typename Ret, typename ...Params> |
114 | class function_ref<Ret(Params...)> { |
115 | Ret (*callback)(intptr_t callable, Params ...params) = nullptr; |
116 | intptr_t callable; |
117 | |
118 | template<typename Callable> |
119 | static Ret callback_fn(intptr_t callable, Params ...params) { |
120 | return (*reinterpret_cast<Callable*>(callable))( |
121 | std::forward<Params>(params)...); |
122 | } |
123 | |
124 | public: |
125 | function_ref() = default; |
126 | function_ref(std::nullptr_t) {} |
127 | |
128 | template <typename Callable> |
129 | function_ref(Callable &&callable, |
130 | typename std::enable_if< |
131 | !std::is_same<typename std::remove_reference<Callable>::type, |
132 | function_ref>::value>::type * = nullptr) |
133 | : callback(callback_fn<typename std::remove_reference<Callable>::type>), |
134 | callable(reinterpret_cast<intptr_t>(&callable)) {} |
135 | |
136 | Ret operator()(Params ...params) const { |
137 | return callback(callable, std::forward<Params>(params)...); |
138 | } |
139 | |
140 | operator bool() const { return callback; } |
141 | }; |
142 | |
143 | // deleter - Very very very simple method that is used to invoke operator |
144 | // delete on something. It is used like this: |
145 | // |
146 | // for_each(V.begin(), B.end(), deleter<Interval>); |
147 | template <class T> |
148 | inline void deleter(T *Ptr) { |
149 | delete Ptr; |
150 | } |
151 | |
152 | //===----------------------------------------------------------------------===// |
153 | // Extra additions to <iterator> |
154 | //===----------------------------------------------------------------------===// |
155 | |
156 | namespace adl_detail { |
157 | |
158 | using std::begin; |
159 | |
160 | template <typename ContainerTy> |
161 | auto adl_begin(ContainerTy &&container) |
162 | -> decltype(begin(std::forward<ContainerTy>(container))) { |
163 | return begin(std::forward<ContainerTy>(container)); |
164 | } |
165 | |
166 | using std::end; |
167 | |
168 | template <typename ContainerTy> |
169 | auto adl_end(ContainerTy &&container) |
170 | -> decltype(end(std::forward<ContainerTy>(container))) { |
171 | return end(std::forward<ContainerTy>(container)); |
172 | } |
173 | |
174 | using std::swap; |
175 | |
176 | template <typename T> |
177 | void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(), |
178 | std::declval<T>()))) { |
179 | swap(std::forward<T>(lhs), std::forward<T>(rhs)); |
180 | } |
181 | |
182 | } // end namespace adl_detail |
183 | |
184 | template <typename ContainerTy> |
185 | auto adl_begin(ContainerTy &&container) |
186 | -> decltype(adl_detail::adl_begin(std::forward<ContainerTy>(container))) { |
187 | return adl_detail::adl_begin(std::forward<ContainerTy>(container)); |
188 | } |
189 | |
190 | template <typename ContainerTy> |
191 | auto adl_end(ContainerTy &&container) |
192 | -> decltype(adl_detail::adl_end(std::forward<ContainerTy>(container))) { |
193 | return adl_detail::adl_end(std::forward<ContainerTy>(container)); |
194 | } |
195 | |
196 | template <typename T> |
197 | void adl_swap(T &&lhs, T &&rhs) noexcept( |
198 | noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) { |
199 | adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs)); |
200 | } |
201 | |
202 | /// Test whether \p RangeOrContainer is empty. Similar to C++17 std::empty. |
203 | template <typename T> |
204 | constexpr bool empty(const T &RangeOrContainer) { |
205 | return adl_begin(RangeOrContainer) == adl_end(RangeOrContainer); |
206 | } |
207 | |
208 | // mapped_iterator - This is a simple iterator adapter that causes a function to |
209 | // be applied whenever operator* is invoked on the iterator. |
210 | |
211 | template <typename ItTy, typename FuncTy, |
212 | typename FuncReturnTy = |
213 | decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))> |
214 | class mapped_iterator |
215 | : public iterator_adaptor_base< |
216 | mapped_iterator<ItTy, FuncTy>, ItTy, |
217 | typename std::iterator_traits<ItTy>::iterator_category, |
218 | typename std::remove_reference<FuncReturnTy>::type> { |
219 | public: |
220 | mapped_iterator(ItTy U, FuncTy F) |
221 | : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {} |
222 | |
223 | ItTy getCurrent() { return this->I; } |
224 | |
225 | FuncReturnTy operator*() { return F(*this->I); } |
226 | |
227 | private: |
228 | FuncTy F; |
229 | }; |
230 | |
231 | // map_iterator - Provide a convenient way to create mapped_iterators, just like |
232 | // make_pair is useful for creating pairs... |
233 | template <class ItTy, class FuncTy> |
234 | inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) { |
235 | return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F)); |
236 | } |
237 | |
238 | /// Helper to determine if type T has a member called rbegin(). |
239 | template <typename Ty> class has_rbegin_impl { |
240 | using yes = char[1]; |
241 | using no = char[2]; |
242 | |
243 | template <typename Inner> |
244 | static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr); |
245 | |
246 | template <typename> |
247 | static no& test(...); |
248 | |
249 | public: |
250 | static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes); |
251 | }; |
252 | |
253 | /// Metafunction to determine if T& or T has a member called rbegin(). |
254 | template <typename Ty> |
255 | struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> { |
256 | }; |
257 | |
258 | // Returns an iterator_range over the given container which iterates in reverse. |
259 | // Note that the container must have rbegin()/rend() methods for this to work. |
260 | template <typename ContainerTy> |
261 | auto reverse(ContainerTy &&C, |
262 | typename std::enable_if<has_rbegin<ContainerTy>::value>::type * = |
263 | nullptr) -> decltype(make_range(C.rbegin(), C.rend())) { |
264 | return make_range(C.rbegin(), C.rend()); |
265 | } |
266 | |
267 | // Returns a std::reverse_iterator wrapped around the given iterator. |
268 | template <typename IteratorTy> |
269 | std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) { |
270 | return std::reverse_iterator<IteratorTy>(It); |
271 | } |
272 | |
273 | // Returns an iterator_range over the given container which iterates in reverse. |
274 | // Note that the container must have begin()/end() methods which return |
275 | // bidirectional iterators for this to work. |
276 | template <typename ContainerTy> |
277 | auto reverse( |
278 | ContainerTy &&C, |
279 | typename std::enable_if<!has_rbegin<ContainerTy>::value>::type * = nullptr) |
280 | -> decltype(make_range(llvm::make_reverse_iterator(std::end(C)), |
281 | llvm::make_reverse_iterator(std::begin(C)))) { |
282 | return make_range(llvm::make_reverse_iterator(std::end(C)), |
283 | llvm::make_reverse_iterator(std::begin(C))); |
284 | } |
285 | |
286 | /// An iterator adaptor that filters the elements of given inner iterators. |
287 | /// |
288 | /// The predicate parameter should be a callable object that accepts the wrapped |
289 | /// iterator's reference type and returns a bool. When incrementing or |
290 | /// decrementing the iterator, it will call the predicate on each element and |
291 | /// skip any where it returns false. |
292 | /// |
293 | /// \code |
294 | /// int A[] = { 1, 2, 3, 4 }; |
295 | /// auto R = make_filter_range(A, [](int N) { return N % 2 == 1; }); |
296 | /// // R contains { 1, 3 }. |
297 | /// \endcode |
298 | /// |
299 | /// Note: filter_iterator_base implements support for forward iteration. |
300 | /// filter_iterator_impl exists to provide support for bidirectional iteration, |
301 | /// conditional on whether the wrapped iterator supports it. |
302 | template <typename WrappedIteratorT, typename PredicateT, typename IterTag> |
303 | class filter_iterator_base |
304 | : public iterator_adaptor_base< |
305 | filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, |
306 | WrappedIteratorT, |
307 | typename std::common_type< |
308 | IterTag, typename std::iterator_traits< |
309 | WrappedIteratorT>::iterator_category>::type> { |
310 | using BaseT = iterator_adaptor_base< |
311 | filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, |
312 | WrappedIteratorT, |
313 | typename std::common_type< |
314 | IterTag, typename std::iterator_traits< |
315 | WrappedIteratorT>::iterator_category>::type>; |
316 | |
317 | protected: |
318 | WrappedIteratorT End; |
319 | PredicateT Pred; |
320 | |
321 | void findNextValid() { |
322 | while (this->I != End && !Pred(*this->I)) |
323 | BaseT::operator++(); |
324 | } |
325 | |
326 | // Construct the iterator. The begin iterator needs to know where the end |
327 | // is, so that it can properly stop when it gets there. The end iterator only |
328 | // needs the predicate to support bidirectional iteration. |
329 | filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End, |
330 | PredicateT Pred) |
331 | : BaseT(Begin), End(End), Pred(Pred) { |
332 | findNextValid(); |
333 | } |
334 | |
335 | public: |
336 | using BaseT::operator++; |
337 | |
338 | filter_iterator_base &operator++() { |
339 | BaseT::operator++(); |
340 | findNextValid(); |
341 | return *this; |
342 | } |
343 | }; |
344 | |
345 | /// Specialization of filter_iterator_base for forward iteration only. |
346 | template <typename WrappedIteratorT, typename PredicateT, |
347 | typename IterTag = std::forward_iterator_tag> |
348 | class filter_iterator_impl |
349 | : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> { |
350 | using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>; |
351 | |
352 | public: |
353 | filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, |
354 | PredicateT Pred) |
355 | : BaseT(Begin, End, Pred) {} |
356 | }; |
357 | |
358 | /// Specialization of filter_iterator_base for bidirectional iteration. |
359 | template <typename WrappedIteratorT, typename PredicateT> |
360 | class filter_iterator_impl<WrappedIteratorT, PredicateT, |
361 | std::bidirectional_iterator_tag> |
362 | : public filter_iterator_base<WrappedIteratorT, PredicateT, |
363 | std::bidirectional_iterator_tag> { |
364 | using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, |
365 | std::bidirectional_iterator_tag>; |
366 | void findPrevValid() { |
367 | while (!this->Pred(*this->I)) |
368 | BaseT::operator--(); |
369 | } |
370 | |
371 | public: |
372 | using BaseT::operator--; |
373 | |
374 | filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, |
375 | PredicateT Pred) |
376 | : BaseT(Begin, End, Pred) {} |
377 | |
378 | filter_iterator_impl &operator--() { |
379 | BaseT::operator--(); |
380 | findPrevValid(); |
381 | return *this; |
382 | } |
383 | }; |
384 | |
385 | namespace detail { |
386 | |
387 | template <bool is_bidirectional> struct fwd_or_bidi_tag_impl { |
388 | using type = std::forward_iterator_tag; |
389 | }; |
390 | |
391 | template <> struct fwd_or_bidi_tag_impl<true> { |
392 | using type = std::bidirectional_iterator_tag; |
393 | }; |
394 | |
395 | /// Helper which sets its type member to forward_iterator_tag if the category |
396 | /// of \p IterT does not derive from bidirectional_iterator_tag, and to |
397 | /// bidirectional_iterator_tag otherwise. |
398 | template <typename IterT> struct fwd_or_bidi_tag { |
399 | using type = typename fwd_or_bidi_tag_impl<std::is_base_of< |
400 | std::bidirectional_iterator_tag, |
401 | typename std::iterator_traits<IterT>::iterator_category>::value>::type; |
402 | }; |
403 | |
404 | } // namespace detail |
405 | |
406 | /// Defines filter_iterator to a suitable specialization of |
407 | /// filter_iterator_impl, based on the underlying iterator's category. |
408 | template <typename WrappedIteratorT, typename PredicateT> |
409 | using filter_iterator = filter_iterator_impl< |
410 | WrappedIteratorT, PredicateT, |
411 | typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>; |
412 | |
413 | /// Convenience function that takes a range of elements and a predicate, |
414 | /// and return a new filter_iterator range. |
415 | /// |
416 | /// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the |
417 | /// lifetime of that temporary is not kept by the returned range object, and the |
418 | /// temporary is going to be dropped on the floor after the make_iterator_range |
419 | /// full expression that contains this function call. |
420 | template <typename RangeT, typename PredicateT> |
421 | iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>> |
422 | make_filter_range(RangeT &&Range, PredicateT Pred) { |
423 | using FilterIteratorT = |
424 | filter_iterator<detail::IterOfRange<RangeT>, PredicateT>; |
425 | return make_range( |
426 | FilterIteratorT(std::begin(std::forward<RangeT>(Range)), |
427 | std::end(std::forward<RangeT>(Range)), Pred), |
428 | FilterIteratorT(std::end(std::forward<RangeT>(Range)), |
429 | std::end(std::forward<RangeT>(Range)), Pred)); |
430 | } |
431 | |
432 | /// A pseudo-iterator adaptor that is designed to implement "early increment" |
433 | /// style loops. |
434 | /// |
435 | /// This is *not a normal iterator* and should almost never be used directly. It |
436 | /// is intended primarily to be used with range based for loops and some range |
437 | /// algorithms. |
438 | /// |
439 | /// The iterator isn't quite an `OutputIterator` or an `InputIterator` but |
440 | /// somewhere between them. The constraints of these iterators are: |
441 | /// |
442 | /// - On construction or after being incremented, it is comparable and |
443 | /// dereferencable. It is *not* incrementable. |
444 | /// - After being dereferenced, it is neither comparable nor dereferencable, it |
445 | /// is only incrementable. |
446 | /// |
447 | /// This means you can only dereference the iterator once, and you can only |
448 | /// increment it once between dereferences. |
449 | template <typename WrappedIteratorT> |
450 | class early_inc_iterator_impl |
451 | : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, |
452 | WrappedIteratorT, std::input_iterator_tag> { |
453 | using BaseT = |
454 | iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, |
455 | WrappedIteratorT, std::input_iterator_tag>; |
456 | |
457 | using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer; |
458 | |
459 | protected: |
460 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
461 | bool IsEarlyIncremented = false; |
462 | #endif |
463 | |
464 | public: |
465 | early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {} |
466 | |
467 | using BaseT::operator*; |
468 | typename BaseT::reference operator*() { |
469 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
470 | assert(!IsEarlyIncremented && "Cannot dereference twice!")((!IsEarlyIncremented && "Cannot dereference twice!") ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot dereference twice!\"" , "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/ADT/STLExtras.h" , 470, __PRETTY_FUNCTION__)); |
471 | IsEarlyIncremented = true; |
472 | #endif |
473 | return *(this->I)++; |
474 | } |
475 | |
476 | using BaseT::operator++; |
477 | early_inc_iterator_impl &operator++() { |
478 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
479 | 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~svn350071/include/llvm/ADT/STLExtras.h" , 479, __PRETTY_FUNCTION__)); |
480 | IsEarlyIncremented = false; |
481 | #endif |
482 | return *this; |
483 | } |
484 | |
485 | using BaseT::operator==; |
486 | bool operator==(const early_inc_iterator_impl &RHS) const { |
487 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
488 | 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~svn350071/include/llvm/ADT/STLExtras.h" , 488, __PRETTY_FUNCTION__)); |
489 | #endif |
490 | return BaseT::operator==(RHS); |
491 | } |
492 | }; |
493 | |
494 | /// Make a range that does early increment to allow mutation of the underlying |
495 | /// range without disrupting iteration. |
496 | /// |
497 | /// The underlying iterator will be incremented immediately after it is |
498 | /// dereferenced, allowing deletion of the current node or insertion of nodes to |
499 | /// not disrupt iteration provided they do not invalidate the *next* iterator -- |
500 | /// the current iterator can be invalidated. |
501 | /// |
502 | /// This requires a very exact pattern of use that is only really suitable to |
503 | /// range based for loops and other range algorithms that explicitly guarantee |
504 | /// to dereference exactly once each element, and to increment exactly once each |
505 | /// element. |
506 | template <typename RangeT> |
507 | iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>> |
508 | make_early_inc_range(RangeT &&Range) { |
509 | using EarlyIncIteratorT = |
510 | early_inc_iterator_impl<detail::IterOfRange<RangeT>>; |
511 | return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))), |
512 | EarlyIncIteratorT(std::end(std::forward<RangeT>(Range)))); |
513 | } |
514 | |
515 | // forward declarations required by zip_shortest/zip_first/zip_longest |
516 | template <typename R, typename UnaryPredicate> |
517 | bool all_of(R &&range, UnaryPredicate P); |
518 | template <typename R, typename UnaryPredicate> |
519 | bool any_of(R &&range, UnaryPredicate P); |
520 | |
521 | template <size_t... I> struct index_sequence; |
522 | |
523 | template <class... Ts> struct index_sequence_for; |
524 | |
525 | namespace detail { |
526 | |
527 | using std::declval; |
528 | |
529 | // We have to alias this since inlining the actual type at the usage site |
530 | // in the parameter list of iterator_facade_base<> below ICEs MSVC 2017. |
531 | template<typename... Iters> struct ZipTupleType { |
532 | using type = std::tuple<decltype(*declval<Iters>())...>; |
533 | }; |
534 | |
535 | template <typename ZipType, typename... Iters> |
536 | using zip_traits = iterator_facade_base< |
537 | ZipType, typename std::common_type<std::bidirectional_iterator_tag, |
538 | typename std::iterator_traits< |
539 | Iters>::iterator_category...>::type, |
540 | // ^ TODO: Implement random access methods. |
541 | typename ZipTupleType<Iters...>::type, |
542 | typename std::iterator_traits<typename std::tuple_element< |
543 | 0, std::tuple<Iters...>>::type>::difference_type, |
544 | // ^ FIXME: This follows boost::make_zip_iterator's assumption that all |
545 | // inner iterators have the same difference_type. It would fail if, for |
546 | // instance, the second field's difference_type were non-numeric while the |
547 | // first is. |
548 | typename ZipTupleType<Iters...>::type *, |
549 | typename ZipTupleType<Iters...>::type>; |
550 | |
551 | template <typename ZipType, typename... Iters> |
552 | struct zip_common : public zip_traits<ZipType, Iters...> { |
553 | using Base = zip_traits<ZipType, Iters...>; |
554 | using value_type = typename Base::value_type; |
555 | |
556 | std::tuple<Iters...> iterators; |
557 | |
558 | protected: |
559 | template <size_t... Ns> value_type deref(index_sequence<Ns...>) const { |
560 | return value_type(*std::get<Ns>(iterators)...); |
561 | } |
562 | |
563 | template <size_t... Ns> |
564 | decltype(iterators) tup_inc(index_sequence<Ns...>) const { |
565 | return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...); |
566 | } |
567 | |
568 | template <size_t... Ns> |
569 | decltype(iterators) tup_dec(index_sequence<Ns...>) const { |
570 | return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...); |
571 | } |
572 | |
573 | public: |
574 | zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {} |
575 | |
576 | value_type operator*() { return deref(index_sequence_for<Iters...>{}); } |
577 | |
578 | const value_type operator*() const { |
579 | return deref(index_sequence_for<Iters...>{}); |
580 | } |
581 | |
582 | ZipType &operator++() { |
583 | iterators = tup_inc(index_sequence_for<Iters...>{}); |
584 | return *reinterpret_cast<ZipType *>(this); |
585 | } |
586 | |
587 | ZipType &operator--() { |
588 | static_assert(Base::IsBidirectional, |
589 | "All inner iterators must be at least bidirectional."); |
590 | iterators = tup_dec(index_sequence_for<Iters...>{}); |
591 | return *reinterpret_cast<ZipType *>(this); |
592 | } |
593 | }; |
594 | |
595 | template <typename... Iters> |
596 | struct zip_first : public zip_common<zip_first<Iters...>, Iters...> { |
597 | using Base = zip_common<zip_first<Iters...>, Iters...>; |
598 | |
599 | bool operator==(const zip_first<Iters...> &other) const { |
600 | return std::get<0>(this->iterators) == std::get<0>(other.iterators); |
601 | } |
602 | |
603 | zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} |
604 | }; |
605 | |
606 | template <typename... Iters> |
607 | class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> { |
608 | template <size_t... Ns> |
609 | bool test(const zip_shortest<Iters...> &other, index_sequence<Ns...>) const { |
610 | return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) != |
611 | std::get<Ns>(other.iterators)...}, |
612 | identity<bool>{}); |
613 | } |
614 | |
615 | public: |
616 | using Base = zip_common<zip_shortest<Iters...>, Iters...>; |
617 | |
618 | zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} |
619 | |
620 | bool operator==(const zip_shortest<Iters...> &other) const { |
621 | return !test(other, index_sequence_for<Iters...>{}); |
622 | } |
623 | }; |
624 | |
625 | template <template <typename...> class ItType, typename... Args> class zippy { |
626 | public: |
627 | using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>; |
628 | using iterator_category = typename iterator::iterator_category; |
629 | using value_type = typename iterator::value_type; |
630 | using difference_type = typename iterator::difference_type; |
631 | using pointer = typename iterator::pointer; |
632 | using reference = typename iterator::reference; |
633 | |
634 | private: |
635 | std::tuple<Args...> ts; |
636 | |
637 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const { |
638 | return iterator(std::begin(std::get<Ns>(ts))...); |
639 | } |
640 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const { |
641 | return iterator(std::end(std::get<Ns>(ts))...); |
642 | } |
643 | |
644 | public: |
645 | zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {} |
646 | |
647 | iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); } |
648 | iterator end() const { return end_impl(index_sequence_for<Args...>{}); } |
649 | }; |
650 | |
651 | } // end namespace detail |
652 | |
653 | /// zip iterator for two or more iteratable types. |
654 | template <typename T, typename U, typename... Args> |
655 | detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u, |
656 | Args &&... args) { |
657 | return detail::zippy<detail::zip_shortest, T, U, Args...>( |
658 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
659 | } |
660 | |
661 | /// zip iterator that, for the sake of efficiency, assumes the first iteratee to |
662 | /// be the shortest. |
663 | template <typename T, typename U, typename... Args> |
664 | detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u, |
665 | Args &&... args) { |
666 | return detail::zippy<detail::zip_first, T, U, Args...>( |
667 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
668 | } |
669 | |
670 | namespace detail { |
671 | template <typename Iter> |
672 | static Iter next_or_end(const Iter &I, const Iter &End) { |
673 | if (I == End) |
674 | return End; |
675 | return std::next(I); |
676 | } |
677 | |
678 | template <typename Iter> |
679 | static auto deref_or_none(const Iter &I, const Iter &End) |
680 | -> llvm::Optional<typename std::remove_const< |
681 | typename std::remove_reference<decltype(*I)>::type>::type> { |
682 | if (I == End) |
683 | return None; |
684 | return *I; |
685 | } |
686 | |
687 | template <typename Iter> struct ZipLongestItemType { |
688 | using type = |
689 | llvm::Optional<typename std::remove_const<typename std::remove_reference< |
690 | decltype(*std::declval<Iter>())>::type>::type>; |
691 | }; |
692 | |
693 | template <typename... Iters> struct ZipLongestTupleType { |
694 | using type = std::tuple<typename ZipLongestItemType<Iters>::type...>; |
695 | }; |
696 | |
697 | template <typename... Iters> |
698 | class zip_longest_iterator |
699 | : public iterator_facade_base< |
700 | zip_longest_iterator<Iters...>, |
701 | typename std::common_type< |
702 | std::forward_iterator_tag, |
703 | typename std::iterator_traits<Iters>::iterator_category...>::type, |
704 | typename ZipLongestTupleType<Iters...>::type, |
705 | typename std::iterator_traits<typename std::tuple_element< |
706 | 0, std::tuple<Iters...>>::type>::difference_type, |
707 | typename ZipLongestTupleType<Iters...>::type *, |
708 | typename ZipLongestTupleType<Iters...>::type> { |
709 | public: |
710 | using value_type = typename ZipLongestTupleType<Iters...>::type; |
711 | |
712 | private: |
713 | std::tuple<Iters...> iterators; |
714 | std::tuple<Iters...> end_iterators; |
715 | |
716 | template <size_t... Ns> |
717 | bool test(const zip_longest_iterator<Iters...> &other, |
718 | index_sequence<Ns...>) const { |
719 | return llvm::any_of( |
720 | std::initializer_list<bool>{std::get<Ns>(this->iterators) != |
721 | std::get<Ns>(other.iterators)...}, |
722 | identity<bool>{}); |
723 | } |
724 | |
725 | template <size_t... Ns> value_type deref(index_sequence<Ns...>) const { |
726 | return value_type( |
727 | deref_or_none(std::get<Ns>(iterators), std::get<Ns>(end_iterators))...); |
728 | } |
729 | |
730 | template <size_t... Ns> |
731 | decltype(iterators) tup_inc(index_sequence<Ns...>) const { |
732 | return std::tuple<Iters...>( |
733 | next_or_end(std::get<Ns>(iterators), std::get<Ns>(end_iterators))...); |
734 | } |
735 | |
736 | public: |
737 | zip_longest_iterator(std::pair<Iters &&, Iters &&>... ts) |
738 | : iterators(std::forward<Iters>(ts.first)...), |
739 | end_iterators(std::forward<Iters>(ts.second)...) {} |
740 | |
741 | value_type operator*() { return deref(index_sequence_for<Iters...>{}); } |
742 | |
743 | value_type operator*() const { return deref(index_sequence_for<Iters...>{}); } |
744 | |
745 | zip_longest_iterator<Iters...> &operator++() { |
746 | iterators = tup_inc(index_sequence_for<Iters...>{}); |
747 | return *this; |
748 | } |
749 | |
750 | bool operator==(const zip_longest_iterator<Iters...> &other) const { |
751 | return !test(other, index_sequence_for<Iters...>{}); |
752 | } |
753 | }; |
754 | |
755 | template <typename... Args> class zip_longest_range { |
756 | public: |
757 | using iterator = |
758 | zip_longest_iterator<decltype(adl_begin(std::declval<Args>()))...>; |
759 | using iterator_category = typename iterator::iterator_category; |
760 | using value_type = typename iterator::value_type; |
761 | using difference_type = typename iterator::difference_type; |
762 | using pointer = typename iterator::pointer; |
763 | using reference = typename iterator::reference; |
764 | |
765 | private: |
766 | std::tuple<Args...> ts; |
767 | |
768 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const { |
769 | return iterator(std::make_pair(adl_begin(std::get<Ns>(ts)), |
770 | adl_end(std::get<Ns>(ts)))...); |
771 | } |
772 | |
773 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const { |
774 | return iterator(std::make_pair(adl_end(std::get<Ns>(ts)), |
775 | adl_end(std::get<Ns>(ts)))...); |
776 | } |
777 | |
778 | public: |
779 | zip_longest_range(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {} |
780 | |
781 | iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); } |
782 | iterator end() const { return end_impl(index_sequence_for<Args...>{}); } |
783 | }; |
784 | } // namespace detail |
785 | |
786 | /// Iterate over two or more iterators at the same time. Iteration continues |
787 | /// until all iterators reach the end. The llvm::Optional only contains a value |
788 | /// if the iterator has not reached the end. |
789 | template <typename T, typename U, typename... Args> |
790 | detail::zip_longest_range<T, U, Args...> zip_longest(T &&t, U &&u, |
791 | Args &&... args) { |
792 | return detail::zip_longest_range<T, U, Args...>( |
793 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
794 | } |
795 | |
796 | /// Iterator wrapper that concatenates sequences together. |
797 | /// |
798 | /// This can concatenate different iterators, even with different types, into |
799 | /// a single iterator provided the value types of all the concatenated |
800 | /// iterators expose `reference` and `pointer` types that can be converted to |
801 | /// `ValueT &` and `ValueT *` respectively. It doesn't support more |
802 | /// interesting/customized pointer or reference types. |
803 | /// |
804 | /// Currently this only supports forward or higher iterator categories as |
805 | /// inputs and always exposes a forward iterator interface. |
806 | template <typename ValueT, typename... IterTs> |
807 | class concat_iterator |
808 | : public iterator_facade_base<concat_iterator<ValueT, IterTs...>, |
809 | std::forward_iterator_tag, ValueT> { |
810 | using BaseT = typename concat_iterator::iterator_facade_base; |
811 | |
812 | /// We store both the current and end iterators for each concatenated |
813 | /// sequence in a tuple of pairs. |
814 | /// |
815 | /// Note that something like iterator_range seems nice at first here, but the |
816 | /// range properties are of little benefit and end up getting in the way |
817 | /// because we need to do mutation on the current iterators. |
818 | std::tuple<IterTs...> Begins; |
819 | std::tuple<IterTs...> Ends; |
820 | |
821 | /// Attempts to increment a specific iterator. |
822 | /// |
823 | /// Returns true if it was able to increment the iterator. Returns false if |
824 | /// the iterator is already at the end iterator. |
825 | template <size_t Index> bool incrementHelper() { |
826 | auto &Begin = std::get<Index>(Begins); |
827 | auto &End = std::get<Index>(Ends); |
828 | if (Begin == End) |
829 | return false; |
830 | |
831 | ++Begin; |
832 | return true; |
833 | } |
834 | |
835 | /// Increments the first non-end iterator. |
836 | /// |
837 | /// It is an error to call this with all iterators at the end. |
838 | template <size_t... Ns> void increment(index_sequence<Ns...>) { |
839 | // Build a sequence of functions to increment each iterator if possible. |
840 | bool (concat_iterator::*IncrementHelperFns[])() = { |
841 | &concat_iterator::incrementHelper<Ns>...}; |
842 | |
843 | // Loop over them, and stop as soon as we succeed at incrementing one. |
844 | for (auto &IncrementHelperFn : IncrementHelperFns) |
845 | if ((this->*IncrementHelperFn)()) |
846 | return; |
847 | |
848 | 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~svn350071/include/llvm/ADT/STLExtras.h" , 848); |
849 | } |
850 | |
851 | /// Returns null if the specified iterator is at the end. Otherwise, |
852 | /// dereferences the iterator and returns the address of the resulting |
853 | /// reference. |
854 | template <size_t Index> ValueT *getHelper() const { |
855 | auto &Begin = std::get<Index>(Begins); |
856 | auto &End = std::get<Index>(Ends); |
857 | if (Begin == End) |
858 | return nullptr; |
859 | |
860 | return &*Begin; |
861 | } |
862 | |
863 | /// Finds the first non-end iterator, dereferences, and returns the resulting |
864 | /// reference. |
865 | /// |
866 | /// It is an error to call this with all iterators at the end. |
867 | template <size_t... Ns> ValueT &get(index_sequence<Ns...>) const { |
868 | // Build a sequence of functions to get from iterator if possible. |
869 | ValueT *(concat_iterator::*GetHelperFns[])() const = { |
870 | &concat_iterator::getHelper<Ns>...}; |
871 | |
872 | // Loop over them, and return the first result we find. |
873 | for (auto &GetHelperFn : GetHelperFns) |
874 | if (ValueT *P = (this->*GetHelperFn)()) |
875 | return *P; |
876 | |
877 | 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~svn350071/include/llvm/ADT/STLExtras.h" , 877); |
878 | } |
879 | |
880 | public: |
881 | /// Constructs an iterator from a squence of ranges. |
882 | /// |
883 | /// We need the full range to know how to switch between each of the |
884 | /// iterators. |
885 | template <typename... RangeTs> |
886 | explicit concat_iterator(RangeTs &&... Ranges) |
887 | : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {} |
888 | |
889 | using BaseT::operator++; |
890 | |
891 | concat_iterator &operator++() { |
892 | increment(index_sequence_for<IterTs...>()); |
893 | return *this; |
894 | } |
895 | |
896 | ValueT &operator*() const { return get(index_sequence_for<IterTs...>()); } |
897 | |
898 | bool operator==(const concat_iterator &RHS) const { |
899 | return Begins == RHS.Begins && Ends == RHS.Ends; |
900 | } |
901 | }; |
902 | |
903 | namespace detail { |
904 | |
905 | /// Helper to store a sequence of ranges being concatenated and access them. |
906 | /// |
907 | /// This is designed to facilitate providing actual storage when temporaries |
908 | /// are passed into the constructor such that we can use it as part of range |
909 | /// based for loops. |
910 | template <typename ValueT, typename... RangeTs> class concat_range { |
911 | public: |
912 | using iterator = |
913 | concat_iterator<ValueT, |
914 | decltype(std::begin(std::declval<RangeTs &>()))...>; |
915 | |
916 | private: |
917 | std::tuple<RangeTs...> Ranges; |
918 | |
919 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) { |
920 | return iterator(std::get<Ns>(Ranges)...); |
921 | } |
922 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) { |
923 | return iterator(make_range(std::end(std::get<Ns>(Ranges)), |
924 | std::end(std::get<Ns>(Ranges)))...); |
925 | } |
926 | |
927 | public: |
928 | concat_range(RangeTs &&... Ranges) |
929 | : Ranges(std::forward<RangeTs>(Ranges)...) {} |
930 | |
931 | iterator begin() { return begin_impl(index_sequence_for<RangeTs...>{}); } |
932 | iterator end() { return end_impl(index_sequence_for<RangeTs...>{}); } |
933 | }; |
934 | |
935 | } // end namespace detail |
936 | |
937 | /// Concatenated range across two or more ranges. |
938 | /// |
939 | /// The desired value type must be explicitly specified. |
940 | template <typename ValueT, typename... RangeTs> |
941 | detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) { |
942 | static_assert(sizeof...(RangeTs) > 1, |
943 | "Need more than one range to concatenate!"); |
944 | return detail::concat_range<ValueT, RangeTs...>( |
945 | std::forward<RangeTs>(Ranges)...); |
946 | } |
947 | |
948 | //===----------------------------------------------------------------------===// |
949 | // Extra additions to <utility> |
950 | //===----------------------------------------------------------------------===// |
951 | |
952 | /// Function object to check whether the first component of a std::pair |
953 | /// compares less than the first component of another std::pair. |
954 | struct less_first { |
955 | template <typename T> bool operator()(const T &lhs, const T &rhs) const { |
956 | return lhs.first < rhs.first; |
957 | } |
958 | }; |
959 | |
960 | /// Function object to check whether the second component of a std::pair |
961 | /// compares less than the second component of another std::pair. |
962 | struct less_second { |
963 | template <typename T> bool operator()(const T &lhs, const T &rhs) const { |
964 | return lhs.second < rhs.second; |
965 | } |
966 | }; |
967 | |
968 | /// \brief Function object to apply a binary function to the first component of |
969 | /// a std::pair. |
970 | template<typename FuncTy> |
971 | struct on_first { |
972 | FuncTy func; |
973 | |
974 | template <typename T> |
975 | auto operator()(const T &lhs, const T &rhs) const |
976 | -> decltype(func(lhs.first, rhs.first)) { |
977 | return func(lhs.first, rhs.first); |
978 | } |
979 | }; |
980 | |
981 | // A subset of N3658. More stuff can be added as-needed. |
982 | |
983 | /// Represents a compile-time sequence of integers. |
984 | template <class T, T... I> struct integer_sequence { |
985 | using value_type = T; |
986 | |
987 | static constexpr size_t size() { return sizeof...(I); } |
988 | }; |
989 | |
990 | /// Alias for the common case of a sequence of size_ts. |
991 | template <size_t... I> |
992 | struct index_sequence : integer_sequence<std::size_t, I...> {}; |
993 | |
994 | template <std::size_t N, std::size_t... I> |
995 | struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {}; |
996 | template <std::size_t... I> |
997 | struct build_index_impl<0, I...> : index_sequence<I...> {}; |
998 | |
999 | /// Creates a compile-time integer sequence for a parameter pack. |
1000 | template <class... Ts> |
1001 | struct index_sequence_for : build_index_impl<sizeof...(Ts)> {}; |
1002 | |
1003 | /// Utility type to build an inheritance chain that makes it easy to rank |
1004 | /// overload candidates. |
1005 | template <int N> struct rank : rank<N - 1> {}; |
1006 | template <> struct rank<0> {}; |
1007 | |
1008 | /// traits class for checking whether type T is one of any of the given |
1009 | /// types in the variadic list. |
1010 | template <typename T, typename... Ts> struct is_one_of { |
1011 | static const bool value = false; |
1012 | }; |
1013 | |
1014 | template <typename T, typename U, typename... Ts> |
1015 | struct is_one_of<T, U, Ts...> { |
1016 | static const bool value = |
1017 | std::is_same<T, U>::value || is_one_of<T, Ts...>::value; |
1018 | }; |
1019 | |
1020 | /// traits class for checking whether type T is a base class for all |
1021 | /// the given types in the variadic list. |
1022 | template <typename T, typename... Ts> struct are_base_of { |
1023 | static const bool value = true; |
1024 | }; |
1025 | |
1026 | template <typename T, typename U, typename... Ts> |
1027 | struct are_base_of<T, U, Ts...> { |
1028 | static const bool value = |
1029 | std::is_base_of<T, U>::value && are_base_of<T, Ts...>::value; |
1030 | }; |
1031 | |
1032 | //===----------------------------------------------------------------------===// |
1033 | // Extra additions for arrays |
1034 | //===----------------------------------------------------------------------===// |
1035 | |
1036 | /// Find the length of an array. |
1037 | template <class T, std::size_t N> |
1038 | constexpr inline size_t array_lengthof(T (&)[N]) { |
1039 | return N; |
1040 | } |
1041 | |
1042 | /// Adapt std::less<T> for array_pod_sort. |
1043 | template<typename T> |
1044 | inline int array_pod_sort_comparator(const void *P1, const void *P2) { |
1045 | if (std::less<T>()(*reinterpret_cast<const T*>(P1), |
1046 | *reinterpret_cast<const T*>(P2))) |
1047 | return -1; |
1048 | if (std::less<T>()(*reinterpret_cast<const T*>(P2), |
1049 | *reinterpret_cast<const T*>(P1))) |
1050 | return 1; |
1051 | return 0; |
1052 | } |
1053 | |
1054 | /// get_array_pod_sort_comparator - This is an internal helper function used to |
1055 | /// get type deduction of T right. |
1056 | template<typename T> |
1057 | inline int (*get_array_pod_sort_comparator(const T &)) |
1058 | (const void*, const void*) { |
1059 | return array_pod_sort_comparator<T>; |
1060 | } |
1061 | |
1062 | /// array_pod_sort - This sorts an array with the specified start and end |
1063 | /// extent. This is just like std::sort, except that it calls qsort instead of |
1064 | /// using an inlined template. qsort is slightly slower than std::sort, but |
1065 | /// most sorts are not performance critical in LLVM and std::sort has to be |
1066 | /// template instantiated for each type, leading to significant measured code |
1067 | /// bloat. This function should generally be used instead of std::sort where |
1068 | /// possible. |
1069 | /// |
1070 | /// This function assumes that you have simple POD-like types that can be |
1071 | /// compared with std::less and can be moved with memcpy. If this isn't true, |
1072 | /// you should use std::sort. |
1073 | /// |
1074 | /// NOTE: If qsort_r were portable, we could allow a custom comparator and |
1075 | /// default to std::less. |
1076 | template<class IteratorTy> |
1077 | inline void array_pod_sort(IteratorTy Start, IteratorTy End) { |
1078 | // Don't inefficiently call qsort with one element or trigger undefined |
1079 | // behavior with an empty sequence. |
1080 | auto NElts = End - Start; |
1081 | if (NElts <= 1) return; |
1082 | #ifdef EXPENSIVE_CHECKS |
1083 | std::mt19937 Generator(std::random_device{}()); |
1084 | std::shuffle(Start, End, Generator); |
1085 | #endif |
1086 | qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start)); |
1087 | } |
1088 | |
1089 | template <class IteratorTy> |
1090 | inline void array_pod_sort( |
1091 | IteratorTy Start, IteratorTy End, |
1092 | int (*Compare)( |
1093 | const typename std::iterator_traits<IteratorTy>::value_type *, |
1094 | const typename std::iterator_traits<IteratorTy>::value_type *)) { |
1095 | // Don't inefficiently call qsort with one element or trigger undefined |
1096 | // behavior with an empty sequence. |
1097 | auto NElts = End - Start; |
1098 | if (NElts <= 1) return; |
1099 | #ifdef EXPENSIVE_CHECKS |
1100 | std::mt19937 Generator(std::random_device{}()); |
1101 | std::shuffle(Start, End, Generator); |
1102 | #endif |
1103 | qsort(&*Start, NElts, sizeof(*Start), |
1104 | reinterpret_cast<int (*)(const void *, const void *)>(Compare)); |
1105 | } |
1106 | |
1107 | // Provide wrappers to std::sort which shuffle the elements before sorting |
1108 | // to help uncover non-deterministic behavior (PR35135). |
1109 | template <typename IteratorTy> |
1110 | inline void sort(IteratorTy Start, IteratorTy End) { |
1111 | #ifdef EXPENSIVE_CHECKS |
1112 | std::mt19937 Generator(std::random_device{}()); |
1113 | std::shuffle(Start, End, Generator); |
1114 | #endif |
1115 | std::sort(Start, End); |
1116 | } |
1117 | |
1118 | template <typename Container> inline void sort(Container &&C) { |
1119 | llvm::sort(adl_begin(C), adl_end(C)); |
1120 | } |
1121 | |
1122 | template <typename IteratorTy, typename Compare> |
1123 | inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) { |
1124 | #ifdef EXPENSIVE_CHECKS |
1125 | std::mt19937 Generator(std::random_device{}()); |
1126 | std::shuffle(Start, End, Generator); |
1127 | #endif |
1128 | std::sort(Start, End, Comp); |
1129 | } |
1130 | |
1131 | template <typename Container, typename Compare> |
1132 | inline void sort(Container &&C, Compare Comp) { |
1133 | llvm::sort(adl_begin(C), adl_end(C), Comp); |
1134 | } |
1135 | |
1136 | //===----------------------------------------------------------------------===// |
1137 | // Extra additions to <algorithm> |
1138 | //===----------------------------------------------------------------------===// |
1139 | |
1140 | /// For a container of pointers, deletes the pointers and then clears the |
1141 | /// container. |
1142 | template<typename Container> |
1143 | void DeleteContainerPointers(Container &C) { |
1144 | for (auto V : C) |
1145 | delete V; |
1146 | C.clear(); |
1147 | } |
1148 | |
1149 | /// In a container of pairs (usually a map) whose second element is a pointer, |
1150 | /// deletes the second elements and then clears the container. |
1151 | template<typename Container> |
1152 | void DeleteContainerSeconds(Container &C) { |
1153 | for (auto &V : C) |
1154 | delete V.second; |
1155 | C.clear(); |
1156 | } |
1157 | |
1158 | /// Get the size of a range. This is a wrapper function around std::distance |
1159 | /// which is only enabled when the operation is O(1). |
1160 | template <typename R> |
1161 | auto size(R &&Range, typename std::enable_if< |
1162 | std::is_same<typename std::iterator_traits<decltype( |
1163 | Range.begin())>::iterator_category, |
1164 | std::random_access_iterator_tag>::value, |
1165 | void>::type * = nullptr) |
1166 | -> decltype(std::distance(Range.begin(), Range.end())) { |
1167 | return std::distance(Range.begin(), Range.end()); |
1168 | } |
1169 | |
1170 | /// Provide wrappers to std::for_each which take ranges instead of having to |
1171 | /// pass begin/end explicitly. |
1172 | template <typename R, typename UnaryPredicate> |
1173 | UnaryPredicate for_each(R &&Range, UnaryPredicate P) { |
1174 | return std::for_each(adl_begin(Range), adl_end(Range), P); |
1175 | } |
1176 | |
1177 | /// Provide wrappers to std::all_of which take ranges instead of having to pass |
1178 | /// begin/end explicitly. |
1179 | template <typename R, typename UnaryPredicate> |
1180 | bool all_of(R &&Range, UnaryPredicate P) { |
1181 | return std::all_of(adl_begin(Range), adl_end(Range), P); |
1182 | } |
1183 | |
1184 | /// Provide wrappers to std::any_of which take ranges instead of having to pass |
1185 | /// begin/end explicitly. |
1186 | template <typename R, typename UnaryPredicate> |
1187 | bool any_of(R &&Range, UnaryPredicate P) { |
1188 | return std::any_of(adl_begin(Range), adl_end(Range), P); |
1189 | } |
1190 | |
1191 | /// Provide wrappers to std::none_of which take ranges instead of having to pass |
1192 | /// begin/end explicitly. |
1193 | template <typename R, typename UnaryPredicate> |
1194 | bool none_of(R &&Range, UnaryPredicate P) { |
1195 | return std::none_of(adl_begin(Range), adl_end(Range), P); |
1196 | } |
1197 | |
1198 | /// Provide wrappers to std::find which take ranges instead of having to pass |
1199 | /// begin/end explicitly. |
1200 | template <typename R, typename T> |
1201 | auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range)) { |
1202 | return std::find(adl_begin(Range), adl_end(Range), Val); |
1203 | } |
1204 | |
1205 | /// Provide wrappers to std::find_if which take ranges instead of having to pass |
1206 | /// begin/end explicitly. |
1207 | template <typename R, typename UnaryPredicate> |
1208 | auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1209 | return std::find_if(adl_begin(Range), adl_end(Range), P); |
1210 | } |
1211 | |
1212 | template <typename R, typename UnaryPredicate> |
1213 | auto find_if_not(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1214 | return std::find_if_not(adl_begin(Range), adl_end(Range), P); |
1215 | } |
1216 | |
1217 | /// Provide wrappers to std::remove_if which take ranges instead of having to |
1218 | /// pass begin/end explicitly. |
1219 | template <typename R, typename UnaryPredicate> |
1220 | auto remove_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1221 | return std::remove_if(adl_begin(Range), adl_end(Range), P); |
1222 | } |
1223 | |
1224 | /// Provide wrappers to std::copy_if which take ranges instead of having to |
1225 | /// pass begin/end explicitly. |
1226 | template <typename R, typename OutputIt, typename UnaryPredicate> |
1227 | OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) { |
1228 | return std::copy_if(adl_begin(Range), adl_end(Range), Out, P); |
1229 | } |
1230 | |
1231 | template <typename R, typename OutputIt> |
1232 | OutputIt copy(R &&Range, OutputIt Out) { |
1233 | return std::copy(adl_begin(Range), adl_end(Range), Out); |
1234 | } |
1235 | |
1236 | /// Wrapper function around std::find to detect if an element exists |
1237 | /// in a container. |
1238 | template <typename R, typename E> |
1239 | bool is_contained(R &&Range, const E &Element) { |
1240 | return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range); |
1241 | } |
1242 | |
1243 | /// Wrapper function around std::count to count the number of times an element |
1244 | /// \p Element occurs in the given range \p Range. |
1245 | template <typename R, typename E> |
1246 | auto count(R &&Range, const E &Element) -> |
1247 | typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type { |
1248 | return std::count(adl_begin(Range), adl_end(Range), Element); |
1249 | } |
1250 | |
1251 | /// Wrapper function around std::count_if to count the number of times an |
1252 | /// element satisfying a given predicate occurs in a range. |
1253 | template <typename R, typename UnaryPredicate> |
1254 | auto count_if(R &&Range, UnaryPredicate P) -> |
1255 | typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type { |
1256 | return std::count_if(adl_begin(Range), adl_end(Range), P); |
1257 | } |
1258 | |
1259 | /// Wrapper function around std::transform to apply a function to a range and |
1260 | /// store the result elsewhere. |
1261 | template <typename R, typename OutputIt, typename UnaryPredicate> |
1262 | OutputIt transform(R &&Range, OutputIt d_first, UnaryPredicate P) { |
1263 | return std::transform(adl_begin(Range), adl_end(Range), d_first, P); |
1264 | } |
1265 | |
1266 | /// Provide wrappers to std::partition which take ranges instead of having to |
1267 | /// pass begin/end explicitly. |
1268 | template <typename R, typename UnaryPredicate> |
1269 | auto partition(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
1270 | return std::partition(adl_begin(Range), adl_end(Range), P); |
1271 | } |
1272 | |
1273 | /// Provide wrappers to std::lower_bound which take ranges instead of having to |
1274 | /// pass begin/end explicitly. |
1275 | template <typename R, typename ForwardIt> |
1276 | auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) { |
1277 | return std::lower_bound(adl_begin(Range), adl_end(Range), I); |
1278 | } |
1279 | |
1280 | template <typename R, typename ForwardIt, typename Compare> |
1281 | auto lower_bound(R &&Range, ForwardIt I, Compare C) |
1282 | -> decltype(adl_begin(Range)) { |
1283 | return std::lower_bound(adl_begin(Range), adl_end(Range), I, C); |
1284 | } |
1285 | |
1286 | /// Provide wrappers to std::upper_bound which take ranges instead of having to |
1287 | /// pass begin/end explicitly. |
1288 | template <typename R, typename ForwardIt> |
1289 | auto upper_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) { |
1290 | return std::upper_bound(adl_begin(Range), adl_end(Range), I); |
1291 | } |
1292 | |
1293 | template <typename R, typename ForwardIt, typename Compare> |
1294 | auto upper_bound(R &&Range, ForwardIt I, Compare C) |
1295 | -> decltype(adl_begin(Range)) { |
1296 | return std::upper_bound(adl_begin(Range), adl_end(Range), I, C); |
1297 | } |
1298 | /// Wrapper function around std::equal to detect if all elements |
1299 | /// in a container are same. |
1300 | template <typename R> |
1301 | bool is_splat(R &&Range) { |
1302 | size_t range_size = size(Range); |
1303 | return range_size != 0 && (range_size == 1 || |
1304 | std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range))); |
1305 | } |
1306 | |
1307 | /// Given a range of type R, iterate the entire range and return a |
1308 | /// SmallVector with elements of the vector. This is useful, for example, |
1309 | /// when you want to iterate a range and then sort the results. |
1310 | template <unsigned Size, typename R> |
1311 | SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size> |
1312 | to_vector(R &&Range) { |
1313 | return {adl_begin(Range), adl_end(Range)}; |
1314 | } |
1315 | |
1316 | /// Provide a container algorithm similar to C++ Library Fundamentals v2's |
1317 | /// `erase_if` which is equivalent to: |
1318 | /// |
1319 | /// C.erase(remove_if(C, pred), C.end()); |
1320 | /// |
1321 | /// This version works for any container with an erase method call accepting |
1322 | /// two iterators. |
1323 | template <typename Container, typename UnaryPredicate> |
1324 | void erase_if(Container &C, UnaryPredicate P) { |
1325 | C.erase(remove_if(C, P), C.end()); |
1326 | } |
1327 | |
1328 | //===----------------------------------------------------------------------===// |
1329 | // Extra additions to <memory> |
1330 | //===----------------------------------------------------------------------===// |
1331 | |
1332 | // Implement make_unique according to N3656. |
1333 | |
1334 | /// Constructs a `new T()` with the given args and returns a |
1335 | /// `unique_ptr<T>` which owns the object. |
1336 | /// |
1337 | /// Example: |
1338 | /// |
1339 | /// auto p = make_unique<int>(); |
1340 | /// auto p = make_unique<std::tuple<int, int>>(0, 1); |
1341 | template <class T, class... Args> |
1342 | typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type |
1343 | make_unique(Args &&... args) { |
1344 | return std::unique_ptr<T>(new T(std::forward<Args>(args)...)); |
1345 | } |
1346 | |
1347 | /// Constructs a `new T[n]` with the given args and returns a |
1348 | /// `unique_ptr<T[]>` which owns the object. |
1349 | /// |
1350 | /// \param n size of the new array. |
1351 | /// |
1352 | /// Example: |
1353 | /// |
1354 | /// auto p = make_unique<int[]>(2); // value-initializes the array with 0's. |
1355 | template <class T> |
1356 | typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0, |
1357 | std::unique_ptr<T>>::type |
1358 | make_unique(size_t n) { |
1359 | return std::unique_ptr<T>(new typename std::remove_extent<T>::type[n]()); |
1360 | } |
1361 | |
1362 | /// This function isn't used and is only here to provide better compile errors. |
1363 | template <class T, class... Args> |
1364 | typename std::enable_if<std::extent<T>::value != 0>::type |
1365 | make_unique(Args &&...) = delete; |
1366 | |
1367 | struct FreeDeleter { |
1368 | void operator()(void* v) { |
1369 | ::free(v); |
1370 | } |
1371 | }; |
1372 | |
1373 | template<typename First, typename Second> |
1374 | struct pair_hash { |
1375 | size_t operator()(const std::pair<First, Second> &P) const { |
1376 | return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second); |
1377 | } |
1378 | }; |
1379 | |
1380 | /// A functor like C++14's std::less<void> in its absence. |
1381 | struct less { |
1382 | template <typename A, typename B> bool operator()(A &&a, B &&b) const { |
1383 | return std::forward<A>(a) < std::forward<B>(b); |
1384 | } |
1385 | }; |
1386 | |
1387 | /// A functor like C++14's std::equal<void> in its absence. |
1388 | struct equal { |
1389 | template <typename A, typename B> bool operator()(A &&a, B &&b) const { |
1390 | return std::forward<A>(a) == std::forward<B>(b); |
1391 | } |
1392 | }; |
1393 | |
1394 | /// Binary functor that adapts to any other binary functor after dereferencing |
1395 | /// operands. |
1396 | template <typename T> struct deref { |
1397 | T func; |
1398 | |
1399 | // Could be further improved to cope with non-derivable functors and |
1400 | // non-binary functors (should be a variadic template member function |
1401 | // operator()). |
1402 | template <typename A, typename B> |
1403 | auto operator()(A &lhs, B &rhs) const -> decltype(func(*lhs, *rhs)) { |
1404 | assert(lhs)((lhs) ? static_cast<void> (0) : __assert_fail ("lhs", "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/ADT/STLExtras.h" , 1404, __PRETTY_FUNCTION__)); |
1405 | assert(rhs)((rhs) ? static_cast<void> (0) : __assert_fail ("rhs", "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/ADT/STLExtras.h" , 1405, __PRETTY_FUNCTION__)); |
1406 | return func(*lhs, *rhs); |
1407 | } |
1408 | }; |
1409 | |
1410 | namespace detail { |
1411 | |
1412 | template <typename R> class enumerator_iter; |
1413 | |
1414 | template <typename R> struct result_pair { |
1415 | friend class enumerator_iter<R>; |
1416 | |
1417 | result_pair() = default; |
1418 | result_pair(std::size_t Index, IterOfRange<R> Iter) |
1419 | : Index(Index), Iter(Iter) {} |
1420 | |
1421 | result_pair<R> &operator=(const result_pair<R> &Other) { |
1422 | Index = Other.Index; |
1423 | Iter = Other.Iter; |
1424 | return *this; |
1425 | } |
1426 | |
1427 | std::size_t index() const { return Index; } |
1428 | const ValueOfRange<R> &value() const { return *Iter; } |
1429 | ValueOfRange<R> &value() { return *Iter; } |
1430 | |
1431 | private: |
1432 | std::size_t Index = std::numeric_limits<std::size_t>::max(); |
1433 | IterOfRange<R> Iter; |
1434 | }; |
1435 | |
1436 | template <typename R> |
1437 | class enumerator_iter |
1438 | : public iterator_facade_base< |
1439 | enumerator_iter<R>, std::forward_iterator_tag, result_pair<R>, |
1440 | typename std::iterator_traits<IterOfRange<R>>::difference_type, |
1441 | typename std::iterator_traits<IterOfRange<R>>::pointer, |
1442 | typename std::iterator_traits<IterOfRange<R>>::reference> { |
1443 | using result_type = result_pair<R>; |
1444 | |
1445 | public: |
1446 | explicit enumerator_iter(IterOfRange<R> EndIter) |
1447 | : Result(std::numeric_limits<size_t>::max(), EndIter) {} |
1448 | |
1449 | enumerator_iter(std::size_t Index, IterOfRange<R> Iter) |
1450 | : Result(Index, Iter) {} |
1451 | |
1452 | result_type &operator*() { return Result; } |
1453 | const result_type &operator*() const { return Result; } |
1454 | |
1455 | enumerator_iter<R> &operator++() { |
1456 | 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~svn350071/include/llvm/ADT/STLExtras.h" , 1456, __PRETTY_FUNCTION__)); |
1457 | ++Result.Iter; |
1458 | ++Result.Index; |
1459 | return *this; |
1460 | } |
1461 | |
1462 | bool operator==(const enumerator_iter<R> &RHS) const { |
1463 | // Don't compare indices here, only iterators. It's possible for an end |
1464 | // iterator to have different indices depending on whether it was created |
1465 | // by calling std::end() versus incrementing a valid iterator. |
1466 | return Result.Iter == RHS.Result.Iter; |
1467 | } |
1468 | |
1469 | enumerator_iter<R> &operator=(const enumerator_iter<R> &Other) { |
1470 | Result = Other.Result; |
1471 | return *this; |
1472 | } |
1473 | |
1474 | private: |
1475 | result_type Result; |
1476 | }; |
1477 | |
1478 | template <typename R> class enumerator { |
1479 | public: |
1480 | explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {} |
1481 | |
1482 | enumerator_iter<R> begin() { |
1483 | return enumerator_iter<R>(0, std::begin(TheRange)); |
1484 | } |
1485 | |
1486 | enumerator_iter<R> end() { |
1487 | return enumerator_iter<R>(std::end(TheRange)); |
1488 | } |
1489 | |
1490 | private: |
1491 | R TheRange; |
1492 | }; |
1493 | |
1494 | } // end namespace detail |
1495 | |
1496 | /// Given an input range, returns a new range whose values are are pair (A,B) |
1497 | /// such that A is the 0-based index of the item in the sequence, and B is |
1498 | /// the value from the original sequence. Example: |
1499 | /// |
1500 | /// std::vector<char> Items = {'A', 'B', 'C', 'D'}; |
1501 | /// for (auto X : enumerate(Items)) { |
1502 | /// printf("Item %d - %c\n", X.index(), X.value()); |
1503 | /// } |
1504 | /// |
1505 | /// Output: |
1506 | /// Item 0 - A |
1507 | /// Item 1 - B |
1508 | /// Item 2 - C |
1509 | /// Item 3 - D |
1510 | /// |
1511 | template <typename R> detail::enumerator<R> enumerate(R &&TheRange) { |
1512 | return detail::enumerator<R>(std::forward<R>(TheRange)); |
1513 | } |
1514 | |
1515 | namespace detail { |
1516 | |
1517 | template <typename F, typename Tuple, std::size_t... I> |
1518 | auto apply_tuple_impl(F &&f, Tuple &&t, index_sequence<I...>) |
1519 | -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...)) { |
1520 | return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...); |
1521 | } |
1522 | |
1523 | } // end namespace detail |
1524 | |
1525 | /// Given an input tuple (a1, a2, ..., an), pass the arguments of the |
1526 | /// tuple variadically to f as if by calling f(a1, a2, ..., an) and |
1527 | /// return the result. |
1528 | template <typename F, typename Tuple> |
1529 | auto apply_tuple(F &&f, Tuple &&t) -> decltype(detail::apply_tuple_impl( |
1530 | std::forward<F>(f), std::forward<Tuple>(t), |
1531 | build_index_impl< |
1532 | std::tuple_size<typename std::decay<Tuple>::type>::value>{})) { |
1533 | using Indices = build_index_impl< |
1534 | std::tuple_size<typename std::decay<Tuple>::type>::value>; |
1535 | |
1536 | return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t), |
1537 | Indices{}); |
1538 | } |
1539 | |
1540 | /// Return true if the sequence [Begin, End) has exactly N items. Runs in O(N) |
1541 | /// time. Not meant for use with random-access iterators. |
1542 | template <typename IterTy> |
1543 | bool hasNItems( |
1544 | IterTy &&Begin, IterTy &&End, unsigned N, |
1545 | typename std::enable_if< |
1546 | !std::is_same< |
1547 | typename std::iterator_traits<typename std::remove_reference< |
1548 | decltype(Begin)>::type>::iterator_category, |
1549 | std::random_access_iterator_tag>::value, |
1550 | void>::type * = nullptr) { |
1551 | for (; N; --N, ++Begin) |
1552 | if (Begin == End) |
1553 | return false; // Too few. |
1554 | return Begin == End; |
1555 | } |
1556 | |
1557 | /// Return true if the sequence [Begin, End) has N or more items. Runs in O(N) |
1558 | /// time. Not meant for use with random-access iterators. |
1559 | template <typename IterTy> |
1560 | bool hasNItemsOrMore( |
1561 | IterTy &&Begin, IterTy &&End, unsigned N, |
1562 | typename std::enable_if< |
1563 | !std::is_same< |
1564 | typename std::iterator_traits<typename std::remove_reference< |
1565 | decltype(Begin)>::type>::iterator_category, |
1566 | std::random_access_iterator_tag>::value, |
1567 | void>::type * = nullptr) { |
1568 | for (; N; --N, ++Begin) |
1569 | if (Begin == End) |
1570 | return false; // Too few. |
1571 | return true; |
1572 | } |
1573 | |
1574 | } // end namespace llvm |
1575 | |
1576 | #endif // LLVM_ADT_STLEXTRAS_H |