1d88c1a5aSDimitry Andric //===- MetadataLoader.cpp - Internal BitcodeReader implementation ---------===//
2d88c1a5aSDimitry Andric //
3d88c1a5aSDimitry Andric //                     The LLVM Compiler Infrastructure
4d88c1a5aSDimitry Andric //
5d88c1a5aSDimitry Andric // This file is distributed under the University of Illinois Open Source
6d88c1a5aSDimitry Andric // License. See LICENSE.TXT for details.
7d88c1a5aSDimitry Andric //
8d88c1a5aSDimitry Andric //===----------------------------------------------------------------------===//
9d88c1a5aSDimitry Andric 
10d88c1a5aSDimitry Andric #include "MetadataLoader.h"
11d88c1a5aSDimitry Andric #include "ValueList.h"
12d88c1a5aSDimitry Andric 
13d88c1a5aSDimitry Andric #include "llvm/ADT/APFloat.h"
14d88c1a5aSDimitry Andric #include "llvm/ADT/APInt.h"
15d88c1a5aSDimitry Andric #include "llvm/ADT/ArrayRef.h"
16d88c1a5aSDimitry Andric #include "llvm/ADT/DenseMap.h"
1795ec533aSDimitry Andric #include "llvm/ADT/DenseSet.h"
18d88c1a5aSDimitry Andric #include "llvm/ADT/None.h"
19d88c1a5aSDimitry Andric #include "llvm/ADT/STLExtras.h"
20d88c1a5aSDimitry Andric #include "llvm/ADT/SmallString.h"
21d88c1a5aSDimitry Andric #include "llvm/ADT/SmallVector.h"
2295ec533aSDimitry Andric #include "llvm/ADT/Statistic.h"
23d88c1a5aSDimitry Andric #include "llvm/ADT/StringRef.h"
24d88c1a5aSDimitry Andric #include "llvm/ADT/Triple.h"
25d88c1a5aSDimitry Andric #include "llvm/ADT/Twine.h"
26d88c1a5aSDimitry Andric #include "llvm/Bitcode/BitcodeReader.h"
27d88c1a5aSDimitry Andric #include "llvm/Bitcode/BitstreamReader.h"
28d88c1a5aSDimitry Andric #include "llvm/Bitcode/LLVMBitCodes.h"
29d88c1a5aSDimitry Andric #include "llvm/IR/Argument.h"
30d88c1a5aSDimitry Andric #include "llvm/IR/Attributes.h"
31d88c1a5aSDimitry Andric #include "llvm/IR/AutoUpgrade.h"
32d88c1a5aSDimitry Andric #include "llvm/IR/BasicBlock.h"
33d88c1a5aSDimitry Andric #include "llvm/IR/CallSite.h"
34d88c1a5aSDimitry Andric #include "llvm/IR/CallingConv.h"
35d88c1a5aSDimitry Andric #include "llvm/IR/Comdat.h"
36d88c1a5aSDimitry Andric #include "llvm/IR/Constant.h"
37d88c1a5aSDimitry Andric #include "llvm/IR/Constants.h"
38d88c1a5aSDimitry Andric #include "llvm/IR/DebugInfo.h"
39d88c1a5aSDimitry Andric #include "llvm/IR/DebugInfoMetadata.h"
40d88c1a5aSDimitry Andric #include "llvm/IR/DebugLoc.h"
41d88c1a5aSDimitry Andric #include "llvm/IR/DerivedTypes.h"
42d88c1a5aSDimitry Andric #include "llvm/IR/DiagnosticInfo.h"
43d88c1a5aSDimitry Andric #include "llvm/IR/DiagnosticPrinter.h"
44d88c1a5aSDimitry Andric #include "llvm/IR/Function.h"
45d88c1a5aSDimitry Andric #include "llvm/IR/GVMaterializer.h"
46d88c1a5aSDimitry Andric #include "llvm/IR/GlobalAlias.h"
47d88c1a5aSDimitry Andric #include "llvm/IR/GlobalIFunc.h"
48d88c1a5aSDimitry Andric #include "llvm/IR/GlobalIndirectSymbol.h"
49d88c1a5aSDimitry Andric #include "llvm/IR/GlobalObject.h"
50d88c1a5aSDimitry Andric #include "llvm/IR/GlobalValue.h"
51d88c1a5aSDimitry Andric #include "llvm/IR/GlobalVariable.h"
52d88c1a5aSDimitry Andric #include "llvm/IR/InlineAsm.h"
53d88c1a5aSDimitry Andric #include "llvm/IR/InstrTypes.h"
54d88c1a5aSDimitry Andric #include "llvm/IR/Instruction.h"
55d88c1a5aSDimitry Andric #include "llvm/IR/Instructions.h"
566bc11b14SDimitry Andric #include "llvm/IR/IntrinsicInst.h"
57db17bf38SDimitry Andric #include "llvm/IR/Intrinsics.h"
58d88c1a5aSDimitry Andric #include "llvm/IR/LLVMContext.h"
59d88c1a5aSDimitry Andric #include "llvm/IR/Module.h"
60d88c1a5aSDimitry Andric #include "llvm/IR/ModuleSummaryIndex.h"
61d88c1a5aSDimitry Andric #include "llvm/IR/OperandTraits.h"
62d88c1a5aSDimitry Andric #include "llvm/IR/Operator.h"
63d88c1a5aSDimitry Andric #include "llvm/IR/TrackingMDRef.h"
64d88c1a5aSDimitry Andric #include "llvm/IR/Type.h"
65d88c1a5aSDimitry Andric #include "llvm/IR/ValueHandle.h"
66d88c1a5aSDimitry Andric #include "llvm/Support/AtomicOrdering.h"
67d88c1a5aSDimitry Andric #include "llvm/Support/Casting.h"
68d88c1a5aSDimitry Andric #include "llvm/Support/CommandLine.h"
69d88c1a5aSDimitry Andric #include "llvm/Support/Compiler.h"
70d88c1a5aSDimitry Andric #include "llvm/Support/Debug.h"
71d88c1a5aSDimitry Andric #include "llvm/Support/Error.h"
72d88c1a5aSDimitry Andric #include "llvm/Support/ErrorHandling.h"
73d88c1a5aSDimitry Andric #include "llvm/Support/ManagedStatic.h"
74d88c1a5aSDimitry Andric #include "llvm/Support/MemoryBuffer.h"
75d88c1a5aSDimitry Andric #include "llvm/Support/raw_ostream.h"
76d88c1a5aSDimitry Andric #include <algorithm>
77d88c1a5aSDimitry Andric #include <cassert>
78d88c1a5aSDimitry Andric #include <cstddef>
79d88c1a5aSDimitry Andric #include <cstdint>
80d88c1a5aSDimitry Andric #include <deque>
81d88c1a5aSDimitry Andric #include <limits>
82d88c1a5aSDimitry Andric #include <map>
83d88c1a5aSDimitry Andric #include <memory>
84d88c1a5aSDimitry Andric #include <string>
85d88c1a5aSDimitry Andric #include <system_error>
86d88c1a5aSDimitry Andric #include <tuple>
87d88c1a5aSDimitry Andric #include <utility>
88d88c1a5aSDimitry Andric #include <vector>
89d88c1a5aSDimitry Andric 
90d88c1a5aSDimitry Andric using namespace llvm;
91d88c1a5aSDimitry Andric 
9295ec533aSDimitry Andric #define DEBUG_TYPE "bitcode-reader"
9395ec533aSDimitry Andric 
9495ec533aSDimitry Andric STATISTIC(NumMDStringLoaded, "Number of MDStrings loaded");
9595ec533aSDimitry Andric STATISTIC(NumMDNodeTemporary, "Number of MDNode::Temporary created");
9695ec533aSDimitry Andric STATISTIC(NumMDRecordLoaded, "Number of Metadata records loaded");
9795ec533aSDimitry Andric 
98d88c1a5aSDimitry Andric /// Flag whether we need to import full type definitions for ThinLTO.
99d88c1a5aSDimitry Andric /// Currently needed for Darwin and LLDB.
100d88c1a5aSDimitry Andric static cl::opt<bool> ImportFullTypeDefinitions(
101d88c1a5aSDimitry Andric     "import-full-type-definitions", cl::init(false), cl::Hidden,
102d88c1a5aSDimitry Andric     cl::desc("Import full type definitions for ThinLTO."));
103d88c1a5aSDimitry Andric 
10495ec533aSDimitry Andric static cl::opt<bool> DisableLazyLoading(
10595ec533aSDimitry Andric     "disable-ondemand-mds-loading", cl::init(false), cl::Hidden,
10695ec533aSDimitry Andric     cl::desc("Force disable the lazy-loading on-demand of metadata when "
10795ec533aSDimitry Andric              "loading bitcode for importing."));
10895ec533aSDimitry Andric 
109d88c1a5aSDimitry Andric namespace {
110d88c1a5aSDimitry Andric 
111d88c1a5aSDimitry Andric static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
112d88c1a5aSDimitry Andric 
113d88c1a5aSDimitry Andric class BitcodeReaderMetadataList {
114d88c1a5aSDimitry Andric   /// Array of metadata references.
115d88c1a5aSDimitry Andric   ///
116d88c1a5aSDimitry Andric   /// Don't use std::vector here.  Some versions of libc++ copy (instead of
117d88c1a5aSDimitry Andric   /// move) on resize, and TrackingMDRef is very expensive to copy.
118d88c1a5aSDimitry Andric   SmallVector<TrackingMDRef, 1> MetadataPtrs;
119d88c1a5aSDimitry Andric 
120d88c1a5aSDimitry Andric   /// The set of indices in MetadataPtrs above of forward references that were
121d88c1a5aSDimitry Andric   /// generated.
122d88c1a5aSDimitry Andric   SmallDenseSet<unsigned, 1> ForwardReference;
123d88c1a5aSDimitry Andric 
124d88c1a5aSDimitry Andric   /// The set of indices in MetadataPtrs above of Metadata that need to be
125d88c1a5aSDimitry Andric   /// resolved.
126d88c1a5aSDimitry Andric   SmallDenseSet<unsigned, 1> UnresolvedNodes;
127d88c1a5aSDimitry Andric 
128d88c1a5aSDimitry Andric   /// Structures for resolving old type refs.
129d88c1a5aSDimitry Andric   struct {
130d88c1a5aSDimitry Andric     SmallDenseMap<MDString *, TempMDTuple, 1> Unknown;
131d88c1a5aSDimitry Andric     SmallDenseMap<MDString *, DICompositeType *, 1> Final;
132d88c1a5aSDimitry Andric     SmallDenseMap<MDString *, DICompositeType *, 1> FwdDecls;
133d88c1a5aSDimitry Andric     SmallVector<std::pair<TrackingMDRef, TempMDTuple>, 1> Arrays;
134d88c1a5aSDimitry Andric   } OldTypeRefs;
135d88c1a5aSDimitry Andric 
136d88c1a5aSDimitry Andric   LLVMContext &Context;
137d88c1a5aSDimitry Andric 
138d88c1a5aSDimitry Andric public:
139d88c1a5aSDimitry Andric   BitcodeReaderMetadataList(LLVMContext &C) : Context(C) {}
140d88c1a5aSDimitry Andric 
141d88c1a5aSDimitry Andric   // vector compatibility methods
142d88c1a5aSDimitry Andric   unsigned size() const { return MetadataPtrs.size(); }
143d88c1a5aSDimitry Andric   void resize(unsigned N) { MetadataPtrs.resize(N); }
144d88c1a5aSDimitry Andric   void push_back(Metadata *MD) { MetadataPtrs.emplace_back(MD); }
145d88c1a5aSDimitry Andric   void clear() { MetadataPtrs.clear(); }
146d88c1a5aSDimitry Andric   Metadata *back() const { return MetadataPtrs.back(); }
147d88c1a5aSDimitry Andric   void pop_back() { MetadataPtrs.pop_back(); }
148d88c1a5aSDimitry Andric   bool empty() const { return MetadataPtrs.empty(); }
149d88c1a5aSDimitry Andric 
150d88c1a5aSDimitry Andric   Metadata *operator[](unsigned i) const {
151d88c1a5aSDimitry Andric     assert(i < MetadataPtrs.size());
152d88c1a5aSDimitry Andric     return MetadataPtrs[i];
153d88c1a5aSDimitry Andric   }
154d88c1a5aSDimitry Andric 
155d88c1a5aSDimitry Andric   Metadata *lookup(unsigned I) const {
156d88c1a5aSDimitry Andric     if (I < MetadataPtrs.size())
157d88c1a5aSDimitry Andric       return MetadataPtrs[I];
158d88c1a5aSDimitry Andric     return nullptr;
159d88c1a5aSDimitry Andric   }
160d88c1a5aSDimitry Andric 
161d88c1a5aSDimitry Andric   void shrinkTo(unsigned N) {
162d88c1a5aSDimitry Andric     assert(N <= size() && "Invalid shrinkTo request!");
163d88c1a5aSDimitry Andric     assert(ForwardReference.empty() && "Unexpected forward refs");
164d88c1a5aSDimitry Andric     assert(UnresolvedNodes.empty() && "Unexpected unresolved node");
165d88c1a5aSDimitry Andric     MetadataPtrs.resize(N);
166d88c1a5aSDimitry Andric   }
167d88c1a5aSDimitry Andric 
168d88c1a5aSDimitry Andric   /// Return the given metadata, creating a replaceable forward reference if
169d88c1a5aSDimitry Andric   /// necessary.
170d88c1a5aSDimitry Andric   Metadata *getMetadataFwdRef(unsigned Idx);
171d88c1a5aSDimitry Andric 
172d88c1a5aSDimitry Andric   /// Return the the given metadata only if it is fully resolved.
173d88c1a5aSDimitry Andric   ///
174d88c1a5aSDimitry Andric   /// Gives the same result as \a lookup(), unless \a MDNode::isResolved()
175d88c1a5aSDimitry Andric   /// would give \c false.
176d88c1a5aSDimitry Andric   Metadata *getMetadataIfResolved(unsigned Idx);
177d88c1a5aSDimitry Andric 
178d88c1a5aSDimitry Andric   MDNode *getMDNodeFwdRefOrNull(unsigned Idx);
179d88c1a5aSDimitry Andric   void assignValue(Metadata *MD, unsigned Idx);
180d88c1a5aSDimitry Andric   void tryToResolveCycles();
181d88c1a5aSDimitry Andric   bool hasFwdRefs() const { return !ForwardReference.empty(); }
18295ec533aSDimitry Andric   int getNextFwdRef() {
18395ec533aSDimitry Andric     assert(hasFwdRefs());
18495ec533aSDimitry Andric     return *ForwardReference.begin();
18595ec533aSDimitry Andric   }
186d88c1a5aSDimitry Andric 
187d88c1a5aSDimitry Andric   /// Upgrade a type that had an MDString reference.
188d88c1a5aSDimitry Andric   void addTypeRef(MDString &UUID, DICompositeType &CT);
189d88c1a5aSDimitry Andric 
190d88c1a5aSDimitry Andric   /// Upgrade a type that had an MDString reference.
191d88c1a5aSDimitry Andric   Metadata *upgradeTypeRef(Metadata *MaybeUUID);
192d88c1a5aSDimitry Andric 
193d88c1a5aSDimitry Andric   /// Upgrade a type ref array that may have MDString references.
194d88c1a5aSDimitry Andric   Metadata *upgradeTypeRefArray(Metadata *MaybeTuple);
195d88c1a5aSDimitry Andric 
196d88c1a5aSDimitry Andric private:
197d88c1a5aSDimitry Andric   Metadata *resolveTypeRefArray(Metadata *MaybeTuple);
198d88c1a5aSDimitry Andric };
199d88c1a5aSDimitry Andric 
200d88c1a5aSDimitry Andric void BitcodeReaderMetadataList::assignValue(Metadata *MD, unsigned Idx) {
201d88c1a5aSDimitry Andric   if (auto *MDN = dyn_cast<MDNode>(MD))
202d88c1a5aSDimitry Andric     if (!MDN->isResolved())
203d88c1a5aSDimitry Andric       UnresolvedNodes.insert(Idx);
204d88c1a5aSDimitry Andric 
205d88c1a5aSDimitry Andric   if (Idx == size()) {
206d88c1a5aSDimitry Andric     push_back(MD);
207d88c1a5aSDimitry Andric     return;
208d88c1a5aSDimitry Andric   }
209d88c1a5aSDimitry Andric 
210d88c1a5aSDimitry Andric   if (Idx >= size())
211d88c1a5aSDimitry Andric     resize(Idx + 1);
212d88c1a5aSDimitry Andric 
213d88c1a5aSDimitry Andric   TrackingMDRef &OldMD = MetadataPtrs[Idx];
214d88c1a5aSDimitry Andric   if (!OldMD) {
215d88c1a5aSDimitry Andric     OldMD.reset(MD);
216d88c1a5aSDimitry Andric     return;
217d88c1a5aSDimitry Andric   }
218d88c1a5aSDimitry Andric 
219d88c1a5aSDimitry Andric   // If there was a forward reference to this value, replace it.
220d88c1a5aSDimitry Andric   TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
221d88c1a5aSDimitry Andric   PrevMD->replaceAllUsesWith(MD);
222d88c1a5aSDimitry Andric   ForwardReference.erase(Idx);
223d88c1a5aSDimitry Andric }
224d88c1a5aSDimitry Andric 
225d88c1a5aSDimitry Andric Metadata *BitcodeReaderMetadataList::getMetadataFwdRef(unsigned Idx) {
226d88c1a5aSDimitry Andric   if (Idx >= size())
227d88c1a5aSDimitry Andric     resize(Idx + 1);
228d88c1a5aSDimitry Andric 
229d88c1a5aSDimitry Andric   if (Metadata *MD = MetadataPtrs[Idx])
230d88c1a5aSDimitry Andric     return MD;
231d88c1a5aSDimitry Andric 
232d88c1a5aSDimitry Andric   // Track forward refs to be resolved later.
233d88c1a5aSDimitry Andric   ForwardReference.insert(Idx);
234d88c1a5aSDimitry Andric 
235d88c1a5aSDimitry Andric   // Create and return a placeholder, which will later be RAUW'd.
23695ec533aSDimitry Andric   ++NumMDNodeTemporary;
237d88c1a5aSDimitry Andric   Metadata *MD = MDNode::getTemporary(Context, None).release();
238d88c1a5aSDimitry Andric   MetadataPtrs[Idx].reset(MD);
239d88c1a5aSDimitry Andric   return MD;
240d88c1a5aSDimitry Andric }
241d88c1a5aSDimitry Andric 
242d88c1a5aSDimitry Andric Metadata *BitcodeReaderMetadataList::getMetadataIfResolved(unsigned Idx) {
243d88c1a5aSDimitry Andric   Metadata *MD = lookup(Idx);
244d88c1a5aSDimitry Andric   if (auto *N = dyn_cast_or_null<MDNode>(MD))
245d88c1a5aSDimitry Andric     if (!N->isResolved())
246d88c1a5aSDimitry Andric       return nullptr;
247d88c1a5aSDimitry Andric   return MD;
248d88c1a5aSDimitry Andric }
249d88c1a5aSDimitry Andric 
250d88c1a5aSDimitry Andric MDNode *BitcodeReaderMetadataList::getMDNodeFwdRefOrNull(unsigned Idx) {
251d88c1a5aSDimitry Andric   return dyn_cast_or_null<MDNode>(getMetadataFwdRef(Idx));
252d88c1a5aSDimitry Andric }
253d88c1a5aSDimitry Andric 
254d88c1a5aSDimitry Andric void BitcodeReaderMetadataList::tryToResolveCycles() {
255d88c1a5aSDimitry Andric   if (!ForwardReference.empty())
256d88c1a5aSDimitry Andric     // Still forward references... can't resolve cycles.
257d88c1a5aSDimitry Andric     return;
258d88c1a5aSDimitry Andric 
259d88c1a5aSDimitry Andric   // Give up on finding a full definition for any forward decls that remain.
260d88c1a5aSDimitry Andric   for (const auto &Ref : OldTypeRefs.FwdDecls)
261d88c1a5aSDimitry Andric     OldTypeRefs.Final.insert(Ref);
262d88c1a5aSDimitry Andric   OldTypeRefs.FwdDecls.clear();
263d88c1a5aSDimitry Andric 
264d88c1a5aSDimitry Andric   // Upgrade from old type ref arrays.  In strange cases, this could add to
265d88c1a5aSDimitry Andric   // OldTypeRefs.Unknown.
266d88c1a5aSDimitry Andric   for (const auto &Array : OldTypeRefs.Arrays)
267d88c1a5aSDimitry Andric     Array.second->replaceAllUsesWith(resolveTypeRefArray(Array.first.get()));
268d88c1a5aSDimitry Andric   OldTypeRefs.Arrays.clear();
269d88c1a5aSDimitry Andric 
270d88c1a5aSDimitry Andric   // Replace old string-based type refs with the resolved node, if possible.
271d88c1a5aSDimitry Andric   // If we haven't seen the node, leave it to the verifier to complain about
272d88c1a5aSDimitry Andric   // the invalid string reference.
273d88c1a5aSDimitry Andric   for (const auto &Ref : OldTypeRefs.Unknown) {
274d88c1a5aSDimitry Andric     if (DICompositeType *CT = OldTypeRefs.Final.lookup(Ref.first))
275d88c1a5aSDimitry Andric       Ref.second->replaceAllUsesWith(CT);
276d88c1a5aSDimitry Andric     else
277d88c1a5aSDimitry Andric       Ref.second->replaceAllUsesWith(Ref.first);
278d88c1a5aSDimitry Andric   }
279d88c1a5aSDimitry Andric   OldTypeRefs.Unknown.clear();
280d88c1a5aSDimitry Andric 
281d88c1a5aSDimitry Andric   if (UnresolvedNodes.empty())
282d88c1a5aSDimitry Andric     // Nothing to do.
283d88c1a5aSDimitry Andric     return;
284d88c1a5aSDimitry Andric 
285d88c1a5aSDimitry Andric   // Resolve any cycles.
286d88c1a5aSDimitry Andric   for (unsigned I : UnresolvedNodes) {
287d88c1a5aSDimitry Andric     auto &MD = MetadataPtrs[I];
288d88c1a5aSDimitry Andric     auto *N = dyn_cast_or_null<MDNode>(MD);
289d88c1a5aSDimitry Andric     if (!N)
290d88c1a5aSDimitry Andric       continue;
291d88c1a5aSDimitry Andric 
292d88c1a5aSDimitry Andric     assert(!N->isTemporary() && "Unexpected forward reference");
293d88c1a5aSDimitry Andric     N->resolveCycles();
294d88c1a5aSDimitry Andric   }
295d88c1a5aSDimitry Andric 
296d88c1a5aSDimitry Andric   // Make sure we return early again until there's another unresolved ref.
297d88c1a5aSDimitry Andric   UnresolvedNodes.clear();
298d88c1a5aSDimitry Andric }
299d88c1a5aSDimitry Andric 
300d88c1a5aSDimitry Andric void BitcodeReaderMetadataList::addTypeRef(MDString &UUID,
301d88c1a5aSDimitry Andric                                            DICompositeType &CT) {
302d88c1a5aSDimitry Andric   assert(CT.getRawIdentifier() == &UUID && "Mismatched UUID");
303d88c1a5aSDimitry Andric   if (CT.isForwardDecl())
304d88c1a5aSDimitry Andric     OldTypeRefs.FwdDecls.insert(std::make_pair(&UUID, &CT));
305d88c1a5aSDimitry Andric   else
306d88c1a5aSDimitry Andric     OldTypeRefs.Final.insert(std::make_pair(&UUID, &CT));
307d88c1a5aSDimitry Andric }
308d88c1a5aSDimitry Andric 
309d88c1a5aSDimitry Andric Metadata *BitcodeReaderMetadataList::upgradeTypeRef(Metadata *MaybeUUID) {
310d88c1a5aSDimitry Andric   auto *UUID = dyn_cast_or_null<MDString>(MaybeUUID);
311d88c1a5aSDimitry Andric   if (LLVM_LIKELY(!UUID))
312d88c1a5aSDimitry Andric     return MaybeUUID;
313d88c1a5aSDimitry Andric 
314d88c1a5aSDimitry Andric   if (auto *CT = OldTypeRefs.Final.lookup(UUID))
315d88c1a5aSDimitry Andric     return CT;
316d88c1a5aSDimitry Andric 
317d88c1a5aSDimitry Andric   auto &Ref = OldTypeRefs.Unknown[UUID];
318d88c1a5aSDimitry Andric   if (!Ref)
319d88c1a5aSDimitry Andric     Ref = MDNode::getTemporary(Context, None);
320d88c1a5aSDimitry Andric   return Ref.get();
321d88c1a5aSDimitry Andric }
322d88c1a5aSDimitry Andric 
323d88c1a5aSDimitry Andric Metadata *BitcodeReaderMetadataList::upgradeTypeRefArray(Metadata *MaybeTuple) {
324d88c1a5aSDimitry Andric   auto *Tuple = dyn_cast_or_null<MDTuple>(MaybeTuple);
325d88c1a5aSDimitry Andric   if (!Tuple || Tuple->isDistinct())
326d88c1a5aSDimitry Andric     return MaybeTuple;
327d88c1a5aSDimitry Andric 
328d88c1a5aSDimitry Andric   // Look through the array immediately if possible.
329d88c1a5aSDimitry Andric   if (!Tuple->isTemporary())
330d88c1a5aSDimitry Andric     return resolveTypeRefArray(Tuple);
331d88c1a5aSDimitry Andric 
332d88c1a5aSDimitry Andric   // Create and return a placeholder to use for now.  Eventually
333d88c1a5aSDimitry Andric   // resolveTypeRefArrays() will be resolve this forward reference.
334d88c1a5aSDimitry Andric   OldTypeRefs.Arrays.emplace_back(
335d88c1a5aSDimitry Andric       std::piecewise_construct, std::forward_as_tuple(Tuple),
336d88c1a5aSDimitry Andric       std::forward_as_tuple(MDTuple::getTemporary(Context, None)));
337d88c1a5aSDimitry Andric   return OldTypeRefs.Arrays.back().second.get();
338d88c1a5aSDimitry Andric }
339d88c1a5aSDimitry Andric 
340d88c1a5aSDimitry Andric Metadata *BitcodeReaderMetadataList::resolveTypeRefArray(Metadata *MaybeTuple) {
341d88c1a5aSDimitry Andric   auto *Tuple = dyn_cast_or_null<MDTuple>(MaybeTuple);
342d88c1a5aSDimitry Andric   if (!Tuple || Tuple->isDistinct())
343d88c1a5aSDimitry Andric     return MaybeTuple;
344d88c1a5aSDimitry Andric 
345d88c1a5aSDimitry Andric   // Look through the DITypeRefArray, upgrading each DITypeRef.
346d88c1a5aSDimitry Andric   SmallVector<Metadata *, 32> Ops;
347d88c1a5aSDimitry Andric   Ops.reserve(Tuple->getNumOperands());
348d88c1a5aSDimitry Andric   for (Metadata *MD : Tuple->operands())
349d88c1a5aSDimitry Andric     Ops.push_back(upgradeTypeRef(MD));
350d88c1a5aSDimitry Andric 
351d88c1a5aSDimitry Andric   return MDTuple::get(Context, Ops);
352d88c1a5aSDimitry Andric }
353d88c1a5aSDimitry Andric 
354d88c1a5aSDimitry Andric namespace {
355d88c1a5aSDimitry Andric 
356d88c1a5aSDimitry Andric class PlaceholderQueue {
357d88c1a5aSDimitry Andric   // Placeholders would thrash around when moved, so store in a std::deque
358d88c1a5aSDimitry Andric   // instead of some sort of vector.
359d88c1a5aSDimitry Andric   std::deque<DistinctMDOperandPlaceholder> PHs;
360d88c1a5aSDimitry Andric 
361d88c1a5aSDimitry Andric public:
3627a7e6055SDimitry Andric   ~PlaceholderQueue() {
3637a7e6055SDimitry Andric     assert(empty() && "PlaceholderQueue hasn't been flushed before being destroyed");
3647a7e6055SDimitry Andric   }
36595ec533aSDimitry Andric   bool empty() { return PHs.empty(); }
366d88c1a5aSDimitry Andric   DistinctMDOperandPlaceholder &getPlaceholderOp(unsigned ID);
367d88c1a5aSDimitry Andric   void flush(BitcodeReaderMetadataList &MetadataList);
36895ec533aSDimitry Andric 
36995ec533aSDimitry Andric   /// Return the list of temporaries nodes in the queue, these need to be
37095ec533aSDimitry Andric   /// loaded before we can flush the queue.
37195ec533aSDimitry Andric   void getTemporaries(BitcodeReaderMetadataList &MetadataList,
37295ec533aSDimitry Andric                       DenseSet<unsigned> &Temporaries) {
37395ec533aSDimitry Andric     for (auto &PH : PHs) {
37495ec533aSDimitry Andric       auto ID = PH.getID();
37595ec533aSDimitry Andric       auto *MD = MetadataList.lookup(ID);
37695ec533aSDimitry Andric       if (!MD) {
37795ec533aSDimitry Andric         Temporaries.insert(ID);
37895ec533aSDimitry Andric         continue;
37995ec533aSDimitry Andric       }
38095ec533aSDimitry Andric       auto *N = dyn_cast_or_null<MDNode>(MD);
38195ec533aSDimitry Andric       if (N && N->isTemporary())
38295ec533aSDimitry Andric         Temporaries.insert(ID);
38395ec533aSDimitry Andric     }
38495ec533aSDimitry Andric   }
385d88c1a5aSDimitry Andric };
386d88c1a5aSDimitry Andric 
387d88c1a5aSDimitry Andric } // end anonymous namespace
388d88c1a5aSDimitry Andric 
389d88c1a5aSDimitry Andric DistinctMDOperandPlaceholder &PlaceholderQueue::getPlaceholderOp(unsigned ID) {
390d88c1a5aSDimitry Andric   PHs.emplace_back(ID);
391d88c1a5aSDimitry Andric   return PHs.back();
392d88c1a5aSDimitry Andric }
393d88c1a5aSDimitry Andric 
394d88c1a5aSDimitry Andric void PlaceholderQueue::flush(BitcodeReaderMetadataList &MetadataList) {
395d88c1a5aSDimitry Andric   while (!PHs.empty()) {
396d88c1a5aSDimitry Andric     auto *MD = MetadataList.lookup(PHs.front().getID());
397d88c1a5aSDimitry Andric     assert(MD && "Flushing placeholder on unassigned MD");
398d88c1a5aSDimitry Andric #ifndef NDEBUG
399d88c1a5aSDimitry Andric     if (auto *MDN = dyn_cast<MDNode>(MD))
400d88c1a5aSDimitry Andric       assert(MDN->isResolved() &&
401d88c1a5aSDimitry Andric              "Flushing Placeholder while cycles aren't resolved");
402d88c1a5aSDimitry Andric #endif
403d88c1a5aSDimitry Andric     PHs.front().replaceUseWith(MD);
404d88c1a5aSDimitry Andric     PHs.pop_front();
405d88c1a5aSDimitry Andric   }
406d88c1a5aSDimitry Andric }
407d88c1a5aSDimitry Andric 
408d88c1a5aSDimitry Andric } // anonynous namespace
409d88c1a5aSDimitry Andric 
410d88c1a5aSDimitry Andric class MetadataLoader::MetadataLoaderImpl {
411d88c1a5aSDimitry Andric   BitcodeReaderMetadataList MetadataList;
412d88c1a5aSDimitry Andric   BitcodeReaderValueList &ValueList;
413d88c1a5aSDimitry Andric   BitstreamCursor &Stream;
414d88c1a5aSDimitry Andric   LLVMContext &Context;
415d88c1a5aSDimitry Andric   Module &TheModule;
416d88c1a5aSDimitry Andric   std::function<Type *(unsigned)> getTypeByID;
417d88c1a5aSDimitry Andric 
41895ec533aSDimitry Andric   /// Cursor associated with the lazy-loading of Metadata. This is the easy way
41995ec533aSDimitry Andric   /// to keep around the right "context" (Abbrev list) to be able to jump in
42095ec533aSDimitry Andric   /// the middle of the metadata block and load any record.
42195ec533aSDimitry Andric   BitstreamCursor IndexCursor;
42295ec533aSDimitry Andric 
42395ec533aSDimitry Andric   /// Index that keeps track of MDString values.
42495ec533aSDimitry Andric   std::vector<StringRef> MDStringRef;
42595ec533aSDimitry Andric 
42695ec533aSDimitry Andric   /// On-demand loading of a single MDString. Requires the index above to be
42795ec533aSDimitry Andric   /// populated.
42895ec533aSDimitry Andric   MDString *lazyLoadOneMDString(unsigned Idx);
42995ec533aSDimitry Andric 
43095ec533aSDimitry Andric   /// Index that keeps track of where to find a metadata record in the stream.
43195ec533aSDimitry Andric   std::vector<uint64_t> GlobalMetadataBitPosIndex;
43295ec533aSDimitry Andric 
43395ec533aSDimitry Andric   /// Populate the index above to enable lazily loading of metadata, and load
43495ec533aSDimitry Andric   /// the named metadata as well as the transitively referenced global
43595ec533aSDimitry Andric   /// Metadata.
43624e2fe98SDimitry Andric   Expected<bool> lazyLoadModuleMetadataBlock();
43795ec533aSDimitry Andric 
43895ec533aSDimitry Andric   /// On-demand loading of a single metadata. Requires the index above to be
43995ec533aSDimitry Andric   /// populated.
44095ec533aSDimitry Andric   void lazyLoadOneMetadata(unsigned Idx, PlaceholderQueue &Placeholders);
44195ec533aSDimitry Andric 
442d88c1a5aSDimitry Andric   // Keep mapping of seens pair of old-style CU <-> SP, and update pointers to
443d88c1a5aSDimitry Andric   // point from SP to CU after a block is completly parsed.
444d88c1a5aSDimitry Andric   std::vector<std::pair<DICompileUnit *, Metadata *>> CUSubprograms;
445d88c1a5aSDimitry Andric 
446d88c1a5aSDimitry Andric   /// Functions that need to be matched with subprograms when upgrading old
447d88c1a5aSDimitry Andric   /// metadata.
448d88c1a5aSDimitry Andric   SmallDenseMap<Function *, DISubprogram *, 16> FunctionsWithSPs;
449d88c1a5aSDimitry Andric 
450d88c1a5aSDimitry Andric   // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
451d88c1a5aSDimitry Andric   DenseMap<unsigned, unsigned> MDKindMap;
452d88c1a5aSDimitry Andric 
453d88c1a5aSDimitry Andric   bool StripTBAA = false;
454d88c1a5aSDimitry Andric   bool HasSeenOldLoopTags = false;
4555ca5951eSDimitry Andric   bool NeedUpgradeToDIGlobalVariableExpression = false;
4566bc11b14SDimitry Andric   bool NeedDeclareExpressionUpgrade = false;
457d88c1a5aSDimitry Andric 
458d88c1a5aSDimitry Andric   /// True if metadata is being parsed for a module being ThinLTO imported.
459d88c1a5aSDimitry Andric   bool IsImporting = false;
460d88c1a5aSDimitry Andric 
461d88c1a5aSDimitry Andric   Error parseOneMetadata(SmallVectorImpl<uint64_t> &Record, unsigned Code,
462d88c1a5aSDimitry Andric                          PlaceholderQueue &Placeholders, StringRef Blob,
463d88c1a5aSDimitry Andric                          unsigned &NextMetadataNo);
46495ec533aSDimitry Andric   Error parseMetadataStrings(ArrayRef<uint64_t> Record, StringRef Blob,
4657a7e6055SDimitry Andric                              function_ref<void(StringRef)> CallBack);
466d88c1a5aSDimitry Andric   Error parseGlobalObjectAttachment(GlobalObject &GO,
467d88c1a5aSDimitry Andric                                     ArrayRef<uint64_t> Record);
468d88c1a5aSDimitry Andric   Error parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record);
469d88c1a5aSDimitry Andric 
47095ec533aSDimitry Andric   void resolveForwardRefsAndPlaceholders(PlaceholderQueue &Placeholders);
47195ec533aSDimitry Andric 
47295ec533aSDimitry Andric   /// Upgrade old-style CU <-> SP pointers to point from SP to CU.
47395ec533aSDimitry Andric   void upgradeCUSubprograms() {
47495ec533aSDimitry Andric     for (auto CU_SP : CUSubprograms)
47595ec533aSDimitry Andric       if (auto *SPs = dyn_cast_or_null<MDTuple>(CU_SP.second))
47695ec533aSDimitry Andric         for (auto &Op : SPs->operands())
477f37b6182SDimitry Andric           if (auto *SP = dyn_cast_or_null<DISubprogram>(Op))
478f37b6182SDimitry Andric             SP->replaceUnit(CU_SP.first);
47995ec533aSDimitry Andric     CUSubprograms.clear();
48095ec533aSDimitry Andric   }
48195ec533aSDimitry Andric 
4825ca5951eSDimitry Andric   /// Upgrade old-style bare DIGlobalVariables to DIGlobalVariableExpressions.
4835ca5951eSDimitry Andric   void upgradeCUVariables() {
4845ca5951eSDimitry Andric     if (!NeedUpgradeToDIGlobalVariableExpression)
4855ca5951eSDimitry Andric       return;
4865ca5951eSDimitry Andric 
4875ca5951eSDimitry Andric     // Upgrade list of variables attached to the CUs.
4885ca5951eSDimitry Andric     if (NamedMDNode *CUNodes = TheModule.getNamedMetadata("llvm.dbg.cu"))
4895ca5951eSDimitry Andric       for (unsigned I = 0, E = CUNodes->getNumOperands(); I != E; ++I) {
4905ca5951eSDimitry Andric         auto *CU = cast<DICompileUnit>(CUNodes->getOperand(I));
4915ca5951eSDimitry Andric         if (auto *GVs = dyn_cast_or_null<MDTuple>(CU->getRawGlobalVariables()))
4925ca5951eSDimitry Andric           for (unsigned I = 0; I < GVs->getNumOperands(); I++)
4935ca5951eSDimitry Andric             if (auto *GV =
4945ca5951eSDimitry Andric                     dyn_cast_or_null<DIGlobalVariable>(GVs->getOperand(I))) {
4955ca5951eSDimitry Andric               auto *DGVE =
4965ca5951eSDimitry Andric                   DIGlobalVariableExpression::getDistinct(Context, GV, nullptr);
4975ca5951eSDimitry Andric               GVs->replaceOperandWith(I, DGVE);
4985ca5951eSDimitry Andric             }
4995ca5951eSDimitry Andric       }
5005ca5951eSDimitry Andric 
5015ca5951eSDimitry Andric     // Upgrade variables attached to globals.
5025ca5951eSDimitry Andric     for (auto &GV : TheModule.globals()) {
5035517e702SDimitry Andric       SmallVector<MDNode *, 1> MDs;
5045ca5951eSDimitry Andric       GV.getMetadata(LLVMContext::MD_dbg, MDs);
5055ca5951eSDimitry Andric       GV.eraseMetadata(LLVMContext::MD_dbg);
5065ca5951eSDimitry Andric       for (auto *MD : MDs)
5075ca5951eSDimitry Andric         if (auto *DGV = dyn_cast_or_null<DIGlobalVariable>(MD)) {
5085ca5951eSDimitry Andric           auto *DGVE =
5095ca5951eSDimitry Andric               DIGlobalVariableExpression::getDistinct(Context, DGV, nullptr);
5105ca5951eSDimitry Andric           GV.addMetadata(LLVMContext::MD_dbg, *DGVE);
5115ca5951eSDimitry Andric         } else
5125ca5951eSDimitry Andric           GV.addMetadata(LLVMContext::MD_dbg, *MD);
5135ca5951eSDimitry Andric     }
5145ca5951eSDimitry Andric   }
5155ca5951eSDimitry Andric 
5166bc11b14SDimitry Andric   /// Remove a leading DW_OP_deref from DIExpressions in a dbg.declare that
5176bc11b14SDimitry Andric   /// describes a function argument.
5186bc11b14SDimitry Andric   void upgradeDeclareExpressions(Function &F) {
5196bc11b14SDimitry Andric     if (!NeedDeclareExpressionUpgrade)
5206bc11b14SDimitry Andric       return;
5216bc11b14SDimitry Andric 
5226bc11b14SDimitry Andric     for (auto &BB : F)
5236bc11b14SDimitry Andric       for (auto &I : BB)
5246bc11b14SDimitry Andric         if (auto *DDI = dyn_cast<DbgDeclareInst>(&I))
5256bc11b14SDimitry Andric           if (auto *DIExpr = DDI->getExpression())
5266bc11b14SDimitry Andric             if (DIExpr->startsWithDeref() &&
5276bc11b14SDimitry Andric                 dyn_cast_or_null<Argument>(DDI->getAddress())) {
5286bc11b14SDimitry Andric               SmallVector<uint64_t, 8> Ops;
5296bc11b14SDimitry Andric               Ops.append(std::next(DIExpr->elements_begin()),
5306bc11b14SDimitry Andric                          DIExpr->elements_end());
5316bc11b14SDimitry Andric               auto *E = DIExpression::get(Context, Ops);
5326bc11b14SDimitry Andric               DDI->setOperand(2, MetadataAsValue::get(Context, E));
5336bc11b14SDimitry Andric             }
5346bc11b14SDimitry Andric   }
5356bc11b14SDimitry Andric 
5365ca5951eSDimitry Andric   void upgradeDebugInfo() {
5375ca5951eSDimitry Andric     upgradeCUSubprograms();
5385ca5951eSDimitry Andric     upgradeCUVariables();
5395ca5951eSDimitry Andric   }
5405ca5951eSDimitry Andric 
541d88c1a5aSDimitry Andric public:
542d88c1a5aSDimitry Andric   MetadataLoaderImpl(BitstreamCursor &Stream, Module &TheModule,
543d88c1a5aSDimitry Andric                      BitcodeReaderValueList &ValueList,
544d88c1a5aSDimitry Andric                      std::function<Type *(unsigned)> getTypeByID,
545d88c1a5aSDimitry Andric                      bool IsImporting)
546d88c1a5aSDimitry Andric       : MetadataList(TheModule.getContext()), ValueList(ValueList),
547d88c1a5aSDimitry Andric         Stream(Stream), Context(TheModule.getContext()), TheModule(TheModule),
5487a7e6055SDimitry Andric         getTypeByID(std::move(getTypeByID)), IsImporting(IsImporting) {}
549d88c1a5aSDimitry Andric 
550d88c1a5aSDimitry Andric   Error parseMetadata(bool ModuleLevel);
551d88c1a5aSDimitry Andric 
552d88c1a5aSDimitry Andric   bool hasFwdRefs() const { return MetadataList.hasFwdRefs(); }
553f8496407SDimitry Andric 
554f8496407SDimitry Andric   Metadata *getMetadataFwdRefOrLoad(unsigned ID) {
555f8496407SDimitry Andric     if (ID < MDStringRef.size())
556f8496407SDimitry Andric       return lazyLoadOneMDString(ID);
557f8496407SDimitry Andric     if (auto *MD = MetadataList.lookup(ID))
558f8496407SDimitry Andric       return MD;
559f8496407SDimitry Andric     // If lazy-loading is enabled, we try recursively to load the operand
560f8496407SDimitry Andric     // instead of creating a temporary.
561f8496407SDimitry Andric     if (ID < (MDStringRef.size() + GlobalMetadataBitPosIndex.size())) {
562f8496407SDimitry Andric       PlaceholderQueue Placeholders;
563f8496407SDimitry Andric       lazyLoadOneMetadata(ID, Placeholders);
564f8496407SDimitry Andric       resolveForwardRefsAndPlaceholders(Placeholders);
565f8496407SDimitry Andric       return MetadataList.lookup(ID);
566f8496407SDimitry Andric     }
567f8496407SDimitry Andric     return MetadataList.getMetadataFwdRef(ID);
568d88c1a5aSDimitry Andric   }
569d88c1a5aSDimitry Andric 
570d88c1a5aSDimitry Andric   MDNode *getMDNodeFwdRefOrNull(unsigned Idx) {
571d88c1a5aSDimitry Andric     return MetadataList.getMDNodeFwdRefOrNull(Idx);
572d88c1a5aSDimitry Andric   }
573d88c1a5aSDimitry Andric 
574d88c1a5aSDimitry Andric   DISubprogram *lookupSubprogramForFunction(Function *F) {
575d88c1a5aSDimitry Andric     return FunctionsWithSPs.lookup(F);
576d88c1a5aSDimitry Andric   }
577d88c1a5aSDimitry Andric 
578d88c1a5aSDimitry Andric   bool hasSeenOldLoopTags() { return HasSeenOldLoopTags; }
579d88c1a5aSDimitry Andric 
580d88c1a5aSDimitry Andric   Error parseMetadataAttachment(
581d88c1a5aSDimitry Andric       Function &F, const SmallVectorImpl<Instruction *> &InstructionList);
582d88c1a5aSDimitry Andric 
583d88c1a5aSDimitry Andric   Error parseMetadataKinds();
584d88c1a5aSDimitry Andric 
585d88c1a5aSDimitry Andric   void setStripTBAA(bool Value) { StripTBAA = Value; }
586d88c1a5aSDimitry Andric   bool isStrippingTBAA() { return StripTBAA; }
587d88c1a5aSDimitry Andric 
588d88c1a5aSDimitry Andric   unsigned size() const { return MetadataList.size(); }
589d88c1a5aSDimitry Andric   void shrinkTo(unsigned N) { MetadataList.shrinkTo(N); }
5906bc11b14SDimitry Andric   void upgradeDebugIntrinsics(Function &F) { upgradeDeclareExpressions(F); }
591d88c1a5aSDimitry Andric };
592d88c1a5aSDimitry Andric 
5937a7e6055SDimitry Andric static Error error(const Twine &Message) {
594d88c1a5aSDimitry Andric   return make_error<StringError>(
595d88c1a5aSDimitry Andric       Message, make_error_code(BitcodeError::CorruptedBitcode));
596d88c1a5aSDimitry Andric }
597d88c1a5aSDimitry Andric 
59824e2fe98SDimitry Andric Expected<bool>
59924e2fe98SDimitry Andric MetadataLoader::MetadataLoaderImpl::lazyLoadModuleMetadataBlock() {
60095ec533aSDimitry Andric   IndexCursor = Stream;
60195ec533aSDimitry Andric   SmallVector<uint64_t, 64> Record;
60295ec533aSDimitry Andric   // Get the abbrevs, and preload record positions to make them lazy-loadable.
60395ec533aSDimitry Andric   while (true) {
60495ec533aSDimitry Andric     BitstreamEntry Entry = IndexCursor.advanceSkippingSubblocks(
60595ec533aSDimitry Andric         BitstreamCursor::AF_DontPopBlockAtEnd);
60695ec533aSDimitry Andric     switch (Entry.Kind) {
60795ec533aSDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
60895ec533aSDimitry Andric     case BitstreamEntry::Error:
60995ec533aSDimitry Andric       return error("Malformed block");
61095ec533aSDimitry Andric     case BitstreamEntry::EndBlock: {
61195ec533aSDimitry Andric       return true;
61295ec533aSDimitry Andric     }
61395ec533aSDimitry Andric     case BitstreamEntry::Record: {
61495ec533aSDimitry Andric       // The interesting case.
61595ec533aSDimitry Andric       ++NumMDRecordLoaded;
61695ec533aSDimitry Andric       uint64_t CurrentPos = IndexCursor.GetCurrentBitNo();
61795ec533aSDimitry Andric       auto Code = IndexCursor.skipRecord(Entry.ID);
61895ec533aSDimitry Andric       switch (Code) {
61995ec533aSDimitry Andric       case bitc::METADATA_STRINGS: {
62095ec533aSDimitry Andric         // Rewind and parse the strings.
62195ec533aSDimitry Andric         IndexCursor.JumpToBit(CurrentPos);
62295ec533aSDimitry Andric         StringRef Blob;
62395ec533aSDimitry Andric         Record.clear();
62495ec533aSDimitry Andric         IndexCursor.readRecord(Entry.ID, Record, &Blob);
62595ec533aSDimitry Andric         unsigned NumStrings = Record[0];
62695ec533aSDimitry Andric         MDStringRef.reserve(NumStrings);
62795ec533aSDimitry Andric         auto IndexNextMDString = [&](StringRef Str) {
62895ec533aSDimitry Andric           MDStringRef.push_back(Str);
62995ec533aSDimitry Andric         };
63095ec533aSDimitry Andric         if (auto Err = parseMetadataStrings(Record, Blob, IndexNextMDString))
63195ec533aSDimitry Andric           return std::move(Err);
63295ec533aSDimitry Andric         break;
63395ec533aSDimitry Andric       }
63495ec533aSDimitry Andric       case bitc::METADATA_INDEX_OFFSET: {
63595ec533aSDimitry Andric         // This is the offset to the index, when we see this we skip all the
63695ec533aSDimitry Andric         // records and load only an index to these.
63795ec533aSDimitry Andric         IndexCursor.JumpToBit(CurrentPos);
63895ec533aSDimitry Andric         Record.clear();
63995ec533aSDimitry Andric         IndexCursor.readRecord(Entry.ID, Record);
64095ec533aSDimitry Andric         if (Record.size() != 2)
64195ec533aSDimitry Andric           return error("Invalid record");
64295ec533aSDimitry Andric         auto Offset = Record[0] + (Record[1] << 32);
64395ec533aSDimitry Andric         auto BeginPos = IndexCursor.GetCurrentBitNo();
64495ec533aSDimitry Andric         IndexCursor.JumpToBit(BeginPos + Offset);
64595ec533aSDimitry Andric         Entry = IndexCursor.advanceSkippingSubblocks(
64695ec533aSDimitry Andric             BitstreamCursor::AF_DontPopBlockAtEnd);
64795ec533aSDimitry Andric         assert(Entry.Kind == BitstreamEntry::Record &&
64895ec533aSDimitry Andric                "Corrupted bitcode: Expected `Record` when trying to find the "
64995ec533aSDimitry Andric                "Metadata index");
65095ec533aSDimitry Andric         Record.clear();
65195ec533aSDimitry Andric         auto Code = IndexCursor.readRecord(Entry.ID, Record);
65295ec533aSDimitry Andric         (void)Code;
65395ec533aSDimitry Andric         assert(Code == bitc::METADATA_INDEX && "Corrupted bitcode: Expected "
65495ec533aSDimitry Andric                                                "`METADATA_INDEX` when trying "
65595ec533aSDimitry Andric                                                "to find the Metadata index");
65695ec533aSDimitry Andric 
65795ec533aSDimitry Andric         // Delta unpack
65895ec533aSDimitry Andric         auto CurrentValue = BeginPos;
65995ec533aSDimitry Andric         GlobalMetadataBitPosIndex.reserve(Record.size());
66095ec533aSDimitry Andric         for (auto &Elt : Record) {
66195ec533aSDimitry Andric           CurrentValue += Elt;
66295ec533aSDimitry Andric           GlobalMetadataBitPosIndex.push_back(CurrentValue);
66395ec533aSDimitry Andric         }
66495ec533aSDimitry Andric         break;
66595ec533aSDimitry Andric       }
66695ec533aSDimitry Andric       case bitc::METADATA_INDEX:
66795ec533aSDimitry Andric         // We don't expect to get there, the Index is loaded when we encounter
66895ec533aSDimitry Andric         // the offset.
66995ec533aSDimitry Andric         return error("Corrupted Metadata block");
67095ec533aSDimitry Andric       case bitc::METADATA_NAME: {
67195ec533aSDimitry Andric         // Named metadata need to be materialized now and aren't deferred.
67295ec533aSDimitry Andric         IndexCursor.JumpToBit(CurrentPos);
67395ec533aSDimitry Andric         Record.clear();
67495ec533aSDimitry Andric         unsigned Code = IndexCursor.readRecord(Entry.ID, Record);
67595ec533aSDimitry Andric         assert(Code == bitc::METADATA_NAME);
67695ec533aSDimitry Andric 
67795ec533aSDimitry Andric         // Read name of the named metadata.
67895ec533aSDimitry Andric         SmallString<8> Name(Record.begin(), Record.end());
67995ec533aSDimitry Andric         Code = IndexCursor.ReadCode();
68095ec533aSDimitry Andric 
68195ec533aSDimitry Andric         // Named Metadata comes in two parts, we expect the name to be followed
68295ec533aSDimitry Andric         // by the node
68395ec533aSDimitry Andric         Record.clear();
68495ec533aSDimitry Andric         unsigned NextBitCode = IndexCursor.readRecord(Code, Record);
68595ec533aSDimitry Andric         assert(NextBitCode == bitc::METADATA_NAMED_NODE);
68695ec533aSDimitry Andric         (void)NextBitCode;
68795ec533aSDimitry Andric 
68895ec533aSDimitry Andric         // Read named metadata elements.
68995ec533aSDimitry Andric         unsigned Size = Record.size();
69095ec533aSDimitry Andric         NamedMDNode *NMD = TheModule.getOrInsertNamedMetadata(Name);
69195ec533aSDimitry Andric         for (unsigned i = 0; i != Size; ++i) {
69295ec533aSDimitry Andric           // FIXME: We could use a placeholder here, however NamedMDNode are
69395ec533aSDimitry Andric           // taking MDNode as operand and not using the Metadata infrastructure.
69495ec533aSDimitry Andric           // It is acknowledged by 'TODO: Inherit from Metadata' in the
69595ec533aSDimitry Andric           // NamedMDNode class definition.
69695ec533aSDimitry Andric           MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[i]);
69795ec533aSDimitry Andric           assert(MD && "Invalid record");
69895ec533aSDimitry Andric           NMD->addOperand(MD);
69995ec533aSDimitry Andric         }
70095ec533aSDimitry Andric         break;
70195ec533aSDimitry Andric       }
70295ec533aSDimitry Andric       case bitc::METADATA_GLOBAL_DECL_ATTACHMENT: {
70395ec533aSDimitry Andric         // FIXME: we need to do this early because we don't materialize global
70495ec533aSDimitry Andric         // value explicitly.
70595ec533aSDimitry Andric         IndexCursor.JumpToBit(CurrentPos);
70695ec533aSDimitry Andric         Record.clear();
70795ec533aSDimitry Andric         IndexCursor.readRecord(Entry.ID, Record);
70895ec533aSDimitry Andric         if (Record.size() % 2 == 0)
70995ec533aSDimitry Andric           return error("Invalid record");
71095ec533aSDimitry Andric         unsigned ValueID = Record[0];
71195ec533aSDimitry Andric         if (ValueID >= ValueList.size())
71295ec533aSDimitry Andric           return error("Invalid record");
71395ec533aSDimitry Andric         if (auto *GO = dyn_cast<GlobalObject>(ValueList[ValueID]))
71495ec533aSDimitry Andric           if (Error Err = parseGlobalObjectAttachment(
71595ec533aSDimitry Andric                   *GO, ArrayRef<uint64_t>(Record).slice(1)))
71695ec533aSDimitry Andric             return std::move(Err);
71795ec533aSDimitry Andric         break;
71895ec533aSDimitry Andric       }
71995ec533aSDimitry Andric       case bitc::METADATA_KIND:
72095ec533aSDimitry Andric       case bitc::METADATA_STRING_OLD:
72195ec533aSDimitry Andric       case bitc::METADATA_OLD_FN_NODE:
72295ec533aSDimitry Andric       case bitc::METADATA_OLD_NODE:
72395ec533aSDimitry Andric       case bitc::METADATA_VALUE:
72495ec533aSDimitry Andric       case bitc::METADATA_DISTINCT_NODE:
72595ec533aSDimitry Andric       case bitc::METADATA_NODE:
72695ec533aSDimitry Andric       case bitc::METADATA_LOCATION:
72795ec533aSDimitry Andric       case bitc::METADATA_GENERIC_DEBUG:
72895ec533aSDimitry Andric       case bitc::METADATA_SUBRANGE:
72995ec533aSDimitry Andric       case bitc::METADATA_ENUMERATOR:
73095ec533aSDimitry Andric       case bitc::METADATA_BASIC_TYPE:
73195ec533aSDimitry Andric       case bitc::METADATA_DERIVED_TYPE:
73295ec533aSDimitry Andric       case bitc::METADATA_COMPOSITE_TYPE:
73395ec533aSDimitry Andric       case bitc::METADATA_SUBROUTINE_TYPE:
73495ec533aSDimitry Andric       case bitc::METADATA_MODULE:
73595ec533aSDimitry Andric       case bitc::METADATA_FILE:
73695ec533aSDimitry Andric       case bitc::METADATA_COMPILE_UNIT:
73795ec533aSDimitry Andric       case bitc::METADATA_SUBPROGRAM:
73895ec533aSDimitry Andric       case bitc::METADATA_LEXICAL_BLOCK:
73995ec533aSDimitry Andric       case bitc::METADATA_LEXICAL_BLOCK_FILE:
74095ec533aSDimitry Andric       case bitc::METADATA_NAMESPACE:
74195ec533aSDimitry Andric       case bitc::METADATA_MACRO:
74295ec533aSDimitry Andric       case bitc::METADATA_MACRO_FILE:
74395ec533aSDimitry Andric       case bitc::METADATA_TEMPLATE_TYPE:
74495ec533aSDimitry Andric       case bitc::METADATA_TEMPLATE_VALUE:
74595ec533aSDimitry Andric       case bitc::METADATA_GLOBAL_VAR:
74695ec533aSDimitry Andric       case bitc::METADATA_LOCAL_VAR:
74795ec533aSDimitry Andric       case bitc::METADATA_EXPRESSION:
74895ec533aSDimitry Andric       case bitc::METADATA_OBJC_PROPERTY:
74995ec533aSDimitry Andric       case bitc::METADATA_IMPORTED_ENTITY:
75095ec533aSDimitry Andric       case bitc::METADATA_GLOBAL_VAR_EXPR:
75195ec533aSDimitry Andric         // We don't expect to see any of these, if we see one, give up on
75295ec533aSDimitry Andric         // lazy-loading and fallback.
75395ec533aSDimitry Andric         MDStringRef.clear();
75495ec533aSDimitry Andric         GlobalMetadataBitPosIndex.clear();
75595ec533aSDimitry Andric         return false;
75695ec533aSDimitry Andric       }
75795ec533aSDimitry Andric       break;
75895ec533aSDimitry Andric     }
75995ec533aSDimitry Andric     }
76095ec533aSDimitry Andric   }
76195ec533aSDimitry Andric }
76295ec533aSDimitry Andric 
763d88c1a5aSDimitry Andric /// Parse a METADATA_BLOCK. If ModuleLevel is true then we are parsing
764d88c1a5aSDimitry Andric /// module level metadata.
765d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseMetadata(bool ModuleLevel) {
766d88c1a5aSDimitry Andric   if (!ModuleLevel && MetadataList.hasFwdRefs())
767d88c1a5aSDimitry Andric     return error("Invalid metadata: fwd refs into function blocks");
768d88c1a5aSDimitry Andric 
76995ec533aSDimitry Andric   // Record the entry position so that we can jump back here and efficiently
77095ec533aSDimitry Andric   // skip the whole block in case we lazy-load.
77195ec533aSDimitry Andric   auto EntryPos = Stream.GetCurrentBitNo();
77295ec533aSDimitry Andric 
773d88c1a5aSDimitry Andric   if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
774d88c1a5aSDimitry Andric     return error("Invalid record");
775d88c1a5aSDimitry Andric 
776d88c1a5aSDimitry Andric   SmallVector<uint64_t, 64> Record;
777d88c1a5aSDimitry Andric   PlaceholderQueue Placeholders;
778d88c1a5aSDimitry Andric 
77995ec533aSDimitry Andric   // We lazy-load module-level metadata: we build an index for each record, and
78095ec533aSDimitry Andric   // then load individual record as needed, starting with the named metadata.
78195ec533aSDimitry Andric   if (ModuleLevel && IsImporting && MetadataList.empty() &&
78295ec533aSDimitry Andric       !DisableLazyLoading) {
78324e2fe98SDimitry Andric     auto SuccessOrErr = lazyLoadModuleMetadataBlock();
78495ec533aSDimitry Andric     if (!SuccessOrErr)
78595ec533aSDimitry Andric       return SuccessOrErr.takeError();
78695ec533aSDimitry Andric     if (SuccessOrErr.get()) {
78795ec533aSDimitry Andric       // An index was successfully created and we will be able to load metadata
78895ec533aSDimitry Andric       // on-demand.
78995ec533aSDimitry Andric       MetadataList.resize(MDStringRef.size() +
79095ec533aSDimitry Andric                           GlobalMetadataBitPosIndex.size());
79195ec533aSDimitry Andric 
79295ec533aSDimitry Andric       // Reading the named metadata created forward references and/or
79395ec533aSDimitry Andric       // placeholders, that we flush here.
79495ec533aSDimitry Andric       resolveForwardRefsAndPlaceholders(Placeholders);
7955ca5951eSDimitry Andric       upgradeDebugInfo();
79695ec533aSDimitry Andric       // Return at the beginning of the block, since it is easy to skip it
79795ec533aSDimitry Andric       // entirely from there.
79895ec533aSDimitry Andric       Stream.ReadBlockEnd(); // Pop the abbrev block context.
79995ec533aSDimitry Andric       Stream.JumpToBit(EntryPos);
80095ec533aSDimitry Andric       if (Stream.SkipBlock())
80195ec533aSDimitry Andric         return error("Invalid record");
80295ec533aSDimitry Andric       return Error::success();
80395ec533aSDimitry Andric     }
80495ec533aSDimitry Andric     // Couldn't load an index, fallback to loading all the block "old-style".
80595ec533aSDimitry Andric   }
80695ec533aSDimitry Andric 
80795ec533aSDimitry Andric   unsigned NextMetadataNo = MetadataList.size();
80895ec533aSDimitry Andric 
809d88c1a5aSDimitry Andric   // Read all the records.
810d88c1a5aSDimitry Andric   while (true) {
811d88c1a5aSDimitry Andric     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
812d88c1a5aSDimitry Andric 
813d88c1a5aSDimitry Andric     switch (Entry.Kind) {
814d88c1a5aSDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
815d88c1a5aSDimitry Andric     case BitstreamEntry::Error:
816d88c1a5aSDimitry Andric       return error("Malformed block");
817d88c1a5aSDimitry Andric     case BitstreamEntry::EndBlock:
81895ec533aSDimitry Andric       resolveForwardRefsAndPlaceholders(Placeholders);
8195ca5951eSDimitry Andric       upgradeDebugInfo();
820d88c1a5aSDimitry Andric       return Error::success();
821d88c1a5aSDimitry Andric     case BitstreamEntry::Record:
822d88c1a5aSDimitry Andric       // The interesting case.
823d88c1a5aSDimitry Andric       break;
824d88c1a5aSDimitry Andric     }
825d88c1a5aSDimitry Andric 
826d88c1a5aSDimitry Andric     // Read a record.
827d88c1a5aSDimitry Andric     Record.clear();
828d88c1a5aSDimitry Andric     StringRef Blob;
82995ec533aSDimitry Andric     ++NumMDRecordLoaded;
830d88c1a5aSDimitry Andric     unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob);
83195ec533aSDimitry Andric     if (Error Err =
83295ec533aSDimitry Andric             parseOneMetadata(Record, Code, Placeholders, Blob, NextMetadataNo))
833d88c1a5aSDimitry Andric       return Err;
834d88c1a5aSDimitry Andric   }
835d88c1a5aSDimitry Andric }
836d88c1a5aSDimitry Andric 
83795ec533aSDimitry Andric MDString *MetadataLoader::MetadataLoaderImpl::lazyLoadOneMDString(unsigned ID) {
83895ec533aSDimitry Andric   ++NumMDStringLoaded;
83995ec533aSDimitry Andric   if (Metadata *MD = MetadataList.lookup(ID))
84095ec533aSDimitry Andric     return cast<MDString>(MD);
84195ec533aSDimitry Andric   auto MDS = MDString::get(Context, MDStringRef[ID]);
84295ec533aSDimitry Andric   MetadataList.assignValue(MDS, ID);
84395ec533aSDimitry Andric   return MDS;
84495ec533aSDimitry Andric }
84595ec533aSDimitry Andric 
84695ec533aSDimitry Andric void MetadataLoader::MetadataLoaderImpl::lazyLoadOneMetadata(
84795ec533aSDimitry Andric     unsigned ID, PlaceholderQueue &Placeholders) {
84895ec533aSDimitry Andric   assert(ID < (MDStringRef.size()) + GlobalMetadataBitPosIndex.size());
84995ec533aSDimitry Andric   assert(ID >= MDStringRef.size() && "Unexpected lazy-loading of MDString");
85095ec533aSDimitry Andric   // Lookup first if the metadata hasn't already been loaded.
85195ec533aSDimitry Andric   if (auto *MD = MetadataList.lookup(ID)) {
85295ec533aSDimitry Andric     auto *N = dyn_cast_or_null<MDNode>(MD);
85394c53d40SDimitry Andric     if (!N->isTemporary())
85494c53d40SDimitry Andric       return;
85595ec533aSDimitry Andric   }
85695ec533aSDimitry Andric   SmallVector<uint64_t, 64> Record;
85795ec533aSDimitry Andric   StringRef Blob;
85895ec533aSDimitry Andric   IndexCursor.JumpToBit(GlobalMetadataBitPosIndex[ID - MDStringRef.size()]);
85995ec533aSDimitry Andric   auto Entry = IndexCursor.advanceSkippingSubblocks();
86095ec533aSDimitry Andric   ++NumMDRecordLoaded;
86195ec533aSDimitry Andric   unsigned Code = IndexCursor.readRecord(Entry.ID, Record, &Blob);
86295ec533aSDimitry Andric   if (Error Err = parseOneMetadata(Record, Code, Placeholders, Blob, ID))
86395ec533aSDimitry Andric     report_fatal_error("Can't lazyload MD");
86495ec533aSDimitry Andric }
86595ec533aSDimitry Andric 
86695ec533aSDimitry Andric /// Ensure that all forward-references and placeholders are resolved.
86795ec533aSDimitry Andric /// Iteratively lazy-loading metadata on-demand if needed.
86895ec533aSDimitry Andric void MetadataLoader::MetadataLoaderImpl::resolveForwardRefsAndPlaceholders(
86995ec533aSDimitry Andric     PlaceholderQueue &Placeholders) {
87095ec533aSDimitry Andric   DenseSet<unsigned> Temporaries;
87195ec533aSDimitry Andric   while (1) {
87295ec533aSDimitry Andric     // Populate Temporaries with the placeholders that haven't been loaded yet.
87395ec533aSDimitry Andric     Placeholders.getTemporaries(MetadataList, Temporaries);
87495ec533aSDimitry Andric 
87595ec533aSDimitry Andric     // If we don't have any temporary, or FwdReference, we're done!
87695ec533aSDimitry Andric     if (Temporaries.empty() && !MetadataList.hasFwdRefs())
87795ec533aSDimitry Andric       break;
87895ec533aSDimitry Andric 
87995ec533aSDimitry Andric     // First, load all the temporaries. This can add new placeholders or
88095ec533aSDimitry Andric     // forward references.
88195ec533aSDimitry Andric     for (auto ID : Temporaries)
88295ec533aSDimitry Andric       lazyLoadOneMetadata(ID, Placeholders);
88395ec533aSDimitry Andric     Temporaries.clear();
88495ec533aSDimitry Andric 
88595ec533aSDimitry Andric     // Second, load the forward-references. This can also add new placeholders
88695ec533aSDimitry Andric     // or forward references.
88795ec533aSDimitry Andric     while (MetadataList.hasFwdRefs())
88895ec533aSDimitry Andric       lazyLoadOneMetadata(MetadataList.getNextFwdRef(), Placeholders);
88995ec533aSDimitry Andric   }
89095ec533aSDimitry Andric   // At this point we don't have any forward reference remaining, or temporary
89195ec533aSDimitry Andric   // that haven't been loaded. We can safely drop RAUW support and mark cycles
89295ec533aSDimitry Andric   // as resolved.
89395ec533aSDimitry Andric   MetadataList.tryToResolveCycles();
89495ec533aSDimitry Andric 
89595ec533aSDimitry Andric   // Finally, everything is in place, we can replace the placeholders operands
89695ec533aSDimitry Andric   // with the final node they refer to.
89795ec533aSDimitry Andric   Placeholders.flush(MetadataList);
89895ec533aSDimitry Andric }
89995ec533aSDimitry Andric 
900d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseOneMetadata(
901d88c1a5aSDimitry Andric     SmallVectorImpl<uint64_t> &Record, unsigned Code,
90295ec533aSDimitry Andric     PlaceholderQueue &Placeholders, StringRef Blob, unsigned &NextMetadataNo) {
903d88c1a5aSDimitry Andric 
904d88c1a5aSDimitry Andric   bool IsDistinct = false;
905d88c1a5aSDimitry Andric   auto getMD = [&](unsigned ID) -> Metadata * {
90695ec533aSDimitry Andric     if (ID < MDStringRef.size())
90795ec533aSDimitry Andric       return lazyLoadOneMDString(ID);
90894c53d40SDimitry Andric     if (!IsDistinct) {
90994c53d40SDimitry Andric       if (auto *MD = MetadataList.lookup(ID))
91094c53d40SDimitry Andric         return MD;
91194c53d40SDimitry Andric       // If lazy-loading is enabled, we try recursively to load the operand
91294c53d40SDimitry Andric       // instead of creating a temporary.
91394c53d40SDimitry Andric       if (ID < (MDStringRef.size() + GlobalMetadataBitPosIndex.size())) {
91494c53d40SDimitry Andric         // Create a temporary for the node that is referencing the operand we
91594c53d40SDimitry Andric         // will lazy-load. It is needed before recursing in case there are
91694c53d40SDimitry Andric         // uniquing cycles.
91794c53d40SDimitry Andric         MetadataList.getMetadataFwdRef(NextMetadataNo);
91894c53d40SDimitry Andric         lazyLoadOneMetadata(ID, Placeholders);
91994c53d40SDimitry Andric         return MetadataList.lookup(ID);
92094c53d40SDimitry Andric       }
92194c53d40SDimitry Andric       // Return a temporary.
922d88c1a5aSDimitry Andric       return MetadataList.getMetadataFwdRef(ID);
92394c53d40SDimitry Andric     }
924d88c1a5aSDimitry Andric     if (auto *MD = MetadataList.getMetadataIfResolved(ID))
925d88c1a5aSDimitry Andric       return MD;
926d88c1a5aSDimitry Andric     return &Placeholders.getPlaceholderOp(ID);
927d88c1a5aSDimitry Andric   };
928d88c1a5aSDimitry Andric   auto getMDOrNull = [&](unsigned ID) -> Metadata * {
929d88c1a5aSDimitry Andric     if (ID)
930d88c1a5aSDimitry Andric       return getMD(ID - 1);
931d88c1a5aSDimitry Andric     return nullptr;
932d88c1a5aSDimitry Andric   };
933d88c1a5aSDimitry Andric   auto getMDOrNullWithoutPlaceholders = [&](unsigned ID) -> Metadata * {
934d88c1a5aSDimitry Andric     if (ID)
935d88c1a5aSDimitry Andric       return MetadataList.getMetadataFwdRef(ID - 1);
936d88c1a5aSDimitry Andric     return nullptr;
937d88c1a5aSDimitry Andric   };
938d88c1a5aSDimitry Andric   auto getMDString = [&](unsigned ID) -> MDString * {
939d88c1a5aSDimitry Andric     // This requires that the ID is not really a forward reference.  In
940d88c1a5aSDimitry Andric     // particular, the MDString must already have been resolved.
94195ec533aSDimitry Andric     auto MDS = getMDOrNull(ID);
94295ec533aSDimitry Andric     return cast_or_null<MDString>(MDS);
943d88c1a5aSDimitry Andric   };
944d88c1a5aSDimitry Andric 
945d88c1a5aSDimitry Andric   // Support for old type refs.
946d88c1a5aSDimitry Andric   auto getDITypeRefOrNull = [&](unsigned ID) {
947d88c1a5aSDimitry Andric     return MetadataList.upgradeTypeRef(getMDOrNull(ID));
948d88c1a5aSDimitry Andric   };
949d88c1a5aSDimitry Andric 
950d88c1a5aSDimitry Andric #define GET_OR_DISTINCT(CLASS, ARGS)                                           \
951d88c1a5aSDimitry Andric   (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS)
952d88c1a5aSDimitry Andric 
953d88c1a5aSDimitry Andric   switch (Code) {
954d88c1a5aSDimitry Andric   default: // Default behavior: ignore.
955d88c1a5aSDimitry Andric     break;
956d88c1a5aSDimitry Andric   case bitc::METADATA_NAME: {
957d88c1a5aSDimitry Andric     // Read name of the named metadata.
958d88c1a5aSDimitry Andric     SmallString<8> Name(Record.begin(), Record.end());
959d88c1a5aSDimitry Andric     Record.clear();
960d88c1a5aSDimitry Andric     Code = Stream.ReadCode();
961d88c1a5aSDimitry Andric 
96295ec533aSDimitry Andric     ++NumMDRecordLoaded;
963d88c1a5aSDimitry Andric     unsigned NextBitCode = Stream.readRecord(Code, Record);
964d88c1a5aSDimitry Andric     if (NextBitCode != bitc::METADATA_NAMED_NODE)
965d88c1a5aSDimitry Andric       return error("METADATA_NAME not followed by METADATA_NAMED_NODE");
966d88c1a5aSDimitry Andric 
967d88c1a5aSDimitry Andric     // Read named metadata elements.
968d88c1a5aSDimitry Andric     unsigned Size = Record.size();
969d88c1a5aSDimitry Andric     NamedMDNode *NMD = TheModule.getOrInsertNamedMetadata(Name);
970d88c1a5aSDimitry Andric     for (unsigned i = 0; i != Size; ++i) {
971d88c1a5aSDimitry Andric       MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[i]);
972d88c1a5aSDimitry Andric       if (!MD)
973d88c1a5aSDimitry Andric         return error("Invalid record");
974d88c1a5aSDimitry Andric       NMD->addOperand(MD);
975d88c1a5aSDimitry Andric     }
976d88c1a5aSDimitry Andric     break;
977d88c1a5aSDimitry Andric   }
978d88c1a5aSDimitry Andric   case bitc::METADATA_OLD_FN_NODE: {
979d88c1a5aSDimitry Andric     // FIXME: Remove in 4.0.
980d88c1a5aSDimitry Andric     // This is a LocalAsMetadata record, the only type of function-local
981d88c1a5aSDimitry Andric     // metadata.
982d88c1a5aSDimitry Andric     if (Record.size() % 2 == 1)
983d88c1a5aSDimitry Andric       return error("Invalid record");
984d88c1a5aSDimitry Andric 
985d88c1a5aSDimitry Andric     // If this isn't a LocalAsMetadata record, we're dropping it.  This used
986d88c1a5aSDimitry Andric     // to be legal, but there's no upgrade path.
987d88c1a5aSDimitry Andric     auto dropRecord = [&] {
98898221d2eSDimitry Andric       MetadataList.assignValue(MDNode::get(Context, None), NextMetadataNo);
98998221d2eSDimitry Andric       NextMetadataNo++;
990d88c1a5aSDimitry Andric     };
991d88c1a5aSDimitry Andric     if (Record.size() != 2) {
992d88c1a5aSDimitry Andric       dropRecord();
993d88c1a5aSDimitry Andric       break;
994d88c1a5aSDimitry Andric     }
995d88c1a5aSDimitry Andric 
996d88c1a5aSDimitry Andric     Type *Ty = getTypeByID(Record[0]);
997d88c1a5aSDimitry Andric     if (Ty->isMetadataTy() || Ty->isVoidTy()) {
998d88c1a5aSDimitry Andric       dropRecord();
999d88c1a5aSDimitry Andric       break;
1000d88c1a5aSDimitry Andric     }
1001d88c1a5aSDimitry Andric 
1002d88c1a5aSDimitry Andric     MetadataList.assignValue(
1003d88c1a5aSDimitry Andric         LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
100498221d2eSDimitry Andric         NextMetadataNo);
100598221d2eSDimitry Andric     NextMetadataNo++;
1006d88c1a5aSDimitry Andric     break;
1007d88c1a5aSDimitry Andric   }
1008d88c1a5aSDimitry Andric   case bitc::METADATA_OLD_NODE: {
1009d88c1a5aSDimitry Andric     // FIXME: Remove in 4.0.
1010d88c1a5aSDimitry Andric     if (Record.size() % 2 == 1)
1011d88c1a5aSDimitry Andric       return error("Invalid record");
1012d88c1a5aSDimitry Andric 
1013d88c1a5aSDimitry Andric     unsigned Size = Record.size();
1014d88c1a5aSDimitry Andric     SmallVector<Metadata *, 8> Elts;
1015d88c1a5aSDimitry Andric     for (unsigned i = 0; i != Size; i += 2) {
1016d88c1a5aSDimitry Andric       Type *Ty = getTypeByID(Record[i]);
1017d88c1a5aSDimitry Andric       if (!Ty)
1018d88c1a5aSDimitry Andric         return error("Invalid record");
1019d88c1a5aSDimitry Andric       if (Ty->isMetadataTy())
1020d88c1a5aSDimitry Andric         Elts.push_back(getMD(Record[i + 1]));
1021d88c1a5aSDimitry Andric       else if (!Ty->isVoidTy()) {
1022d88c1a5aSDimitry Andric         auto *MD =
1023d88c1a5aSDimitry Andric             ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
1024d88c1a5aSDimitry Andric         assert(isa<ConstantAsMetadata>(MD) &&
1025d88c1a5aSDimitry Andric                "Expected non-function-local metadata");
1026d88c1a5aSDimitry Andric         Elts.push_back(MD);
1027d88c1a5aSDimitry Andric       } else
1028d88c1a5aSDimitry Andric         Elts.push_back(nullptr);
1029d88c1a5aSDimitry Andric     }
103098221d2eSDimitry Andric     MetadataList.assignValue(MDNode::get(Context, Elts), NextMetadataNo);
103198221d2eSDimitry Andric     NextMetadataNo++;
1032d88c1a5aSDimitry Andric     break;
1033d88c1a5aSDimitry Andric   }
1034d88c1a5aSDimitry Andric   case bitc::METADATA_VALUE: {
1035d88c1a5aSDimitry Andric     if (Record.size() != 2)
1036d88c1a5aSDimitry Andric       return error("Invalid record");
1037d88c1a5aSDimitry Andric 
1038d88c1a5aSDimitry Andric     Type *Ty = getTypeByID(Record[0]);
1039d88c1a5aSDimitry Andric     if (Ty->isMetadataTy() || Ty->isVoidTy())
1040d88c1a5aSDimitry Andric       return error("Invalid record");
1041d88c1a5aSDimitry Andric 
1042d88c1a5aSDimitry Andric     MetadataList.assignValue(
1043d88c1a5aSDimitry Andric         ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
104498221d2eSDimitry Andric         NextMetadataNo);
104598221d2eSDimitry Andric     NextMetadataNo++;
1046d88c1a5aSDimitry Andric     break;
1047d88c1a5aSDimitry Andric   }
1048d88c1a5aSDimitry Andric   case bitc::METADATA_DISTINCT_NODE:
1049d88c1a5aSDimitry Andric     IsDistinct = true;
1050d88c1a5aSDimitry Andric     LLVM_FALLTHROUGH;
1051d88c1a5aSDimitry Andric   case bitc::METADATA_NODE: {
1052d88c1a5aSDimitry Andric     SmallVector<Metadata *, 8> Elts;
1053d88c1a5aSDimitry Andric     Elts.reserve(Record.size());
1054d88c1a5aSDimitry Andric     for (unsigned ID : Record)
1055d88c1a5aSDimitry Andric       Elts.push_back(getMDOrNull(ID));
1056d88c1a5aSDimitry Andric     MetadataList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
1057d88c1a5aSDimitry Andric                                         : MDNode::get(Context, Elts),
105898221d2eSDimitry Andric                              NextMetadataNo);
105998221d2eSDimitry Andric     NextMetadataNo++;
1060d88c1a5aSDimitry Andric     break;
1061d88c1a5aSDimitry Andric   }
1062d88c1a5aSDimitry Andric   case bitc::METADATA_LOCATION: {
1063d88c1a5aSDimitry Andric     if (Record.size() != 5)
1064d88c1a5aSDimitry Andric       return error("Invalid record");
1065d88c1a5aSDimitry Andric 
1066d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1067d88c1a5aSDimitry Andric     unsigned Line = Record[1];
1068d88c1a5aSDimitry Andric     unsigned Column = Record[2];
1069d88c1a5aSDimitry Andric     Metadata *Scope = getMD(Record[3]);
1070d88c1a5aSDimitry Andric     Metadata *InlinedAt = getMDOrNull(Record[4]);
1071d88c1a5aSDimitry Andric     MetadataList.assignValue(
1072d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DILocation, (Context, Line, Column, Scope, InlinedAt)),
107398221d2eSDimitry Andric         NextMetadataNo);
107498221d2eSDimitry Andric     NextMetadataNo++;
1075d88c1a5aSDimitry Andric     break;
1076d88c1a5aSDimitry Andric   }
1077d88c1a5aSDimitry Andric   case bitc::METADATA_GENERIC_DEBUG: {
1078d88c1a5aSDimitry Andric     if (Record.size() < 4)
1079d88c1a5aSDimitry Andric       return error("Invalid record");
1080d88c1a5aSDimitry Andric 
1081d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1082d88c1a5aSDimitry Andric     unsigned Tag = Record[1];
1083d88c1a5aSDimitry Andric     unsigned Version = Record[2];
1084d88c1a5aSDimitry Andric 
1085d88c1a5aSDimitry Andric     if (Tag >= 1u << 16 || Version != 0)
1086d88c1a5aSDimitry Andric       return error("Invalid record");
1087d88c1a5aSDimitry Andric 
1088d88c1a5aSDimitry Andric     auto *Header = getMDString(Record[3]);
1089d88c1a5aSDimitry Andric     SmallVector<Metadata *, 8> DwarfOps;
1090d88c1a5aSDimitry Andric     for (unsigned I = 4, E = Record.size(); I != E; ++I)
1091d88c1a5aSDimitry Andric       DwarfOps.push_back(getMDOrNull(Record[I]));
1092d88c1a5aSDimitry Andric     MetadataList.assignValue(
1093d88c1a5aSDimitry Andric         GET_OR_DISTINCT(GenericDINode, (Context, Tag, Header, DwarfOps)),
109498221d2eSDimitry Andric         NextMetadataNo);
109598221d2eSDimitry Andric     NextMetadataNo++;
1096d88c1a5aSDimitry Andric     break;
1097d88c1a5aSDimitry Andric   }
1098d88c1a5aSDimitry Andric   case bitc::METADATA_SUBRANGE: {
1099d88c1a5aSDimitry Andric     if (Record.size() != 3)
1100d88c1a5aSDimitry Andric       return error("Invalid record");
1101d88c1a5aSDimitry Andric 
1102d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1103d88c1a5aSDimitry Andric     MetadataList.assignValue(
1104d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DISubrange,
1105d88c1a5aSDimitry Andric                         (Context, Record[1], unrotateSign(Record[2]))),
110698221d2eSDimitry Andric         NextMetadataNo);
110798221d2eSDimitry Andric     NextMetadataNo++;
1108d88c1a5aSDimitry Andric     break;
1109d88c1a5aSDimitry Andric   }
1110d88c1a5aSDimitry Andric   case bitc::METADATA_ENUMERATOR: {
1111d88c1a5aSDimitry Andric     if (Record.size() != 3)
1112d88c1a5aSDimitry Andric       return error("Invalid record");
1113d88c1a5aSDimitry Andric 
1114d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1115d88c1a5aSDimitry Andric     MetadataList.assignValue(
1116d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIEnumerator, (Context, unrotateSign(Record[1]),
1117d88c1a5aSDimitry Andric                                        getMDString(Record[2]))),
111898221d2eSDimitry Andric         NextMetadataNo);
111998221d2eSDimitry Andric     NextMetadataNo++;
1120d88c1a5aSDimitry Andric     break;
1121d88c1a5aSDimitry Andric   }
1122d88c1a5aSDimitry Andric   case bitc::METADATA_BASIC_TYPE: {
1123d88c1a5aSDimitry Andric     if (Record.size() != 6)
1124d88c1a5aSDimitry Andric       return error("Invalid record");
1125d88c1a5aSDimitry Andric 
1126d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1127d88c1a5aSDimitry Andric     MetadataList.assignValue(
1128d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIBasicType,
1129d88c1a5aSDimitry Andric                         (Context, Record[1], getMDString(Record[2]), Record[3],
1130d88c1a5aSDimitry Andric                          Record[4], Record[5])),
113198221d2eSDimitry Andric         NextMetadataNo);
113298221d2eSDimitry Andric     NextMetadataNo++;
1133d88c1a5aSDimitry Andric     break;
1134d88c1a5aSDimitry Andric   }
1135d88c1a5aSDimitry Andric   case bitc::METADATA_DERIVED_TYPE: {
11367a7e6055SDimitry Andric     if (Record.size() < 12 || Record.size() > 13)
1137d88c1a5aSDimitry Andric       return error("Invalid record");
1138d88c1a5aSDimitry Andric 
11397a7e6055SDimitry Andric     // DWARF address space is encoded as N->getDWARFAddressSpace() + 1. 0 means
11407a7e6055SDimitry Andric     // that there is no DWARF address space associated with DIDerivedType.
11417a7e6055SDimitry Andric     Optional<unsigned> DWARFAddressSpace;
11427a7e6055SDimitry Andric     if (Record.size() > 12 && Record[12])
11437a7e6055SDimitry Andric       DWARFAddressSpace = Record[12] - 1;
11447a7e6055SDimitry Andric 
1145d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1146d88c1a5aSDimitry Andric     DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[10]);
1147d88c1a5aSDimitry Andric     MetadataList.assignValue(
1148d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIDerivedType,
1149d88c1a5aSDimitry Andric                         (Context, Record[1], getMDString(Record[2]),
1150d88c1a5aSDimitry Andric                          getMDOrNull(Record[3]), Record[4],
1151d88c1a5aSDimitry Andric                          getDITypeRefOrNull(Record[5]),
1152d88c1a5aSDimitry Andric                          getDITypeRefOrNull(Record[6]), Record[7], Record[8],
11537a7e6055SDimitry Andric                          Record[9], DWARFAddressSpace, Flags,
11547a7e6055SDimitry Andric                          getDITypeRefOrNull(Record[11]))),
115598221d2eSDimitry Andric         NextMetadataNo);
115698221d2eSDimitry Andric     NextMetadataNo++;
1157d88c1a5aSDimitry Andric     break;
1158d88c1a5aSDimitry Andric   }
1159d88c1a5aSDimitry Andric   case bitc::METADATA_COMPOSITE_TYPE: {
1160d88c1a5aSDimitry Andric     if (Record.size() != 16)
1161d88c1a5aSDimitry Andric       return error("Invalid record");
1162d88c1a5aSDimitry Andric 
1163d88c1a5aSDimitry Andric     // If we have a UUID and this is not a forward declaration, lookup the
1164d88c1a5aSDimitry Andric     // mapping.
1165d88c1a5aSDimitry Andric     IsDistinct = Record[0] & 0x1;
1166d88c1a5aSDimitry Andric     bool IsNotUsedInTypeRef = Record[0] >= 2;
1167d88c1a5aSDimitry Andric     unsigned Tag = Record[1];
1168d88c1a5aSDimitry Andric     MDString *Name = getMDString(Record[2]);
1169d88c1a5aSDimitry Andric     Metadata *File = getMDOrNull(Record[3]);
1170d88c1a5aSDimitry Andric     unsigned Line = Record[4];
1171d88c1a5aSDimitry Andric     Metadata *Scope = getDITypeRefOrNull(Record[5]);
1172d88c1a5aSDimitry Andric     Metadata *BaseType = nullptr;
1173d88c1a5aSDimitry Andric     uint64_t SizeInBits = Record[7];
1174d88c1a5aSDimitry Andric     if (Record[8] > (uint64_t)std::numeric_limits<uint32_t>::max())
1175d88c1a5aSDimitry Andric       return error("Alignment value is too large");
1176d88c1a5aSDimitry Andric     uint32_t AlignInBits = Record[8];
1177d88c1a5aSDimitry Andric     uint64_t OffsetInBits = 0;
1178d88c1a5aSDimitry Andric     DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[10]);
1179d88c1a5aSDimitry Andric     Metadata *Elements = nullptr;
1180d88c1a5aSDimitry Andric     unsigned RuntimeLang = Record[12];
1181d88c1a5aSDimitry Andric     Metadata *VTableHolder = nullptr;
1182d88c1a5aSDimitry Andric     Metadata *TemplateParams = nullptr;
1183d88c1a5aSDimitry Andric     auto *Identifier = getMDString(Record[15]);
1184d88c1a5aSDimitry Andric     // If this module is being parsed so that it can be ThinLTO imported
1185d88c1a5aSDimitry Andric     // into another module, composite types only need to be imported
1186d88c1a5aSDimitry Andric     // as type declarations (unless full type definitions requested).
1187d88c1a5aSDimitry Andric     // Create type declarations up front to save memory. Also, buildODRType
1188d88c1a5aSDimitry Andric     // handles the case where this is type ODRed with a definition needed
1189d88c1a5aSDimitry Andric     // by the importing module, in which case the existing definition is
1190d88c1a5aSDimitry Andric     // used.
11918e0f8b8cSDimitry Andric     if (IsImporting && !ImportFullTypeDefinitions && Identifier &&
1192d88c1a5aSDimitry Andric         (Tag == dwarf::DW_TAG_enumeration_type ||
1193d88c1a5aSDimitry Andric          Tag == dwarf::DW_TAG_class_type ||
1194d88c1a5aSDimitry Andric          Tag == dwarf::DW_TAG_structure_type ||
1195d88c1a5aSDimitry Andric          Tag == dwarf::DW_TAG_union_type)) {
1196d88c1a5aSDimitry Andric       Flags = Flags | DINode::FlagFwdDecl;
1197d88c1a5aSDimitry Andric     } else {
1198d88c1a5aSDimitry Andric       BaseType = getDITypeRefOrNull(Record[6]);
1199d88c1a5aSDimitry Andric       OffsetInBits = Record[9];
1200d88c1a5aSDimitry Andric       Elements = getMDOrNull(Record[11]);
1201d88c1a5aSDimitry Andric       VTableHolder = getDITypeRefOrNull(Record[13]);
1202d88c1a5aSDimitry Andric       TemplateParams = getMDOrNull(Record[14]);
1203d88c1a5aSDimitry Andric     }
1204d88c1a5aSDimitry Andric     DICompositeType *CT = nullptr;
1205d88c1a5aSDimitry Andric     if (Identifier)
1206d88c1a5aSDimitry Andric       CT = DICompositeType::buildODRType(
1207d88c1a5aSDimitry Andric           Context, *Identifier, Tag, Name, File, Line, Scope, BaseType,
1208d88c1a5aSDimitry Andric           SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
1209d88c1a5aSDimitry Andric           VTableHolder, TemplateParams);
1210d88c1a5aSDimitry Andric 
1211d88c1a5aSDimitry Andric     // Create a node if we didn't get a lazy ODR type.
1212d88c1a5aSDimitry Andric     if (!CT)
1213d88c1a5aSDimitry Andric       CT = GET_OR_DISTINCT(DICompositeType,
1214d88c1a5aSDimitry Andric                            (Context, Tag, Name, File, Line, Scope, BaseType,
1215d88c1a5aSDimitry Andric                             SizeInBits, AlignInBits, OffsetInBits, Flags,
1216d88c1a5aSDimitry Andric                             Elements, RuntimeLang, VTableHolder, TemplateParams,
1217d88c1a5aSDimitry Andric                             Identifier));
1218d88c1a5aSDimitry Andric     if (!IsNotUsedInTypeRef && Identifier)
1219d88c1a5aSDimitry Andric       MetadataList.addTypeRef(*Identifier, *cast<DICompositeType>(CT));
1220d88c1a5aSDimitry Andric 
122198221d2eSDimitry Andric     MetadataList.assignValue(CT, NextMetadataNo);
122298221d2eSDimitry Andric     NextMetadataNo++;
1223d88c1a5aSDimitry Andric     break;
1224d88c1a5aSDimitry Andric   }
1225d88c1a5aSDimitry Andric   case bitc::METADATA_SUBROUTINE_TYPE: {
1226d88c1a5aSDimitry Andric     if (Record.size() < 3 || Record.size() > 4)
1227d88c1a5aSDimitry Andric       return error("Invalid record");
1228d88c1a5aSDimitry Andric     bool IsOldTypeRefArray = Record[0] < 2;
1229d88c1a5aSDimitry Andric     unsigned CC = (Record.size() > 3) ? Record[3] : 0;
1230d88c1a5aSDimitry Andric 
1231d88c1a5aSDimitry Andric     IsDistinct = Record[0] & 0x1;
1232d88c1a5aSDimitry Andric     DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[1]);
1233d88c1a5aSDimitry Andric     Metadata *Types = getMDOrNull(Record[2]);
1234d88c1a5aSDimitry Andric     if (LLVM_UNLIKELY(IsOldTypeRefArray))
1235d88c1a5aSDimitry Andric       Types = MetadataList.upgradeTypeRefArray(Types);
1236d88c1a5aSDimitry Andric 
1237d88c1a5aSDimitry Andric     MetadataList.assignValue(
1238d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DISubroutineType, (Context, Flags, CC, Types)),
123998221d2eSDimitry Andric         NextMetadataNo);
124098221d2eSDimitry Andric     NextMetadataNo++;
1241d88c1a5aSDimitry Andric     break;
1242d88c1a5aSDimitry Andric   }
1243d88c1a5aSDimitry Andric 
1244d88c1a5aSDimitry Andric   case bitc::METADATA_MODULE: {
1245d88c1a5aSDimitry Andric     if (Record.size() != 6)
1246d88c1a5aSDimitry Andric       return error("Invalid record");
1247d88c1a5aSDimitry Andric 
1248d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1249d88c1a5aSDimitry Andric     MetadataList.assignValue(
1250d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIModule,
1251d88c1a5aSDimitry Andric                         (Context, getMDOrNull(Record[1]),
1252d88c1a5aSDimitry Andric                          getMDString(Record[2]), getMDString(Record[3]),
1253d88c1a5aSDimitry Andric                          getMDString(Record[4]), getMDString(Record[5]))),
125498221d2eSDimitry Andric         NextMetadataNo);
125598221d2eSDimitry Andric     NextMetadataNo++;
1256d88c1a5aSDimitry Andric     break;
1257d88c1a5aSDimitry Andric   }
1258d88c1a5aSDimitry Andric 
1259d88c1a5aSDimitry Andric   case bitc::METADATA_FILE: {
1260d88c1a5aSDimitry Andric     if (Record.size() != 3 && Record.size() != 5)
1261d88c1a5aSDimitry Andric       return error("Invalid record");
1262d88c1a5aSDimitry Andric 
1263d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1264d88c1a5aSDimitry Andric     MetadataList.assignValue(
1265d88c1a5aSDimitry Andric         GET_OR_DISTINCT(
1266d88c1a5aSDimitry Andric             DIFile,
1267d88c1a5aSDimitry Andric             (Context, getMDString(Record[1]), getMDString(Record[2]),
1268d88c1a5aSDimitry Andric              Record.size() == 3 ? DIFile::CSK_None
1269d88c1a5aSDimitry Andric                                 : static_cast<DIFile::ChecksumKind>(Record[3]),
1270d88c1a5aSDimitry Andric              Record.size() == 3 ? nullptr : getMDString(Record[4]))),
127198221d2eSDimitry Andric         NextMetadataNo);
127298221d2eSDimitry Andric     NextMetadataNo++;
1273d88c1a5aSDimitry Andric     break;
1274d88c1a5aSDimitry Andric   }
1275d88c1a5aSDimitry Andric   case bitc::METADATA_COMPILE_UNIT: {
12767a7e6055SDimitry Andric     if (Record.size() < 14 || Record.size() > 18)
1277d88c1a5aSDimitry Andric       return error("Invalid record");
1278d88c1a5aSDimitry Andric 
1279d88c1a5aSDimitry Andric     // Ignore Record[0], which indicates whether this compile unit is
1280d88c1a5aSDimitry Andric     // distinct.  It's always distinct.
1281d88c1a5aSDimitry Andric     IsDistinct = true;
1282d88c1a5aSDimitry Andric     auto *CU = DICompileUnit::getDistinct(
1283d88c1a5aSDimitry Andric         Context, Record[1], getMDOrNull(Record[2]), getMDString(Record[3]),
1284d88c1a5aSDimitry Andric         Record[4], getMDString(Record[5]), Record[6], getMDString(Record[7]),
1285d88c1a5aSDimitry Andric         Record[8], getMDOrNull(Record[9]), getMDOrNull(Record[10]),
1286d88c1a5aSDimitry Andric         getMDOrNull(Record[12]), getMDOrNull(Record[13]),
1287d88c1a5aSDimitry Andric         Record.size() <= 15 ? nullptr : getMDOrNull(Record[15]),
1288d88c1a5aSDimitry Andric         Record.size() <= 14 ? 0 : Record[14],
12897a7e6055SDimitry Andric         Record.size() <= 16 ? true : Record[16],
12907a7e6055SDimitry Andric         Record.size() <= 17 ? false : Record[17]);
1291d88c1a5aSDimitry Andric 
129298221d2eSDimitry Andric     MetadataList.assignValue(CU, NextMetadataNo);
129398221d2eSDimitry Andric     NextMetadataNo++;
1294d88c1a5aSDimitry Andric 
1295d88c1a5aSDimitry Andric     // Move the Upgrade the list of subprograms.
1296d88c1a5aSDimitry Andric     if (Metadata *SPs = getMDOrNullWithoutPlaceholders(Record[11]))
1297d88c1a5aSDimitry Andric       CUSubprograms.push_back({CU, SPs});
1298d88c1a5aSDimitry Andric     break;
1299d88c1a5aSDimitry Andric   }
1300d88c1a5aSDimitry Andric   case bitc::METADATA_SUBPROGRAM: {
1301f37b6182SDimitry Andric     if (Record.size() < 18 || Record.size() > 21)
1302d88c1a5aSDimitry Andric       return error("Invalid record");
1303d88c1a5aSDimitry Andric 
1304d88c1a5aSDimitry Andric     IsDistinct =
1305d88c1a5aSDimitry Andric         (Record[0] & 1) || Record[8]; // All definitions should be distinct.
1306d88c1a5aSDimitry Andric     // Version 1 has a Function as Record[15].
1307d88c1a5aSDimitry Andric     // Version 2 has removed Record[15].
1308d88c1a5aSDimitry Andric     // Version 3 has the Unit as Record[15].
1309d88c1a5aSDimitry Andric     // Version 4 added thisAdjustment.
1310d88c1a5aSDimitry Andric     bool HasUnit = Record[0] >= 2;
1311d88c1a5aSDimitry Andric     if (HasUnit && Record.size() < 19)
1312d88c1a5aSDimitry Andric       return error("Invalid record");
1313d88c1a5aSDimitry Andric     Metadata *CUorFn = getMDOrNull(Record[15]);
1314d88c1a5aSDimitry Andric     unsigned Offset = Record.size() >= 19 ? 1 : 0;
1315d88c1a5aSDimitry Andric     bool HasFn = Offset && !HasUnit;
1316d88c1a5aSDimitry Andric     bool HasThisAdj = Record.size() >= 20;
1317f37b6182SDimitry Andric     bool HasThrownTypes = Record.size() >= 21;
1318d88c1a5aSDimitry Andric     DISubprogram *SP = GET_OR_DISTINCT(
1319f37b6182SDimitry Andric         DISubprogram,
1320f37b6182SDimitry Andric         (Context,
1321d88c1a5aSDimitry Andric          getDITypeRefOrNull(Record[1]),                     // scope
1322d88c1a5aSDimitry Andric          getMDString(Record[2]),                            // name
1323d88c1a5aSDimitry Andric          getMDString(Record[3]),                            // linkageName
1324d88c1a5aSDimitry Andric          getMDOrNull(Record[4]),                            // file
1325d88c1a5aSDimitry Andric          Record[5],                                         // line
1326d88c1a5aSDimitry Andric          getMDOrNull(Record[6]),                            // type
1327d88c1a5aSDimitry Andric          Record[7],                                         // isLocal
1328d88c1a5aSDimitry Andric          Record[8],                                         // isDefinition
1329d88c1a5aSDimitry Andric          Record[9],                                         // scopeLine
1330d88c1a5aSDimitry Andric          getDITypeRefOrNull(Record[10]),                    // containingType
1331d88c1a5aSDimitry Andric          Record[11],                                        // virtuality
1332d88c1a5aSDimitry Andric          Record[12],                                        // virtualIndex
1333d88c1a5aSDimitry Andric          HasThisAdj ? Record[19] : 0,                       // thisAdjustment
1334f37b6182SDimitry Andric          static_cast<DINode::DIFlags>(Record[13]),          // flags
1335d88c1a5aSDimitry Andric          Record[14],                                        // isOptimized
1336d88c1a5aSDimitry Andric          HasUnit ? CUorFn : nullptr,                        // unit
1337d88c1a5aSDimitry Andric          getMDOrNull(Record[15 + Offset]),                  // templateParams
1338d88c1a5aSDimitry Andric          getMDOrNull(Record[16 + Offset]),                  // declaration
1339f37b6182SDimitry Andric          getMDOrNull(Record[17 + Offset]),                  // variables
1340f37b6182SDimitry Andric          HasThrownTypes ? getMDOrNull(Record[20]) : nullptr // thrownTypes
1341d88c1a5aSDimitry Andric          ));
134298221d2eSDimitry Andric     MetadataList.assignValue(SP, NextMetadataNo);
134398221d2eSDimitry Andric     NextMetadataNo++;
1344d88c1a5aSDimitry Andric 
1345d88c1a5aSDimitry Andric     // Upgrade sp->function mapping to function->sp mapping.
1346d88c1a5aSDimitry Andric     if (HasFn) {
1347d88c1a5aSDimitry Andric       if (auto *CMD = dyn_cast_or_null<ConstantAsMetadata>(CUorFn))
1348d88c1a5aSDimitry Andric         if (auto *F = dyn_cast<Function>(CMD->getValue())) {
1349d88c1a5aSDimitry Andric           if (F->isMaterializable())
1350d88c1a5aSDimitry Andric             // Defer until materialized; unmaterialized functions may not have
1351d88c1a5aSDimitry Andric             // metadata.
1352d88c1a5aSDimitry Andric             FunctionsWithSPs[F] = SP;
1353d88c1a5aSDimitry Andric           else if (!F->empty())
1354d88c1a5aSDimitry Andric             F->setSubprogram(SP);
1355d88c1a5aSDimitry Andric         }
1356d88c1a5aSDimitry Andric     }
1357d88c1a5aSDimitry Andric     break;
1358d88c1a5aSDimitry Andric   }
1359d88c1a5aSDimitry Andric   case bitc::METADATA_LEXICAL_BLOCK: {
1360d88c1a5aSDimitry Andric     if (Record.size() != 5)
1361d88c1a5aSDimitry Andric       return error("Invalid record");
1362d88c1a5aSDimitry Andric 
1363d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1364d88c1a5aSDimitry Andric     MetadataList.assignValue(
1365d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DILexicalBlock,
1366d88c1a5aSDimitry Andric                         (Context, getMDOrNull(Record[1]),
1367d88c1a5aSDimitry Andric                          getMDOrNull(Record[2]), Record[3], Record[4])),
136898221d2eSDimitry Andric         NextMetadataNo);
136998221d2eSDimitry Andric     NextMetadataNo++;
1370d88c1a5aSDimitry Andric     break;
1371d88c1a5aSDimitry Andric   }
1372d88c1a5aSDimitry Andric   case bitc::METADATA_LEXICAL_BLOCK_FILE: {
1373d88c1a5aSDimitry Andric     if (Record.size() != 4)
1374d88c1a5aSDimitry Andric       return error("Invalid record");
1375d88c1a5aSDimitry Andric 
1376d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1377d88c1a5aSDimitry Andric     MetadataList.assignValue(
1378d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DILexicalBlockFile,
1379d88c1a5aSDimitry Andric                         (Context, getMDOrNull(Record[1]),
1380d88c1a5aSDimitry Andric                          getMDOrNull(Record[2]), Record[3])),
138198221d2eSDimitry Andric         NextMetadataNo);
138298221d2eSDimitry Andric     NextMetadataNo++;
1383d88c1a5aSDimitry Andric     break;
1384d88c1a5aSDimitry Andric   }
1385d88c1a5aSDimitry Andric   case bitc::METADATA_NAMESPACE: {
1386f37b6182SDimitry Andric     // Newer versions of DINamespace dropped file and line.
1387f37b6182SDimitry Andric     MDString *Name;
1388f37b6182SDimitry Andric     if (Record.size() == 3)
1389f37b6182SDimitry Andric       Name = getMDString(Record[2]);
1390f37b6182SDimitry Andric     else if (Record.size() == 5)
1391f37b6182SDimitry Andric       Name = getMDString(Record[3]);
1392f37b6182SDimitry Andric     else
1393d88c1a5aSDimitry Andric       return error("Invalid record");
1394d88c1a5aSDimitry Andric 
1395d88c1a5aSDimitry Andric     IsDistinct = Record[0] & 1;
1396d88c1a5aSDimitry Andric     bool ExportSymbols = Record[0] & 2;
1397d88c1a5aSDimitry Andric     MetadataList.assignValue(
1398d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DINamespace,
1399f37b6182SDimitry Andric                         (Context, getMDOrNull(Record[1]), Name, ExportSymbols)),
140098221d2eSDimitry Andric         NextMetadataNo);
140198221d2eSDimitry Andric     NextMetadataNo++;
1402d88c1a5aSDimitry Andric     break;
1403d88c1a5aSDimitry Andric   }
1404d88c1a5aSDimitry Andric   case bitc::METADATA_MACRO: {
1405d88c1a5aSDimitry Andric     if (Record.size() != 5)
1406d88c1a5aSDimitry Andric       return error("Invalid record");
1407d88c1a5aSDimitry Andric 
1408d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1409d88c1a5aSDimitry Andric     MetadataList.assignValue(
1410d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIMacro,
1411d88c1a5aSDimitry Andric                         (Context, Record[1], Record[2], getMDString(Record[3]),
1412d88c1a5aSDimitry Andric                          getMDString(Record[4]))),
141398221d2eSDimitry Andric         NextMetadataNo);
141498221d2eSDimitry Andric     NextMetadataNo++;
1415d88c1a5aSDimitry Andric     break;
1416d88c1a5aSDimitry Andric   }
1417d88c1a5aSDimitry Andric   case bitc::METADATA_MACRO_FILE: {
1418d88c1a5aSDimitry Andric     if (Record.size() != 5)
1419d88c1a5aSDimitry Andric       return error("Invalid record");
1420d88c1a5aSDimitry Andric 
1421d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1422d88c1a5aSDimitry Andric     MetadataList.assignValue(
1423d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIMacroFile,
1424d88c1a5aSDimitry Andric                         (Context, Record[1], Record[2], getMDOrNull(Record[3]),
1425d88c1a5aSDimitry Andric                          getMDOrNull(Record[4]))),
142698221d2eSDimitry Andric         NextMetadataNo);
142798221d2eSDimitry Andric     NextMetadataNo++;
1428d88c1a5aSDimitry Andric     break;
1429d88c1a5aSDimitry Andric   }
1430d88c1a5aSDimitry Andric   case bitc::METADATA_TEMPLATE_TYPE: {
1431d88c1a5aSDimitry Andric     if (Record.size() != 3)
1432d88c1a5aSDimitry Andric       return error("Invalid record");
1433d88c1a5aSDimitry Andric 
1434d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1435d88c1a5aSDimitry Andric     MetadataList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter,
1436d88c1a5aSDimitry Andric                                              (Context, getMDString(Record[1]),
1437d88c1a5aSDimitry Andric                                               getDITypeRefOrNull(Record[2]))),
143898221d2eSDimitry Andric                              NextMetadataNo);
143998221d2eSDimitry Andric     NextMetadataNo++;
1440d88c1a5aSDimitry Andric     break;
1441d88c1a5aSDimitry Andric   }
1442d88c1a5aSDimitry Andric   case bitc::METADATA_TEMPLATE_VALUE: {
1443d88c1a5aSDimitry Andric     if (Record.size() != 5)
1444d88c1a5aSDimitry Andric       return error("Invalid record");
1445d88c1a5aSDimitry Andric 
1446d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1447d88c1a5aSDimitry Andric     MetadataList.assignValue(
1448d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DITemplateValueParameter,
1449d88c1a5aSDimitry Andric                         (Context, Record[1], getMDString(Record[2]),
1450d88c1a5aSDimitry Andric                          getDITypeRefOrNull(Record[3]),
1451d88c1a5aSDimitry Andric                          getMDOrNull(Record[4]))),
145298221d2eSDimitry Andric         NextMetadataNo);
145398221d2eSDimitry Andric     NextMetadataNo++;
1454d88c1a5aSDimitry Andric     break;
1455d88c1a5aSDimitry Andric   }
1456d88c1a5aSDimitry Andric   case bitc::METADATA_GLOBAL_VAR: {
1457d88c1a5aSDimitry Andric     if (Record.size() < 11 || Record.size() > 12)
1458d88c1a5aSDimitry Andric       return error("Invalid record");
1459d88c1a5aSDimitry Andric 
1460d88c1a5aSDimitry Andric     IsDistinct = Record[0] & 1;
1461d88c1a5aSDimitry Andric     unsigned Version = Record[0] >> 1;
1462d88c1a5aSDimitry Andric 
1463d88c1a5aSDimitry Andric     if (Version == 1) {
1464d88c1a5aSDimitry Andric       MetadataList.assignValue(
1465d88c1a5aSDimitry Andric           GET_OR_DISTINCT(DIGlobalVariable,
1466d88c1a5aSDimitry Andric                           (Context, getMDOrNull(Record[1]),
1467d88c1a5aSDimitry Andric                            getMDString(Record[2]), getMDString(Record[3]),
1468d88c1a5aSDimitry Andric                            getMDOrNull(Record[4]), Record[5],
1469d88c1a5aSDimitry Andric                            getDITypeRefOrNull(Record[6]), Record[7], Record[8],
1470d88c1a5aSDimitry Andric                            getMDOrNull(Record[10]), Record[11])),
147198221d2eSDimitry Andric           NextMetadataNo);
147298221d2eSDimitry Andric       NextMetadataNo++;
1473d88c1a5aSDimitry Andric     } else if (Version == 0) {
1474d88c1a5aSDimitry Andric       // Upgrade old metadata, which stored a global variable reference or a
1475d88c1a5aSDimitry Andric       // ConstantInt here.
14767a7e6055SDimitry Andric       NeedUpgradeToDIGlobalVariableExpression = true;
1477d88c1a5aSDimitry Andric       Metadata *Expr = getMDOrNull(Record[9]);
1478d88c1a5aSDimitry Andric       uint32_t AlignInBits = 0;
1479d88c1a5aSDimitry Andric       if (Record.size() > 11) {
1480d88c1a5aSDimitry Andric         if (Record[11] > (uint64_t)std::numeric_limits<uint32_t>::max())
1481d88c1a5aSDimitry Andric           return error("Alignment value is too large");
1482d88c1a5aSDimitry Andric         AlignInBits = Record[11];
1483d88c1a5aSDimitry Andric       }
1484d88c1a5aSDimitry Andric       GlobalVariable *Attach = nullptr;
1485d88c1a5aSDimitry Andric       if (auto *CMD = dyn_cast_or_null<ConstantAsMetadata>(Expr)) {
1486d88c1a5aSDimitry Andric         if (auto *GV = dyn_cast<GlobalVariable>(CMD->getValue())) {
1487d88c1a5aSDimitry Andric           Attach = GV;
1488d88c1a5aSDimitry Andric           Expr = nullptr;
1489d88c1a5aSDimitry Andric         } else if (auto *CI = dyn_cast<ConstantInt>(CMD->getValue())) {
1490d88c1a5aSDimitry Andric           Expr = DIExpression::get(Context,
1491d88c1a5aSDimitry Andric                                    {dwarf::DW_OP_constu, CI->getZExtValue(),
1492d88c1a5aSDimitry Andric                                     dwarf::DW_OP_stack_value});
1493d88c1a5aSDimitry Andric         } else {
1494d88c1a5aSDimitry Andric           Expr = nullptr;
1495d88c1a5aSDimitry Andric         }
1496d88c1a5aSDimitry Andric       }
1497d88c1a5aSDimitry Andric       DIGlobalVariable *DGV = GET_OR_DISTINCT(
1498d88c1a5aSDimitry Andric           DIGlobalVariable,
1499d88c1a5aSDimitry Andric           (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
1500d88c1a5aSDimitry Andric            getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
1501d88c1a5aSDimitry Andric            getDITypeRefOrNull(Record[6]), Record[7], Record[8],
1502d88c1a5aSDimitry Andric            getMDOrNull(Record[10]), AlignInBits));
1503d88c1a5aSDimitry Andric 
15045ca5951eSDimitry Andric       DIGlobalVariableExpression *DGVE = nullptr;
15055ca5951eSDimitry Andric       if (Attach || Expr)
15065ca5951eSDimitry Andric         DGVE = DIGlobalVariableExpression::getDistinct(Context, DGV, Expr);
1507d88c1a5aSDimitry Andric       if (Attach)
1508d88c1a5aSDimitry Andric         Attach->addDebugInfo(DGVE);
15095ca5951eSDimitry Andric 
15105ca5951eSDimitry Andric       auto *MDNode = Expr ? cast<Metadata>(DGVE) : cast<Metadata>(DGV);
15115ca5951eSDimitry Andric       MetadataList.assignValue(MDNode, NextMetadataNo);
15125ca5951eSDimitry Andric       NextMetadataNo++;
1513d88c1a5aSDimitry Andric     } else
1514d88c1a5aSDimitry Andric       return error("Invalid record");
1515d88c1a5aSDimitry Andric 
1516d88c1a5aSDimitry Andric     break;
1517d88c1a5aSDimitry Andric   }
1518d88c1a5aSDimitry Andric   case bitc::METADATA_LOCAL_VAR: {
1519d88c1a5aSDimitry Andric     // 10th field is for the obseleted 'inlinedAt:' field.
1520d88c1a5aSDimitry Andric     if (Record.size() < 8 || Record.size() > 10)
1521d88c1a5aSDimitry Andric       return error("Invalid record");
1522d88c1a5aSDimitry Andric 
1523d88c1a5aSDimitry Andric     IsDistinct = Record[0] & 1;
1524d88c1a5aSDimitry Andric     bool HasAlignment = Record[0] & 2;
1525d88c1a5aSDimitry Andric     // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or
1526d88c1a5aSDimitry Andric     // DW_TAG_arg_variable, if we have alignment flag encoded it means, that
15277a7e6055SDimitry Andric     // this is newer version of record which doesn't have artificial tag.
1528d88c1a5aSDimitry Andric     bool HasTag = !HasAlignment && Record.size() > 8;
1529d88c1a5aSDimitry Andric     DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[7 + HasTag]);
1530d88c1a5aSDimitry Andric     uint32_t AlignInBits = 0;
1531d88c1a5aSDimitry Andric     if (HasAlignment) {
1532d88c1a5aSDimitry Andric       if (Record[8 + HasTag] > (uint64_t)std::numeric_limits<uint32_t>::max())
1533d88c1a5aSDimitry Andric         return error("Alignment value is too large");
1534d88c1a5aSDimitry Andric       AlignInBits = Record[8 + HasTag];
1535d88c1a5aSDimitry Andric     }
1536d88c1a5aSDimitry Andric     MetadataList.assignValue(
1537d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DILocalVariable,
1538d88c1a5aSDimitry Andric                         (Context, getMDOrNull(Record[1 + HasTag]),
1539d88c1a5aSDimitry Andric                          getMDString(Record[2 + HasTag]),
1540d88c1a5aSDimitry Andric                          getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag],
1541d88c1a5aSDimitry Andric                          getDITypeRefOrNull(Record[5 + HasTag]),
1542d88c1a5aSDimitry Andric                          Record[6 + HasTag], Flags, AlignInBits)),
154398221d2eSDimitry Andric         NextMetadataNo);
154498221d2eSDimitry Andric     NextMetadataNo++;
1545d88c1a5aSDimitry Andric     break;
1546d88c1a5aSDimitry Andric   }
1547d88c1a5aSDimitry Andric   case bitc::METADATA_EXPRESSION: {
1548d88c1a5aSDimitry Andric     if (Record.size() < 1)
1549d88c1a5aSDimitry Andric       return error("Invalid record");
1550d88c1a5aSDimitry Andric 
1551d88c1a5aSDimitry Andric     IsDistinct = Record[0] & 1;
15526bc11b14SDimitry Andric     uint64_t Version = Record[0] >> 1;
1553d88c1a5aSDimitry Andric     auto Elts = MutableArrayRef<uint64_t>(Record).slice(1);
15546bc11b14SDimitry Andric     unsigned N = Elts.size();
15556bc11b14SDimitry Andric     // Perform various upgrades.
15566bc11b14SDimitry Andric     switch (Version) {
15576bc11b14SDimitry Andric     case 0:
1558d88c1a5aSDimitry Andric       if (N >= 3 && Elts[N - 3] == dwarf::DW_OP_bit_piece)
1559d88c1a5aSDimitry Andric         Elts[N - 3] = dwarf::DW_OP_LLVM_fragment;
15606bc11b14SDimitry Andric       LLVM_FALLTHROUGH;
15616bc11b14SDimitry Andric     case 1:
15626bc11b14SDimitry Andric       // Move DW_OP_deref to the end.
15636bc11b14SDimitry Andric       if (N && Elts[0] == dwarf::DW_OP_deref) {
15646bc11b14SDimitry Andric         auto End = Elts.end();
15656bc11b14SDimitry Andric         if (Elts.size() >= 3 && *std::prev(End, 3) == dwarf::DW_OP_LLVM_fragment)
15666bc11b14SDimitry Andric           End = std::prev(End, 3);
15676bc11b14SDimitry Andric         std::move(std::next(Elts.begin()), End, Elts.begin());
15686bc11b14SDimitry Andric         *std::prev(End) = dwarf::DW_OP_deref;
15696bc11b14SDimitry Andric       }
15706bc11b14SDimitry Andric       NeedDeclareExpressionUpgrade = true;
15716bc11b14SDimitry Andric       LLVM_FALLTHROUGH;
15726bc11b14SDimitry Andric     case 2:
15736bc11b14SDimitry Andric       // Up-to-date!
15746bc11b14SDimitry Andric       break;
15756bc11b14SDimitry Andric     default:
15766bc11b14SDimitry Andric       return error("Invalid record");
15776bc11b14SDimitry Andric     }
1578d88c1a5aSDimitry Andric 
1579d88c1a5aSDimitry Andric     MetadataList.assignValue(
1580d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIExpression, (Context, makeArrayRef(Record).slice(1))),
158198221d2eSDimitry Andric         NextMetadataNo);
158298221d2eSDimitry Andric     NextMetadataNo++;
1583d88c1a5aSDimitry Andric     break;
1584d88c1a5aSDimitry Andric   }
1585d88c1a5aSDimitry Andric   case bitc::METADATA_GLOBAL_VAR_EXPR: {
1586d88c1a5aSDimitry Andric     if (Record.size() != 3)
1587d88c1a5aSDimitry Andric       return error("Invalid record");
1588d88c1a5aSDimitry Andric 
1589d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1590d88c1a5aSDimitry Andric     MetadataList.assignValue(GET_OR_DISTINCT(DIGlobalVariableExpression,
1591d88c1a5aSDimitry Andric                                              (Context, getMDOrNull(Record[1]),
1592d88c1a5aSDimitry Andric                                               getMDOrNull(Record[2]))),
159398221d2eSDimitry Andric                              NextMetadataNo);
159498221d2eSDimitry Andric     NextMetadataNo++;
1595d88c1a5aSDimitry Andric     break;
1596d88c1a5aSDimitry Andric   }
1597d88c1a5aSDimitry Andric   case bitc::METADATA_OBJC_PROPERTY: {
1598d88c1a5aSDimitry Andric     if (Record.size() != 8)
1599d88c1a5aSDimitry Andric       return error("Invalid record");
1600d88c1a5aSDimitry Andric 
1601d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1602d88c1a5aSDimitry Andric     MetadataList.assignValue(
1603d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIObjCProperty,
1604d88c1a5aSDimitry Andric                         (Context, getMDString(Record[1]),
1605d88c1a5aSDimitry Andric                          getMDOrNull(Record[2]), Record[3],
1606d88c1a5aSDimitry Andric                          getMDString(Record[4]), getMDString(Record[5]),
1607d88c1a5aSDimitry Andric                          Record[6], getDITypeRefOrNull(Record[7]))),
160898221d2eSDimitry Andric         NextMetadataNo);
160998221d2eSDimitry Andric     NextMetadataNo++;
1610d88c1a5aSDimitry Andric     break;
1611d88c1a5aSDimitry Andric   }
1612d88c1a5aSDimitry Andric   case bitc::METADATA_IMPORTED_ENTITY: {
1613d88c1a5aSDimitry Andric     if (Record.size() != 6)
1614d88c1a5aSDimitry Andric       return error("Invalid record");
1615d88c1a5aSDimitry Andric 
1616d88c1a5aSDimitry Andric     IsDistinct = Record[0];
1617d88c1a5aSDimitry Andric     MetadataList.assignValue(
1618d88c1a5aSDimitry Andric         GET_OR_DISTINCT(DIImportedEntity,
1619d88c1a5aSDimitry Andric                         (Context, Record[1], getMDOrNull(Record[2]),
1620d88c1a5aSDimitry Andric                          getDITypeRefOrNull(Record[3]), Record[4],
1621d88c1a5aSDimitry Andric                          getMDString(Record[5]))),
162298221d2eSDimitry Andric         NextMetadataNo);
162398221d2eSDimitry Andric     NextMetadataNo++;
1624d88c1a5aSDimitry Andric     break;
1625d88c1a5aSDimitry Andric   }
1626d88c1a5aSDimitry Andric   case bitc::METADATA_STRING_OLD: {
1627d88c1a5aSDimitry Andric     std::string String(Record.begin(), Record.end());
1628d88c1a5aSDimitry Andric 
1629d88c1a5aSDimitry Andric     // Test for upgrading !llvm.loop.
1630d88c1a5aSDimitry Andric     HasSeenOldLoopTags |= mayBeOldLoopAttachmentTag(String);
163195ec533aSDimitry Andric     ++NumMDStringLoaded;
1632d88c1a5aSDimitry Andric     Metadata *MD = MDString::get(Context, String);
163398221d2eSDimitry Andric     MetadataList.assignValue(MD, NextMetadataNo);
163498221d2eSDimitry Andric     NextMetadataNo++;
1635d88c1a5aSDimitry Andric     break;
1636d88c1a5aSDimitry Andric   }
163795ec533aSDimitry Andric   case bitc::METADATA_STRINGS: {
163895ec533aSDimitry Andric     auto CreateNextMDString = [&](StringRef Str) {
163995ec533aSDimitry Andric       ++NumMDStringLoaded;
164098221d2eSDimitry Andric       MetadataList.assignValue(MDString::get(Context, Str), NextMetadataNo);
164198221d2eSDimitry Andric       NextMetadataNo++;
164295ec533aSDimitry Andric     };
164395ec533aSDimitry Andric     if (Error Err = parseMetadataStrings(Record, Blob, CreateNextMDString))
1644d88c1a5aSDimitry Andric       return Err;
1645d88c1a5aSDimitry Andric     break;
164695ec533aSDimitry Andric   }
1647d88c1a5aSDimitry Andric   case bitc::METADATA_GLOBAL_DECL_ATTACHMENT: {
1648d88c1a5aSDimitry Andric     if (Record.size() % 2 == 0)
1649d88c1a5aSDimitry Andric       return error("Invalid record");
1650d88c1a5aSDimitry Andric     unsigned ValueID = Record[0];
1651d88c1a5aSDimitry Andric     if (ValueID >= ValueList.size())
1652d88c1a5aSDimitry Andric       return error("Invalid record");
1653d88c1a5aSDimitry Andric     if (auto *GO = dyn_cast<GlobalObject>(ValueList[ValueID]))
1654d88c1a5aSDimitry Andric       if (Error Err = parseGlobalObjectAttachment(
1655d88c1a5aSDimitry Andric               *GO, ArrayRef<uint64_t>(Record).slice(1)))
1656d88c1a5aSDimitry Andric         return Err;
1657d88c1a5aSDimitry Andric     break;
1658d88c1a5aSDimitry Andric   }
1659d88c1a5aSDimitry Andric   case bitc::METADATA_KIND: {
1660d88c1a5aSDimitry Andric     // Support older bitcode files that had METADATA_KIND records in a
1661d88c1a5aSDimitry Andric     // block with METADATA_BLOCK_ID.
1662d88c1a5aSDimitry Andric     if (Error Err = parseMetadataKindRecord(Record))
1663d88c1a5aSDimitry Andric       return Err;
1664d88c1a5aSDimitry Andric     break;
1665d88c1a5aSDimitry Andric   }
1666d88c1a5aSDimitry Andric   }
1667d88c1a5aSDimitry Andric   return Error::success();
166895ec533aSDimitry Andric #undef GET_OR_DISTINCT
1669d88c1a5aSDimitry Andric }
1670d88c1a5aSDimitry Andric 
1671d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseMetadataStrings(
167295ec533aSDimitry Andric     ArrayRef<uint64_t> Record, StringRef Blob,
16737a7e6055SDimitry Andric     function_ref<void(StringRef)> CallBack) {
1674d88c1a5aSDimitry Andric   // All the MDStrings in the block are emitted together in a single
1675d88c1a5aSDimitry Andric   // record.  The strings are concatenated and stored in a blob along with
1676d88c1a5aSDimitry Andric   // their sizes.
1677d88c1a5aSDimitry Andric   if (Record.size() != 2)
1678d88c1a5aSDimitry Andric     return error("Invalid record: metadata strings layout");
1679d88c1a5aSDimitry Andric 
1680d88c1a5aSDimitry Andric   unsigned NumStrings = Record[0];
1681d88c1a5aSDimitry Andric   unsigned StringsOffset = Record[1];
1682d88c1a5aSDimitry Andric   if (!NumStrings)
1683d88c1a5aSDimitry Andric     return error("Invalid record: metadata strings with no strings");
1684d88c1a5aSDimitry Andric   if (StringsOffset > Blob.size())
1685d88c1a5aSDimitry Andric     return error("Invalid record: metadata strings corrupt offset");
1686d88c1a5aSDimitry Andric 
1687d88c1a5aSDimitry Andric   StringRef Lengths = Blob.slice(0, StringsOffset);
1688d88c1a5aSDimitry Andric   SimpleBitstreamCursor R(Lengths);
1689d88c1a5aSDimitry Andric 
1690d88c1a5aSDimitry Andric   StringRef Strings = Blob.drop_front(StringsOffset);
1691d88c1a5aSDimitry Andric   do {
1692d88c1a5aSDimitry Andric     if (R.AtEndOfStream())
1693d88c1a5aSDimitry Andric       return error("Invalid record: metadata strings bad length");
1694d88c1a5aSDimitry Andric 
1695d88c1a5aSDimitry Andric     unsigned Size = R.ReadVBR(6);
1696d88c1a5aSDimitry Andric     if (Strings.size() < Size)
1697d88c1a5aSDimitry Andric       return error("Invalid record: metadata strings truncated chars");
1698d88c1a5aSDimitry Andric 
169995ec533aSDimitry Andric     CallBack(Strings.slice(0, Size));
1700d88c1a5aSDimitry Andric     Strings = Strings.drop_front(Size);
1701d88c1a5aSDimitry Andric   } while (--NumStrings);
1702d88c1a5aSDimitry Andric 
1703d88c1a5aSDimitry Andric   return Error::success();
1704d88c1a5aSDimitry Andric }
1705d88c1a5aSDimitry Andric 
1706d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseGlobalObjectAttachment(
1707d88c1a5aSDimitry Andric     GlobalObject &GO, ArrayRef<uint64_t> Record) {
1708d88c1a5aSDimitry Andric   assert(Record.size() % 2 == 0);
1709d88c1a5aSDimitry Andric   for (unsigned I = 0, E = Record.size(); I != E; I += 2) {
1710d88c1a5aSDimitry Andric     auto K = MDKindMap.find(Record[I]);
1711d88c1a5aSDimitry Andric     if (K == MDKindMap.end())
1712d88c1a5aSDimitry Andric       return error("Invalid ID");
1713d88c1a5aSDimitry Andric     MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[I + 1]);
1714d88c1a5aSDimitry Andric     if (!MD)
1715d88c1a5aSDimitry Andric       return error("Invalid metadata attachment");
1716d88c1a5aSDimitry Andric     GO.addMetadata(K->second, *MD);
1717d88c1a5aSDimitry Andric   }
1718d88c1a5aSDimitry Andric   return Error::success();
1719d88c1a5aSDimitry Andric }
1720d88c1a5aSDimitry Andric 
1721d88c1a5aSDimitry Andric /// Parse metadata attachments.
1722d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseMetadataAttachment(
1723d88c1a5aSDimitry Andric     Function &F, const SmallVectorImpl<Instruction *> &InstructionList) {
1724d88c1a5aSDimitry Andric   if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
1725d88c1a5aSDimitry Andric     return error("Invalid record");
1726d88c1a5aSDimitry Andric 
1727d88c1a5aSDimitry Andric   SmallVector<uint64_t, 64> Record;
172895ec533aSDimitry Andric   PlaceholderQueue Placeholders;
172995ec533aSDimitry Andric 
1730d88c1a5aSDimitry Andric   while (true) {
1731d88c1a5aSDimitry Andric     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1732d88c1a5aSDimitry Andric 
1733d88c1a5aSDimitry Andric     switch (Entry.Kind) {
1734d88c1a5aSDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1735d88c1a5aSDimitry Andric     case BitstreamEntry::Error:
1736d88c1a5aSDimitry Andric       return error("Malformed block");
1737d88c1a5aSDimitry Andric     case BitstreamEntry::EndBlock:
173895ec533aSDimitry Andric       resolveForwardRefsAndPlaceholders(Placeholders);
1739d88c1a5aSDimitry Andric       return Error::success();
1740d88c1a5aSDimitry Andric     case BitstreamEntry::Record:
1741d88c1a5aSDimitry Andric       // The interesting case.
1742d88c1a5aSDimitry Andric       break;
1743d88c1a5aSDimitry Andric     }
1744d88c1a5aSDimitry Andric 
1745d88c1a5aSDimitry Andric     // Read a metadata attachment record.
1746d88c1a5aSDimitry Andric     Record.clear();
174795ec533aSDimitry Andric     ++NumMDRecordLoaded;
1748d88c1a5aSDimitry Andric     switch (Stream.readRecord(Entry.ID, Record)) {
1749d88c1a5aSDimitry Andric     default: // Default behavior: ignore.
1750d88c1a5aSDimitry Andric       break;
1751d88c1a5aSDimitry Andric     case bitc::METADATA_ATTACHMENT: {
1752d88c1a5aSDimitry Andric       unsigned RecordLength = Record.size();
1753d88c1a5aSDimitry Andric       if (Record.empty())
1754d88c1a5aSDimitry Andric         return error("Invalid record");
1755d88c1a5aSDimitry Andric       if (RecordLength % 2 == 0) {
1756d88c1a5aSDimitry Andric         // A function attachment.
1757d88c1a5aSDimitry Andric         if (Error Err = parseGlobalObjectAttachment(F, Record))
1758d88c1a5aSDimitry Andric           return Err;
1759d88c1a5aSDimitry Andric         continue;
1760d88c1a5aSDimitry Andric       }
1761d88c1a5aSDimitry Andric 
1762d88c1a5aSDimitry Andric       // An instruction attachment.
1763d88c1a5aSDimitry Andric       Instruction *Inst = InstructionList[Record[0]];
1764d88c1a5aSDimitry Andric       for (unsigned i = 1; i != RecordLength; i = i + 2) {
1765d88c1a5aSDimitry Andric         unsigned Kind = Record[i];
1766d88c1a5aSDimitry Andric         DenseMap<unsigned, unsigned>::iterator I = MDKindMap.find(Kind);
1767d88c1a5aSDimitry Andric         if (I == MDKindMap.end())
1768d88c1a5aSDimitry Andric           return error("Invalid ID");
1769d88c1a5aSDimitry Andric         if (I->second == LLVMContext::MD_tbaa && StripTBAA)
1770d88c1a5aSDimitry Andric           continue;
1771d88c1a5aSDimitry Andric 
177295ec533aSDimitry Andric         auto Idx = Record[i + 1];
177395ec533aSDimitry Andric         if (Idx < (MDStringRef.size() + GlobalMetadataBitPosIndex.size()) &&
177424e2fe98SDimitry Andric             !MetadataList.lookup(Idx)) {
177595ec533aSDimitry Andric           // Load the attachment if it is in the lazy-loadable range and hasn't
177695ec533aSDimitry Andric           // been loaded yet.
177795ec533aSDimitry Andric           lazyLoadOneMetadata(Idx, Placeholders);
177824e2fe98SDimitry Andric           resolveForwardRefsAndPlaceholders(Placeholders);
177924e2fe98SDimitry Andric         }
178095ec533aSDimitry Andric 
178195ec533aSDimitry Andric         Metadata *Node = MetadataList.getMetadataFwdRef(Idx);
1782d88c1a5aSDimitry Andric         if (isa<LocalAsMetadata>(Node))
1783d88c1a5aSDimitry Andric           // Drop the attachment.  This used to be legal, but there's no
1784d88c1a5aSDimitry Andric           // upgrade path.
1785d88c1a5aSDimitry Andric           break;
1786d88c1a5aSDimitry Andric         MDNode *MD = dyn_cast_or_null<MDNode>(Node);
1787d88c1a5aSDimitry Andric         if (!MD)
1788d88c1a5aSDimitry Andric           return error("Invalid metadata attachment");
1789d88c1a5aSDimitry Andric 
1790d88c1a5aSDimitry Andric         if (HasSeenOldLoopTags && I->second == LLVMContext::MD_loop)
1791d88c1a5aSDimitry Andric           MD = upgradeInstructionLoopAttachment(*MD);
1792d88c1a5aSDimitry Andric 
1793d88c1a5aSDimitry Andric         if (I->second == LLVMContext::MD_tbaa) {
1794d88c1a5aSDimitry Andric           assert(!MD->isTemporary() && "should load MDs before attachments");
1795d88c1a5aSDimitry Andric           MD = UpgradeTBAANode(*MD);
1796d88c1a5aSDimitry Andric         }
1797d88c1a5aSDimitry Andric         Inst->setMetadata(I->second, MD);
1798d88c1a5aSDimitry Andric       }
1799d88c1a5aSDimitry Andric       break;
1800d88c1a5aSDimitry Andric     }
1801d88c1a5aSDimitry Andric     }
1802d88c1a5aSDimitry Andric   }
1803d88c1a5aSDimitry Andric }
1804d88c1a5aSDimitry Andric 
1805d88c1a5aSDimitry Andric /// Parse a single METADATA_KIND record, inserting result in MDKindMap.
1806d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseMetadataKindRecord(
1807d88c1a5aSDimitry Andric     SmallVectorImpl<uint64_t> &Record) {
1808d88c1a5aSDimitry Andric   if (Record.size() < 2)
1809d88c1a5aSDimitry Andric     return error("Invalid record");
1810d88c1a5aSDimitry Andric 
1811d88c1a5aSDimitry Andric   unsigned Kind = Record[0];
1812d88c1a5aSDimitry Andric   SmallString<8> Name(Record.begin() + 1, Record.end());
1813d88c1a5aSDimitry Andric 
1814d88c1a5aSDimitry Andric   unsigned NewKind = TheModule.getMDKindID(Name.str());
1815d88c1a5aSDimitry Andric   if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1816d88c1a5aSDimitry Andric     return error("Conflicting METADATA_KIND records");
1817d88c1a5aSDimitry Andric   return Error::success();
1818d88c1a5aSDimitry Andric }
1819d88c1a5aSDimitry Andric 
1820d88c1a5aSDimitry Andric /// Parse the metadata kinds out of the METADATA_KIND_BLOCK.
1821d88c1a5aSDimitry Andric Error MetadataLoader::MetadataLoaderImpl::parseMetadataKinds() {
1822d88c1a5aSDimitry Andric   if (Stream.EnterSubBlock(bitc::METADATA_KIND_BLOCK_ID))
1823d88c1a5aSDimitry Andric     return error("Invalid record");
1824d88c1a5aSDimitry Andric 
1825d88c1a5aSDimitry Andric   SmallVector<uint64_t, 64> Record;
1826d88c1a5aSDimitry Andric 
1827d88c1a5aSDimitry Andric   // Read all the records.
1828d88c1a5aSDimitry Andric   while (true) {
1829d88c1a5aSDimitry Andric     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1830d88c1a5aSDimitry Andric 
1831d88c1a5aSDimitry Andric     switch (Entry.Kind) {
1832d88c1a5aSDimitry Andric     case BitstreamEntry::SubBlock: // Handled for us already.
1833d88c1a5aSDimitry Andric     case BitstreamEntry::Error:
1834d88c1a5aSDimitry Andric       return error("Malformed block");
1835d88c1a5aSDimitry Andric     case BitstreamEntry::EndBlock:
1836d88c1a5aSDimitry Andric       return Error::success();
1837d88c1a5aSDimitry Andric     case BitstreamEntry::Record:
1838d88c1a5aSDimitry Andric       // The interesting case.
1839d88c1a5aSDimitry Andric       break;
1840d88c1a5aSDimitry Andric     }
1841d88c1a5aSDimitry Andric 
1842d88c1a5aSDimitry Andric     // Read a record.
1843d88c1a5aSDimitry Andric     Record.clear();
184495ec533aSDimitry Andric     ++NumMDRecordLoaded;
1845d88c1a5aSDimitry Andric     unsigned Code = Stream.readRecord(Entry.ID, Record);
1846d88c1a5aSDimitry Andric     switch (Code) {
1847d88c1a5aSDimitry Andric     default: // Default behavior: ignore.
1848d88c1a5aSDimitry Andric       break;
1849d88c1a5aSDimitry Andric     case bitc::METADATA_KIND: {
1850d88c1a5aSDimitry Andric       if (Error Err = parseMetadataKindRecord(Record))
1851d88c1a5aSDimitry Andric         return Err;
1852d88c1a5aSDimitry Andric       break;
1853d88c1a5aSDimitry Andric     }
1854d88c1a5aSDimitry Andric     }
1855d88c1a5aSDimitry Andric   }
1856d88c1a5aSDimitry Andric }
1857d88c1a5aSDimitry Andric 
1858d88c1a5aSDimitry Andric MetadataLoader &MetadataLoader::operator=(MetadataLoader &&RHS) {
1859d88c1a5aSDimitry Andric   Pimpl = std::move(RHS.Pimpl);
1860d88c1a5aSDimitry Andric   return *this;
1861d88c1a5aSDimitry Andric }
1862d88c1a5aSDimitry Andric MetadataLoader::MetadataLoader(MetadataLoader &&RHS)
1863d88c1a5aSDimitry Andric     : Pimpl(std::move(RHS.Pimpl)) {}
1864d88c1a5aSDimitry Andric 
1865d88c1a5aSDimitry Andric MetadataLoader::~MetadataLoader() = default;
1866d88c1a5aSDimitry Andric MetadataLoader::MetadataLoader(BitstreamCursor &Stream, Module &TheModule,
1867d88c1a5aSDimitry Andric                                BitcodeReaderValueList &ValueList,
1868d88c1a5aSDimitry Andric                                bool IsImporting,
1869d88c1a5aSDimitry Andric                                std::function<Type *(unsigned)> getTypeByID)
18707a7e6055SDimitry Andric     : Pimpl(llvm::make_unique<MetadataLoaderImpl>(
18717a7e6055SDimitry Andric           Stream, TheModule, ValueList, std::move(getTypeByID), IsImporting)) {}
1872d88c1a5aSDimitry Andric 
1873d88c1a5aSDimitry Andric Error MetadataLoader::parseMetadata(bool ModuleLevel) {
1874d88c1a5aSDimitry Andric   return Pimpl->parseMetadata(ModuleLevel);
1875d88c1a5aSDimitry Andric }
1876d88c1a5aSDimitry Andric 
1877d88c1a5aSDimitry Andric bool MetadataLoader::hasFwdRefs() const { return Pimpl->hasFwdRefs(); }
1878d88c1a5aSDimitry Andric 
1879d88c1a5aSDimitry Andric /// Return the given metadata, creating a replaceable forward reference if
1880d88c1a5aSDimitry Andric /// necessary.
1881f8496407SDimitry Andric Metadata *MetadataLoader::getMetadataFwdRefOrLoad(unsigned Idx) {
1882f8496407SDimitry Andric   return Pimpl->getMetadataFwdRefOrLoad(Idx);
1883d88c1a5aSDimitry Andric }
1884d88c1a5aSDimitry Andric 
1885d88c1a5aSDimitry Andric MDNode *MetadataLoader::getMDNodeFwdRefOrNull(unsigned Idx) {
1886d88c1a5aSDimitry Andric   return Pimpl->getMDNodeFwdRefOrNull(Idx);
1887d88c1a5aSDimitry Andric }
1888d88c1a5aSDimitry Andric 
1889d88c1a5aSDimitry Andric DISubprogram *MetadataLoader::lookupSubprogramForFunction(Function *F) {
1890d88c1a5aSDimitry Andric   return Pimpl->lookupSubprogramForFunction(F);
1891d88c1a5aSDimitry Andric }
1892d88c1a5aSDimitry Andric 
1893d88c1a5aSDimitry Andric Error MetadataLoader::parseMetadataAttachment(
1894d88c1a5aSDimitry Andric     Function &F, const SmallVectorImpl<Instruction *> &InstructionList) {
1895d88c1a5aSDimitry Andric   return Pimpl->parseMetadataAttachment(F, InstructionList);
1896d88c1a5aSDimitry Andric }
1897d88c1a5aSDimitry Andric 
1898d88c1a5aSDimitry Andric Error MetadataLoader::parseMetadataKinds() {
1899d88c1a5aSDimitry Andric   return Pimpl->parseMetadataKinds();
1900d88c1a5aSDimitry Andric }
1901d88c1a5aSDimitry Andric 
1902d88c1a5aSDimitry Andric void MetadataLoader::setStripTBAA(bool StripTBAA) {
1903d88c1a5aSDimitry Andric   return Pimpl->setStripTBAA(StripTBAA);
1904d88c1a5aSDimitry Andric }
1905d88c1a5aSDimitry Andric 
1906d88c1a5aSDimitry Andric bool MetadataLoader::isStrippingTBAA() { return Pimpl->isStrippingTBAA(); }
1907d88c1a5aSDimitry Andric 
1908d88c1a5aSDimitry Andric unsigned MetadataLoader::size() const { return Pimpl->size(); }
1909d88c1a5aSDimitry Andric void MetadataLoader::shrinkTo(unsigned N) { return Pimpl->shrinkTo(N); }
19106bc11b14SDimitry Andric 
19116bc11b14SDimitry Andric void MetadataLoader::upgradeDebugIntrinsics(Function &F) {
19126bc11b14SDimitry Andric   return Pimpl->upgradeDebugIntrinsics(F);
19136bc11b14SDimitry Andric }
1914