1ef27db87SMehdi Amini //===- MetadataLoader.cpp - Internal BitcodeReader implementation ---------===//
2ef27db87SMehdi Amini //
3ef27db87SMehdi Amini //                     The LLVM Compiler Infrastructure
4ef27db87SMehdi Amini //
5ef27db87SMehdi Amini // This file is distributed under the University of Illinois Open Source
6ef27db87SMehdi Amini // License. See LICENSE.TXT for details.
7ef27db87SMehdi Amini //
8ef27db87SMehdi Amini //===----------------------------------------------------------------------===//
9ef27db87SMehdi Amini 
10ef27db87SMehdi Amini #include "MetadataLoader.h"
11ef27db87SMehdi Amini #include "ValueList.h"
12ef27db87SMehdi Amini 
13ef27db87SMehdi Amini #include "llvm/ADT/APFloat.h"
14ef27db87SMehdi Amini #include "llvm/ADT/APInt.h"
15ef27db87SMehdi Amini #include "llvm/ADT/ArrayRef.h"
16ef27db87SMehdi Amini #include "llvm/ADT/DenseMap.h"
17ef27db87SMehdi Amini #include "llvm/ADT/None.h"
18ef27db87SMehdi Amini #include "llvm/ADT/STLExtras.h"
19ef27db87SMehdi Amini #include "llvm/ADT/SmallString.h"
20ef27db87SMehdi Amini #include "llvm/ADT/SmallVector.h"
21ef27db87SMehdi Amini #include "llvm/ADT/StringRef.h"
22ef27db87SMehdi Amini #include "llvm/ADT/Triple.h"
23ef27db87SMehdi Amini #include "llvm/ADT/Twine.h"
24ef27db87SMehdi Amini #include "llvm/Bitcode/BitcodeReader.h"
25ef27db87SMehdi Amini #include "llvm/Bitcode/BitstreamReader.h"
26ef27db87SMehdi Amini #include "llvm/Bitcode/LLVMBitCodes.h"
27ef27db87SMehdi Amini #include "llvm/IR/Argument.h"
28ef27db87SMehdi Amini #include "llvm/IR/Attributes.h"
29ef27db87SMehdi Amini #include "llvm/IR/AutoUpgrade.h"
30ef27db87SMehdi Amini #include "llvm/IR/BasicBlock.h"
31ef27db87SMehdi Amini #include "llvm/IR/CallSite.h"
32ef27db87SMehdi Amini #include "llvm/IR/CallingConv.h"
33ef27db87SMehdi Amini #include "llvm/IR/Comdat.h"
34ef27db87SMehdi Amini #include "llvm/IR/Constant.h"
35ef27db87SMehdi Amini #include "llvm/IR/Constants.h"
36ef27db87SMehdi Amini #include "llvm/IR/DebugInfo.h"
37ef27db87SMehdi Amini #include "llvm/IR/DebugInfoMetadata.h"
38ef27db87SMehdi Amini #include "llvm/IR/DebugLoc.h"
39ef27db87SMehdi Amini #include "llvm/IR/DerivedTypes.h"
40ef27db87SMehdi Amini #include "llvm/IR/DiagnosticInfo.h"
41ef27db87SMehdi Amini #include "llvm/IR/DiagnosticPrinter.h"
42ef27db87SMehdi Amini #include "llvm/IR/Function.h"
43ef27db87SMehdi Amini #include "llvm/IR/GVMaterializer.h"
44ef27db87SMehdi Amini #include "llvm/IR/GlobalAlias.h"
45ef27db87SMehdi Amini #include "llvm/IR/GlobalIFunc.h"
46ef27db87SMehdi Amini #include "llvm/IR/GlobalIndirectSymbol.h"
47ef27db87SMehdi Amini #include "llvm/IR/GlobalObject.h"
48ef27db87SMehdi Amini #include "llvm/IR/GlobalValue.h"
49ef27db87SMehdi Amini #include "llvm/IR/GlobalVariable.h"
50ef27db87SMehdi Amini #include "llvm/IR/InlineAsm.h"
51ef27db87SMehdi Amini #include "llvm/IR/InstrTypes.h"
52ef27db87SMehdi Amini #include "llvm/IR/Instruction.h"
53ef27db87SMehdi Amini #include "llvm/IR/Instructions.h"
54ef27db87SMehdi Amini #include "llvm/IR/Intrinsics.h"
55ef27db87SMehdi Amini #include "llvm/IR/LLVMContext.h"
56ef27db87SMehdi Amini #include "llvm/IR/Module.h"
57ef27db87SMehdi Amini #include "llvm/IR/ModuleSummaryIndex.h"
58ef27db87SMehdi Amini #include "llvm/IR/OperandTraits.h"
59ef27db87SMehdi Amini #include "llvm/IR/Operator.h"
60ef27db87SMehdi Amini #include "llvm/IR/TrackingMDRef.h"
61ef27db87SMehdi Amini #include "llvm/IR/Type.h"
62ef27db87SMehdi Amini #include "llvm/IR/ValueHandle.h"
63ef27db87SMehdi Amini #include "llvm/Support/AtomicOrdering.h"
64ef27db87SMehdi Amini #include "llvm/Support/Casting.h"
65ef27db87SMehdi Amini #include "llvm/Support/CommandLine.h"
66ef27db87SMehdi Amini #include "llvm/Support/Compiler.h"
67ef27db87SMehdi Amini #include "llvm/Support/Debug.h"
68ef27db87SMehdi Amini #include "llvm/Support/Error.h"
69ef27db87SMehdi Amini #include "llvm/Support/ErrorHandling.h"
70ef27db87SMehdi Amini #include "llvm/Support/ManagedStatic.h"
71ef27db87SMehdi Amini #include "llvm/Support/MemoryBuffer.h"
72ef27db87SMehdi Amini #include "llvm/Support/raw_ostream.h"
73ef27db87SMehdi Amini #include <algorithm>
74ef27db87SMehdi Amini #include <cassert>
75ef27db87SMehdi Amini #include <cstddef>
76ef27db87SMehdi Amini #include <cstdint>
77ef27db87SMehdi Amini #include <deque>
78ef27db87SMehdi Amini #include <limits>
79ef27db87SMehdi Amini #include <map>
80ef27db87SMehdi Amini #include <memory>
81ef27db87SMehdi Amini #include <string>
82ef27db87SMehdi Amini #include <system_error>
83ef27db87SMehdi Amini #include <tuple>
84ef27db87SMehdi Amini #include <utility>
85ef27db87SMehdi Amini #include <vector>
86ef27db87SMehdi Amini 
87ef27db87SMehdi Amini using namespace llvm;
88ef27db87SMehdi Amini 
89ef27db87SMehdi Amini namespace {
90ef27db87SMehdi Amini 
91ef27db87SMehdi Amini static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; }
92ef27db87SMehdi Amini 
93ef27db87SMehdi Amini class BitcodeReaderMetadataList {
94ef27db87SMehdi Amini   unsigned NumFwdRefs;
95ef27db87SMehdi Amini   bool AnyFwdRefs;
96ef27db87SMehdi Amini   unsigned MinFwdRef;
97ef27db87SMehdi Amini   unsigned MaxFwdRef;
98ef27db87SMehdi Amini 
99ef27db87SMehdi Amini   /// Array of metadata references.
100ef27db87SMehdi Amini   ///
101ef27db87SMehdi Amini   /// Don't use std::vector here.  Some versions of libc++ copy (instead of
102ef27db87SMehdi Amini   /// move) on resize, and TrackingMDRef is very expensive to copy.
103ef27db87SMehdi Amini   SmallVector<TrackingMDRef, 1> MetadataPtrs;
104ef27db87SMehdi Amini 
105ef27db87SMehdi Amini   /// Structures for resolving old type refs.
106ef27db87SMehdi Amini   struct {
107ef27db87SMehdi Amini     SmallDenseMap<MDString *, TempMDTuple, 1> Unknown;
108ef27db87SMehdi Amini     SmallDenseMap<MDString *, DICompositeType *, 1> Final;
109ef27db87SMehdi Amini     SmallDenseMap<MDString *, DICompositeType *, 1> FwdDecls;
110ef27db87SMehdi Amini     SmallVector<std::pair<TrackingMDRef, TempMDTuple>, 1> Arrays;
111ef27db87SMehdi Amini   } OldTypeRefs;
112ef27db87SMehdi Amini 
113ef27db87SMehdi Amini   LLVMContext &Context;
114ef27db87SMehdi Amini 
115ef27db87SMehdi Amini public:
116ef27db87SMehdi Amini   BitcodeReaderMetadataList(LLVMContext &C)
117ef27db87SMehdi Amini       : NumFwdRefs(0), AnyFwdRefs(false), Context(C) {}
118ef27db87SMehdi Amini 
119ef27db87SMehdi Amini   // vector compatibility methods
120ef27db87SMehdi Amini   unsigned size() const { return MetadataPtrs.size(); }
121ef27db87SMehdi Amini   void resize(unsigned N) { MetadataPtrs.resize(N); }
122ef27db87SMehdi Amini   void push_back(Metadata *MD) { MetadataPtrs.emplace_back(MD); }
123ef27db87SMehdi Amini   void clear() { MetadataPtrs.clear(); }
124ef27db87SMehdi Amini   Metadata *back() const { return MetadataPtrs.back(); }
125ef27db87SMehdi Amini   void pop_back() { MetadataPtrs.pop_back(); }
126ef27db87SMehdi Amini   bool empty() const { return MetadataPtrs.empty(); }
127ef27db87SMehdi Amini 
128ef27db87SMehdi Amini   Metadata *operator[](unsigned i) const {
129ef27db87SMehdi Amini     assert(i < MetadataPtrs.size());
130ef27db87SMehdi Amini     return MetadataPtrs[i];
131ef27db87SMehdi Amini   }
132ef27db87SMehdi Amini 
133ef27db87SMehdi Amini   Metadata *lookup(unsigned I) const {
134ef27db87SMehdi Amini     if (I < MetadataPtrs.size())
135ef27db87SMehdi Amini       return MetadataPtrs[I];
136ef27db87SMehdi Amini     return nullptr;
137ef27db87SMehdi Amini   }
138ef27db87SMehdi Amini 
139ef27db87SMehdi Amini   void shrinkTo(unsigned N) {
140ef27db87SMehdi Amini     assert(N <= size() && "Invalid shrinkTo request!");
141ef27db87SMehdi Amini     assert(!AnyFwdRefs && "Unexpected forward refs");
142ef27db87SMehdi Amini     MetadataPtrs.resize(N);
143ef27db87SMehdi Amini   }
144ef27db87SMehdi Amini 
145ef27db87SMehdi Amini   /// Return the given metadata, creating a replaceable forward reference if
146ef27db87SMehdi Amini   /// necessary.
147ef27db87SMehdi Amini   Metadata *getMetadataFwdRef(unsigned Idx);
148ef27db87SMehdi Amini 
149ef27db87SMehdi Amini   /// Return the the given metadata only if it is fully resolved.
150ef27db87SMehdi Amini   ///
151ef27db87SMehdi Amini   /// Gives the same result as \a lookup(), unless \a MDNode::isResolved()
152ef27db87SMehdi Amini   /// would give \c false.
153ef27db87SMehdi Amini   Metadata *getMetadataIfResolved(unsigned Idx);
154ef27db87SMehdi Amini 
155ef27db87SMehdi Amini   MDNode *getMDNodeFwdRefOrNull(unsigned Idx);
156ef27db87SMehdi Amini   void assignValue(Metadata *MD, unsigned Idx);
157ef27db87SMehdi Amini   void tryToResolveCycles();
158ef27db87SMehdi Amini   bool hasFwdRefs() const { return AnyFwdRefs; }
159ef27db87SMehdi Amini 
160ef27db87SMehdi Amini   /// Upgrade a type that had an MDString reference.
161ef27db87SMehdi Amini   void addTypeRef(MDString &UUID, DICompositeType &CT);
162ef27db87SMehdi Amini 
163ef27db87SMehdi Amini   /// Upgrade a type that had an MDString reference.
164ef27db87SMehdi Amini   Metadata *upgradeTypeRef(Metadata *MaybeUUID);
165ef27db87SMehdi Amini 
166ef27db87SMehdi Amini   /// Upgrade a type ref array that may have MDString references.
167ef27db87SMehdi Amini   Metadata *upgradeTypeRefArray(Metadata *MaybeTuple);
168ef27db87SMehdi Amini 
169ef27db87SMehdi Amini private:
170ef27db87SMehdi Amini   Metadata *resolveTypeRefArray(Metadata *MaybeTuple);
171ef27db87SMehdi Amini };
172ef27db87SMehdi Amini 
173ef27db87SMehdi Amini void BitcodeReaderMetadataList::assignValue(Metadata *MD, unsigned Idx) {
174ef27db87SMehdi Amini   if (Idx == size()) {
175ef27db87SMehdi Amini     push_back(MD);
176ef27db87SMehdi Amini     return;
177ef27db87SMehdi Amini   }
178ef27db87SMehdi Amini 
179ef27db87SMehdi Amini   if (Idx >= size())
180ef27db87SMehdi Amini     resize(Idx + 1);
181ef27db87SMehdi Amini 
182ef27db87SMehdi Amini   TrackingMDRef &OldMD = MetadataPtrs[Idx];
183ef27db87SMehdi Amini   if (!OldMD) {
184ef27db87SMehdi Amini     OldMD.reset(MD);
185ef27db87SMehdi Amini     return;
186ef27db87SMehdi Amini   }
187ef27db87SMehdi Amini 
188ef27db87SMehdi Amini   // If there was a forward reference to this value, replace it.
189ef27db87SMehdi Amini   TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
190ef27db87SMehdi Amini   PrevMD->replaceAllUsesWith(MD);
191ef27db87SMehdi Amini   --NumFwdRefs;
192ef27db87SMehdi Amini }
193ef27db87SMehdi Amini 
194ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::getMetadataFwdRef(unsigned Idx) {
195ef27db87SMehdi Amini   if (Idx >= size())
196ef27db87SMehdi Amini     resize(Idx + 1);
197ef27db87SMehdi Amini 
198ef27db87SMehdi Amini   if (Metadata *MD = MetadataPtrs[Idx])
199ef27db87SMehdi Amini     return MD;
200ef27db87SMehdi Amini 
201ef27db87SMehdi Amini   // Track forward refs to be resolved later.
202ef27db87SMehdi Amini   if (AnyFwdRefs) {
203ef27db87SMehdi Amini     MinFwdRef = std::min(MinFwdRef, Idx);
204ef27db87SMehdi Amini     MaxFwdRef = std::max(MaxFwdRef, Idx);
205ef27db87SMehdi Amini   } else {
206ef27db87SMehdi Amini     AnyFwdRefs = true;
207ef27db87SMehdi Amini     MinFwdRef = MaxFwdRef = Idx;
208ef27db87SMehdi Amini   }
209ef27db87SMehdi Amini   ++NumFwdRefs;
210ef27db87SMehdi Amini 
211ef27db87SMehdi Amini   // Create and return a placeholder, which will later be RAUW'd.
212ef27db87SMehdi Amini   Metadata *MD = MDNode::getTemporary(Context, None).release();
213ef27db87SMehdi Amini   MetadataPtrs[Idx].reset(MD);
214ef27db87SMehdi Amini   return MD;
215ef27db87SMehdi Amini }
216ef27db87SMehdi Amini 
217ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::getMetadataIfResolved(unsigned Idx) {
218ef27db87SMehdi Amini   Metadata *MD = lookup(Idx);
219ef27db87SMehdi Amini   if (auto *N = dyn_cast_or_null<MDNode>(MD))
220ef27db87SMehdi Amini     if (!N->isResolved())
221ef27db87SMehdi Amini       return nullptr;
222ef27db87SMehdi Amini   return MD;
223ef27db87SMehdi Amini }
224ef27db87SMehdi Amini 
225ef27db87SMehdi Amini MDNode *BitcodeReaderMetadataList::getMDNodeFwdRefOrNull(unsigned Idx) {
226ef27db87SMehdi Amini   return dyn_cast_or_null<MDNode>(getMetadataFwdRef(Idx));
227ef27db87SMehdi Amini }
228ef27db87SMehdi Amini 
229ef27db87SMehdi Amini void BitcodeReaderMetadataList::tryToResolveCycles() {
230ef27db87SMehdi Amini   if (NumFwdRefs)
231ef27db87SMehdi Amini     // Still forward references... can't resolve cycles.
232ef27db87SMehdi Amini     return;
233ef27db87SMehdi Amini 
234ef27db87SMehdi Amini   bool DidReplaceTypeRefs = false;
235ef27db87SMehdi Amini 
236ef27db87SMehdi Amini   // Give up on finding a full definition for any forward decls that remain.
237ef27db87SMehdi Amini   for (const auto &Ref : OldTypeRefs.FwdDecls)
238ef27db87SMehdi Amini     OldTypeRefs.Final.insert(Ref);
239ef27db87SMehdi Amini   OldTypeRefs.FwdDecls.clear();
240ef27db87SMehdi Amini 
241ef27db87SMehdi Amini   // Upgrade from old type ref arrays.  In strange cases, this could add to
242ef27db87SMehdi Amini   // OldTypeRefs.Unknown.
243ef27db87SMehdi Amini   for (const auto &Array : OldTypeRefs.Arrays) {
244ef27db87SMehdi Amini     DidReplaceTypeRefs = true;
245ef27db87SMehdi Amini     Array.second->replaceAllUsesWith(resolveTypeRefArray(Array.first.get()));
246ef27db87SMehdi Amini   }
247ef27db87SMehdi Amini   OldTypeRefs.Arrays.clear();
248ef27db87SMehdi Amini 
249ef27db87SMehdi Amini   // Replace old string-based type refs with the resolved node, if possible.
250ef27db87SMehdi Amini   // If we haven't seen the node, leave it to the verifier to complain about
251ef27db87SMehdi Amini   // the invalid string reference.
252ef27db87SMehdi Amini   for (const auto &Ref : OldTypeRefs.Unknown) {
253ef27db87SMehdi Amini     DidReplaceTypeRefs = true;
254ef27db87SMehdi Amini     if (DICompositeType *CT = OldTypeRefs.Final.lookup(Ref.first))
255ef27db87SMehdi Amini       Ref.second->replaceAllUsesWith(CT);
256ef27db87SMehdi Amini     else
257ef27db87SMehdi Amini       Ref.second->replaceAllUsesWith(Ref.first);
258ef27db87SMehdi Amini   }
259ef27db87SMehdi Amini   OldTypeRefs.Unknown.clear();
260ef27db87SMehdi Amini 
261ef27db87SMehdi Amini   // Make sure all the upgraded types are resolved.
262ef27db87SMehdi Amini   if (DidReplaceTypeRefs) {
263ef27db87SMehdi Amini     AnyFwdRefs = true;
264ef27db87SMehdi Amini     MinFwdRef = 0;
265ef27db87SMehdi Amini     MaxFwdRef = MetadataPtrs.size() - 1;
266ef27db87SMehdi Amini   }
267ef27db87SMehdi Amini 
268ef27db87SMehdi Amini   if (!AnyFwdRefs)
269ef27db87SMehdi Amini     // Nothing to do.
270ef27db87SMehdi Amini     return;
271ef27db87SMehdi Amini 
272ef27db87SMehdi Amini   // Resolve any cycles.
273ef27db87SMehdi Amini   for (unsigned I = MinFwdRef, E = MaxFwdRef + 1; I != E; ++I) {
274ef27db87SMehdi Amini     auto &MD = MetadataPtrs[I];
275ef27db87SMehdi Amini     auto *N = dyn_cast_or_null<MDNode>(MD);
276ef27db87SMehdi Amini     if (!N)
277ef27db87SMehdi Amini       continue;
278ef27db87SMehdi Amini 
279ef27db87SMehdi Amini     assert(!N->isTemporary() && "Unexpected forward reference");
280ef27db87SMehdi Amini     N->resolveCycles();
281ef27db87SMehdi Amini   }
282ef27db87SMehdi Amini 
283ef27db87SMehdi Amini   // Make sure we return early again until there's another forward ref.
284ef27db87SMehdi Amini   AnyFwdRefs = false;
285ef27db87SMehdi Amini }
286ef27db87SMehdi Amini 
287ef27db87SMehdi Amini void BitcodeReaderMetadataList::addTypeRef(MDString &UUID,
288ef27db87SMehdi Amini                                            DICompositeType &CT) {
289ef27db87SMehdi Amini   assert(CT.getRawIdentifier() == &UUID && "Mismatched UUID");
290ef27db87SMehdi Amini   if (CT.isForwardDecl())
291ef27db87SMehdi Amini     OldTypeRefs.FwdDecls.insert(std::make_pair(&UUID, &CT));
292ef27db87SMehdi Amini   else
293ef27db87SMehdi Amini     OldTypeRefs.Final.insert(std::make_pair(&UUID, &CT));
294ef27db87SMehdi Amini }
295ef27db87SMehdi Amini 
296ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::upgradeTypeRef(Metadata *MaybeUUID) {
297ef27db87SMehdi Amini   auto *UUID = dyn_cast_or_null<MDString>(MaybeUUID);
298ef27db87SMehdi Amini   if (LLVM_LIKELY(!UUID))
299ef27db87SMehdi Amini     return MaybeUUID;
300ef27db87SMehdi Amini 
301ef27db87SMehdi Amini   if (auto *CT = OldTypeRefs.Final.lookup(UUID))
302ef27db87SMehdi Amini     return CT;
303ef27db87SMehdi Amini 
304ef27db87SMehdi Amini   auto &Ref = OldTypeRefs.Unknown[UUID];
305ef27db87SMehdi Amini   if (!Ref)
306ef27db87SMehdi Amini     Ref = MDNode::getTemporary(Context, None);
307ef27db87SMehdi Amini   return Ref.get();
308ef27db87SMehdi Amini }
309ef27db87SMehdi Amini 
310ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::upgradeTypeRefArray(Metadata *MaybeTuple) {
311ef27db87SMehdi Amini   auto *Tuple = dyn_cast_or_null<MDTuple>(MaybeTuple);
312ef27db87SMehdi Amini   if (!Tuple || Tuple->isDistinct())
313ef27db87SMehdi Amini     return MaybeTuple;
314ef27db87SMehdi Amini 
315ef27db87SMehdi Amini   // Look through the array immediately if possible.
316ef27db87SMehdi Amini   if (!Tuple->isTemporary())
317ef27db87SMehdi Amini     return resolveTypeRefArray(Tuple);
318ef27db87SMehdi Amini 
319ef27db87SMehdi Amini   // Create and return a placeholder to use for now.  Eventually
320ef27db87SMehdi Amini   // resolveTypeRefArrays() will be resolve this forward reference.
321ef27db87SMehdi Amini   OldTypeRefs.Arrays.emplace_back(
322ef27db87SMehdi Amini       std::piecewise_construct, std::forward_as_tuple(Tuple),
323ef27db87SMehdi Amini       std::forward_as_tuple(MDTuple::getTemporary(Context, None)));
324ef27db87SMehdi Amini   return OldTypeRefs.Arrays.back().second.get();
325ef27db87SMehdi Amini }
326ef27db87SMehdi Amini 
327ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::resolveTypeRefArray(Metadata *MaybeTuple) {
328ef27db87SMehdi Amini   auto *Tuple = dyn_cast_or_null<MDTuple>(MaybeTuple);
329ef27db87SMehdi Amini   if (!Tuple || Tuple->isDistinct())
330ef27db87SMehdi Amini     return MaybeTuple;
331ef27db87SMehdi Amini 
332ef27db87SMehdi Amini   // Look through the DITypeRefArray, upgrading each DITypeRef.
333ef27db87SMehdi Amini   SmallVector<Metadata *, 32> Ops;
334ef27db87SMehdi Amini   Ops.reserve(Tuple->getNumOperands());
335ef27db87SMehdi Amini   for (Metadata *MD : Tuple->operands())
336ef27db87SMehdi Amini     Ops.push_back(upgradeTypeRef(MD));
337ef27db87SMehdi Amini 
338ef27db87SMehdi Amini   return MDTuple::get(Context, Ops);
339ef27db87SMehdi Amini }
340ef27db87SMehdi Amini 
341ef27db87SMehdi Amini namespace {
342ef27db87SMehdi Amini 
343ef27db87SMehdi Amini class PlaceholderQueue {
344ef27db87SMehdi Amini   // Placeholders would thrash around when moved, so store in a std::deque
345ef27db87SMehdi Amini   // instead of some sort of vector.
346ef27db87SMehdi Amini   std::deque<DistinctMDOperandPlaceholder> PHs;
347ef27db87SMehdi Amini 
348ef27db87SMehdi Amini public:
349ef27db87SMehdi Amini   DistinctMDOperandPlaceholder &getPlaceholderOp(unsigned ID);
350ef27db87SMehdi Amini   void flush(BitcodeReaderMetadataList &MetadataList);
351ef27db87SMehdi Amini };
352ef27db87SMehdi Amini 
353ef27db87SMehdi Amini } // end anonymous namespace
354ef27db87SMehdi Amini 
355ef27db87SMehdi Amini DistinctMDOperandPlaceholder &PlaceholderQueue::getPlaceholderOp(unsigned ID) {
356ef27db87SMehdi Amini   PHs.emplace_back(ID);
357ef27db87SMehdi Amini   return PHs.back();
358ef27db87SMehdi Amini }
359ef27db87SMehdi Amini 
360ef27db87SMehdi Amini void PlaceholderQueue::flush(BitcodeReaderMetadataList &MetadataList) {
361ef27db87SMehdi Amini   while (!PHs.empty()) {
362ef27db87SMehdi Amini     PHs.front().replaceUseWith(
363ef27db87SMehdi Amini         MetadataList.getMetadataFwdRef(PHs.front().getID()));
364ef27db87SMehdi Amini     PHs.pop_front();
365ef27db87SMehdi Amini   }
366ef27db87SMehdi Amini }
367ef27db87SMehdi Amini 
368ef27db87SMehdi Amini } // anonynous namespace
369ef27db87SMehdi Amini 
370ef27db87SMehdi Amini class MetadataLoader::MetadataLoaderImpl {
371ef27db87SMehdi Amini   BitcodeReaderMetadataList MetadataList;
372ef27db87SMehdi Amini   BitcodeReaderValueList &ValueList;
373ef27db87SMehdi Amini   BitstreamCursor &Stream;
374ef27db87SMehdi Amini   LLVMContext &Context;
375ef27db87SMehdi Amini   Module &TheModule;
376ef27db87SMehdi Amini   std::function<Type *(unsigned)> getTypeByID;
377ef27db87SMehdi Amini 
378ef27db87SMehdi Amini   /// Functions that need to be matched with subprograms when upgrading old
379ef27db87SMehdi Amini   /// metadata.
380ef27db87SMehdi Amini   SmallDenseMap<Function *, DISubprogram *, 16> FunctionsWithSPs;
381ef27db87SMehdi Amini 
382ef27db87SMehdi Amini   // Map the bitcode's custom MDKind ID to the Module's MDKind ID.
383ef27db87SMehdi Amini   DenseMap<unsigned, unsigned> MDKindMap;
384ef27db87SMehdi Amini 
385ef27db87SMehdi Amini   bool HasSeenOldLoopTags = false;
386ef27db87SMehdi Amini 
387ef27db87SMehdi Amini   Error parseMetadataStrings(ArrayRef<uint64_t> Record, StringRef Blob,
388ef27db87SMehdi Amini                              unsigned &NextMetadataNo);
389ef27db87SMehdi Amini   Error parseGlobalObjectAttachment(GlobalObject &GO,
390ef27db87SMehdi Amini                                     ArrayRef<uint64_t> Record);
391ef27db87SMehdi Amini   Error parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record);
392ef27db87SMehdi Amini 
393ef27db87SMehdi Amini public:
394ef27db87SMehdi Amini   MetadataLoaderImpl(BitstreamCursor &Stream, Module &TheModule,
395ef27db87SMehdi Amini                      BitcodeReaderValueList &ValueList,
396ef27db87SMehdi Amini                      std::function<Type *(unsigned)> getTypeByID)
397ef27db87SMehdi Amini       : MetadataList(TheModule.getContext()), ValueList(ValueList),
398ef27db87SMehdi Amini         Stream(Stream), Context(TheModule.getContext()), TheModule(TheModule),
399ef27db87SMehdi Amini         getTypeByID(getTypeByID) {}
400ef27db87SMehdi Amini 
401ef27db87SMehdi Amini   Error parseMetadata(bool ModuleLevel);
402ef27db87SMehdi Amini 
403ef27db87SMehdi Amini   bool hasFwdRefs() const { return MetadataList.hasFwdRefs(); }
404ef27db87SMehdi Amini   Metadata *getMetadataFwdRef(unsigned Idx) {
405ef27db87SMehdi Amini     return MetadataList.getMetadataFwdRef(Idx);
406ef27db87SMehdi Amini   }
407ef27db87SMehdi Amini 
408ef27db87SMehdi Amini   MDNode *getMDNodeFwdRefOrNull(unsigned Idx) {
409ef27db87SMehdi Amini     return MetadataList.getMDNodeFwdRefOrNull(Idx);
410ef27db87SMehdi Amini   }
411ef27db87SMehdi Amini 
412ef27db87SMehdi Amini   DISubprogram *lookupSubprogramForFunction(Function *F) {
413ef27db87SMehdi Amini     return FunctionsWithSPs.lookup(F);
414ef27db87SMehdi Amini   }
415ef27db87SMehdi Amini 
416ef27db87SMehdi Amini   bool hasSeenOldLoopTags() { return HasSeenOldLoopTags; }
417ef27db87SMehdi Amini 
418ef27db87SMehdi Amini   Error parseMetadataAttachment(
419ef27db87SMehdi Amini       Function &F, const SmallVectorImpl<Instruction *> &InstructionList);
420ef27db87SMehdi Amini 
421ef27db87SMehdi Amini   Error parseMetadataKinds();
422ef27db87SMehdi Amini 
423ef27db87SMehdi Amini   unsigned size() const { return MetadataList.size(); }
424ef27db87SMehdi Amini   void shrinkTo(unsigned N) { MetadataList.shrinkTo(N); }
425ef27db87SMehdi Amini };
426ef27db87SMehdi Amini 
427ef27db87SMehdi Amini Error error(const Twine &Message) {
428ef27db87SMehdi Amini   return make_error<StringError>(
429ef27db87SMehdi Amini       Message, make_error_code(BitcodeError::CorruptedBitcode));
430ef27db87SMehdi Amini }
431ef27db87SMehdi Amini 
432ef27db87SMehdi Amini /// Parse a METADATA_BLOCK. If ModuleLevel is true then we are parsing
433ef27db87SMehdi Amini /// module level metadata.
434ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadata(bool ModuleLevel) {
435ef27db87SMehdi Amini   if (!ModuleLevel && MetadataList.hasFwdRefs())
436ef27db87SMehdi Amini     return error("Invalid metadata: fwd refs into function blocks");
437ef27db87SMehdi Amini 
438ef27db87SMehdi Amini   if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
439ef27db87SMehdi Amini     return error("Invalid record");
440ef27db87SMehdi Amini 
441ef27db87SMehdi Amini   unsigned NextMetadataNo = MetadataList.size();
442ef27db87SMehdi Amini   std::vector<std::pair<DICompileUnit *, Metadata *>> CUSubprograms;
443ef27db87SMehdi Amini   SmallVector<uint64_t, 64> Record;
444ef27db87SMehdi Amini 
445ef27db87SMehdi Amini   PlaceholderQueue Placeholders;
446ef27db87SMehdi Amini   bool IsDistinct;
447ef27db87SMehdi Amini   auto getMD = [&](unsigned ID) -> Metadata * {
448ef27db87SMehdi Amini     if (!IsDistinct)
449ef27db87SMehdi Amini       return MetadataList.getMetadataFwdRef(ID);
450ef27db87SMehdi Amini     if (auto *MD = MetadataList.getMetadataIfResolved(ID))
451ef27db87SMehdi Amini       return MD;
452ef27db87SMehdi Amini     return &Placeholders.getPlaceholderOp(ID);
453ef27db87SMehdi Amini   };
454ef27db87SMehdi Amini   auto getMDOrNull = [&](unsigned ID) -> Metadata * {
455ef27db87SMehdi Amini     if (ID)
456ef27db87SMehdi Amini       return getMD(ID - 1);
457ef27db87SMehdi Amini     return nullptr;
458ef27db87SMehdi Amini   };
459ef27db87SMehdi Amini   auto getMDOrNullWithoutPlaceholders = [&](unsigned ID) -> Metadata * {
460ef27db87SMehdi Amini     if (ID)
461ef27db87SMehdi Amini       return MetadataList.getMetadataFwdRef(ID - 1);
462ef27db87SMehdi Amini     return nullptr;
463ef27db87SMehdi Amini   };
464ef27db87SMehdi Amini   auto getMDString = [&](unsigned ID) -> MDString * {
465ef27db87SMehdi Amini     // This requires that the ID is not really a forward reference.  In
466ef27db87SMehdi Amini     // particular, the MDString must already have been resolved.
467ef27db87SMehdi Amini     return cast_or_null<MDString>(getMDOrNull(ID));
468ef27db87SMehdi Amini   };
469ef27db87SMehdi Amini 
470ef27db87SMehdi Amini   // Support for old type refs.
471ef27db87SMehdi Amini   auto getDITypeRefOrNull = [&](unsigned ID) {
472ef27db87SMehdi Amini     return MetadataList.upgradeTypeRef(getMDOrNull(ID));
473ef27db87SMehdi Amini   };
474ef27db87SMehdi Amini 
475ef27db87SMehdi Amini #define GET_OR_DISTINCT(CLASS, ARGS)                                           \
476ef27db87SMehdi Amini   (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS)
477ef27db87SMehdi Amini 
478ef27db87SMehdi Amini   // Read all the records.
479ef27db87SMehdi Amini   while (true) {
480ef27db87SMehdi Amini     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
481ef27db87SMehdi Amini 
482ef27db87SMehdi Amini     switch (Entry.Kind) {
483ef27db87SMehdi Amini     case BitstreamEntry::SubBlock: // Handled for us already.
484ef27db87SMehdi Amini     case BitstreamEntry::Error:
485ef27db87SMehdi Amini       return error("Malformed block");
486ef27db87SMehdi Amini     case BitstreamEntry::EndBlock:
487ef27db87SMehdi Amini       // Upgrade old-style CU <-> SP pointers to point from SP to CU.
488ef27db87SMehdi Amini       for (auto CU_SP : CUSubprograms)
489ef27db87SMehdi Amini         if (auto *SPs = dyn_cast_or_null<MDTuple>(CU_SP.second))
490ef27db87SMehdi Amini           for (auto &Op : SPs->operands())
491ef27db87SMehdi Amini             if (auto *SP = dyn_cast_or_null<MDNode>(Op))
492ef27db87SMehdi Amini               SP->replaceOperandWith(7, CU_SP.first);
493ef27db87SMehdi Amini 
494ef27db87SMehdi Amini       MetadataList.tryToResolveCycles();
495ef27db87SMehdi Amini       Placeholders.flush(MetadataList);
496ef27db87SMehdi Amini       return Error::success();
497ef27db87SMehdi Amini     case BitstreamEntry::Record:
498ef27db87SMehdi Amini       // The interesting case.
499ef27db87SMehdi Amini       break;
500ef27db87SMehdi Amini     }
501ef27db87SMehdi Amini 
502ef27db87SMehdi Amini     // Read a record.
503ef27db87SMehdi Amini     Record.clear();
504ef27db87SMehdi Amini     StringRef Blob;
505ef27db87SMehdi Amini     unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob);
506ef27db87SMehdi Amini     IsDistinct = false;
507ef27db87SMehdi Amini     switch (Code) {
508ef27db87SMehdi Amini     default: // Default behavior: ignore.
509ef27db87SMehdi Amini       break;
510ef27db87SMehdi Amini     case bitc::METADATA_NAME: {
511ef27db87SMehdi Amini       // Read name of the named metadata.
512ef27db87SMehdi Amini       SmallString<8> Name(Record.begin(), Record.end());
513ef27db87SMehdi Amini       Record.clear();
514ef27db87SMehdi Amini       Code = Stream.ReadCode();
515ef27db87SMehdi Amini 
516ef27db87SMehdi Amini       unsigned NextBitCode = Stream.readRecord(Code, Record);
517ef27db87SMehdi Amini       if (NextBitCode != bitc::METADATA_NAMED_NODE)
518ef27db87SMehdi Amini         return error("METADATA_NAME not followed by METADATA_NAMED_NODE");
519ef27db87SMehdi Amini 
520ef27db87SMehdi Amini       // Read named metadata elements.
521ef27db87SMehdi Amini       unsigned Size = Record.size();
522ef27db87SMehdi Amini       NamedMDNode *NMD = TheModule.getOrInsertNamedMetadata(Name);
523ef27db87SMehdi Amini       for (unsigned i = 0; i != Size; ++i) {
524ef27db87SMehdi Amini         MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[i]);
525ef27db87SMehdi Amini         if (!MD)
526ef27db87SMehdi Amini           return error("Invalid record");
527ef27db87SMehdi Amini         NMD->addOperand(MD);
528ef27db87SMehdi Amini       }
529ef27db87SMehdi Amini       break;
530ef27db87SMehdi Amini     }
531ef27db87SMehdi Amini     case bitc::METADATA_OLD_FN_NODE: {
532ef27db87SMehdi Amini       // FIXME: Remove in 4.0.
533ef27db87SMehdi Amini       // This is a LocalAsMetadata record, the only type of function-local
534ef27db87SMehdi Amini       // metadata.
535ef27db87SMehdi Amini       if (Record.size() % 2 == 1)
536ef27db87SMehdi Amini         return error("Invalid record");
537ef27db87SMehdi Amini 
538ef27db87SMehdi Amini       // If this isn't a LocalAsMetadata record, we're dropping it.  This used
539ef27db87SMehdi Amini       // to be legal, but there's no upgrade path.
540ef27db87SMehdi Amini       auto dropRecord = [&] {
541ef27db87SMehdi Amini         MetadataList.assignValue(MDNode::get(Context, None), NextMetadataNo++);
542ef27db87SMehdi Amini       };
543ef27db87SMehdi Amini       if (Record.size() != 2) {
544ef27db87SMehdi Amini         dropRecord();
545ef27db87SMehdi Amini         break;
546ef27db87SMehdi Amini       }
547ef27db87SMehdi Amini 
548ef27db87SMehdi Amini       Type *Ty = getTypeByID(Record[0]);
549ef27db87SMehdi Amini       if (Ty->isMetadataTy() || Ty->isVoidTy()) {
550ef27db87SMehdi Amini         dropRecord();
551ef27db87SMehdi Amini         break;
552ef27db87SMehdi Amini       }
553ef27db87SMehdi Amini 
554ef27db87SMehdi Amini       MetadataList.assignValue(
555ef27db87SMehdi Amini           LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
556ef27db87SMehdi Amini           NextMetadataNo++);
557ef27db87SMehdi Amini       break;
558ef27db87SMehdi Amini     }
559ef27db87SMehdi Amini     case bitc::METADATA_OLD_NODE: {
560ef27db87SMehdi Amini       // FIXME: Remove in 4.0.
561ef27db87SMehdi Amini       if (Record.size() % 2 == 1)
562ef27db87SMehdi Amini         return error("Invalid record");
563ef27db87SMehdi Amini 
564ef27db87SMehdi Amini       unsigned Size = Record.size();
565ef27db87SMehdi Amini       SmallVector<Metadata *, 8> Elts;
566ef27db87SMehdi Amini       for (unsigned i = 0; i != Size; i += 2) {
567ef27db87SMehdi Amini         Type *Ty = getTypeByID(Record[i]);
568ef27db87SMehdi Amini         if (!Ty)
569ef27db87SMehdi Amini           return error("Invalid record");
570ef27db87SMehdi Amini         if (Ty->isMetadataTy())
571ef27db87SMehdi Amini           Elts.push_back(getMD(Record[i + 1]));
572ef27db87SMehdi Amini         else if (!Ty->isVoidTy()) {
573ef27db87SMehdi Amini           auto *MD =
574ef27db87SMehdi Amini               ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
575ef27db87SMehdi Amini           assert(isa<ConstantAsMetadata>(MD) &&
576ef27db87SMehdi Amini                  "Expected non-function-local metadata");
577ef27db87SMehdi Amini           Elts.push_back(MD);
578ef27db87SMehdi Amini         } else
579ef27db87SMehdi Amini           Elts.push_back(nullptr);
580ef27db87SMehdi Amini       }
581ef27db87SMehdi Amini       MetadataList.assignValue(MDNode::get(Context, Elts), NextMetadataNo++);
582ef27db87SMehdi Amini       break;
583ef27db87SMehdi Amini     }
584ef27db87SMehdi Amini     case bitc::METADATA_VALUE: {
585ef27db87SMehdi Amini       if (Record.size() != 2)
586ef27db87SMehdi Amini         return error("Invalid record");
587ef27db87SMehdi Amini 
588ef27db87SMehdi Amini       Type *Ty = getTypeByID(Record[0]);
589ef27db87SMehdi Amini       if (Ty->isMetadataTy() || Ty->isVoidTy())
590ef27db87SMehdi Amini         return error("Invalid record");
591ef27db87SMehdi Amini 
592ef27db87SMehdi Amini       MetadataList.assignValue(
593ef27db87SMehdi Amini           ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
594ef27db87SMehdi Amini           NextMetadataNo++);
595ef27db87SMehdi Amini       break;
596ef27db87SMehdi Amini     }
597ef27db87SMehdi Amini     case bitc::METADATA_DISTINCT_NODE:
598ef27db87SMehdi Amini       IsDistinct = true;
599ef27db87SMehdi Amini       LLVM_FALLTHROUGH;
600ef27db87SMehdi Amini     case bitc::METADATA_NODE: {
601ef27db87SMehdi Amini       SmallVector<Metadata *, 8> Elts;
602ef27db87SMehdi Amini       Elts.reserve(Record.size());
603ef27db87SMehdi Amini       for (unsigned ID : Record)
604ef27db87SMehdi Amini         Elts.push_back(getMDOrNull(ID));
605ef27db87SMehdi Amini       MetadataList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
606ef27db87SMehdi Amini                                           : MDNode::get(Context, Elts),
607ef27db87SMehdi Amini                                NextMetadataNo++);
608ef27db87SMehdi Amini       break;
609ef27db87SMehdi Amini     }
610ef27db87SMehdi Amini     case bitc::METADATA_LOCATION: {
611ef27db87SMehdi Amini       if (Record.size() != 5)
612ef27db87SMehdi Amini         return error("Invalid record");
613ef27db87SMehdi Amini 
614ef27db87SMehdi Amini       IsDistinct = Record[0];
615ef27db87SMehdi Amini       unsigned Line = Record[1];
616ef27db87SMehdi Amini       unsigned Column = Record[2];
617ef27db87SMehdi Amini       Metadata *Scope = getMD(Record[3]);
618ef27db87SMehdi Amini       Metadata *InlinedAt = getMDOrNull(Record[4]);
619ef27db87SMehdi Amini       MetadataList.assignValue(
620ef27db87SMehdi Amini           GET_OR_DISTINCT(DILocation,
621ef27db87SMehdi Amini                           (Context, Line, Column, Scope, InlinedAt)),
622ef27db87SMehdi Amini           NextMetadataNo++);
623ef27db87SMehdi Amini       break;
624ef27db87SMehdi Amini     }
625ef27db87SMehdi Amini     case bitc::METADATA_GENERIC_DEBUG: {
626ef27db87SMehdi Amini       if (Record.size() < 4)
627ef27db87SMehdi Amini         return error("Invalid record");
628ef27db87SMehdi Amini 
629ef27db87SMehdi Amini       IsDistinct = Record[0];
630ef27db87SMehdi Amini       unsigned Tag = Record[1];
631ef27db87SMehdi Amini       unsigned Version = Record[2];
632ef27db87SMehdi Amini 
633ef27db87SMehdi Amini       if (Tag >= 1u << 16 || Version != 0)
634ef27db87SMehdi Amini         return error("Invalid record");
635ef27db87SMehdi Amini 
636ef27db87SMehdi Amini       auto *Header = getMDString(Record[3]);
637ef27db87SMehdi Amini       SmallVector<Metadata *, 8> DwarfOps;
638ef27db87SMehdi Amini       for (unsigned I = 4, E = Record.size(); I != E; ++I)
639ef27db87SMehdi Amini         DwarfOps.push_back(getMDOrNull(Record[I]));
640ef27db87SMehdi Amini       MetadataList.assignValue(
641ef27db87SMehdi Amini           GET_OR_DISTINCT(GenericDINode, (Context, Tag, Header, DwarfOps)),
642ef27db87SMehdi Amini           NextMetadataNo++);
643ef27db87SMehdi Amini       break;
644ef27db87SMehdi Amini     }
645ef27db87SMehdi Amini     case bitc::METADATA_SUBRANGE: {
646ef27db87SMehdi Amini       if (Record.size() != 3)
647ef27db87SMehdi Amini         return error("Invalid record");
648ef27db87SMehdi Amini 
649ef27db87SMehdi Amini       IsDistinct = Record[0];
650ef27db87SMehdi Amini       MetadataList.assignValue(
651ef27db87SMehdi Amini           GET_OR_DISTINCT(DISubrange,
652ef27db87SMehdi Amini                           (Context, Record[1], unrotateSign(Record[2]))),
653ef27db87SMehdi Amini           NextMetadataNo++);
654ef27db87SMehdi Amini       break;
655ef27db87SMehdi Amini     }
656ef27db87SMehdi Amini     case bitc::METADATA_ENUMERATOR: {
657ef27db87SMehdi Amini       if (Record.size() != 3)
658ef27db87SMehdi Amini         return error("Invalid record");
659ef27db87SMehdi Amini 
660ef27db87SMehdi Amini       IsDistinct = Record[0];
661ef27db87SMehdi Amini       MetadataList.assignValue(
662ef27db87SMehdi Amini           GET_OR_DISTINCT(DIEnumerator, (Context, unrotateSign(Record[1]),
663ef27db87SMehdi Amini                                          getMDString(Record[2]))),
664ef27db87SMehdi Amini           NextMetadataNo++);
665ef27db87SMehdi Amini       break;
666ef27db87SMehdi Amini     }
667ef27db87SMehdi Amini     case bitc::METADATA_BASIC_TYPE: {
668ef27db87SMehdi Amini       if (Record.size() != 6)
669ef27db87SMehdi Amini         return error("Invalid record");
670ef27db87SMehdi Amini 
671ef27db87SMehdi Amini       IsDistinct = Record[0];
672ef27db87SMehdi Amini       MetadataList.assignValue(
673ef27db87SMehdi Amini           GET_OR_DISTINCT(DIBasicType,
674ef27db87SMehdi Amini                           (Context, Record[1], getMDString(Record[2]),
675ef27db87SMehdi Amini                            Record[3], Record[4], Record[5])),
676ef27db87SMehdi Amini           NextMetadataNo++);
677ef27db87SMehdi Amini       break;
678ef27db87SMehdi Amini     }
679ef27db87SMehdi Amini     case bitc::METADATA_DERIVED_TYPE: {
680ef27db87SMehdi Amini       if (Record.size() != 12)
681ef27db87SMehdi Amini         return error("Invalid record");
682ef27db87SMehdi Amini 
683ef27db87SMehdi Amini       IsDistinct = Record[0];
684ef27db87SMehdi Amini       DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[10]);
685ef27db87SMehdi Amini       MetadataList.assignValue(
686ef27db87SMehdi Amini           GET_OR_DISTINCT(DIDerivedType,
687ef27db87SMehdi Amini                           (Context, Record[1], getMDString(Record[2]),
688ef27db87SMehdi Amini                            getMDOrNull(Record[3]), Record[4],
689ef27db87SMehdi Amini                            getDITypeRefOrNull(Record[5]),
690ef27db87SMehdi Amini                            getDITypeRefOrNull(Record[6]), Record[7], Record[8],
691ef27db87SMehdi Amini                            Record[9], Flags, getDITypeRefOrNull(Record[11]))),
692ef27db87SMehdi Amini           NextMetadataNo++);
693ef27db87SMehdi Amini       break;
694ef27db87SMehdi Amini     }
695ef27db87SMehdi Amini     case bitc::METADATA_COMPOSITE_TYPE: {
696ef27db87SMehdi Amini       if (Record.size() != 16)
697ef27db87SMehdi Amini         return error("Invalid record");
698ef27db87SMehdi Amini 
699ef27db87SMehdi Amini       // If we have a UUID and this is not a forward declaration, lookup the
700ef27db87SMehdi Amini       // mapping.
701ef27db87SMehdi Amini       IsDistinct = Record[0] & 0x1;
702ef27db87SMehdi Amini       bool IsNotUsedInTypeRef = Record[0] >= 2;
703ef27db87SMehdi Amini       unsigned Tag = Record[1];
704ef27db87SMehdi Amini       MDString *Name = getMDString(Record[2]);
705ef27db87SMehdi Amini       Metadata *File = getMDOrNull(Record[3]);
706ef27db87SMehdi Amini       unsigned Line = Record[4];
707ef27db87SMehdi Amini       Metadata *Scope = getDITypeRefOrNull(Record[5]);
708ef27db87SMehdi Amini       Metadata *BaseType = getDITypeRefOrNull(Record[6]);
709ef27db87SMehdi Amini       uint64_t SizeInBits = Record[7];
710ef27db87SMehdi Amini       if (Record[8] > (uint64_t)std::numeric_limits<uint32_t>::max())
711ef27db87SMehdi Amini         return error("Alignment value is too large");
712ef27db87SMehdi Amini       uint32_t AlignInBits = Record[8];
713ef27db87SMehdi Amini       uint64_t OffsetInBits = Record[9];
714ef27db87SMehdi Amini       DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[10]);
715ef27db87SMehdi Amini       Metadata *Elements = getMDOrNull(Record[11]);
716ef27db87SMehdi Amini       unsigned RuntimeLang = Record[12];
717ef27db87SMehdi Amini       Metadata *VTableHolder = getDITypeRefOrNull(Record[13]);
718ef27db87SMehdi Amini       Metadata *TemplateParams = getMDOrNull(Record[14]);
719ef27db87SMehdi Amini       auto *Identifier = getMDString(Record[15]);
720ef27db87SMehdi Amini       DICompositeType *CT = nullptr;
721ef27db87SMehdi Amini       if (Identifier)
722ef27db87SMehdi Amini         CT = DICompositeType::buildODRType(
723ef27db87SMehdi Amini             Context, *Identifier, Tag, Name, File, Line, Scope, BaseType,
724ef27db87SMehdi Amini             SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
725ef27db87SMehdi Amini             VTableHolder, TemplateParams);
726ef27db87SMehdi Amini 
727ef27db87SMehdi Amini       // Create a node if we didn't get a lazy ODR type.
728ef27db87SMehdi Amini       if (!CT)
729ef27db87SMehdi Amini         CT = GET_OR_DISTINCT(DICompositeType,
730ef27db87SMehdi Amini                              (Context, Tag, Name, File, Line, Scope, BaseType,
731ef27db87SMehdi Amini                               SizeInBits, AlignInBits, OffsetInBits, Flags,
732ef27db87SMehdi Amini                               Elements, RuntimeLang, VTableHolder,
733ef27db87SMehdi Amini                               TemplateParams, Identifier));
734ef27db87SMehdi Amini       if (!IsNotUsedInTypeRef && Identifier)
735ef27db87SMehdi Amini         MetadataList.addTypeRef(*Identifier, *cast<DICompositeType>(CT));
736ef27db87SMehdi Amini 
737ef27db87SMehdi Amini       MetadataList.assignValue(CT, NextMetadataNo++);
738ef27db87SMehdi Amini       break;
739ef27db87SMehdi Amini     }
740ef27db87SMehdi Amini     case bitc::METADATA_SUBROUTINE_TYPE: {
741ef27db87SMehdi Amini       if (Record.size() < 3 || Record.size() > 4)
742ef27db87SMehdi Amini         return error("Invalid record");
743ef27db87SMehdi Amini       bool IsOldTypeRefArray = Record[0] < 2;
744ef27db87SMehdi Amini       unsigned CC = (Record.size() > 3) ? Record[3] : 0;
745ef27db87SMehdi Amini 
746ef27db87SMehdi Amini       IsDistinct = Record[0] & 0x1;
747ef27db87SMehdi Amini       DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[1]);
748ef27db87SMehdi Amini       Metadata *Types = getMDOrNull(Record[2]);
749ef27db87SMehdi Amini       if (LLVM_UNLIKELY(IsOldTypeRefArray))
750ef27db87SMehdi Amini         Types = MetadataList.upgradeTypeRefArray(Types);
751ef27db87SMehdi Amini 
752ef27db87SMehdi Amini       MetadataList.assignValue(
753ef27db87SMehdi Amini           GET_OR_DISTINCT(DISubroutineType, (Context, Flags, CC, Types)),
754ef27db87SMehdi Amini           NextMetadataNo++);
755ef27db87SMehdi Amini       break;
756ef27db87SMehdi Amini     }
757ef27db87SMehdi Amini 
758ef27db87SMehdi Amini     case bitc::METADATA_MODULE: {
759ef27db87SMehdi Amini       if (Record.size() != 6)
760ef27db87SMehdi Amini         return error("Invalid record");
761ef27db87SMehdi Amini 
762ef27db87SMehdi Amini       IsDistinct = Record[0];
763ef27db87SMehdi Amini       MetadataList.assignValue(
764ef27db87SMehdi Amini           GET_OR_DISTINCT(DIModule,
765ef27db87SMehdi Amini                           (Context, getMDOrNull(Record[1]),
766ef27db87SMehdi Amini                            getMDString(Record[2]), getMDString(Record[3]),
767ef27db87SMehdi Amini                            getMDString(Record[4]), getMDString(Record[5]))),
768ef27db87SMehdi Amini           NextMetadataNo++);
769ef27db87SMehdi Amini       break;
770ef27db87SMehdi Amini     }
771ef27db87SMehdi Amini 
772ef27db87SMehdi Amini     case bitc::METADATA_FILE: {
773ef27db87SMehdi Amini       if (Record.size() != 3)
774ef27db87SMehdi Amini         return error("Invalid record");
775ef27db87SMehdi Amini 
776ef27db87SMehdi Amini       IsDistinct = Record[0];
777ef27db87SMehdi Amini       MetadataList.assignValue(
778ef27db87SMehdi Amini           GET_OR_DISTINCT(DIFile, (Context, getMDString(Record[1]),
779ef27db87SMehdi Amini                                    getMDString(Record[2]))),
780ef27db87SMehdi Amini           NextMetadataNo++);
781ef27db87SMehdi Amini       break;
782ef27db87SMehdi Amini     }
783ef27db87SMehdi Amini     case bitc::METADATA_COMPILE_UNIT: {
784ef27db87SMehdi Amini       if (Record.size() < 14 || Record.size() > 17)
785ef27db87SMehdi Amini         return error("Invalid record");
786ef27db87SMehdi Amini 
787ef27db87SMehdi Amini       // Ignore Record[0], which indicates whether this compile unit is
788ef27db87SMehdi Amini       // distinct.  It's always distinct.
789ef27db87SMehdi Amini       IsDistinct = true;
790ef27db87SMehdi Amini       auto *CU = DICompileUnit::getDistinct(
791ef27db87SMehdi Amini           Context, Record[1], getMDOrNull(Record[2]), getMDString(Record[3]),
792ef27db87SMehdi Amini           Record[4], getMDString(Record[5]), Record[6], getMDString(Record[7]),
793ef27db87SMehdi Amini           Record[8], getMDOrNull(Record[9]), getMDOrNull(Record[10]),
794ef27db87SMehdi Amini           getMDOrNull(Record[12]), getMDOrNull(Record[13]),
795ef27db87SMehdi Amini           Record.size() <= 15 ? nullptr : getMDOrNull(Record[15]),
796ef27db87SMehdi Amini           Record.size() <= 14 ? 0 : Record[14],
797ef27db87SMehdi Amini           Record.size() <= 16 ? true : Record[16]);
798ef27db87SMehdi Amini 
799ef27db87SMehdi Amini       MetadataList.assignValue(CU, NextMetadataNo++);
800ef27db87SMehdi Amini 
801ef27db87SMehdi Amini       // Move the Upgrade the list of subprograms.
802ef27db87SMehdi Amini       if (Metadata *SPs = getMDOrNullWithoutPlaceholders(Record[11]))
803ef27db87SMehdi Amini         CUSubprograms.push_back({CU, SPs});
804ef27db87SMehdi Amini       break;
805ef27db87SMehdi Amini     }
806ef27db87SMehdi Amini     case bitc::METADATA_SUBPROGRAM: {
807ef27db87SMehdi Amini       if (Record.size() < 18 || Record.size() > 20)
808ef27db87SMehdi Amini         return error("Invalid record");
809ef27db87SMehdi Amini 
810ef27db87SMehdi Amini       IsDistinct =
811ef27db87SMehdi Amini           (Record[0] & 1) || Record[8]; // All definitions should be distinct.
812ef27db87SMehdi Amini       // Version 1 has a Function as Record[15].
813ef27db87SMehdi Amini       // Version 2 has removed Record[15].
814ef27db87SMehdi Amini       // Version 3 has the Unit as Record[15].
815ef27db87SMehdi Amini       // Version 4 added thisAdjustment.
816ef27db87SMehdi Amini       bool HasUnit = Record[0] >= 2;
817ef27db87SMehdi Amini       if (HasUnit && Record.size() < 19)
818ef27db87SMehdi Amini         return error("Invalid record");
819ef27db87SMehdi Amini       Metadata *CUorFn = getMDOrNull(Record[15]);
820ef27db87SMehdi Amini       unsigned Offset = Record.size() >= 19 ? 1 : 0;
821ef27db87SMehdi Amini       bool HasFn = Offset && !HasUnit;
822ef27db87SMehdi Amini       bool HasThisAdj = Record.size() >= 20;
823ef27db87SMehdi Amini       DISubprogram *SP = GET_OR_DISTINCT(
824ef27db87SMehdi Amini           DISubprogram, (Context,
825ef27db87SMehdi Amini                          getDITypeRefOrNull(Record[1]),  // scope
826ef27db87SMehdi Amini                          getMDString(Record[2]),         // name
827ef27db87SMehdi Amini                          getMDString(Record[3]),         // linkageName
828ef27db87SMehdi Amini                          getMDOrNull(Record[4]),         // file
829ef27db87SMehdi Amini                          Record[5],                      // line
830ef27db87SMehdi Amini                          getMDOrNull(Record[6]),         // type
831ef27db87SMehdi Amini                          Record[7],                      // isLocal
832ef27db87SMehdi Amini                          Record[8],                      // isDefinition
833ef27db87SMehdi Amini                          Record[9],                      // scopeLine
834ef27db87SMehdi Amini                          getDITypeRefOrNull(Record[10]), // containingType
835ef27db87SMehdi Amini                          Record[11],                     // virtuality
836ef27db87SMehdi Amini                          Record[12],                     // virtualIndex
837ef27db87SMehdi Amini                          HasThisAdj ? Record[19] : 0,    // thisAdjustment
838ef27db87SMehdi Amini                          static_cast<DINode::DIFlags>(Record[13] // flags
839ef27db87SMehdi Amini                                                       ),
840ef27db87SMehdi Amini                          Record[14],                       // isOptimized
841ef27db87SMehdi Amini                          HasUnit ? CUorFn : nullptr,       // unit
842ef27db87SMehdi Amini                          getMDOrNull(Record[15 + Offset]), // templateParams
843ef27db87SMehdi Amini                          getMDOrNull(Record[16 + Offset]), // declaration
844ef27db87SMehdi Amini                          getMDOrNull(Record[17 + Offset])  // variables
845ef27db87SMehdi Amini                          ));
846ef27db87SMehdi Amini       MetadataList.assignValue(SP, NextMetadataNo++);
847ef27db87SMehdi Amini 
848ef27db87SMehdi Amini       // Upgrade sp->function mapping to function->sp mapping.
849ef27db87SMehdi Amini       if (HasFn) {
850ef27db87SMehdi Amini         if (auto *CMD = dyn_cast_or_null<ConstantAsMetadata>(CUorFn))
851ef27db87SMehdi Amini           if (auto *F = dyn_cast<Function>(CMD->getValue())) {
852ef27db87SMehdi Amini             if (F->isMaterializable())
853ef27db87SMehdi Amini               // Defer until materialized; unmaterialized functions may not have
854ef27db87SMehdi Amini               // metadata.
855ef27db87SMehdi Amini               FunctionsWithSPs[F] = SP;
856ef27db87SMehdi Amini             else if (!F->empty())
857ef27db87SMehdi Amini               F->setSubprogram(SP);
858ef27db87SMehdi Amini           }
859ef27db87SMehdi Amini       }
860ef27db87SMehdi Amini       break;
861ef27db87SMehdi Amini     }
862ef27db87SMehdi Amini     case bitc::METADATA_LEXICAL_BLOCK: {
863ef27db87SMehdi Amini       if (Record.size() != 5)
864ef27db87SMehdi Amini         return error("Invalid record");
865ef27db87SMehdi Amini 
866ef27db87SMehdi Amini       IsDistinct = Record[0];
867ef27db87SMehdi Amini       MetadataList.assignValue(
868ef27db87SMehdi Amini           GET_OR_DISTINCT(DILexicalBlock,
869ef27db87SMehdi Amini                           (Context, getMDOrNull(Record[1]),
870ef27db87SMehdi Amini                            getMDOrNull(Record[2]), Record[3], Record[4])),
871ef27db87SMehdi Amini           NextMetadataNo++);
872ef27db87SMehdi Amini       break;
873ef27db87SMehdi Amini     }
874ef27db87SMehdi Amini     case bitc::METADATA_LEXICAL_BLOCK_FILE: {
875ef27db87SMehdi Amini       if (Record.size() != 4)
876ef27db87SMehdi Amini         return error("Invalid record");
877ef27db87SMehdi Amini 
878ef27db87SMehdi Amini       IsDistinct = Record[0];
879ef27db87SMehdi Amini       MetadataList.assignValue(
880ef27db87SMehdi Amini           GET_OR_DISTINCT(DILexicalBlockFile,
881ef27db87SMehdi Amini                           (Context, getMDOrNull(Record[1]),
882ef27db87SMehdi Amini                            getMDOrNull(Record[2]), Record[3])),
883ef27db87SMehdi Amini           NextMetadataNo++);
884ef27db87SMehdi Amini       break;
885ef27db87SMehdi Amini     }
886ef27db87SMehdi Amini     case bitc::METADATA_NAMESPACE: {
887ef27db87SMehdi Amini       if (Record.size() != 5)
888ef27db87SMehdi Amini         return error("Invalid record");
889ef27db87SMehdi Amini 
890ef27db87SMehdi Amini       IsDistinct = Record[0] & 1;
891ef27db87SMehdi Amini       bool ExportSymbols = Record[0] & 2;
892ef27db87SMehdi Amini       MetadataList.assignValue(
893ef27db87SMehdi Amini           GET_OR_DISTINCT(DINamespace,
894ef27db87SMehdi Amini                           (Context, getMDOrNull(Record[1]),
895ef27db87SMehdi Amini                            getMDOrNull(Record[2]), getMDString(Record[3]),
896ef27db87SMehdi Amini                            Record[4], ExportSymbols)),
897ef27db87SMehdi Amini           NextMetadataNo++);
898ef27db87SMehdi Amini       break;
899ef27db87SMehdi Amini     }
900ef27db87SMehdi Amini     case bitc::METADATA_MACRO: {
901ef27db87SMehdi Amini       if (Record.size() != 5)
902ef27db87SMehdi Amini         return error("Invalid record");
903ef27db87SMehdi Amini 
904ef27db87SMehdi Amini       IsDistinct = Record[0];
905ef27db87SMehdi Amini       MetadataList.assignValue(
906ef27db87SMehdi Amini           GET_OR_DISTINCT(DIMacro,
907ef27db87SMehdi Amini                           (Context, Record[1], Record[2],
908ef27db87SMehdi Amini                            getMDString(Record[3]), getMDString(Record[4]))),
909ef27db87SMehdi Amini           NextMetadataNo++);
910ef27db87SMehdi Amini       break;
911ef27db87SMehdi Amini     }
912ef27db87SMehdi Amini     case bitc::METADATA_MACRO_FILE: {
913ef27db87SMehdi Amini       if (Record.size() != 5)
914ef27db87SMehdi Amini         return error("Invalid record");
915ef27db87SMehdi Amini 
916ef27db87SMehdi Amini       IsDistinct = Record[0];
917ef27db87SMehdi Amini       MetadataList.assignValue(
918ef27db87SMehdi Amini           GET_OR_DISTINCT(DIMacroFile,
919ef27db87SMehdi Amini                           (Context, Record[1], Record[2],
920ef27db87SMehdi Amini                            getMDOrNull(Record[3]), getMDOrNull(Record[4]))),
921ef27db87SMehdi Amini           NextMetadataNo++);
922ef27db87SMehdi Amini       break;
923ef27db87SMehdi Amini     }
924ef27db87SMehdi Amini     case bitc::METADATA_TEMPLATE_TYPE: {
925ef27db87SMehdi Amini       if (Record.size() != 3)
926ef27db87SMehdi Amini         return error("Invalid record");
927ef27db87SMehdi Amini 
928ef27db87SMehdi Amini       IsDistinct = Record[0];
929ef27db87SMehdi Amini       MetadataList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter,
930ef27db87SMehdi Amini                                                (Context, getMDString(Record[1]),
931ef27db87SMehdi Amini                                                 getDITypeRefOrNull(Record[2]))),
932ef27db87SMehdi Amini                                NextMetadataNo++);
933ef27db87SMehdi Amini       break;
934ef27db87SMehdi Amini     }
935ef27db87SMehdi Amini     case bitc::METADATA_TEMPLATE_VALUE: {
936ef27db87SMehdi Amini       if (Record.size() != 5)
937ef27db87SMehdi Amini         return error("Invalid record");
938ef27db87SMehdi Amini 
939ef27db87SMehdi Amini       IsDistinct = Record[0];
940ef27db87SMehdi Amini       MetadataList.assignValue(
941ef27db87SMehdi Amini           GET_OR_DISTINCT(DITemplateValueParameter,
942ef27db87SMehdi Amini                           (Context, Record[1], getMDString(Record[2]),
943ef27db87SMehdi Amini                            getDITypeRefOrNull(Record[3]),
944ef27db87SMehdi Amini                            getMDOrNull(Record[4]))),
945ef27db87SMehdi Amini           NextMetadataNo++);
946ef27db87SMehdi Amini       break;
947ef27db87SMehdi Amini     }
948ef27db87SMehdi Amini     case bitc::METADATA_GLOBAL_VAR: {
949ef27db87SMehdi Amini       if (Record.size() < 11 || Record.size() > 12)
950ef27db87SMehdi Amini         return error("Invalid record");
951ef27db87SMehdi Amini 
952ef27db87SMehdi Amini       IsDistinct = Record[0];
953ef27db87SMehdi Amini 
954ef27db87SMehdi Amini       // Upgrade old metadata, which stored a global variable reference or a
955ef27db87SMehdi Amini       // ConstantInt here.
956ef27db87SMehdi Amini       Metadata *Expr = getMDOrNull(Record[9]);
957ef27db87SMehdi Amini       uint32_t AlignInBits = 0;
958ef27db87SMehdi Amini       if (Record.size() > 11) {
959ef27db87SMehdi Amini         if (Record[11] > (uint64_t)std::numeric_limits<uint32_t>::max())
960ef27db87SMehdi Amini           return error("Alignment value is too large");
961ef27db87SMehdi Amini         AlignInBits = Record[11];
962ef27db87SMehdi Amini       }
963ef27db87SMehdi Amini       GlobalVariable *Attach = nullptr;
964ef27db87SMehdi Amini       if (auto *CMD = dyn_cast_or_null<ConstantAsMetadata>(Expr)) {
965ef27db87SMehdi Amini         if (auto *GV = dyn_cast<GlobalVariable>(CMD->getValue())) {
966ef27db87SMehdi Amini           Attach = GV;
967ef27db87SMehdi Amini           Expr = nullptr;
968ef27db87SMehdi Amini         } else if (auto *CI = dyn_cast<ConstantInt>(CMD->getValue())) {
969ef27db87SMehdi Amini           Expr = DIExpression::get(Context,
970ef27db87SMehdi Amini                                    {dwarf::DW_OP_constu, CI->getZExtValue(),
971ef27db87SMehdi Amini                                     dwarf::DW_OP_stack_value});
972ef27db87SMehdi Amini         } else {
973ef27db87SMehdi Amini           Expr = nullptr;
974ef27db87SMehdi Amini         }
975ef27db87SMehdi Amini       }
976ef27db87SMehdi Amini 
977ef27db87SMehdi Amini       DIGlobalVariable *DGV = GET_OR_DISTINCT(
978ef27db87SMehdi Amini           DIGlobalVariable,
979ef27db87SMehdi Amini           (Context, getMDOrNull(Record[1]), getMDString(Record[2]),
980ef27db87SMehdi Amini            getMDString(Record[3]), getMDOrNull(Record[4]), Record[5],
981*74a835cdSAdrian Prantl            getDITypeRefOrNull(Record[6]), Record[7], Record[8],
982ef27db87SMehdi Amini            getMDOrNull(Record[10]), AlignInBits));
983ef27db87SMehdi Amini 
984*74a835cdSAdrian Prantl       if (Expr || Attach) {
985*74a835cdSAdrian Prantl         auto *DGVE = DIGlobalVariableExpression::getDistinct(Context, DGV, Expr);
986*74a835cdSAdrian Prantl         MetadataList.assignValue(DGVE, NextMetadataNo++);
98703c6d31aSAdrian Prantl         if (Attach)
988*74a835cdSAdrian Prantl           Attach->addDebugInfo(DGVE);
989*74a835cdSAdrian Prantl       } else
990*74a835cdSAdrian Prantl         MetadataList.assignValue(DGV, NextMetadataNo++);
99103c6d31aSAdrian Prantl 
992ef27db87SMehdi Amini       break;
993ef27db87SMehdi Amini     }
994ef27db87SMehdi Amini     case bitc::METADATA_LOCAL_VAR: {
995ef27db87SMehdi Amini       // 10th field is for the obseleted 'inlinedAt:' field.
996ef27db87SMehdi Amini       if (Record.size() < 8 || Record.size() > 10)
997ef27db87SMehdi Amini         return error("Invalid record");
998ef27db87SMehdi Amini 
999ef27db87SMehdi Amini       IsDistinct = Record[0] & 1;
1000ef27db87SMehdi Amini       bool HasAlignment = Record[0] & 2;
1001ef27db87SMehdi Amini       // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or
1002ef27db87SMehdi Amini       // DW_TAG_arg_variable, if we have alignment flag encoded it means, that
1003ef27db87SMehdi Amini       // this is newer version of record which doesn't have artifical tag.
1004ef27db87SMehdi Amini       bool HasTag = !HasAlignment && Record.size() > 8;
1005ef27db87SMehdi Amini       DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[7 + HasTag]);
1006ef27db87SMehdi Amini       uint32_t AlignInBits = 0;
1007ef27db87SMehdi Amini       if (HasAlignment) {
1008ef27db87SMehdi Amini         if (Record[8 + HasTag] > (uint64_t)std::numeric_limits<uint32_t>::max())
1009ef27db87SMehdi Amini           return error("Alignment value is too large");
1010ef27db87SMehdi Amini         AlignInBits = Record[8 + HasTag];
1011ef27db87SMehdi Amini       }
1012ef27db87SMehdi Amini       MetadataList.assignValue(
1013ef27db87SMehdi Amini           GET_OR_DISTINCT(DILocalVariable,
1014ef27db87SMehdi Amini                           (Context, getMDOrNull(Record[1 + HasTag]),
1015ef27db87SMehdi Amini                            getMDString(Record[2 + HasTag]),
1016ef27db87SMehdi Amini                            getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag],
1017ef27db87SMehdi Amini                            getDITypeRefOrNull(Record[5 + HasTag]),
1018ef27db87SMehdi Amini                            Record[6 + HasTag], Flags, AlignInBits)),
1019ef27db87SMehdi Amini           NextMetadataNo++);
1020ef27db87SMehdi Amini       break;
1021ef27db87SMehdi Amini     }
1022ef27db87SMehdi Amini     case bitc::METADATA_EXPRESSION: {
1023ef27db87SMehdi Amini       if (Record.size() < 1)
1024ef27db87SMehdi Amini         return error("Invalid record");
1025ef27db87SMehdi Amini 
1026ef27db87SMehdi Amini       IsDistinct = Record[0] & 1;
1027ef27db87SMehdi Amini       bool HasOpFragment = Record[0] & 2;
1028ef27db87SMehdi Amini       auto Elts = MutableArrayRef<uint64_t>(Record).slice(1);
1029ef27db87SMehdi Amini       if (!HasOpFragment)
1030ef27db87SMehdi Amini         if (unsigned N = Elts.size())
1031ef27db87SMehdi Amini           if (N >= 3 && Elts[N - 3] == dwarf::DW_OP_bit_piece)
1032ef27db87SMehdi Amini             Elts[N - 3] = dwarf::DW_OP_LLVM_fragment;
1033ef27db87SMehdi Amini 
1034ef27db87SMehdi Amini       MetadataList.assignValue(
1035ef27db87SMehdi Amini           GET_OR_DISTINCT(DIExpression,
1036ef27db87SMehdi Amini                           (Context, makeArrayRef(Record).slice(1))),
1037ef27db87SMehdi Amini           NextMetadataNo++);
1038ef27db87SMehdi Amini       break;
1039ef27db87SMehdi Amini     }
1040*74a835cdSAdrian Prantl     case bitc::METADATA_GLOBAL_VAR_EXPR: {
1041*74a835cdSAdrian Prantl       if (Record.size() != 3)
1042*74a835cdSAdrian Prantl         return error("Invalid record");
1043*74a835cdSAdrian Prantl 
1044*74a835cdSAdrian Prantl       IsDistinct = Record[0];
1045*74a835cdSAdrian Prantl       MetadataList.assignValue(GET_OR_DISTINCT(DIGlobalVariableExpression,
1046*74a835cdSAdrian Prantl                                                (Context, getMDOrNull(Record[1]),
1047*74a835cdSAdrian Prantl                                                 getMDOrNull(Record[2]))),
1048*74a835cdSAdrian Prantl                                NextMetadataNo++);
1049*74a835cdSAdrian Prantl       break;
1050*74a835cdSAdrian Prantl     }
1051ef27db87SMehdi Amini     case bitc::METADATA_OBJC_PROPERTY: {
1052ef27db87SMehdi Amini       if (Record.size() != 8)
1053ef27db87SMehdi Amini         return error("Invalid record");
1054ef27db87SMehdi Amini 
1055ef27db87SMehdi Amini       IsDistinct = Record[0];
1056ef27db87SMehdi Amini       MetadataList.assignValue(
1057ef27db87SMehdi Amini           GET_OR_DISTINCT(DIObjCProperty,
1058ef27db87SMehdi Amini                           (Context, getMDString(Record[1]),
1059ef27db87SMehdi Amini                            getMDOrNull(Record[2]), Record[3],
1060ef27db87SMehdi Amini                            getMDString(Record[4]), getMDString(Record[5]),
1061ef27db87SMehdi Amini                            Record[6], getDITypeRefOrNull(Record[7]))),
1062ef27db87SMehdi Amini           NextMetadataNo++);
1063ef27db87SMehdi Amini       break;
1064ef27db87SMehdi Amini     }
1065ef27db87SMehdi Amini     case bitc::METADATA_IMPORTED_ENTITY: {
1066ef27db87SMehdi Amini       if (Record.size() != 6)
1067ef27db87SMehdi Amini         return error("Invalid record");
1068ef27db87SMehdi Amini 
1069ef27db87SMehdi Amini       IsDistinct = Record[0];
1070ef27db87SMehdi Amini       MetadataList.assignValue(
1071ef27db87SMehdi Amini           GET_OR_DISTINCT(DIImportedEntity,
1072ef27db87SMehdi Amini                           (Context, Record[1], getMDOrNull(Record[2]),
1073ef27db87SMehdi Amini                            getDITypeRefOrNull(Record[3]), Record[4],
1074ef27db87SMehdi Amini                            getMDString(Record[5]))),
1075ef27db87SMehdi Amini           NextMetadataNo++);
1076ef27db87SMehdi Amini       break;
1077ef27db87SMehdi Amini     }
1078ef27db87SMehdi Amini     case bitc::METADATA_STRING_OLD: {
1079ef27db87SMehdi Amini       std::string String(Record.begin(), Record.end());
1080ef27db87SMehdi Amini 
1081ef27db87SMehdi Amini       // Test for upgrading !llvm.loop.
1082ef27db87SMehdi Amini       HasSeenOldLoopTags |= mayBeOldLoopAttachmentTag(String);
1083ef27db87SMehdi Amini 
1084ef27db87SMehdi Amini       Metadata *MD = MDString::get(Context, String);
1085ef27db87SMehdi Amini       MetadataList.assignValue(MD, NextMetadataNo++);
1086ef27db87SMehdi Amini       break;
1087ef27db87SMehdi Amini     }
1088ef27db87SMehdi Amini     case bitc::METADATA_STRINGS:
1089ef27db87SMehdi Amini       if (Error Err = parseMetadataStrings(Record, Blob, NextMetadataNo))
1090ef27db87SMehdi Amini         return Err;
1091ef27db87SMehdi Amini       break;
1092ef27db87SMehdi Amini     case bitc::METADATA_GLOBAL_DECL_ATTACHMENT: {
1093ef27db87SMehdi Amini       if (Record.size() % 2 == 0)
1094ef27db87SMehdi Amini         return error("Invalid record");
1095ef27db87SMehdi Amini       unsigned ValueID = Record[0];
1096ef27db87SMehdi Amini       if (ValueID >= ValueList.size())
1097ef27db87SMehdi Amini         return error("Invalid record");
1098ef27db87SMehdi Amini       if (auto *GO = dyn_cast<GlobalObject>(ValueList[ValueID]))
1099ef27db87SMehdi Amini         if (Error Err = parseGlobalObjectAttachment(
1100ef27db87SMehdi Amini                 *GO, ArrayRef<uint64_t>(Record).slice(1)))
1101ef27db87SMehdi Amini           return Err;
1102ef27db87SMehdi Amini       break;
1103ef27db87SMehdi Amini     }
1104ef27db87SMehdi Amini     case bitc::METADATA_KIND: {
1105ef27db87SMehdi Amini       // Support older bitcode files that had METADATA_KIND records in a
1106ef27db87SMehdi Amini       // block with METADATA_BLOCK_ID.
1107ef27db87SMehdi Amini       if (Error Err = parseMetadataKindRecord(Record))
1108ef27db87SMehdi Amini         return Err;
1109ef27db87SMehdi Amini       break;
1110ef27db87SMehdi Amini     }
1111ef27db87SMehdi Amini     }
1112ef27db87SMehdi Amini   }
1113ef27db87SMehdi Amini #undef GET_OR_DISTINCT
1114ef27db87SMehdi Amini }
1115ef27db87SMehdi Amini 
1116ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataStrings(
1117ef27db87SMehdi Amini     ArrayRef<uint64_t> Record, StringRef Blob, unsigned &NextMetadataNo) {
1118ef27db87SMehdi Amini   // All the MDStrings in the block are emitted together in a single
1119ef27db87SMehdi Amini   // record.  The strings are concatenated and stored in a blob along with
1120ef27db87SMehdi Amini   // their sizes.
1121ef27db87SMehdi Amini   if (Record.size() != 2)
1122ef27db87SMehdi Amini     return error("Invalid record: metadata strings layout");
1123ef27db87SMehdi Amini 
1124ef27db87SMehdi Amini   unsigned NumStrings = Record[0];
1125ef27db87SMehdi Amini   unsigned StringsOffset = Record[1];
1126ef27db87SMehdi Amini   if (!NumStrings)
1127ef27db87SMehdi Amini     return error("Invalid record: metadata strings with no strings");
1128ef27db87SMehdi Amini   if (StringsOffset > Blob.size())
1129ef27db87SMehdi Amini     return error("Invalid record: metadata strings corrupt offset");
1130ef27db87SMehdi Amini 
1131ef27db87SMehdi Amini   StringRef Lengths = Blob.slice(0, StringsOffset);
1132ef27db87SMehdi Amini   SimpleBitstreamCursor R(Lengths);
1133ef27db87SMehdi Amini 
1134ef27db87SMehdi Amini   StringRef Strings = Blob.drop_front(StringsOffset);
1135ef27db87SMehdi Amini   do {
1136ef27db87SMehdi Amini     if (R.AtEndOfStream())
1137ef27db87SMehdi Amini       return error("Invalid record: metadata strings bad length");
1138ef27db87SMehdi Amini 
1139ef27db87SMehdi Amini     unsigned Size = R.ReadVBR(6);
1140ef27db87SMehdi Amini     if (Strings.size() < Size)
1141ef27db87SMehdi Amini       return error("Invalid record: metadata strings truncated chars");
1142ef27db87SMehdi Amini 
1143ef27db87SMehdi Amini     MetadataList.assignValue(MDString::get(Context, Strings.slice(0, Size)),
1144ef27db87SMehdi Amini                              NextMetadataNo++);
1145ef27db87SMehdi Amini     Strings = Strings.drop_front(Size);
1146ef27db87SMehdi Amini   } while (--NumStrings);
1147ef27db87SMehdi Amini 
1148ef27db87SMehdi Amini   return Error::success();
1149ef27db87SMehdi Amini }
1150ef27db87SMehdi Amini 
1151ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseGlobalObjectAttachment(
1152ef27db87SMehdi Amini     GlobalObject &GO, ArrayRef<uint64_t> Record) {
1153ef27db87SMehdi Amini   assert(Record.size() % 2 == 0);
1154ef27db87SMehdi Amini   for (unsigned I = 0, E = Record.size(); I != E; I += 2) {
1155ef27db87SMehdi Amini     auto K = MDKindMap.find(Record[I]);
1156ef27db87SMehdi Amini     if (K == MDKindMap.end())
1157ef27db87SMehdi Amini       return error("Invalid ID");
1158ef27db87SMehdi Amini     MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[I + 1]);
1159ef27db87SMehdi Amini     if (!MD)
1160ef27db87SMehdi Amini       return error("Invalid metadata attachment");
1161ef27db87SMehdi Amini     GO.addMetadata(K->second, *MD);
1162ef27db87SMehdi Amini   }
1163ef27db87SMehdi Amini   return Error::success();
1164ef27db87SMehdi Amini }
1165ef27db87SMehdi Amini 
1166ef27db87SMehdi Amini /// Parse metadata attachments.
1167ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataAttachment(
1168ef27db87SMehdi Amini     Function &F, const SmallVectorImpl<Instruction *> &InstructionList) {
1169ef27db87SMehdi Amini   if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
1170ef27db87SMehdi Amini     return error("Invalid record");
1171ef27db87SMehdi Amini 
1172ef27db87SMehdi Amini   SmallVector<uint64_t, 64> Record;
1173ef27db87SMehdi Amini 
1174ef27db87SMehdi Amini   while (true) {
1175ef27db87SMehdi Amini     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1176ef27db87SMehdi Amini 
1177ef27db87SMehdi Amini     switch (Entry.Kind) {
1178ef27db87SMehdi Amini     case BitstreamEntry::SubBlock: // Handled for us already.
1179ef27db87SMehdi Amini     case BitstreamEntry::Error:
1180ef27db87SMehdi Amini       return error("Malformed block");
1181ef27db87SMehdi Amini     case BitstreamEntry::EndBlock:
1182ef27db87SMehdi Amini       return Error::success();
1183ef27db87SMehdi Amini     case BitstreamEntry::Record:
1184ef27db87SMehdi Amini       // The interesting case.
1185ef27db87SMehdi Amini       break;
1186ef27db87SMehdi Amini     }
1187ef27db87SMehdi Amini 
1188ef27db87SMehdi Amini     // Read a metadata attachment record.
1189ef27db87SMehdi Amini     Record.clear();
1190ef27db87SMehdi Amini     switch (Stream.readRecord(Entry.ID, Record)) {
1191ef27db87SMehdi Amini     default: // Default behavior: ignore.
1192ef27db87SMehdi Amini       break;
1193ef27db87SMehdi Amini     case bitc::METADATA_ATTACHMENT: {
1194ef27db87SMehdi Amini       unsigned RecordLength = Record.size();
1195ef27db87SMehdi Amini       if (Record.empty())
1196ef27db87SMehdi Amini         return error("Invalid record");
1197ef27db87SMehdi Amini       if (RecordLength % 2 == 0) {
1198ef27db87SMehdi Amini         // A function attachment.
1199ef27db87SMehdi Amini         if (Error Err = parseGlobalObjectAttachment(F, Record))
1200ef27db87SMehdi Amini           return Err;
1201ef27db87SMehdi Amini         continue;
1202ef27db87SMehdi Amini       }
1203ef27db87SMehdi Amini 
1204ef27db87SMehdi Amini       // An instruction attachment.
1205ef27db87SMehdi Amini       Instruction *Inst = InstructionList[Record[0]];
1206ef27db87SMehdi Amini       for (unsigned i = 1; i != RecordLength; i = i + 2) {
1207ef27db87SMehdi Amini         unsigned Kind = Record[i];
1208ef27db87SMehdi Amini         DenseMap<unsigned, unsigned>::iterator I = MDKindMap.find(Kind);
1209ef27db87SMehdi Amini         if (I == MDKindMap.end())
1210ef27db87SMehdi Amini           return error("Invalid ID");
1211ef27db87SMehdi Amini         Metadata *Node = MetadataList.getMetadataFwdRef(Record[i + 1]);
1212ef27db87SMehdi Amini         if (isa<LocalAsMetadata>(Node))
1213ef27db87SMehdi Amini           // Drop the attachment.  This used to be legal, but there's no
1214ef27db87SMehdi Amini           // upgrade path.
1215ef27db87SMehdi Amini           break;
1216ef27db87SMehdi Amini         MDNode *MD = dyn_cast_or_null<MDNode>(Node);
1217ef27db87SMehdi Amini         if (!MD)
1218ef27db87SMehdi Amini           return error("Invalid metadata attachment");
1219ef27db87SMehdi Amini 
1220ef27db87SMehdi Amini         if (HasSeenOldLoopTags && I->second == LLVMContext::MD_loop)
1221ef27db87SMehdi Amini           MD = upgradeInstructionLoopAttachment(*MD);
1222ef27db87SMehdi Amini 
1223ef27db87SMehdi Amini         if (I->second == LLVMContext::MD_tbaa) {
1224ef27db87SMehdi Amini           assert(!MD->isTemporary() && "should load MDs before attachments");
1225ef27db87SMehdi Amini           MD = UpgradeTBAANode(*MD);
1226ef27db87SMehdi Amini         }
1227ef27db87SMehdi Amini         Inst->setMetadata(I->second, MD);
1228ef27db87SMehdi Amini       }
1229ef27db87SMehdi Amini       break;
1230ef27db87SMehdi Amini     }
1231ef27db87SMehdi Amini     }
1232ef27db87SMehdi Amini   }
1233ef27db87SMehdi Amini }
1234ef27db87SMehdi Amini 
1235ef27db87SMehdi Amini /// Parse a single METADATA_KIND record, inserting result in MDKindMap.
1236ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataKindRecord(
1237ef27db87SMehdi Amini     SmallVectorImpl<uint64_t> &Record) {
1238ef27db87SMehdi Amini   if (Record.size() < 2)
1239ef27db87SMehdi Amini     return error("Invalid record");
1240ef27db87SMehdi Amini 
1241ef27db87SMehdi Amini   unsigned Kind = Record[0];
1242ef27db87SMehdi Amini   SmallString<8> Name(Record.begin() + 1, Record.end());
1243ef27db87SMehdi Amini 
1244ef27db87SMehdi Amini   unsigned NewKind = TheModule.getMDKindID(Name.str());
1245ef27db87SMehdi Amini   if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1246ef27db87SMehdi Amini     return error("Conflicting METADATA_KIND records");
1247ef27db87SMehdi Amini   return Error::success();
1248ef27db87SMehdi Amini }
1249ef27db87SMehdi Amini 
1250ef27db87SMehdi Amini /// Parse the metadata kinds out of the METADATA_KIND_BLOCK.
1251ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataKinds() {
1252ef27db87SMehdi Amini   if (Stream.EnterSubBlock(bitc::METADATA_KIND_BLOCK_ID))
1253ef27db87SMehdi Amini     return error("Invalid record");
1254ef27db87SMehdi Amini 
1255ef27db87SMehdi Amini   SmallVector<uint64_t, 64> Record;
1256ef27db87SMehdi Amini 
1257ef27db87SMehdi Amini   // Read all the records.
1258ef27db87SMehdi Amini   while (true) {
1259ef27db87SMehdi Amini     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1260ef27db87SMehdi Amini 
1261ef27db87SMehdi Amini     switch (Entry.Kind) {
1262ef27db87SMehdi Amini     case BitstreamEntry::SubBlock: // Handled for us already.
1263ef27db87SMehdi Amini     case BitstreamEntry::Error:
1264ef27db87SMehdi Amini       return error("Malformed block");
1265ef27db87SMehdi Amini     case BitstreamEntry::EndBlock:
1266ef27db87SMehdi Amini       return Error::success();
1267ef27db87SMehdi Amini     case BitstreamEntry::Record:
1268ef27db87SMehdi Amini       // The interesting case.
1269ef27db87SMehdi Amini       break;
1270ef27db87SMehdi Amini     }
1271ef27db87SMehdi Amini 
1272ef27db87SMehdi Amini     // Read a record.
1273ef27db87SMehdi Amini     Record.clear();
1274ef27db87SMehdi Amini     unsigned Code = Stream.readRecord(Entry.ID, Record);
1275ef27db87SMehdi Amini     switch (Code) {
1276ef27db87SMehdi Amini     default: // Default behavior: ignore.
1277ef27db87SMehdi Amini       break;
1278ef27db87SMehdi Amini     case bitc::METADATA_KIND: {
1279ef27db87SMehdi Amini       if (Error Err = parseMetadataKindRecord(Record))
1280ef27db87SMehdi Amini         return Err;
1281ef27db87SMehdi Amini       break;
1282ef27db87SMehdi Amini     }
1283ef27db87SMehdi Amini     }
1284ef27db87SMehdi Amini   }
1285ef27db87SMehdi Amini }
1286ef27db87SMehdi Amini 
1287ef27db87SMehdi Amini MetadataLoader &MetadataLoader::operator=(MetadataLoader &&RHS) {
1288ef27db87SMehdi Amini   Pimpl = std::move(RHS.Pimpl);
1289ef27db87SMehdi Amini   return *this;
1290ef27db87SMehdi Amini }
1291ef27db87SMehdi Amini MetadataLoader::MetadataLoader(MetadataLoader &&RHS)
1292ef27db87SMehdi Amini     : Pimpl(std::move(RHS.Pimpl)) {}
1293ef27db87SMehdi Amini 
1294ef27db87SMehdi Amini MetadataLoader::~MetadataLoader() = default;
1295ef27db87SMehdi Amini MetadataLoader::MetadataLoader(BitstreamCursor &Stream, Module &TheModule,
1296ef27db87SMehdi Amini                                BitcodeReaderValueList &ValueList,
1297ef27db87SMehdi Amini                                std::function<Type *(unsigned)> getTypeByID)
1298b3901bddSNico Weber     : Pimpl(llvm::make_unique<MetadataLoaderImpl>(Stream, TheModule, ValueList,
1299ef27db87SMehdi Amini                                                   getTypeByID)) {}
1300ef27db87SMehdi Amini 
1301ef27db87SMehdi Amini Error MetadataLoader::parseMetadata(bool ModuleLevel) {
1302ef27db87SMehdi Amini   return Pimpl->parseMetadata(ModuleLevel);
1303ef27db87SMehdi Amini }
1304ef27db87SMehdi Amini 
1305ef27db87SMehdi Amini bool MetadataLoader::hasFwdRefs() const { return Pimpl->hasFwdRefs(); }
1306ef27db87SMehdi Amini 
1307ef27db87SMehdi Amini /// Return the given metadata, creating a replaceable forward reference if
1308ef27db87SMehdi Amini /// necessary.
1309ef27db87SMehdi Amini Metadata *MetadataLoader::getMetadataFwdRef(unsigned Idx) {
1310ef27db87SMehdi Amini   return Pimpl->getMetadataFwdRef(Idx);
1311ef27db87SMehdi Amini }
1312ef27db87SMehdi Amini 
1313ef27db87SMehdi Amini MDNode *MetadataLoader::getMDNodeFwdRefOrNull(unsigned Idx) {
1314ef27db87SMehdi Amini   return Pimpl->getMDNodeFwdRefOrNull(Idx);
1315ef27db87SMehdi Amini }
1316ef27db87SMehdi Amini 
1317ef27db87SMehdi Amini DISubprogram *MetadataLoader::lookupSubprogramForFunction(Function *F) {
1318ef27db87SMehdi Amini   return Pimpl->lookupSubprogramForFunction(F);
1319ef27db87SMehdi Amini }
1320ef27db87SMehdi Amini 
1321ef27db87SMehdi Amini Error MetadataLoader::parseMetadataAttachment(
1322ef27db87SMehdi Amini     Function &F, const SmallVectorImpl<Instruction *> &InstructionList) {
1323ef27db87SMehdi Amini   return Pimpl->parseMetadataAttachment(F, InstructionList);
1324ef27db87SMehdi Amini }
1325ef27db87SMehdi Amini 
1326ef27db87SMehdi Amini Error MetadataLoader::parseMetadataKinds() {
1327ef27db87SMehdi Amini   return Pimpl->parseMetadataKinds();
1328ef27db87SMehdi Amini }
1329ef27db87SMehdi Amini 
1330ef27db87SMehdi Amini unsigned MetadataLoader::size() const { return Pimpl->size(); }
1331ef27db87SMehdi Amini void MetadataLoader::shrinkTo(unsigned N) { return Pimpl->shrinkTo(N); }
1332