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" 1719ef4fadSMehdi Amini #include "llvm/ADT/DenseSet.h" 18ef27db87SMehdi Amini #include "llvm/ADT/None.h" 19ef27db87SMehdi Amini #include "llvm/ADT/STLExtras.h" 20ef27db87SMehdi Amini #include "llvm/ADT/SmallString.h" 21ef27db87SMehdi Amini #include "llvm/ADT/SmallVector.h" 2219ef4fadSMehdi Amini #include "llvm/ADT/Statistic.h" 23ef27db87SMehdi Amini #include "llvm/ADT/StringRef.h" 24ef27db87SMehdi Amini #include "llvm/ADT/Triple.h" 25ef27db87SMehdi Amini #include "llvm/ADT/Twine.h" 26ef27db87SMehdi Amini #include "llvm/Bitcode/BitcodeReader.h" 27ef27db87SMehdi Amini #include "llvm/Bitcode/BitstreamReader.h" 28ef27db87SMehdi Amini #include "llvm/Bitcode/LLVMBitCodes.h" 29ef27db87SMehdi Amini #include "llvm/IR/Argument.h" 30ef27db87SMehdi Amini #include "llvm/IR/Attributes.h" 31ef27db87SMehdi Amini #include "llvm/IR/AutoUpgrade.h" 32ef27db87SMehdi Amini #include "llvm/IR/BasicBlock.h" 33ef27db87SMehdi Amini #include "llvm/IR/CallSite.h" 34ef27db87SMehdi Amini #include "llvm/IR/CallingConv.h" 35ef27db87SMehdi Amini #include "llvm/IR/Comdat.h" 36ef27db87SMehdi Amini #include "llvm/IR/Constant.h" 37ef27db87SMehdi Amini #include "llvm/IR/Constants.h" 38ef27db87SMehdi Amini #include "llvm/IR/DebugInfo.h" 39ef27db87SMehdi Amini #include "llvm/IR/DebugInfoMetadata.h" 40ef27db87SMehdi Amini #include "llvm/IR/DebugLoc.h" 41ef27db87SMehdi Amini #include "llvm/IR/DerivedTypes.h" 42ef27db87SMehdi Amini #include "llvm/IR/DiagnosticInfo.h" 43ef27db87SMehdi Amini #include "llvm/IR/DiagnosticPrinter.h" 44ef27db87SMehdi Amini #include "llvm/IR/Function.h" 45ef27db87SMehdi Amini #include "llvm/IR/GVMaterializer.h" 46ef27db87SMehdi Amini #include "llvm/IR/GlobalAlias.h" 47ef27db87SMehdi Amini #include "llvm/IR/GlobalIFunc.h" 48ef27db87SMehdi Amini #include "llvm/IR/GlobalIndirectSymbol.h" 49ef27db87SMehdi Amini #include "llvm/IR/GlobalObject.h" 50ef27db87SMehdi Amini #include "llvm/IR/GlobalValue.h" 51ef27db87SMehdi Amini #include "llvm/IR/GlobalVariable.h" 52ef27db87SMehdi Amini #include "llvm/IR/InlineAsm.h" 53ef27db87SMehdi Amini #include "llvm/IR/InstrTypes.h" 54ef27db87SMehdi Amini #include "llvm/IR/Instruction.h" 55ef27db87SMehdi Amini #include "llvm/IR/Instructions.h" 56ef27db87SMehdi Amini #include "llvm/IR/Intrinsics.h" 576825fb64SAdrian Prantl #include "llvm/IR/IntrinsicInst.h" 58ef27db87SMehdi Amini #include "llvm/IR/LLVMContext.h" 59ef27db87SMehdi Amini #include "llvm/IR/Module.h" 60ef27db87SMehdi Amini #include "llvm/IR/ModuleSummaryIndex.h" 61ef27db87SMehdi Amini #include "llvm/IR/OperandTraits.h" 62ef27db87SMehdi Amini #include "llvm/IR/Operator.h" 63ef27db87SMehdi Amini #include "llvm/IR/TrackingMDRef.h" 64ef27db87SMehdi Amini #include "llvm/IR/Type.h" 65ef27db87SMehdi Amini #include "llvm/IR/ValueHandle.h" 66ef27db87SMehdi Amini #include "llvm/Support/AtomicOrdering.h" 67ef27db87SMehdi Amini #include "llvm/Support/Casting.h" 68ef27db87SMehdi Amini #include "llvm/Support/CommandLine.h" 69ef27db87SMehdi Amini #include "llvm/Support/Compiler.h" 70ef27db87SMehdi Amini #include "llvm/Support/Debug.h" 71ef27db87SMehdi Amini #include "llvm/Support/Error.h" 72ef27db87SMehdi Amini #include "llvm/Support/ErrorHandling.h" 73ef27db87SMehdi Amini #include "llvm/Support/ManagedStatic.h" 74ef27db87SMehdi Amini #include "llvm/Support/MemoryBuffer.h" 75ef27db87SMehdi Amini #include "llvm/Support/raw_ostream.h" 76ef27db87SMehdi Amini #include <algorithm> 77ef27db87SMehdi Amini #include <cassert> 78ef27db87SMehdi Amini #include <cstddef> 79ef27db87SMehdi Amini #include <cstdint> 80ef27db87SMehdi Amini #include <deque> 81ef27db87SMehdi Amini #include <limits> 82ef27db87SMehdi Amini #include <map> 83ef27db87SMehdi Amini #include <memory> 84ef27db87SMehdi Amini #include <string> 85ef27db87SMehdi Amini #include <system_error> 86ef27db87SMehdi Amini #include <tuple> 87ef27db87SMehdi Amini #include <utility> 88ef27db87SMehdi Amini #include <vector> 89ef27db87SMehdi Amini 90ef27db87SMehdi Amini using namespace llvm; 91ef27db87SMehdi Amini 9219ef4fadSMehdi Amini #define DEBUG_TYPE "bitcode-reader" 9319ef4fadSMehdi Amini 9419ef4fadSMehdi Amini STATISTIC(NumMDStringLoaded, "Number of MDStrings loaded"); 9519ef4fadSMehdi Amini STATISTIC(NumMDNodeTemporary, "Number of MDNode::Temporary created"); 9619ef4fadSMehdi Amini STATISTIC(NumMDRecordLoaded, "Number of Metadata records loaded"); 9719ef4fadSMehdi Amini 98a61f5e37STeresa Johnson /// Flag whether we need to import full type definitions for ThinLTO. 99a61f5e37STeresa Johnson /// Currently needed for Darwin and LLDB. 100a61f5e37STeresa Johnson static cl::opt<bool> ImportFullTypeDefinitions( 101a61f5e37STeresa Johnson "import-full-type-definitions", cl::init(false), cl::Hidden, 102a61f5e37STeresa Johnson cl::desc("Import full type definitions for ThinLTO.")); 103a61f5e37STeresa Johnson 10419ef4fadSMehdi Amini static cl::opt<bool> DisableLazyLoading( 10519ef4fadSMehdi Amini "disable-ondemand-mds-loading", cl::init(false), cl::Hidden, 10619ef4fadSMehdi Amini cl::desc("Force disable the lazy-loading on-demand of metadata when " 10719ef4fadSMehdi Amini "loading bitcode for importing.")); 10819ef4fadSMehdi Amini 109ef27db87SMehdi Amini namespace { 110ef27db87SMehdi Amini 111ef27db87SMehdi Amini static int64_t unrotateSign(uint64_t U) { return U & 1 ? ~(U >> 1) : U >> 1; } 112ef27db87SMehdi Amini 113ef27db87SMehdi Amini class BitcodeReaderMetadataList { 114ef27db87SMehdi Amini /// Array of metadata references. 115ef27db87SMehdi Amini /// 116ef27db87SMehdi Amini /// Don't use std::vector here. Some versions of libc++ copy (instead of 117ef27db87SMehdi Amini /// move) on resize, and TrackingMDRef is very expensive to copy. 118ef27db87SMehdi Amini SmallVector<TrackingMDRef, 1> MetadataPtrs; 119ef27db87SMehdi Amini 120690952d1SMehdi Amini /// The set of indices in MetadataPtrs above of forward references that were 121690952d1SMehdi Amini /// generated. 122690952d1SMehdi Amini SmallDenseSet<unsigned, 1> ForwardReference; 123690952d1SMehdi Amini 124690952d1SMehdi Amini /// The set of indices in MetadataPtrs above of Metadata that need to be 125690952d1SMehdi Amini /// resolved. 126690952d1SMehdi Amini SmallDenseSet<unsigned, 1> UnresolvedNodes; 127690952d1SMehdi Amini 128ef27db87SMehdi Amini /// Structures for resolving old type refs. 129ef27db87SMehdi Amini struct { 130ef27db87SMehdi Amini SmallDenseMap<MDString *, TempMDTuple, 1> Unknown; 131ef27db87SMehdi Amini SmallDenseMap<MDString *, DICompositeType *, 1> Final; 132ef27db87SMehdi Amini SmallDenseMap<MDString *, DICompositeType *, 1> FwdDecls; 133ef27db87SMehdi Amini SmallVector<std::pair<TrackingMDRef, TempMDTuple>, 1> Arrays; 134ef27db87SMehdi Amini } OldTypeRefs; 135ef27db87SMehdi Amini 136ef27db87SMehdi Amini LLVMContext &Context; 137ef27db87SMehdi Amini 138ef27db87SMehdi Amini public: 13970a9cd4cSMehdi Amini BitcodeReaderMetadataList(LLVMContext &C) : Context(C) {} 140ef27db87SMehdi Amini 141ef27db87SMehdi Amini // vector compatibility methods 142ef27db87SMehdi Amini unsigned size() const { return MetadataPtrs.size(); } 143ef27db87SMehdi Amini void resize(unsigned N) { MetadataPtrs.resize(N); } 144ef27db87SMehdi Amini void push_back(Metadata *MD) { MetadataPtrs.emplace_back(MD); } 145ef27db87SMehdi Amini void clear() { MetadataPtrs.clear(); } 146ef27db87SMehdi Amini Metadata *back() const { return MetadataPtrs.back(); } 147ef27db87SMehdi Amini void pop_back() { MetadataPtrs.pop_back(); } 148ef27db87SMehdi Amini bool empty() const { return MetadataPtrs.empty(); } 149ef27db87SMehdi Amini 150ef27db87SMehdi Amini Metadata *operator[](unsigned i) const { 151ef27db87SMehdi Amini assert(i < MetadataPtrs.size()); 152ef27db87SMehdi Amini return MetadataPtrs[i]; 153ef27db87SMehdi Amini } 154ef27db87SMehdi Amini 155ef27db87SMehdi Amini Metadata *lookup(unsigned I) const { 156ef27db87SMehdi Amini if (I < MetadataPtrs.size()) 157ef27db87SMehdi Amini return MetadataPtrs[I]; 158ef27db87SMehdi Amini return nullptr; 159ef27db87SMehdi Amini } 160ef27db87SMehdi Amini 161ef27db87SMehdi Amini void shrinkTo(unsigned N) { 162ef27db87SMehdi Amini assert(N <= size() && "Invalid shrinkTo request!"); 163690952d1SMehdi Amini assert(ForwardReference.empty() && "Unexpected forward refs"); 164690952d1SMehdi Amini assert(UnresolvedNodes.empty() && "Unexpected unresolved node"); 165ef27db87SMehdi Amini MetadataPtrs.resize(N); 166ef27db87SMehdi Amini } 167ef27db87SMehdi Amini 168ef27db87SMehdi Amini /// Return the given metadata, creating a replaceable forward reference if 169ef27db87SMehdi Amini /// necessary. 170ef27db87SMehdi Amini Metadata *getMetadataFwdRef(unsigned Idx); 171ef27db87SMehdi Amini 172ef27db87SMehdi Amini /// Return the the given metadata only if it is fully resolved. 173ef27db87SMehdi Amini /// 174ef27db87SMehdi Amini /// Gives the same result as \a lookup(), unless \a MDNode::isResolved() 175ef27db87SMehdi Amini /// would give \c false. 176ef27db87SMehdi Amini Metadata *getMetadataIfResolved(unsigned Idx); 177ef27db87SMehdi Amini 178ef27db87SMehdi Amini MDNode *getMDNodeFwdRefOrNull(unsigned Idx); 179ef27db87SMehdi Amini void assignValue(Metadata *MD, unsigned Idx); 180ef27db87SMehdi Amini void tryToResolveCycles(); 181690952d1SMehdi Amini bool hasFwdRefs() const { return !ForwardReference.empty(); } 18219ef4fadSMehdi Amini int getNextFwdRef() { 18319ef4fadSMehdi Amini assert(hasFwdRefs()); 18419ef4fadSMehdi Amini return *ForwardReference.begin(); 18519ef4fadSMehdi Amini } 186ef27db87SMehdi Amini 187ef27db87SMehdi Amini /// Upgrade a type that had an MDString reference. 188ef27db87SMehdi Amini void addTypeRef(MDString &UUID, DICompositeType &CT); 189ef27db87SMehdi Amini 190ef27db87SMehdi Amini /// Upgrade a type that had an MDString reference. 191ef27db87SMehdi Amini Metadata *upgradeTypeRef(Metadata *MaybeUUID); 192ef27db87SMehdi Amini 193ef27db87SMehdi Amini /// Upgrade a type ref array that may have MDString references. 194ef27db87SMehdi Amini Metadata *upgradeTypeRefArray(Metadata *MaybeTuple); 195ef27db87SMehdi Amini 196ef27db87SMehdi Amini private: 197ef27db87SMehdi Amini Metadata *resolveTypeRefArray(Metadata *MaybeTuple); 198ef27db87SMehdi Amini }; 199ef27db87SMehdi Amini 200ef27db87SMehdi Amini void BitcodeReaderMetadataList::assignValue(Metadata *MD, unsigned Idx) { 201690952d1SMehdi Amini if (auto *MDN = dyn_cast<MDNode>(MD)) 202690952d1SMehdi Amini if (!MDN->isResolved()) 203690952d1SMehdi Amini UnresolvedNodes.insert(Idx); 204690952d1SMehdi Amini 205ef27db87SMehdi Amini if (Idx == size()) { 206ef27db87SMehdi Amini push_back(MD); 207ef27db87SMehdi Amini return; 208ef27db87SMehdi Amini } 209ef27db87SMehdi Amini 210ef27db87SMehdi Amini if (Idx >= size()) 211ef27db87SMehdi Amini resize(Idx + 1); 212ef27db87SMehdi Amini 213ef27db87SMehdi Amini TrackingMDRef &OldMD = MetadataPtrs[Idx]; 214ef27db87SMehdi Amini if (!OldMD) { 215ef27db87SMehdi Amini OldMD.reset(MD); 216ef27db87SMehdi Amini return; 217ef27db87SMehdi Amini } 218ef27db87SMehdi Amini 219ef27db87SMehdi Amini // If there was a forward reference to this value, replace it. 220ef27db87SMehdi Amini TempMDTuple PrevMD(cast<MDTuple>(OldMD.get())); 221ef27db87SMehdi Amini PrevMD->replaceAllUsesWith(MD); 222690952d1SMehdi Amini ForwardReference.erase(Idx); 223ef27db87SMehdi Amini } 224ef27db87SMehdi Amini 225ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::getMetadataFwdRef(unsigned Idx) { 226ef27db87SMehdi Amini if (Idx >= size()) 227ef27db87SMehdi Amini resize(Idx + 1); 228ef27db87SMehdi Amini 229ef27db87SMehdi Amini if (Metadata *MD = MetadataPtrs[Idx]) 230ef27db87SMehdi Amini return MD; 231ef27db87SMehdi Amini 232ef27db87SMehdi Amini // Track forward refs to be resolved later. 233690952d1SMehdi Amini ForwardReference.insert(Idx); 234ef27db87SMehdi Amini 235ef27db87SMehdi Amini // Create and return a placeholder, which will later be RAUW'd. 23619ef4fadSMehdi Amini ++NumMDNodeTemporary; 237ef27db87SMehdi Amini Metadata *MD = MDNode::getTemporary(Context, None).release(); 238ef27db87SMehdi Amini MetadataPtrs[Idx].reset(MD); 239ef27db87SMehdi Amini return MD; 240ef27db87SMehdi Amini } 241ef27db87SMehdi Amini 242ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::getMetadataIfResolved(unsigned Idx) { 243ef27db87SMehdi Amini Metadata *MD = lookup(Idx); 244ef27db87SMehdi Amini if (auto *N = dyn_cast_or_null<MDNode>(MD)) 245ef27db87SMehdi Amini if (!N->isResolved()) 246ef27db87SMehdi Amini return nullptr; 247ef27db87SMehdi Amini return MD; 248ef27db87SMehdi Amini } 249ef27db87SMehdi Amini 250ef27db87SMehdi Amini MDNode *BitcodeReaderMetadataList::getMDNodeFwdRefOrNull(unsigned Idx) { 251ef27db87SMehdi Amini return dyn_cast_or_null<MDNode>(getMetadataFwdRef(Idx)); 252ef27db87SMehdi Amini } 253ef27db87SMehdi Amini 254ef27db87SMehdi Amini void BitcodeReaderMetadataList::tryToResolveCycles() { 255690952d1SMehdi Amini if (!ForwardReference.empty()) 256ef27db87SMehdi Amini // Still forward references... can't resolve cycles. 257ef27db87SMehdi Amini return; 258ef27db87SMehdi Amini 259ef27db87SMehdi Amini // Give up on finding a full definition for any forward decls that remain. 260ef27db87SMehdi Amini for (const auto &Ref : OldTypeRefs.FwdDecls) 261ef27db87SMehdi Amini OldTypeRefs.Final.insert(Ref); 262ef27db87SMehdi Amini OldTypeRefs.FwdDecls.clear(); 263ef27db87SMehdi Amini 264ef27db87SMehdi Amini // Upgrade from old type ref arrays. In strange cases, this could add to 265ef27db87SMehdi Amini // OldTypeRefs.Unknown. 266690952d1SMehdi Amini for (const auto &Array : OldTypeRefs.Arrays) 267ef27db87SMehdi Amini Array.second->replaceAllUsesWith(resolveTypeRefArray(Array.first.get())); 268ef27db87SMehdi Amini OldTypeRefs.Arrays.clear(); 269ef27db87SMehdi Amini 270ef27db87SMehdi Amini // Replace old string-based type refs with the resolved node, if possible. 271ef27db87SMehdi Amini // If we haven't seen the node, leave it to the verifier to complain about 272ef27db87SMehdi Amini // the invalid string reference. 273ef27db87SMehdi Amini for (const auto &Ref : OldTypeRefs.Unknown) { 274ef27db87SMehdi Amini if (DICompositeType *CT = OldTypeRefs.Final.lookup(Ref.first)) 275ef27db87SMehdi Amini Ref.second->replaceAllUsesWith(CT); 276ef27db87SMehdi Amini else 277ef27db87SMehdi Amini Ref.second->replaceAllUsesWith(Ref.first); 278ef27db87SMehdi Amini } 279ef27db87SMehdi Amini OldTypeRefs.Unknown.clear(); 280ef27db87SMehdi Amini 281690952d1SMehdi Amini if (UnresolvedNodes.empty()) 282ef27db87SMehdi Amini // Nothing to do. 283ef27db87SMehdi Amini return; 284ef27db87SMehdi Amini 285ef27db87SMehdi Amini // Resolve any cycles. 286690952d1SMehdi Amini for (unsigned I : UnresolvedNodes) { 287ef27db87SMehdi Amini auto &MD = MetadataPtrs[I]; 288ef27db87SMehdi Amini auto *N = dyn_cast_or_null<MDNode>(MD); 289ef27db87SMehdi Amini if (!N) 290ef27db87SMehdi Amini continue; 291ef27db87SMehdi Amini 292ef27db87SMehdi Amini assert(!N->isTemporary() && "Unexpected forward reference"); 293ef27db87SMehdi Amini N->resolveCycles(); 294ef27db87SMehdi Amini } 295ef27db87SMehdi Amini 296690952d1SMehdi Amini // Make sure we return early again until there's another unresolved ref. 297690952d1SMehdi Amini UnresolvedNodes.clear(); 298ef27db87SMehdi Amini } 299ef27db87SMehdi Amini 300ef27db87SMehdi Amini void BitcodeReaderMetadataList::addTypeRef(MDString &UUID, 301ef27db87SMehdi Amini DICompositeType &CT) { 302ef27db87SMehdi Amini assert(CT.getRawIdentifier() == &UUID && "Mismatched UUID"); 303ef27db87SMehdi Amini if (CT.isForwardDecl()) 304ef27db87SMehdi Amini OldTypeRefs.FwdDecls.insert(std::make_pair(&UUID, &CT)); 305ef27db87SMehdi Amini else 306ef27db87SMehdi Amini OldTypeRefs.Final.insert(std::make_pair(&UUID, &CT)); 307ef27db87SMehdi Amini } 308ef27db87SMehdi Amini 309ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::upgradeTypeRef(Metadata *MaybeUUID) { 310ef27db87SMehdi Amini auto *UUID = dyn_cast_or_null<MDString>(MaybeUUID); 311ef27db87SMehdi Amini if (LLVM_LIKELY(!UUID)) 312ef27db87SMehdi Amini return MaybeUUID; 313ef27db87SMehdi Amini 314ef27db87SMehdi Amini if (auto *CT = OldTypeRefs.Final.lookup(UUID)) 315ef27db87SMehdi Amini return CT; 316ef27db87SMehdi Amini 317ef27db87SMehdi Amini auto &Ref = OldTypeRefs.Unknown[UUID]; 318ef27db87SMehdi Amini if (!Ref) 319ef27db87SMehdi Amini Ref = MDNode::getTemporary(Context, None); 320ef27db87SMehdi Amini return Ref.get(); 321ef27db87SMehdi Amini } 322ef27db87SMehdi Amini 323ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::upgradeTypeRefArray(Metadata *MaybeTuple) { 324ef27db87SMehdi Amini auto *Tuple = dyn_cast_or_null<MDTuple>(MaybeTuple); 325ef27db87SMehdi Amini if (!Tuple || Tuple->isDistinct()) 326ef27db87SMehdi Amini return MaybeTuple; 327ef27db87SMehdi Amini 328ef27db87SMehdi Amini // Look through the array immediately if possible. 329ef27db87SMehdi Amini if (!Tuple->isTemporary()) 330ef27db87SMehdi Amini return resolveTypeRefArray(Tuple); 331ef27db87SMehdi Amini 332ef27db87SMehdi Amini // Create and return a placeholder to use for now. Eventually 333ef27db87SMehdi Amini // resolveTypeRefArrays() will be resolve this forward reference. 334ef27db87SMehdi Amini OldTypeRefs.Arrays.emplace_back( 335ef27db87SMehdi Amini std::piecewise_construct, std::forward_as_tuple(Tuple), 336ef27db87SMehdi Amini std::forward_as_tuple(MDTuple::getTemporary(Context, None))); 337ef27db87SMehdi Amini return OldTypeRefs.Arrays.back().second.get(); 338ef27db87SMehdi Amini } 339ef27db87SMehdi Amini 340ef27db87SMehdi Amini Metadata *BitcodeReaderMetadataList::resolveTypeRefArray(Metadata *MaybeTuple) { 341ef27db87SMehdi Amini auto *Tuple = dyn_cast_or_null<MDTuple>(MaybeTuple); 342ef27db87SMehdi Amini if (!Tuple || Tuple->isDistinct()) 343ef27db87SMehdi Amini return MaybeTuple; 344ef27db87SMehdi Amini 345ef27db87SMehdi Amini // Look through the DITypeRefArray, upgrading each DITypeRef. 346ef27db87SMehdi Amini SmallVector<Metadata *, 32> Ops; 347ef27db87SMehdi Amini Ops.reserve(Tuple->getNumOperands()); 348ef27db87SMehdi Amini for (Metadata *MD : Tuple->operands()) 349ef27db87SMehdi Amini Ops.push_back(upgradeTypeRef(MD)); 350ef27db87SMehdi Amini 351ef27db87SMehdi Amini return MDTuple::get(Context, Ops); 352ef27db87SMehdi Amini } 353ef27db87SMehdi Amini 354ef27db87SMehdi Amini namespace { 355ef27db87SMehdi Amini 356ef27db87SMehdi Amini class PlaceholderQueue { 357ef27db87SMehdi Amini // Placeholders would thrash around when moved, so store in a std::deque 358ef27db87SMehdi Amini // instead of some sort of vector. 359ef27db87SMehdi Amini std::deque<DistinctMDOperandPlaceholder> PHs; 360ef27db87SMehdi Amini 361ef27db87SMehdi Amini public: 36227379892SMehdi Amini ~PlaceholderQueue() { 36327379892SMehdi Amini assert(empty() && "PlaceholderQueue hasn't been flushed before being destroyed"); 36427379892SMehdi Amini } 36519ef4fadSMehdi Amini bool empty() { return PHs.empty(); } 366ef27db87SMehdi Amini DistinctMDOperandPlaceholder &getPlaceholderOp(unsigned ID); 367ef27db87SMehdi Amini void flush(BitcodeReaderMetadataList &MetadataList); 36819ef4fadSMehdi Amini 36919ef4fadSMehdi Amini /// Return the list of temporaries nodes in the queue, these need to be 37019ef4fadSMehdi Amini /// loaded before we can flush the queue. 37119ef4fadSMehdi Amini void getTemporaries(BitcodeReaderMetadataList &MetadataList, 37219ef4fadSMehdi Amini DenseSet<unsigned> &Temporaries) { 37319ef4fadSMehdi Amini for (auto &PH : PHs) { 37419ef4fadSMehdi Amini auto ID = PH.getID(); 37519ef4fadSMehdi Amini auto *MD = MetadataList.lookup(ID); 37619ef4fadSMehdi Amini if (!MD) { 37719ef4fadSMehdi Amini Temporaries.insert(ID); 37819ef4fadSMehdi Amini continue; 37919ef4fadSMehdi Amini } 38019ef4fadSMehdi Amini auto *N = dyn_cast_or_null<MDNode>(MD); 38119ef4fadSMehdi Amini if (N && N->isTemporary()) 38219ef4fadSMehdi Amini Temporaries.insert(ID); 38319ef4fadSMehdi Amini } 38419ef4fadSMehdi Amini } 385ef27db87SMehdi Amini }; 386ef27db87SMehdi Amini 387ef27db87SMehdi Amini } // end anonymous namespace 388ef27db87SMehdi Amini 389ef27db87SMehdi Amini DistinctMDOperandPlaceholder &PlaceholderQueue::getPlaceholderOp(unsigned ID) { 390ef27db87SMehdi Amini PHs.emplace_back(ID); 391ef27db87SMehdi Amini return PHs.back(); 392ef27db87SMehdi Amini } 393ef27db87SMehdi Amini 394ef27db87SMehdi Amini void PlaceholderQueue::flush(BitcodeReaderMetadataList &MetadataList) { 395ef27db87SMehdi Amini while (!PHs.empty()) { 3964f90ee00SMehdi Amini auto *MD = MetadataList.lookup(PHs.front().getID()); 3974f90ee00SMehdi Amini assert(MD && "Flushing placeholder on unassigned MD"); 3985ae6170fSMehdi Amini #ifndef NDEBUG 3994f90ee00SMehdi Amini if (auto *MDN = dyn_cast<MDNode>(MD)) 4005ae6170fSMehdi Amini assert(MDN->isResolved() && 4015ae6170fSMehdi Amini "Flushing Placeholder while cycles aren't resolved"); 4025ae6170fSMehdi Amini #endif 4035ae6170fSMehdi Amini PHs.front().replaceUseWith(MD); 404ef27db87SMehdi Amini PHs.pop_front(); 405ef27db87SMehdi Amini } 406ef27db87SMehdi Amini } 407ef27db87SMehdi Amini 408ef27db87SMehdi Amini } // anonynous namespace 409ef27db87SMehdi Amini 410ef27db87SMehdi Amini class MetadataLoader::MetadataLoaderImpl { 411ef27db87SMehdi Amini BitcodeReaderMetadataList MetadataList; 412ef27db87SMehdi Amini BitcodeReaderValueList &ValueList; 413ef27db87SMehdi Amini BitstreamCursor &Stream; 414ef27db87SMehdi Amini LLVMContext &Context; 415ef27db87SMehdi Amini Module &TheModule; 416ef27db87SMehdi Amini std::function<Type *(unsigned)> getTypeByID; 417ef27db87SMehdi Amini 41819ef4fadSMehdi Amini /// Cursor associated with the lazy-loading of Metadata. This is the easy way 41919ef4fadSMehdi Amini /// to keep around the right "context" (Abbrev list) to be able to jump in 42019ef4fadSMehdi Amini /// the middle of the metadata block and load any record. 42119ef4fadSMehdi Amini BitstreamCursor IndexCursor; 42219ef4fadSMehdi Amini 42319ef4fadSMehdi Amini /// Index that keeps track of MDString values. 42419ef4fadSMehdi Amini std::vector<StringRef> MDStringRef; 42519ef4fadSMehdi Amini 42619ef4fadSMehdi Amini /// On-demand loading of a single MDString. Requires the index above to be 42719ef4fadSMehdi Amini /// populated. 42819ef4fadSMehdi Amini MDString *lazyLoadOneMDString(unsigned Idx); 42919ef4fadSMehdi Amini 43019ef4fadSMehdi Amini /// Index that keeps track of where to find a metadata record in the stream. 43119ef4fadSMehdi Amini std::vector<uint64_t> GlobalMetadataBitPosIndex; 43219ef4fadSMehdi Amini 43319ef4fadSMehdi Amini /// Populate the index above to enable lazily loading of metadata, and load 43419ef4fadSMehdi Amini /// the named metadata as well as the transitively referenced global 43519ef4fadSMehdi Amini /// Metadata. 43642ef1990SMehdi Amini Expected<bool> lazyLoadModuleMetadataBlock(); 43719ef4fadSMehdi Amini 43819ef4fadSMehdi Amini /// On-demand loading of a single metadata. Requires the index above to be 43919ef4fadSMehdi Amini /// populated. 44019ef4fadSMehdi Amini void lazyLoadOneMetadata(unsigned Idx, PlaceholderQueue &Placeholders); 44119ef4fadSMehdi Amini 4429f926f70SMehdi Amini // Keep mapping of seens pair of old-style CU <-> SP, and update pointers to 4439f926f70SMehdi Amini // point from SP to CU after a block is completly parsed. 4449f926f70SMehdi Amini std::vector<std::pair<DICompileUnit *, Metadata *>> CUSubprograms; 4459f926f70SMehdi Amini 446ef27db87SMehdi Amini /// Functions that need to be matched with subprograms when upgrading old 447ef27db87SMehdi Amini /// metadata. 448ef27db87SMehdi Amini SmallDenseMap<Function *, DISubprogram *, 16> FunctionsWithSPs; 449ef27db87SMehdi Amini 450ef27db87SMehdi Amini // Map the bitcode's custom MDKind ID to the Module's MDKind ID. 451ef27db87SMehdi Amini DenseMap<unsigned, unsigned> MDKindMap; 452ef27db87SMehdi Amini 4538662305bSMehdi Amini bool StripTBAA = false; 454ef27db87SMehdi Amini bool HasSeenOldLoopTags = false; 455e37d3144SAdrian Prantl bool NeedUpgradeToDIGlobalVariableExpression = false; 4566825fb64SAdrian Prantl bool NeedDeclareExpressionUpgrade = false; 457ef27db87SMehdi Amini 458ec68dd49SMehdi Amini /// True if metadata is being parsed for a module being ThinLTO imported. 459ec68dd49SMehdi Amini bool IsImporting = false; 460ec68dd49SMehdi Amini 4619f926f70SMehdi Amini Error parseOneMetadata(SmallVectorImpl<uint64_t> &Record, unsigned Code, 4629f926f70SMehdi Amini PlaceholderQueue &Placeholders, StringRef Blob, 463ef27db87SMehdi Amini unsigned &NextMetadataNo); 46419ef4fadSMehdi Amini Error parseMetadataStrings(ArrayRef<uint64_t> Record, StringRef Blob, 465061f4a5fSBenjamin Kramer function_ref<void(StringRef)> CallBack); 466ef27db87SMehdi Amini Error parseGlobalObjectAttachment(GlobalObject &GO, 467ef27db87SMehdi Amini ArrayRef<uint64_t> Record); 468ef27db87SMehdi Amini Error parseMetadataKindRecord(SmallVectorImpl<uint64_t> &Record); 469ef27db87SMehdi Amini 47019ef4fadSMehdi Amini void resolveForwardRefsAndPlaceholders(PlaceholderQueue &Placeholders); 47119ef4fadSMehdi Amini 47219ef4fadSMehdi Amini /// Upgrade old-style CU <-> SP pointers to point from SP to CU. 47319ef4fadSMehdi Amini void upgradeCUSubprograms() { 47419ef4fadSMehdi Amini for (auto CU_SP : CUSubprograms) 47519ef4fadSMehdi Amini if (auto *SPs = dyn_cast_or_null<MDTuple>(CU_SP.second)) 47619ef4fadSMehdi Amini for (auto &Op : SPs->operands()) 477*9d2f019fSAdrian Prantl if (auto *SP = dyn_cast_or_null<DISubprogram>(Op)) 478*9d2f019fSAdrian Prantl SP->replaceUnit(CU_SP.first); 47919ef4fadSMehdi Amini CUSubprograms.clear(); 48019ef4fadSMehdi Amini } 48119ef4fadSMehdi Amini 482e37d3144SAdrian Prantl /// Upgrade old-style bare DIGlobalVariables to DIGlobalVariableExpressions. 483e37d3144SAdrian Prantl void upgradeCUVariables() { 484e37d3144SAdrian Prantl if (!NeedUpgradeToDIGlobalVariableExpression) 485e37d3144SAdrian Prantl return; 486e37d3144SAdrian Prantl 487e37d3144SAdrian Prantl // Upgrade list of variables attached to the CUs. 488e37d3144SAdrian Prantl if (NamedMDNode *CUNodes = TheModule.getNamedMetadata("llvm.dbg.cu")) 489e37d3144SAdrian Prantl for (unsigned I = 0, E = CUNodes->getNumOperands(); I != E; ++I) { 490e37d3144SAdrian Prantl auto *CU = cast<DICompileUnit>(CUNodes->getOperand(I)); 491e37d3144SAdrian Prantl if (auto *GVs = dyn_cast_or_null<MDTuple>(CU->getRawGlobalVariables())) 492e37d3144SAdrian Prantl for (unsigned I = 0; I < GVs->getNumOperands(); I++) 493e37d3144SAdrian Prantl if (auto *GV = 494e37d3144SAdrian Prantl dyn_cast_or_null<DIGlobalVariable>(GVs->getOperand(I))) { 495e37d3144SAdrian Prantl auto *DGVE = 496e37d3144SAdrian Prantl DIGlobalVariableExpression::getDistinct(Context, GV, nullptr); 497e37d3144SAdrian Prantl GVs->replaceOperandWith(I, DGVE); 498e37d3144SAdrian Prantl } 499e37d3144SAdrian Prantl } 500e37d3144SAdrian Prantl 501e37d3144SAdrian Prantl // Upgrade variables attached to globals. 502e37d3144SAdrian Prantl for (auto &GV : TheModule.globals()) { 503e37d3144SAdrian Prantl SmallVector<MDNode *, 1> MDs, NewMDs; 504e37d3144SAdrian Prantl GV.getMetadata(LLVMContext::MD_dbg, MDs); 505e37d3144SAdrian Prantl GV.eraseMetadata(LLVMContext::MD_dbg); 506e37d3144SAdrian Prantl for (auto *MD : MDs) 507e37d3144SAdrian Prantl if (auto *DGV = dyn_cast_or_null<DIGlobalVariable>(MD)) { 508e37d3144SAdrian Prantl auto *DGVE = 509e37d3144SAdrian Prantl DIGlobalVariableExpression::getDistinct(Context, DGV, nullptr); 510e37d3144SAdrian Prantl GV.addMetadata(LLVMContext::MD_dbg, *DGVE); 511e37d3144SAdrian Prantl } else 512e37d3144SAdrian Prantl GV.addMetadata(LLVMContext::MD_dbg, *MD); 513e37d3144SAdrian Prantl } 514e37d3144SAdrian Prantl } 515e37d3144SAdrian Prantl 5166825fb64SAdrian Prantl /// Remove a leading DW_OP_deref from DIExpressions in a dbg.declare that 5176825fb64SAdrian Prantl /// describes a function argument. 5186825fb64SAdrian Prantl void upgradeDeclareExpressions(Function &F) { 5196825fb64SAdrian Prantl if (!NeedDeclareExpressionUpgrade) 5206825fb64SAdrian Prantl return; 5216825fb64SAdrian Prantl 5226825fb64SAdrian Prantl for (auto &BB : F) 5236825fb64SAdrian Prantl for (auto &I : BB) 5246825fb64SAdrian Prantl if (auto *DDI = dyn_cast<DbgDeclareInst>(&I)) 5256825fb64SAdrian Prantl if (auto *DIExpr = DDI->getExpression()) 5266825fb64SAdrian Prantl if (DIExpr->startsWithDeref() && 5276825fb64SAdrian Prantl dyn_cast_or_null<Argument>(DDI->getAddress())) { 5286825fb64SAdrian Prantl SmallVector<uint64_t, 8> Ops; 5296825fb64SAdrian Prantl Ops.append(std::next(DIExpr->elements_begin()), 5306825fb64SAdrian Prantl DIExpr->elements_end()); 5316825fb64SAdrian Prantl auto *E = DIExpression::get(Context, Ops); 5326825fb64SAdrian Prantl DDI->setOperand(2, MetadataAsValue::get(Context, E)); 5336825fb64SAdrian Prantl } 5346825fb64SAdrian Prantl } 5356825fb64SAdrian Prantl 536e37d3144SAdrian Prantl void upgradeDebugInfo() { 537e37d3144SAdrian Prantl upgradeCUSubprograms(); 538e37d3144SAdrian Prantl upgradeCUVariables(); 539e37d3144SAdrian Prantl } 540e37d3144SAdrian Prantl 541ef27db87SMehdi Amini public: 542ef27db87SMehdi Amini MetadataLoaderImpl(BitstreamCursor &Stream, Module &TheModule, 543ef27db87SMehdi Amini BitcodeReaderValueList &ValueList, 544ec68dd49SMehdi Amini std::function<Type *(unsigned)> getTypeByID, 545ec68dd49SMehdi Amini bool IsImporting) 546ef27db87SMehdi Amini : MetadataList(TheModule.getContext()), ValueList(ValueList), 547ef27db87SMehdi Amini Stream(Stream), Context(TheModule.getContext()), TheModule(TheModule), 548061f4a5fSBenjamin Kramer getTypeByID(std::move(getTypeByID)), IsImporting(IsImporting) {} 549ef27db87SMehdi Amini 550ec68dd49SMehdi Amini Error parseMetadata(bool ModuleLevel); 551ef27db87SMehdi Amini 552ef27db87SMehdi Amini bool hasFwdRefs() const { return MetadataList.hasFwdRefs(); } 5533bb4d01dSMehdi Amini 5543bb4d01dSMehdi Amini Metadata *getMetadataFwdRefOrLoad(unsigned ID) { 5553bb4d01dSMehdi Amini if (ID < MDStringRef.size()) 5563bb4d01dSMehdi Amini return lazyLoadOneMDString(ID); 5573bb4d01dSMehdi Amini if (auto *MD = MetadataList.lookup(ID)) 5583bb4d01dSMehdi Amini return MD; 5593bb4d01dSMehdi Amini // If lazy-loading is enabled, we try recursively to load the operand 5603bb4d01dSMehdi Amini // instead of creating a temporary. 5613bb4d01dSMehdi Amini if (ID < (MDStringRef.size() + GlobalMetadataBitPosIndex.size())) { 5623bb4d01dSMehdi Amini PlaceholderQueue Placeholders; 5633bb4d01dSMehdi Amini lazyLoadOneMetadata(ID, Placeholders); 5643bb4d01dSMehdi Amini resolveForwardRefsAndPlaceholders(Placeholders); 5653bb4d01dSMehdi Amini return MetadataList.lookup(ID); 5663bb4d01dSMehdi Amini } 5673bb4d01dSMehdi Amini return MetadataList.getMetadataFwdRef(ID); 568ef27db87SMehdi Amini } 569ef27db87SMehdi Amini 570ef27db87SMehdi Amini MDNode *getMDNodeFwdRefOrNull(unsigned Idx) { 571ef27db87SMehdi Amini return MetadataList.getMDNodeFwdRefOrNull(Idx); 572ef27db87SMehdi Amini } 573ef27db87SMehdi Amini 574ef27db87SMehdi Amini DISubprogram *lookupSubprogramForFunction(Function *F) { 575ef27db87SMehdi Amini return FunctionsWithSPs.lookup(F); 576ef27db87SMehdi Amini } 577ef27db87SMehdi Amini 578ef27db87SMehdi Amini bool hasSeenOldLoopTags() { return HasSeenOldLoopTags; } 579ef27db87SMehdi Amini 580ef27db87SMehdi Amini Error parseMetadataAttachment( 581ef27db87SMehdi Amini Function &F, const SmallVectorImpl<Instruction *> &InstructionList); 582ef27db87SMehdi Amini 583ef27db87SMehdi Amini Error parseMetadataKinds(); 584ef27db87SMehdi Amini 5858662305bSMehdi Amini void setStripTBAA(bool Value) { StripTBAA = Value; } 5868662305bSMehdi Amini bool isStrippingTBAA() { return StripTBAA; } 5878662305bSMehdi Amini 588ef27db87SMehdi Amini unsigned size() const { return MetadataList.size(); } 589ef27db87SMehdi Amini void shrinkTo(unsigned N) { MetadataList.shrinkTo(N); } 5906825fb64SAdrian Prantl void upgradeDebugIntrinsics(Function &F) { upgradeDeclareExpressions(F); } 591ef27db87SMehdi Amini }; 592ef27db87SMehdi Amini 593efcf06f5SBenjamin Kramer static Error error(const Twine &Message) { 594ef27db87SMehdi Amini return make_error<StringError>( 595ef27db87SMehdi Amini Message, make_error_code(BitcodeError::CorruptedBitcode)); 596ef27db87SMehdi Amini } 597ef27db87SMehdi Amini 59842ef1990SMehdi Amini Expected<bool> 59942ef1990SMehdi Amini MetadataLoader::MetadataLoaderImpl::lazyLoadModuleMetadataBlock() { 60019ef4fadSMehdi Amini IndexCursor = Stream; 60119ef4fadSMehdi Amini SmallVector<uint64_t, 64> Record; 60219ef4fadSMehdi Amini // Get the abbrevs, and preload record positions to make them lazy-loadable. 60319ef4fadSMehdi Amini while (true) { 60419ef4fadSMehdi Amini BitstreamEntry Entry = IndexCursor.advanceSkippingSubblocks( 60519ef4fadSMehdi Amini BitstreamCursor::AF_DontPopBlockAtEnd); 60619ef4fadSMehdi Amini switch (Entry.Kind) { 60719ef4fadSMehdi Amini case BitstreamEntry::SubBlock: // Handled for us already. 60819ef4fadSMehdi Amini case BitstreamEntry::Error: 60919ef4fadSMehdi Amini return error("Malformed block"); 61019ef4fadSMehdi Amini case BitstreamEntry::EndBlock: { 61119ef4fadSMehdi Amini return true; 61219ef4fadSMehdi Amini } 61319ef4fadSMehdi Amini case BitstreamEntry::Record: { 61419ef4fadSMehdi Amini // The interesting case. 61519ef4fadSMehdi Amini ++NumMDRecordLoaded; 61619ef4fadSMehdi Amini uint64_t CurrentPos = IndexCursor.GetCurrentBitNo(); 61719ef4fadSMehdi Amini auto Code = IndexCursor.skipRecord(Entry.ID); 61819ef4fadSMehdi Amini switch (Code) { 61919ef4fadSMehdi Amini case bitc::METADATA_STRINGS: { 62019ef4fadSMehdi Amini // Rewind and parse the strings. 62119ef4fadSMehdi Amini IndexCursor.JumpToBit(CurrentPos); 62219ef4fadSMehdi Amini StringRef Blob; 62319ef4fadSMehdi Amini Record.clear(); 62419ef4fadSMehdi Amini IndexCursor.readRecord(Entry.ID, Record, &Blob); 62519ef4fadSMehdi Amini unsigned NumStrings = Record[0]; 62619ef4fadSMehdi Amini MDStringRef.reserve(NumStrings); 62719ef4fadSMehdi Amini auto IndexNextMDString = [&](StringRef Str) { 62819ef4fadSMehdi Amini MDStringRef.push_back(Str); 62919ef4fadSMehdi Amini }; 63019ef4fadSMehdi Amini if (auto Err = parseMetadataStrings(Record, Blob, IndexNextMDString)) 63119ef4fadSMehdi Amini return std::move(Err); 63219ef4fadSMehdi Amini break; 63319ef4fadSMehdi Amini } 63419ef4fadSMehdi Amini case bitc::METADATA_INDEX_OFFSET: { 63519ef4fadSMehdi Amini // This is the offset to the index, when we see this we skip all the 63619ef4fadSMehdi Amini // records and load only an index to these. 63719ef4fadSMehdi Amini IndexCursor.JumpToBit(CurrentPos); 63819ef4fadSMehdi Amini Record.clear(); 63919ef4fadSMehdi Amini IndexCursor.readRecord(Entry.ID, Record); 64019ef4fadSMehdi Amini if (Record.size() != 2) 64119ef4fadSMehdi Amini return error("Invalid record"); 64219ef4fadSMehdi Amini auto Offset = Record[0] + (Record[1] << 32); 64319ef4fadSMehdi Amini auto BeginPos = IndexCursor.GetCurrentBitNo(); 64419ef4fadSMehdi Amini IndexCursor.JumpToBit(BeginPos + Offset); 64519ef4fadSMehdi Amini Entry = IndexCursor.advanceSkippingSubblocks( 64619ef4fadSMehdi Amini BitstreamCursor::AF_DontPopBlockAtEnd); 64719ef4fadSMehdi Amini assert(Entry.Kind == BitstreamEntry::Record && 64819ef4fadSMehdi Amini "Corrupted bitcode: Expected `Record` when trying to find the " 64919ef4fadSMehdi Amini "Metadata index"); 65019ef4fadSMehdi Amini Record.clear(); 65119ef4fadSMehdi Amini auto Code = IndexCursor.readRecord(Entry.ID, Record); 65219ef4fadSMehdi Amini (void)Code; 65319ef4fadSMehdi Amini assert(Code == bitc::METADATA_INDEX && "Corrupted bitcode: Expected " 65419ef4fadSMehdi Amini "`METADATA_INDEX` when trying " 65519ef4fadSMehdi Amini "to find the Metadata index"); 65619ef4fadSMehdi Amini 65719ef4fadSMehdi Amini // Delta unpack 65819ef4fadSMehdi Amini auto CurrentValue = BeginPos; 65919ef4fadSMehdi Amini GlobalMetadataBitPosIndex.reserve(Record.size()); 66019ef4fadSMehdi Amini for (auto &Elt : Record) { 66119ef4fadSMehdi Amini CurrentValue += Elt; 66219ef4fadSMehdi Amini GlobalMetadataBitPosIndex.push_back(CurrentValue); 66319ef4fadSMehdi Amini } 66419ef4fadSMehdi Amini break; 66519ef4fadSMehdi Amini } 66619ef4fadSMehdi Amini case bitc::METADATA_INDEX: 66719ef4fadSMehdi Amini // We don't expect to get there, the Index is loaded when we encounter 66819ef4fadSMehdi Amini // the offset. 66919ef4fadSMehdi Amini return error("Corrupted Metadata block"); 67019ef4fadSMehdi Amini case bitc::METADATA_NAME: { 67119ef4fadSMehdi Amini // Named metadata need to be materialized now and aren't deferred. 67219ef4fadSMehdi Amini IndexCursor.JumpToBit(CurrentPos); 67319ef4fadSMehdi Amini Record.clear(); 67419ef4fadSMehdi Amini unsigned Code = IndexCursor.readRecord(Entry.ID, Record); 67519ef4fadSMehdi Amini assert(Code == bitc::METADATA_NAME); 67619ef4fadSMehdi Amini 67719ef4fadSMehdi Amini // Read name of the named metadata. 67819ef4fadSMehdi Amini SmallString<8> Name(Record.begin(), Record.end()); 67919ef4fadSMehdi Amini Code = IndexCursor.ReadCode(); 68019ef4fadSMehdi Amini 68119ef4fadSMehdi Amini // Named Metadata comes in two parts, we expect the name to be followed 68219ef4fadSMehdi Amini // by the node 68319ef4fadSMehdi Amini Record.clear(); 68419ef4fadSMehdi Amini unsigned NextBitCode = IndexCursor.readRecord(Code, Record); 68519ef4fadSMehdi Amini assert(NextBitCode == bitc::METADATA_NAMED_NODE); 68619ef4fadSMehdi Amini (void)NextBitCode; 68719ef4fadSMehdi Amini 68819ef4fadSMehdi Amini // Read named metadata elements. 68919ef4fadSMehdi Amini unsigned Size = Record.size(); 69019ef4fadSMehdi Amini NamedMDNode *NMD = TheModule.getOrInsertNamedMetadata(Name); 69119ef4fadSMehdi Amini for (unsigned i = 0; i != Size; ++i) { 69219ef4fadSMehdi Amini // FIXME: We could use a placeholder here, however NamedMDNode are 69319ef4fadSMehdi Amini // taking MDNode as operand and not using the Metadata infrastructure. 69419ef4fadSMehdi Amini // It is acknowledged by 'TODO: Inherit from Metadata' in the 69519ef4fadSMehdi Amini // NamedMDNode class definition. 69619ef4fadSMehdi Amini MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[i]); 69719ef4fadSMehdi Amini assert(MD && "Invalid record"); 69819ef4fadSMehdi Amini NMD->addOperand(MD); 69919ef4fadSMehdi Amini } 70019ef4fadSMehdi Amini break; 70119ef4fadSMehdi Amini } 70219ef4fadSMehdi Amini case bitc::METADATA_GLOBAL_DECL_ATTACHMENT: { 70319ef4fadSMehdi Amini // FIXME: we need to do this early because we don't materialize global 70419ef4fadSMehdi Amini // value explicitly. 70519ef4fadSMehdi Amini IndexCursor.JumpToBit(CurrentPos); 70619ef4fadSMehdi Amini Record.clear(); 70719ef4fadSMehdi Amini IndexCursor.readRecord(Entry.ID, Record); 70819ef4fadSMehdi Amini if (Record.size() % 2 == 0) 70919ef4fadSMehdi Amini return error("Invalid record"); 71019ef4fadSMehdi Amini unsigned ValueID = Record[0]; 71119ef4fadSMehdi Amini if (ValueID >= ValueList.size()) 71219ef4fadSMehdi Amini return error("Invalid record"); 71319ef4fadSMehdi Amini if (auto *GO = dyn_cast<GlobalObject>(ValueList[ValueID])) 71419ef4fadSMehdi Amini if (Error Err = parseGlobalObjectAttachment( 71519ef4fadSMehdi Amini *GO, ArrayRef<uint64_t>(Record).slice(1))) 71619ef4fadSMehdi Amini return std::move(Err); 71719ef4fadSMehdi Amini break; 71819ef4fadSMehdi Amini } 71919ef4fadSMehdi Amini case bitc::METADATA_KIND: 72019ef4fadSMehdi Amini case bitc::METADATA_STRING_OLD: 72119ef4fadSMehdi Amini case bitc::METADATA_OLD_FN_NODE: 72219ef4fadSMehdi Amini case bitc::METADATA_OLD_NODE: 72319ef4fadSMehdi Amini case bitc::METADATA_VALUE: 72419ef4fadSMehdi Amini case bitc::METADATA_DISTINCT_NODE: 72519ef4fadSMehdi Amini case bitc::METADATA_NODE: 72619ef4fadSMehdi Amini case bitc::METADATA_LOCATION: 72719ef4fadSMehdi Amini case bitc::METADATA_GENERIC_DEBUG: 72819ef4fadSMehdi Amini case bitc::METADATA_SUBRANGE: 72919ef4fadSMehdi Amini case bitc::METADATA_ENUMERATOR: 73019ef4fadSMehdi Amini case bitc::METADATA_BASIC_TYPE: 73119ef4fadSMehdi Amini case bitc::METADATA_DERIVED_TYPE: 73219ef4fadSMehdi Amini case bitc::METADATA_COMPOSITE_TYPE: 73319ef4fadSMehdi Amini case bitc::METADATA_SUBROUTINE_TYPE: 73419ef4fadSMehdi Amini case bitc::METADATA_MODULE: 73519ef4fadSMehdi Amini case bitc::METADATA_FILE: 73619ef4fadSMehdi Amini case bitc::METADATA_COMPILE_UNIT: 73719ef4fadSMehdi Amini case bitc::METADATA_SUBPROGRAM: 73819ef4fadSMehdi Amini case bitc::METADATA_LEXICAL_BLOCK: 73919ef4fadSMehdi Amini case bitc::METADATA_LEXICAL_BLOCK_FILE: 74019ef4fadSMehdi Amini case bitc::METADATA_NAMESPACE: 74119ef4fadSMehdi Amini case bitc::METADATA_MACRO: 74219ef4fadSMehdi Amini case bitc::METADATA_MACRO_FILE: 74319ef4fadSMehdi Amini case bitc::METADATA_TEMPLATE_TYPE: 74419ef4fadSMehdi Amini case bitc::METADATA_TEMPLATE_VALUE: 74519ef4fadSMehdi Amini case bitc::METADATA_GLOBAL_VAR: 74619ef4fadSMehdi Amini case bitc::METADATA_LOCAL_VAR: 74719ef4fadSMehdi Amini case bitc::METADATA_EXPRESSION: 74819ef4fadSMehdi Amini case bitc::METADATA_OBJC_PROPERTY: 74919ef4fadSMehdi Amini case bitc::METADATA_IMPORTED_ENTITY: 75019ef4fadSMehdi Amini case bitc::METADATA_GLOBAL_VAR_EXPR: 75119ef4fadSMehdi Amini // We don't expect to see any of these, if we see one, give up on 75219ef4fadSMehdi Amini // lazy-loading and fallback. 75319ef4fadSMehdi Amini MDStringRef.clear(); 75419ef4fadSMehdi Amini GlobalMetadataBitPosIndex.clear(); 75519ef4fadSMehdi Amini return false; 75619ef4fadSMehdi Amini } 75719ef4fadSMehdi Amini break; 75819ef4fadSMehdi Amini } 75919ef4fadSMehdi Amini } 76019ef4fadSMehdi Amini } 76119ef4fadSMehdi Amini } 76219ef4fadSMehdi Amini 763ef27db87SMehdi Amini /// Parse a METADATA_BLOCK. If ModuleLevel is true then we are parsing 764ef27db87SMehdi Amini /// module level metadata. 765ec68dd49SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadata(bool ModuleLevel) { 766ef27db87SMehdi Amini if (!ModuleLevel && MetadataList.hasFwdRefs()) 767ef27db87SMehdi Amini return error("Invalid metadata: fwd refs into function blocks"); 768ef27db87SMehdi Amini 76919ef4fadSMehdi Amini // Record the entry position so that we can jump back here and efficiently 77019ef4fadSMehdi Amini // skip the whole block in case we lazy-load. 77119ef4fadSMehdi Amini auto EntryPos = Stream.GetCurrentBitNo(); 77219ef4fadSMehdi Amini 773ef27db87SMehdi Amini if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID)) 774ef27db87SMehdi Amini return error("Invalid record"); 775ef27db87SMehdi Amini 776ef27db87SMehdi Amini SmallVector<uint64_t, 64> Record; 777ef27db87SMehdi Amini PlaceholderQueue Placeholders; 7789f926f70SMehdi Amini 77919ef4fadSMehdi Amini // We lazy-load module-level metadata: we build an index for each record, and 78019ef4fadSMehdi Amini // then load individual record as needed, starting with the named metadata. 78119ef4fadSMehdi Amini if (ModuleLevel && IsImporting && MetadataList.empty() && 78219ef4fadSMehdi Amini !DisableLazyLoading) { 78342ef1990SMehdi Amini auto SuccessOrErr = lazyLoadModuleMetadataBlock(); 78419ef4fadSMehdi Amini if (!SuccessOrErr) 78519ef4fadSMehdi Amini return SuccessOrErr.takeError(); 78619ef4fadSMehdi Amini if (SuccessOrErr.get()) { 78719ef4fadSMehdi Amini // An index was successfully created and we will be able to load metadata 78819ef4fadSMehdi Amini // on-demand. 78919ef4fadSMehdi Amini MetadataList.resize(MDStringRef.size() + 79019ef4fadSMehdi Amini GlobalMetadataBitPosIndex.size()); 79119ef4fadSMehdi Amini 79219ef4fadSMehdi Amini // Reading the named metadata created forward references and/or 79319ef4fadSMehdi Amini // placeholders, that we flush here. 79419ef4fadSMehdi Amini resolveForwardRefsAndPlaceholders(Placeholders); 795e37d3144SAdrian Prantl upgradeDebugInfo(); 79619ef4fadSMehdi Amini // Return at the beginning of the block, since it is easy to skip it 79719ef4fadSMehdi Amini // entirely from there. 79819ef4fadSMehdi Amini Stream.ReadBlockEnd(); // Pop the abbrev block context. 79919ef4fadSMehdi Amini Stream.JumpToBit(EntryPos); 80019ef4fadSMehdi Amini if (Stream.SkipBlock()) 80119ef4fadSMehdi Amini return error("Invalid record"); 80219ef4fadSMehdi Amini return Error::success(); 80319ef4fadSMehdi Amini } 80419ef4fadSMehdi Amini // Couldn't load an index, fallback to loading all the block "old-style". 80519ef4fadSMehdi Amini } 80619ef4fadSMehdi Amini 80719ef4fadSMehdi Amini unsigned NextMetadataNo = MetadataList.size(); 80819ef4fadSMehdi Amini 8099f926f70SMehdi Amini // Read all the records. 8109f926f70SMehdi Amini while (true) { 8119f926f70SMehdi Amini BitstreamEntry Entry = Stream.advanceSkippingSubblocks(); 8129f926f70SMehdi Amini 8139f926f70SMehdi Amini switch (Entry.Kind) { 8149f926f70SMehdi Amini case BitstreamEntry::SubBlock: // Handled for us already. 8159f926f70SMehdi Amini case BitstreamEntry::Error: 8169f926f70SMehdi Amini return error("Malformed block"); 8179f926f70SMehdi Amini case BitstreamEntry::EndBlock: 81819ef4fadSMehdi Amini resolveForwardRefsAndPlaceholders(Placeholders); 819e37d3144SAdrian Prantl upgradeDebugInfo(); 8209f926f70SMehdi Amini return Error::success(); 8219f926f70SMehdi Amini case BitstreamEntry::Record: 8229f926f70SMehdi Amini // The interesting case. 8239f926f70SMehdi Amini break; 8249f926f70SMehdi Amini } 8259f926f70SMehdi Amini 8269f926f70SMehdi Amini // Read a record. 8279f926f70SMehdi Amini Record.clear(); 8289f926f70SMehdi Amini StringRef Blob; 82919ef4fadSMehdi Amini ++NumMDRecordLoaded; 8309f926f70SMehdi Amini unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob); 83119ef4fadSMehdi Amini if (Error Err = 83219ef4fadSMehdi Amini parseOneMetadata(Record, Code, Placeholders, Blob, NextMetadataNo)) 8339f926f70SMehdi Amini return Err; 8349f926f70SMehdi Amini } 8359f926f70SMehdi Amini } 8369f926f70SMehdi Amini 83719ef4fadSMehdi Amini MDString *MetadataLoader::MetadataLoaderImpl::lazyLoadOneMDString(unsigned ID) { 83819ef4fadSMehdi Amini ++NumMDStringLoaded; 83919ef4fadSMehdi Amini if (Metadata *MD = MetadataList.lookup(ID)) 84019ef4fadSMehdi Amini return cast<MDString>(MD); 84119ef4fadSMehdi Amini auto MDS = MDString::get(Context, MDStringRef[ID]); 84219ef4fadSMehdi Amini MetadataList.assignValue(MDS, ID); 84319ef4fadSMehdi Amini return MDS; 84419ef4fadSMehdi Amini } 84519ef4fadSMehdi Amini 84619ef4fadSMehdi Amini void MetadataLoader::MetadataLoaderImpl::lazyLoadOneMetadata( 84719ef4fadSMehdi Amini unsigned ID, PlaceholderQueue &Placeholders) { 84819ef4fadSMehdi Amini assert(ID < (MDStringRef.size()) + GlobalMetadataBitPosIndex.size()); 84919ef4fadSMehdi Amini assert(ID >= MDStringRef.size() && "Unexpected lazy-loading of MDString"); 85019ef4fadSMehdi Amini // Lookup first if the metadata hasn't already been loaded. 85119ef4fadSMehdi Amini if (auto *MD = MetadataList.lookup(ID)) { 85219ef4fadSMehdi Amini auto *N = dyn_cast_or_null<MDNode>(MD); 85367d2cc1fSMehdi Amini if (!N->isTemporary()) 85467d2cc1fSMehdi Amini return; 85519ef4fadSMehdi Amini } 85619ef4fadSMehdi Amini SmallVector<uint64_t, 64> Record; 85719ef4fadSMehdi Amini StringRef Blob; 85819ef4fadSMehdi Amini IndexCursor.JumpToBit(GlobalMetadataBitPosIndex[ID - MDStringRef.size()]); 85919ef4fadSMehdi Amini auto Entry = IndexCursor.advanceSkippingSubblocks(); 86019ef4fadSMehdi Amini ++NumMDRecordLoaded; 86119ef4fadSMehdi Amini unsigned Code = IndexCursor.readRecord(Entry.ID, Record, &Blob); 86219ef4fadSMehdi Amini if (Error Err = parseOneMetadata(Record, Code, Placeholders, Blob, ID)) 86319ef4fadSMehdi Amini report_fatal_error("Can't lazyload MD"); 86419ef4fadSMehdi Amini } 86519ef4fadSMehdi Amini 86619ef4fadSMehdi Amini /// Ensure that all forward-references and placeholders are resolved. 86719ef4fadSMehdi Amini /// Iteratively lazy-loading metadata on-demand if needed. 86819ef4fadSMehdi Amini void MetadataLoader::MetadataLoaderImpl::resolveForwardRefsAndPlaceholders( 86919ef4fadSMehdi Amini PlaceholderQueue &Placeholders) { 87019ef4fadSMehdi Amini DenseSet<unsigned> Temporaries; 87119ef4fadSMehdi Amini while (1) { 87219ef4fadSMehdi Amini // Populate Temporaries with the placeholders that haven't been loaded yet. 87319ef4fadSMehdi Amini Placeholders.getTemporaries(MetadataList, Temporaries); 87419ef4fadSMehdi Amini 87519ef4fadSMehdi Amini // If we don't have any temporary, or FwdReference, we're done! 87619ef4fadSMehdi Amini if (Temporaries.empty() && !MetadataList.hasFwdRefs()) 87719ef4fadSMehdi Amini break; 87819ef4fadSMehdi Amini 87919ef4fadSMehdi Amini // First, load all the temporaries. This can add new placeholders or 88019ef4fadSMehdi Amini // forward references. 88119ef4fadSMehdi Amini for (auto ID : Temporaries) 88219ef4fadSMehdi Amini lazyLoadOneMetadata(ID, Placeholders); 88319ef4fadSMehdi Amini Temporaries.clear(); 88419ef4fadSMehdi Amini 88519ef4fadSMehdi Amini // Second, load the forward-references. This can also add new placeholders 88619ef4fadSMehdi Amini // or forward references. 88719ef4fadSMehdi Amini while (MetadataList.hasFwdRefs()) 88819ef4fadSMehdi Amini lazyLoadOneMetadata(MetadataList.getNextFwdRef(), Placeholders); 88919ef4fadSMehdi Amini } 89019ef4fadSMehdi Amini // At this point we don't have any forward reference remaining, or temporary 89119ef4fadSMehdi Amini // that haven't been loaded. We can safely drop RAUW support and mark cycles 89219ef4fadSMehdi Amini // as resolved. 89319ef4fadSMehdi Amini MetadataList.tryToResolveCycles(); 89419ef4fadSMehdi Amini 89519ef4fadSMehdi Amini // Finally, everything is in place, we can replace the placeholders operands 89619ef4fadSMehdi Amini // with the final node they refer to. 89719ef4fadSMehdi Amini Placeholders.flush(MetadataList); 89819ef4fadSMehdi Amini } 89919ef4fadSMehdi Amini 9009f926f70SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseOneMetadata( 9019f926f70SMehdi Amini SmallVectorImpl<uint64_t> &Record, unsigned Code, 90219ef4fadSMehdi Amini PlaceholderQueue &Placeholders, StringRef Blob, unsigned &NextMetadataNo) { 9039f926f70SMehdi Amini 9049f926f70SMehdi Amini bool IsDistinct = false; 905ef27db87SMehdi Amini auto getMD = [&](unsigned ID) -> Metadata * { 90619ef4fadSMehdi Amini if (ID < MDStringRef.size()) 90719ef4fadSMehdi Amini return lazyLoadOneMDString(ID); 90867d2cc1fSMehdi Amini if (!IsDistinct) { 90967d2cc1fSMehdi Amini if (auto *MD = MetadataList.lookup(ID)) 91067d2cc1fSMehdi Amini return MD; 91167d2cc1fSMehdi Amini // If lazy-loading is enabled, we try recursively to load the operand 91267d2cc1fSMehdi Amini // instead of creating a temporary. 91367d2cc1fSMehdi Amini if (ID < (MDStringRef.size() + GlobalMetadataBitPosIndex.size())) { 91467d2cc1fSMehdi Amini // Create a temporary for the node that is referencing the operand we 91567d2cc1fSMehdi Amini // will lazy-load. It is needed before recursing in case there are 91667d2cc1fSMehdi Amini // uniquing cycles. 91767d2cc1fSMehdi Amini MetadataList.getMetadataFwdRef(NextMetadataNo); 91867d2cc1fSMehdi Amini lazyLoadOneMetadata(ID, Placeholders); 91967d2cc1fSMehdi Amini return MetadataList.lookup(ID); 92067d2cc1fSMehdi Amini } 92167d2cc1fSMehdi Amini // Return a temporary. 922ef27db87SMehdi Amini return MetadataList.getMetadataFwdRef(ID); 92367d2cc1fSMehdi Amini } 924ef27db87SMehdi Amini if (auto *MD = MetadataList.getMetadataIfResolved(ID)) 925ef27db87SMehdi Amini return MD; 926ef27db87SMehdi Amini return &Placeholders.getPlaceholderOp(ID); 927ef27db87SMehdi Amini }; 928ef27db87SMehdi Amini auto getMDOrNull = [&](unsigned ID) -> Metadata * { 929ef27db87SMehdi Amini if (ID) 930ef27db87SMehdi Amini return getMD(ID - 1); 931ef27db87SMehdi Amini return nullptr; 932ef27db87SMehdi Amini }; 933ef27db87SMehdi Amini auto getMDOrNullWithoutPlaceholders = [&](unsigned ID) -> Metadata * { 934ef27db87SMehdi Amini if (ID) 935ef27db87SMehdi Amini return MetadataList.getMetadataFwdRef(ID - 1); 936ef27db87SMehdi Amini return nullptr; 937ef27db87SMehdi Amini }; 938ef27db87SMehdi Amini auto getMDString = [&](unsigned ID) -> MDString * { 939ef27db87SMehdi Amini // This requires that the ID is not really a forward reference. In 940ef27db87SMehdi Amini // particular, the MDString must already have been resolved. 94119ef4fadSMehdi Amini auto MDS = getMDOrNull(ID); 94219ef4fadSMehdi Amini return cast_or_null<MDString>(MDS); 943ef27db87SMehdi Amini }; 944ef27db87SMehdi Amini 945ef27db87SMehdi Amini // Support for old type refs. 946ef27db87SMehdi Amini auto getDITypeRefOrNull = [&](unsigned ID) { 947ef27db87SMehdi Amini return MetadataList.upgradeTypeRef(getMDOrNull(ID)); 948ef27db87SMehdi Amini }; 949ef27db87SMehdi Amini 950ef27db87SMehdi Amini #define GET_OR_DISTINCT(CLASS, ARGS) \ 951ef27db87SMehdi Amini (IsDistinct ? CLASS::getDistinct ARGS : CLASS::get ARGS) 952ef27db87SMehdi Amini 953ef27db87SMehdi Amini switch (Code) { 954ef27db87SMehdi Amini default: // Default behavior: ignore. 955ef27db87SMehdi Amini break; 956ef27db87SMehdi Amini case bitc::METADATA_NAME: { 957ef27db87SMehdi Amini // Read name of the named metadata. 958ef27db87SMehdi Amini SmallString<8> Name(Record.begin(), Record.end()); 959ef27db87SMehdi Amini Record.clear(); 960ef27db87SMehdi Amini Code = Stream.ReadCode(); 961ef27db87SMehdi Amini 96219ef4fadSMehdi Amini ++NumMDRecordLoaded; 963ef27db87SMehdi Amini unsigned NextBitCode = Stream.readRecord(Code, Record); 964ef27db87SMehdi Amini if (NextBitCode != bitc::METADATA_NAMED_NODE) 965ef27db87SMehdi Amini return error("METADATA_NAME not followed by METADATA_NAMED_NODE"); 966ef27db87SMehdi Amini 967ef27db87SMehdi Amini // Read named metadata elements. 968ef27db87SMehdi Amini unsigned Size = Record.size(); 969ef27db87SMehdi Amini NamedMDNode *NMD = TheModule.getOrInsertNamedMetadata(Name); 970ef27db87SMehdi Amini for (unsigned i = 0; i != Size; ++i) { 971ef27db87SMehdi Amini MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[i]); 972ef27db87SMehdi Amini if (!MD) 973ef27db87SMehdi Amini return error("Invalid record"); 974ef27db87SMehdi Amini NMD->addOperand(MD); 975ef27db87SMehdi Amini } 976ef27db87SMehdi Amini break; 977ef27db87SMehdi Amini } 978ef27db87SMehdi Amini case bitc::METADATA_OLD_FN_NODE: { 979ef27db87SMehdi Amini // FIXME: Remove in 4.0. 980ef27db87SMehdi Amini // This is a LocalAsMetadata record, the only type of function-local 981ef27db87SMehdi Amini // metadata. 982ef27db87SMehdi Amini if (Record.size() % 2 == 1) 983ef27db87SMehdi Amini return error("Invalid record"); 984ef27db87SMehdi Amini 985ef27db87SMehdi Amini // If this isn't a LocalAsMetadata record, we're dropping it. This used 986ef27db87SMehdi Amini // to be legal, but there's no upgrade path. 987ef27db87SMehdi Amini auto dropRecord = [&] { 988c05c9db3SIvan Krasin MetadataList.assignValue(MDNode::get(Context, None), NextMetadataNo); 989c05c9db3SIvan Krasin NextMetadataNo++; 990ef27db87SMehdi Amini }; 991ef27db87SMehdi Amini if (Record.size() != 2) { 992ef27db87SMehdi Amini dropRecord(); 993ef27db87SMehdi Amini break; 994ef27db87SMehdi Amini } 995ef27db87SMehdi Amini 996ef27db87SMehdi Amini Type *Ty = getTypeByID(Record[0]); 997ef27db87SMehdi Amini if (Ty->isMetadataTy() || Ty->isVoidTy()) { 998ef27db87SMehdi Amini dropRecord(); 999ef27db87SMehdi Amini break; 1000ef27db87SMehdi Amini } 1001ef27db87SMehdi Amini 1002ef27db87SMehdi Amini MetadataList.assignValue( 1003ef27db87SMehdi Amini LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)), 1004c05c9db3SIvan Krasin NextMetadataNo); 1005c05c9db3SIvan Krasin NextMetadataNo++; 1006ef27db87SMehdi Amini break; 1007ef27db87SMehdi Amini } 1008ef27db87SMehdi Amini case bitc::METADATA_OLD_NODE: { 1009ef27db87SMehdi Amini // FIXME: Remove in 4.0. 1010ef27db87SMehdi Amini if (Record.size() % 2 == 1) 1011ef27db87SMehdi Amini return error("Invalid record"); 1012ef27db87SMehdi Amini 1013ef27db87SMehdi Amini unsigned Size = Record.size(); 1014ef27db87SMehdi Amini SmallVector<Metadata *, 8> Elts; 1015ef27db87SMehdi Amini for (unsigned i = 0; i != Size; i += 2) { 1016ef27db87SMehdi Amini Type *Ty = getTypeByID(Record[i]); 1017ef27db87SMehdi Amini if (!Ty) 1018ef27db87SMehdi Amini return error("Invalid record"); 1019ef27db87SMehdi Amini if (Ty->isMetadataTy()) 1020ef27db87SMehdi Amini Elts.push_back(getMD(Record[i + 1])); 1021ef27db87SMehdi Amini else if (!Ty->isVoidTy()) { 1022ef27db87SMehdi Amini auto *MD = 1023ef27db87SMehdi Amini ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty)); 1024ef27db87SMehdi Amini assert(isa<ConstantAsMetadata>(MD) && 1025ef27db87SMehdi Amini "Expected non-function-local metadata"); 1026ef27db87SMehdi Amini Elts.push_back(MD); 1027ef27db87SMehdi Amini } else 1028ef27db87SMehdi Amini Elts.push_back(nullptr); 1029ef27db87SMehdi Amini } 1030c05c9db3SIvan Krasin MetadataList.assignValue(MDNode::get(Context, Elts), NextMetadataNo); 1031c05c9db3SIvan Krasin NextMetadataNo++; 1032ef27db87SMehdi Amini break; 1033ef27db87SMehdi Amini } 1034ef27db87SMehdi Amini case bitc::METADATA_VALUE: { 1035ef27db87SMehdi Amini if (Record.size() != 2) 1036ef27db87SMehdi Amini return error("Invalid record"); 1037ef27db87SMehdi Amini 1038ef27db87SMehdi Amini Type *Ty = getTypeByID(Record[0]); 1039ef27db87SMehdi Amini if (Ty->isMetadataTy() || Ty->isVoidTy()) 1040ef27db87SMehdi Amini return error("Invalid record"); 1041ef27db87SMehdi Amini 1042ef27db87SMehdi Amini MetadataList.assignValue( 1043ef27db87SMehdi Amini ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)), 1044c05c9db3SIvan Krasin NextMetadataNo); 1045c05c9db3SIvan Krasin NextMetadataNo++; 1046ef27db87SMehdi Amini break; 1047ef27db87SMehdi Amini } 1048ef27db87SMehdi Amini case bitc::METADATA_DISTINCT_NODE: 1049ef27db87SMehdi Amini IsDistinct = true; 1050ef27db87SMehdi Amini LLVM_FALLTHROUGH; 1051ef27db87SMehdi Amini case bitc::METADATA_NODE: { 1052ef27db87SMehdi Amini SmallVector<Metadata *, 8> Elts; 1053ef27db87SMehdi Amini Elts.reserve(Record.size()); 1054ef27db87SMehdi Amini for (unsigned ID : Record) 1055ef27db87SMehdi Amini Elts.push_back(getMDOrNull(ID)); 1056ef27db87SMehdi Amini MetadataList.assignValue(IsDistinct ? MDNode::getDistinct(Context, Elts) 1057ef27db87SMehdi Amini : MDNode::get(Context, Elts), 1058c05c9db3SIvan Krasin NextMetadataNo); 1059c05c9db3SIvan Krasin NextMetadataNo++; 1060ef27db87SMehdi Amini break; 1061ef27db87SMehdi Amini } 1062ef27db87SMehdi Amini case bitc::METADATA_LOCATION: { 1063ef27db87SMehdi Amini if (Record.size() != 5) 1064ef27db87SMehdi Amini return error("Invalid record"); 1065ef27db87SMehdi Amini 1066ef27db87SMehdi Amini IsDistinct = Record[0]; 1067ef27db87SMehdi Amini unsigned Line = Record[1]; 1068ef27db87SMehdi Amini unsigned Column = Record[2]; 1069ef27db87SMehdi Amini Metadata *Scope = getMD(Record[3]); 1070ef27db87SMehdi Amini Metadata *InlinedAt = getMDOrNull(Record[4]); 1071ef27db87SMehdi Amini MetadataList.assignValue( 10729f926f70SMehdi Amini GET_OR_DISTINCT(DILocation, (Context, Line, Column, Scope, InlinedAt)), 1073c05c9db3SIvan Krasin NextMetadataNo); 1074c05c9db3SIvan Krasin NextMetadataNo++; 1075ef27db87SMehdi Amini break; 1076ef27db87SMehdi Amini } 1077ef27db87SMehdi Amini case bitc::METADATA_GENERIC_DEBUG: { 1078ef27db87SMehdi Amini if (Record.size() < 4) 1079ef27db87SMehdi Amini return error("Invalid record"); 1080ef27db87SMehdi Amini 1081ef27db87SMehdi Amini IsDistinct = Record[0]; 1082ef27db87SMehdi Amini unsigned Tag = Record[1]; 1083ef27db87SMehdi Amini unsigned Version = Record[2]; 1084ef27db87SMehdi Amini 1085ef27db87SMehdi Amini if (Tag >= 1u << 16 || Version != 0) 1086ef27db87SMehdi Amini return error("Invalid record"); 1087ef27db87SMehdi Amini 1088ef27db87SMehdi Amini auto *Header = getMDString(Record[3]); 1089ef27db87SMehdi Amini SmallVector<Metadata *, 8> DwarfOps; 1090ef27db87SMehdi Amini for (unsigned I = 4, E = Record.size(); I != E; ++I) 1091ef27db87SMehdi Amini DwarfOps.push_back(getMDOrNull(Record[I])); 1092ef27db87SMehdi Amini MetadataList.assignValue( 1093ef27db87SMehdi Amini GET_OR_DISTINCT(GenericDINode, (Context, Tag, Header, DwarfOps)), 1094c05c9db3SIvan Krasin NextMetadataNo); 1095c05c9db3SIvan Krasin NextMetadataNo++; 1096ef27db87SMehdi Amini break; 1097ef27db87SMehdi Amini } 1098ef27db87SMehdi Amini case bitc::METADATA_SUBRANGE: { 1099ef27db87SMehdi Amini if (Record.size() != 3) 1100ef27db87SMehdi Amini return error("Invalid record"); 1101ef27db87SMehdi Amini 1102ef27db87SMehdi Amini IsDistinct = Record[0]; 1103ef27db87SMehdi Amini MetadataList.assignValue( 1104ef27db87SMehdi Amini GET_OR_DISTINCT(DISubrange, 1105ef27db87SMehdi Amini (Context, Record[1], unrotateSign(Record[2]))), 1106c05c9db3SIvan Krasin NextMetadataNo); 1107c05c9db3SIvan Krasin NextMetadataNo++; 1108ef27db87SMehdi Amini break; 1109ef27db87SMehdi Amini } 1110ef27db87SMehdi Amini case bitc::METADATA_ENUMERATOR: { 1111ef27db87SMehdi Amini if (Record.size() != 3) 1112ef27db87SMehdi Amini return error("Invalid record"); 1113ef27db87SMehdi Amini 1114ef27db87SMehdi Amini IsDistinct = Record[0]; 1115ef27db87SMehdi Amini MetadataList.assignValue( 1116ef27db87SMehdi Amini GET_OR_DISTINCT(DIEnumerator, (Context, unrotateSign(Record[1]), 1117ef27db87SMehdi Amini getMDString(Record[2]))), 1118c05c9db3SIvan Krasin NextMetadataNo); 1119c05c9db3SIvan Krasin NextMetadataNo++; 1120ef27db87SMehdi Amini break; 1121ef27db87SMehdi Amini } 1122ef27db87SMehdi Amini case bitc::METADATA_BASIC_TYPE: { 1123ef27db87SMehdi Amini if (Record.size() != 6) 1124ef27db87SMehdi Amini return error("Invalid record"); 1125ef27db87SMehdi Amini 1126ef27db87SMehdi Amini IsDistinct = Record[0]; 1127ef27db87SMehdi Amini MetadataList.assignValue( 1128ef27db87SMehdi Amini GET_OR_DISTINCT(DIBasicType, 11299f926f70SMehdi Amini (Context, Record[1], getMDString(Record[2]), Record[3], 11309f926f70SMehdi Amini Record[4], Record[5])), 1131c05c9db3SIvan Krasin NextMetadataNo); 1132c05c9db3SIvan Krasin NextMetadataNo++; 1133ef27db87SMehdi Amini break; 1134ef27db87SMehdi Amini } 1135ef27db87SMehdi Amini case bitc::METADATA_DERIVED_TYPE: { 1136d5561e0aSKonstantin Zhuravlyov if (Record.size() < 12 || Record.size() > 13) 1137ef27db87SMehdi Amini return error("Invalid record"); 1138ef27db87SMehdi Amini 1139d5561e0aSKonstantin Zhuravlyov // DWARF address space is encoded as N->getDWARFAddressSpace() + 1. 0 means 1140d5561e0aSKonstantin Zhuravlyov // that there is no DWARF address space associated with DIDerivedType. 1141d5561e0aSKonstantin Zhuravlyov Optional<unsigned> DWARFAddressSpace; 1142d5561e0aSKonstantin Zhuravlyov if (Record.size() > 12 && Record[12]) 1143d5561e0aSKonstantin Zhuravlyov DWARFAddressSpace = Record[12] - 1; 1144d5561e0aSKonstantin Zhuravlyov 1145ef27db87SMehdi Amini IsDistinct = Record[0]; 1146ef27db87SMehdi Amini DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[10]); 1147ef27db87SMehdi Amini MetadataList.assignValue( 1148ef27db87SMehdi Amini GET_OR_DISTINCT(DIDerivedType, 1149ef27db87SMehdi Amini (Context, Record[1], getMDString(Record[2]), 1150ef27db87SMehdi Amini getMDOrNull(Record[3]), Record[4], 1151ef27db87SMehdi Amini getDITypeRefOrNull(Record[5]), 1152ef27db87SMehdi Amini getDITypeRefOrNull(Record[6]), Record[7], Record[8], 1153d5561e0aSKonstantin Zhuravlyov Record[9], DWARFAddressSpace, Flags, 1154d5561e0aSKonstantin Zhuravlyov getDITypeRefOrNull(Record[11]))), 1155c05c9db3SIvan Krasin NextMetadataNo); 1156c05c9db3SIvan Krasin NextMetadataNo++; 1157ef27db87SMehdi Amini break; 1158ef27db87SMehdi Amini } 1159ef27db87SMehdi Amini case bitc::METADATA_COMPOSITE_TYPE: { 1160ef27db87SMehdi Amini if (Record.size() != 16) 1161ef27db87SMehdi Amini return error("Invalid record"); 1162ef27db87SMehdi Amini 1163ef27db87SMehdi Amini // If we have a UUID and this is not a forward declaration, lookup the 1164ef27db87SMehdi Amini // mapping. 1165ef27db87SMehdi Amini IsDistinct = Record[0] & 0x1; 1166ef27db87SMehdi Amini bool IsNotUsedInTypeRef = Record[0] >= 2; 1167ef27db87SMehdi Amini unsigned Tag = Record[1]; 1168ef27db87SMehdi Amini MDString *Name = getMDString(Record[2]); 1169ef27db87SMehdi Amini Metadata *File = getMDOrNull(Record[3]); 1170ef27db87SMehdi Amini unsigned Line = Record[4]; 1171ef27db87SMehdi Amini Metadata *Scope = getDITypeRefOrNull(Record[5]); 1172a61f5e37STeresa Johnson Metadata *BaseType = nullptr; 1173ef27db87SMehdi Amini uint64_t SizeInBits = Record[7]; 1174ef27db87SMehdi Amini if (Record[8] > (uint64_t)std::numeric_limits<uint32_t>::max()) 1175ef27db87SMehdi Amini return error("Alignment value is too large"); 1176ef27db87SMehdi Amini uint32_t AlignInBits = Record[8]; 1177a61f5e37STeresa Johnson uint64_t OffsetInBits = 0; 1178ef27db87SMehdi Amini DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[10]); 1179a61f5e37STeresa Johnson Metadata *Elements = nullptr; 1180ef27db87SMehdi Amini unsigned RuntimeLang = Record[12]; 1181a61f5e37STeresa Johnson Metadata *VTableHolder = nullptr; 1182a61f5e37STeresa Johnson Metadata *TemplateParams = nullptr; 1183ef27db87SMehdi Amini auto *Identifier = getMDString(Record[15]); 1184a61f5e37STeresa Johnson // If this module is being parsed so that it can be ThinLTO imported 1185a61f5e37STeresa Johnson // into another module, composite types only need to be imported 1186a61f5e37STeresa Johnson // as type declarations (unless full type definitions requested). 1187a61f5e37STeresa Johnson // Create type declarations up front to save memory. Also, buildODRType 1188a61f5e37STeresa Johnson // handles the case where this is type ODRed with a definition needed 1189a61f5e37STeresa Johnson // by the importing module, in which case the existing definition is 1190a61f5e37STeresa Johnson // used. 11915a8dba5bSTeresa Johnson if (IsImporting && !ImportFullTypeDefinitions && Identifier && 1192a61f5e37STeresa Johnson (Tag == dwarf::DW_TAG_enumeration_type || 1193a61f5e37STeresa Johnson Tag == dwarf::DW_TAG_class_type || 1194a61f5e37STeresa Johnson Tag == dwarf::DW_TAG_structure_type || 1195a61f5e37STeresa Johnson Tag == dwarf::DW_TAG_union_type)) { 1196a61f5e37STeresa Johnson Flags = Flags | DINode::FlagFwdDecl; 1197a61f5e37STeresa Johnson } else { 1198a61f5e37STeresa Johnson BaseType = getDITypeRefOrNull(Record[6]); 1199a61f5e37STeresa Johnson OffsetInBits = Record[9]; 1200a61f5e37STeresa Johnson Elements = getMDOrNull(Record[11]); 1201a61f5e37STeresa Johnson VTableHolder = getDITypeRefOrNull(Record[13]); 1202a61f5e37STeresa Johnson TemplateParams = getMDOrNull(Record[14]); 1203a61f5e37STeresa Johnson } 1204ef27db87SMehdi Amini DICompositeType *CT = nullptr; 1205ef27db87SMehdi Amini if (Identifier) 1206ef27db87SMehdi Amini CT = DICompositeType::buildODRType( 1207ef27db87SMehdi Amini Context, *Identifier, Tag, Name, File, Line, Scope, BaseType, 1208ef27db87SMehdi Amini SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, 1209ef27db87SMehdi Amini VTableHolder, TemplateParams); 1210ef27db87SMehdi Amini 1211ef27db87SMehdi Amini // Create a node if we didn't get a lazy ODR type. 1212ef27db87SMehdi Amini if (!CT) 1213ef27db87SMehdi Amini CT = GET_OR_DISTINCT(DICompositeType, 1214ef27db87SMehdi Amini (Context, Tag, Name, File, Line, Scope, BaseType, 1215ef27db87SMehdi Amini SizeInBits, AlignInBits, OffsetInBits, Flags, 12169f926f70SMehdi Amini Elements, RuntimeLang, VTableHolder, TemplateParams, 12179f926f70SMehdi Amini Identifier)); 1218ef27db87SMehdi Amini if (!IsNotUsedInTypeRef && Identifier) 1219ef27db87SMehdi Amini MetadataList.addTypeRef(*Identifier, *cast<DICompositeType>(CT)); 1220ef27db87SMehdi Amini 1221c05c9db3SIvan Krasin MetadataList.assignValue(CT, NextMetadataNo); 1222c05c9db3SIvan Krasin NextMetadataNo++; 1223ef27db87SMehdi Amini break; 1224ef27db87SMehdi Amini } 1225ef27db87SMehdi Amini case bitc::METADATA_SUBROUTINE_TYPE: { 1226ef27db87SMehdi Amini if (Record.size() < 3 || Record.size() > 4) 1227ef27db87SMehdi Amini return error("Invalid record"); 1228ef27db87SMehdi Amini bool IsOldTypeRefArray = Record[0] < 2; 1229ef27db87SMehdi Amini unsigned CC = (Record.size() > 3) ? Record[3] : 0; 1230ef27db87SMehdi Amini 1231ef27db87SMehdi Amini IsDistinct = Record[0] & 0x1; 1232ef27db87SMehdi Amini DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[1]); 1233ef27db87SMehdi Amini Metadata *Types = getMDOrNull(Record[2]); 1234ef27db87SMehdi Amini if (LLVM_UNLIKELY(IsOldTypeRefArray)) 1235ef27db87SMehdi Amini Types = MetadataList.upgradeTypeRefArray(Types); 1236ef27db87SMehdi Amini 1237ef27db87SMehdi Amini MetadataList.assignValue( 1238ef27db87SMehdi Amini GET_OR_DISTINCT(DISubroutineType, (Context, Flags, CC, Types)), 1239c05c9db3SIvan Krasin NextMetadataNo); 1240c05c9db3SIvan Krasin NextMetadataNo++; 1241ef27db87SMehdi Amini break; 1242ef27db87SMehdi Amini } 1243ef27db87SMehdi Amini 1244ef27db87SMehdi Amini case bitc::METADATA_MODULE: { 1245ef27db87SMehdi Amini if (Record.size() != 6) 1246ef27db87SMehdi Amini return error("Invalid record"); 1247ef27db87SMehdi Amini 1248ef27db87SMehdi Amini IsDistinct = Record[0]; 1249ef27db87SMehdi Amini MetadataList.assignValue( 1250ef27db87SMehdi Amini GET_OR_DISTINCT(DIModule, 1251ef27db87SMehdi Amini (Context, getMDOrNull(Record[1]), 1252ef27db87SMehdi Amini getMDString(Record[2]), getMDString(Record[3]), 1253ef27db87SMehdi Amini getMDString(Record[4]), getMDString(Record[5]))), 1254c05c9db3SIvan Krasin NextMetadataNo); 1255c05c9db3SIvan Krasin NextMetadataNo++; 1256ef27db87SMehdi Amini break; 1257ef27db87SMehdi Amini } 1258ef27db87SMehdi Amini 1259ef27db87SMehdi Amini case bitc::METADATA_FILE: { 12607faeecc8SAmjad Aboud if (Record.size() != 3 && Record.size() != 5) 1261ef27db87SMehdi Amini return error("Invalid record"); 1262ef27db87SMehdi Amini 1263ef27db87SMehdi Amini IsDistinct = Record[0]; 1264ef27db87SMehdi Amini MetadataList.assignValue( 12659f926f70SMehdi Amini GET_OR_DISTINCT( 12667faeecc8SAmjad Aboud DIFile, 12677faeecc8SAmjad Aboud (Context, getMDString(Record[1]), getMDString(Record[2]), 12687faeecc8SAmjad Aboud Record.size() == 3 ? DIFile::CSK_None 12697faeecc8SAmjad Aboud : static_cast<DIFile::ChecksumKind>(Record[3]), 12707faeecc8SAmjad Aboud Record.size() == 3 ? nullptr : getMDString(Record[4]))), 1271c05c9db3SIvan Krasin NextMetadataNo); 1272c05c9db3SIvan Krasin NextMetadataNo++; 1273ef27db87SMehdi Amini break; 1274ef27db87SMehdi Amini } 1275ef27db87SMehdi Amini case bitc::METADATA_COMPILE_UNIT: { 12760944a8c2SDehao Chen if (Record.size() < 14 || Record.size() > 18) 1277ef27db87SMehdi Amini return error("Invalid record"); 1278ef27db87SMehdi Amini 1279ef27db87SMehdi Amini // Ignore Record[0], which indicates whether this compile unit is 1280ef27db87SMehdi Amini // distinct. It's always distinct. 1281ef27db87SMehdi Amini IsDistinct = true; 1282ef27db87SMehdi Amini auto *CU = DICompileUnit::getDistinct( 1283ef27db87SMehdi Amini Context, Record[1], getMDOrNull(Record[2]), getMDString(Record[3]), 1284ef27db87SMehdi Amini Record[4], getMDString(Record[5]), Record[6], getMDString(Record[7]), 1285ef27db87SMehdi Amini Record[8], getMDOrNull(Record[9]), getMDOrNull(Record[10]), 1286ef27db87SMehdi Amini getMDOrNull(Record[12]), getMDOrNull(Record[13]), 1287ef27db87SMehdi Amini Record.size() <= 15 ? nullptr : getMDOrNull(Record[15]), 1288ef27db87SMehdi Amini Record.size() <= 14 ? 0 : Record[14], 12890944a8c2SDehao Chen Record.size() <= 16 ? true : Record[16], 12900944a8c2SDehao Chen Record.size() <= 17 ? false : Record[17]); 1291ef27db87SMehdi Amini 1292c05c9db3SIvan Krasin MetadataList.assignValue(CU, NextMetadataNo); 1293c05c9db3SIvan Krasin NextMetadataNo++; 1294ef27db87SMehdi Amini 1295ef27db87SMehdi Amini // Move the Upgrade the list of subprograms. 1296ef27db87SMehdi Amini if (Metadata *SPs = getMDOrNullWithoutPlaceholders(Record[11])) 1297ef27db87SMehdi Amini CUSubprograms.push_back({CU, SPs}); 1298ef27db87SMehdi Amini break; 1299ef27db87SMehdi Amini } 1300ef27db87SMehdi Amini case bitc::METADATA_SUBPROGRAM: { 13011d12b885SAdrian Prantl if (Record.size() < 18 || Record.size() > 21) 1302ef27db87SMehdi Amini return error("Invalid record"); 1303ef27db87SMehdi Amini 1304ef27db87SMehdi Amini IsDistinct = 1305ef27db87SMehdi Amini (Record[0] & 1) || Record[8]; // All definitions should be distinct. 1306ef27db87SMehdi Amini // Version 1 has a Function as Record[15]. 1307ef27db87SMehdi Amini // Version 2 has removed Record[15]. 1308ef27db87SMehdi Amini // Version 3 has the Unit as Record[15]. 1309ef27db87SMehdi Amini // Version 4 added thisAdjustment. 1310ef27db87SMehdi Amini bool HasUnit = Record[0] >= 2; 1311ef27db87SMehdi Amini if (HasUnit && Record.size() < 19) 1312ef27db87SMehdi Amini return error("Invalid record"); 1313ef27db87SMehdi Amini Metadata *CUorFn = getMDOrNull(Record[15]); 1314ef27db87SMehdi Amini unsigned Offset = Record.size() >= 19 ? 1 : 0; 1315ef27db87SMehdi Amini bool HasFn = Offset && !HasUnit; 1316ef27db87SMehdi Amini bool HasThisAdj = Record.size() >= 20; 13171d12b885SAdrian Prantl bool HasThrownTypes = Record.size() >= 21; 1318ef27db87SMehdi Amini DISubprogram *SP = GET_OR_DISTINCT( 13191d12b885SAdrian Prantl DISubprogram, 13201d12b885SAdrian Prantl (Context, 1321ef27db87SMehdi Amini getDITypeRefOrNull(Record[1]), // scope 1322ef27db87SMehdi Amini getMDString(Record[2]), // name 1323ef27db87SMehdi Amini getMDString(Record[3]), // linkageName 1324ef27db87SMehdi Amini getMDOrNull(Record[4]), // file 1325ef27db87SMehdi Amini Record[5], // line 1326ef27db87SMehdi Amini getMDOrNull(Record[6]), // type 1327ef27db87SMehdi Amini Record[7], // isLocal 1328ef27db87SMehdi Amini Record[8], // isDefinition 1329ef27db87SMehdi Amini Record[9], // scopeLine 1330ef27db87SMehdi Amini getDITypeRefOrNull(Record[10]), // containingType 1331ef27db87SMehdi Amini Record[11], // virtuality 1332ef27db87SMehdi Amini Record[12], // virtualIndex 1333ef27db87SMehdi Amini HasThisAdj ? Record[19] : 0, // thisAdjustment 13341d12b885SAdrian Prantl static_cast<DINode::DIFlags>(Record[13]), // flags 1335ef27db87SMehdi Amini Record[14], // isOptimized 1336ef27db87SMehdi Amini HasUnit ? CUorFn : nullptr, // unit 1337ef27db87SMehdi Amini getMDOrNull(Record[15 + Offset]), // templateParams 1338ef27db87SMehdi Amini getMDOrNull(Record[16 + Offset]), // declaration 13391d12b885SAdrian Prantl getMDOrNull(Record[17 + Offset]), // variables 13401d12b885SAdrian Prantl HasThrownTypes ? getMDOrNull(Record[20]) : nullptr // thrownTypes 1341ef27db87SMehdi Amini )); 1342c05c9db3SIvan Krasin MetadataList.assignValue(SP, NextMetadataNo); 1343c05c9db3SIvan Krasin NextMetadataNo++; 1344ef27db87SMehdi Amini 1345ef27db87SMehdi Amini // Upgrade sp->function mapping to function->sp mapping. 1346ef27db87SMehdi Amini if (HasFn) { 1347ef27db87SMehdi Amini if (auto *CMD = dyn_cast_or_null<ConstantAsMetadata>(CUorFn)) 1348ef27db87SMehdi Amini if (auto *F = dyn_cast<Function>(CMD->getValue())) { 1349ef27db87SMehdi Amini if (F->isMaterializable()) 1350ef27db87SMehdi Amini // Defer until materialized; unmaterialized functions may not have 1351ef27db87SMehdi Amini // metadata. 1352ef27db87SMehdi Amini FunctionsWithSPs[F] = SP; 1353ef27db87SMehdi Amini else if (!F->empty()) 1354ef27db87SMehdi Amini F->setSubprogram(SP); 1355ef27db87SMehdi Amini } 1356ef27db87SMehdi Amini } 1357ef27db87SMehdi Amini break; 1358ef27db87SMehdi Amini } 1359ef27db87SMehdi Amini case bitc::METADATA_LEXICAL_BLOCK: { 1360ef27db87SMehdi Amini if (Record.size() != 5) 1361ef27db87SMehdi Amini return error("Invalid record"); 1362ef27db87SMehdi Amini 1363ef27db87SMehdi Amini IsDistinct = Record[0]; 1364ef27db87SMehdi Amini MetadataList.assignValue( 1365ef27db87SMehdi Amini GET_OR_DISTINCT(DILexicalBlock, 1366ef27db87SMehdi Amini (Context, getMDOrNull(Record[1]), 1367ef27db87SMehdi Amini getMDOrNull(Record[2]), Record[3], Record[4])), 1368c05c9db3SIvan Krasin NextMetadataNo); 1369c05c9db3SIvan Krasin NextMetadataNo++; 1370ef27db87SMehdi Amini break; 1371ef27db87SMehdi Amini } 1372ef27db87SMehdi Amini case bitc::METADATA_LEXICAL_BLOCK_FILE: { 1373ef27db87SMehdi Amini if (Record.size() != 4) 1374ef27db87SMehdi Amini return error("Invalid record"); 1375ef27db87SMehdi Amini 1376ef27db87SMehdi Amini IsDistinct = Record[0]; 1377ef27db87SMehdi Amini MetadataList.assignValue( 1378ef27db87SMehdi Amini GET_OR_DISTINCT(DILexicalBlockFile, 1379ef27db87SMehdi Amini (Context, getMDOrNull(Record[1]), 1380ef27db87SMehdi Amini getMDOrNull(Record[2]), Record[3])), 1381c05c9db3SIvan Krasin NextMetadataNo); 1382c05c9db3SIvan Krasin NextMetadataNo++; 1383ef27db87SMehdi Amini break; 1384ef27db87SMehdi Amini } 1385ef27db87SMehdi Amini case bitc::METADATA_NAMESPACE: { 1386ef27db87SMehdi Amini if (Record.size() != 5) 1387ef27db87SMehdi Amini return error("Invalid record"); 1388ef27db87SMehdi Amini 1389ef27db87SMehdi Amini IsDistinct = Record[0] & 1; 1390ef27db87SMehdi Amini bool ExportSymbols = Record[0] & 2; 1391ef27db87SMehdi Amini MetadataList.assignValue( 1392ef27db87SMehdi Amini GET_OR_DISTINCT(DINamespace, 1393ef27db87SMehdi Amini (Context, getMDOrNull(Record[1]), 1394ef27db87SMehdi Amini getMDOrNull(Record[2]), getMDString(Record[3]), 1395ef27db87SMehdi Amini Record[4], ExportSymbols)), 1396c05c9db3SIvan Krasin NextMetadataNo); 1397c05c9db3SIvan Krasin NextMetadataNo++; 1398ef27db87SMehdi Amini break; 1399ef27db87SMehdi Amini } 1400ef27db87SMehdi Amini case bitc::METADATA_MACRO: { 1401ef27db87SMehdi Amini if (Record.size() != 5) 1402ef27db87SMehdi Amini return error("Invalid record"); 1403ef27db87SMehdi Amini 1404ef27db87SMehdi Amini IsDistinct = Record[0]; 1405ef27db87SMehdi Amini MetadataList.assignValue( 1406ef27db87SMehdi Amini GET_OR_DISTINCT(DIMacro, 14079f926f70SMehdi Amini (Context, Record[1], Record[2], getMDString(Record[3]), 14089f926f70SMehdi Amini getMDString(Record[4]))), 1409c05c9db3SIvan Krasin NextMetadataNo); 1410c05c9db3SIvan Krasin NextMetadataNo++; 1411ef27db87SMehdi Amini break; 1412ef27db87SMehdi Amini } 1413ef27db87SMehdi Amini case bitc::METADATA_MACRO_FILE: { 1414ef27db87SMehdi Amini if (Record.size() != 5) 1415ef27db87SMehdi Amini return error("Invalid record"); 1416ef27db87SMehdi Amini 1417ef27db87SMehdi Amini IsDistinct = Record[0]; 1418ef27db87SMehdi Amini MetadataList.assignValue( 1419ef27db87SMehdi Amini GET_OR_DISTINCT(DIMacroFile, 14209f926f70SMehdi Amini (Context, Record[1], Record[2], getMDOrNull(Record[3]), 14219f926f70SMehdi Amini getMDOrNull(Record[4]))), 1422c05c9db3SIvan Krasin NextMetadataNo); 1423c05c9db3SIvan Krasin NextMetadataNo++; 1424ef27db87SMehdi Amini break; 1425ef27db87SMehdi Amini } 1426ef27db87SMehdi Amini case bitc::METADATA_TEMPLATE_TYPE: { 1427ef27db87SMehdi Amini if (Record.size() != 3) 1428ef27db87SMehdi Amini return error("Invalid record"); 1429ef27db87SMehdi Amini 1430ef27db87SMehdi Amini IsDistinct = Record[0]; 1431ef27db87SMehdi Amini MetadataList.assignValue(GET_OR_DISTINCT(DITemplateTypeParameter, 1432ef27db87SMehdi Amini (Context, getMDString(Record[1]), 1433ef27db87SMehdi Amini getDITypeRefOrNull(Record[2]))), 1434c05c9db3SIvan Krasin NextMetadataNo); 1435c05c9db3SIvan Krasin NextMetadataNo++; 1436ef27db87SMehdi Amini break; 1437ef27db87SMehdi Amini } 1438ef27db87SMehdi Amini case bitc::METADATA_TEMPLATE_VALUE: { 1439ef27db87SMehdi Amini if (Record.size() != 5) 1440ef27db87SMehdi Amini return error("Invalid record"); 1441ef27db87SMehdi Amini 1442ef27db87SMehdi Amini IsDistinct = Record[0]; 1443ef27db87SMehdi Amini MetadataList.assignValue( 1444ef27db87SMehdi Amini GET_OR_DISTINCT(DITemplateValueParameter, 1445ef27db87SMehdi Amini (Context, Record[1], getMDString(Record[2]), 1446ef27db87SMehdi Amini getDITypeRefOrNull(Record[3]), 1447ef27db87SMehdi Amini getMDOrNull(Record[4]))), 1448c05c9db3SIvan Krasin NextMetadataNo); 1449c05c9db3SIvan Krasin NextMetadataNo++; 1450ef27db87SMehdi Amini break; 1451ef27db87SMehdi Amini } 1452ef27db87SMehdi Amini case bitc::METADATA_GLOBAL_VAR: { 1453ef27db87SMehdi Amini if (Record.size() < 11 || Record.size() > 12) 1454ef27db87SMehdi Amini return error("Invalid record"); 1455ef27db87SMehdi Amini 1456bceaaa96SAdrian Prantl IsDistinct = Record[0] & 1; 1457bceaaa96SAdrian Prantl unsigned Version = Record[0] >> 1; 1458ef27db87SMehdi Amini 1459bceaaa96SAdrian Prantl if (Version == 1) { 1460bceaaa96SAdrian Prantl MetadataList.assignValue( 1461bceaaa96SAdrian Prantl GET_OR_DISTINCT(DIGlobalVariable, 1462bceaaa96SAdrian Prantl (Context, getMDOrNull(Record[1]), 1463bceaaa96SAdrian Prantl getMDString(Record[2]), getMDString(Record[3]), 1464bceaaa96SAdrian Prantl getMDOrNull(Record[4]), Record[5], 14659f926f70SMehdi Amini getDITypeRefOrNull(Record[6]), Record[7], Record[8], 14669f926f70SMehdi Amini getMDOrNull(Record[10]), Record[11])), 1467c05c9db3SIvan Krasin NextMetadataNo); 1468c05c9db3SIvan Krasin NextMetadataNo++; 1469bceaaa96SAdrian Prantl } else if (Version == 0) { 1470ef27db87SMehdi Amini // Upgrade old metadata, which stored a global variable reference or a 1471ef27db87SMehdi Amini // ConstantInt here. 1472a5bf2d70SAdrian Prantl NeedUpgradeToDIGlobalVariableExpression = true; 1473ef27db87SMehdi Amini Metadata *Expr = getMDOrNull(Record[9]); 1474ef27db87SMehdi Amini uint32_t AlignInBits = 0; 1475ef27db87SMehdi Amini if (Record.size() > 11) { 1476ef27db87SMehdi Amini if (Record[11] > (uint64_t)std::numeric_limits<uint32_t>::max()) 1477ef27db87SMehdi Amini return error("Alignment value is too large"); 1478ef27db87SMehdi Amini AlignInBits = Record[11]; 1479ef27db87SMehdi Amini } 1480ef27db87SMehdi Amini GlobalVariable *Attach = nullptr; 1481ef27db87SMehdi Amini if (auto *CMD = dyn_cast_or_null<ConstantAsMetadata>(Expr)) { 1482ef27db87SMehdi Amini if (auto *GV = dyn_cast<GlobalVariable>(CMD->getValue())) { 1483ef27db87SMehdi Amini Attach = GV; 1484ef27db87SMehdi Amini Expr = nullptr; 1485ef27db87SMehdi Amini } else if (auto *CI = dyn_cast<ConstantInt>(CMD->getValue())) { 1486ef27db87SMehdi Amini Expr = DIExpression::get(Context, 1487ef27db87SMehdi Amini {dwarf::DW_OP_constu, CI->getZExtValue(), 1488ef27db87SMehdi Amini dwarf::DW_OP_stack_value}); 1489ef27db87SMehdi Amini } else { 1490ef27db87SMehdi Amini Expr = nullptr; 1491ef27db87SMehdi Amini } 1492ef27db87SMehdi Amini } 1493ef27db87SMehdi Amini DIGlobalVariable *DGV = GET_OR_DISTINCT( 1494ef27db87SMehdi Amini DIGlobalVariable, 1495ef27db87SMehdi Amini (Context, getMDOrNull(Record[1]), getMDString(Record[2]), 1496ef27db87SMehdi Amini getMDString(Record[3]), getMDOrNull(Record[4]), Record[5], 1497bceaaa96SAdrian Prantl getDITypeRefOrNull(Record[6]), Record[7], Record[8], 1498ef27db87SMehdi Amini getMDOrNull(Record[10]), AlignInBits)); 149903c6d31aSAdrian Prantl 1500e37d3144SAdrian Prantl DIGlobalVariableExpression *DGVE = nullptr; 1501e37d3144SAdrian Prantl if (Attach || Expr) 1502e37d3144SAdrian Prantl DGVE = DIGlobalVariableExpression::getDistinct(Context, DGV, Expr); 150373ec0656SAdrian Prantl if (Attach) 1504bceaaa96SAdrian Prantl Attach->addDebugInfo(DGVE); 1505e37d3144SAdrian Prantl 1506e37d3144SAdrian Prantl auto *MDNode = Expr ? cast<Metadata>(DGVE) : cast<Metadata>(DGV); 1507e37d3144SAdrian Prantl MetadataList.assignValue(MDNode, NextMetadataNo); 1508e37d3144SAdrian Prantl NextMetadataNo++; 1509bceaaa96SAdrian Prantl } else 1510bceaaa96SAdrian Prantl return error("Invalid record"); 151173ec0656SAdrian Prantl 1512ef27db87SMehdi Amini break; 1513ef27db87SMehdi Amini } 1514ef27db87SMehdi Amini case bitc::METADATA_LOCAL_VAR: { 1515ef27db87SMehdi Amini // 10th field is for the obseleted 'inlinedAt:' field. 1516ef27db87SMehdi Amini if (Record.size() < 8 || Record.size() > 10) 1517ef27db87SMehdi Amini return error("Invalid record"); 1518ef27db87SMehdi Amini 1519ef27db87SMehdi Amini IsDistinct = Record[0] & 1; 1520ef27db87SMehdi Amini bool HasAlignment = Record[0] & 2; 1521ef27db87SMehdi Amini // 2nd field used to be an artificial tag, either DW_TAG_auto_variable or 1522ef27db87SMehdi Amini // DW_TAG_arg_variable, if we have alignment flag encoded it means, that 152368168d17SSimon Pilgrim // this is newer version of record which doesn't have artificial tag. 1524ef27db87SMehdi Amini bool HasTag = !HasAlignment && Record.size() > 8; 1525ef27db87SMehdi Amini DINode::DIFlags Flags = static_cast<DINode::DIFlags>(Record[7 + HasTag]); 1526ef27db87SMehdi Amini uint32_t AlignInBits = 0; 1527ef27db87SMehdi Amini if (HasAlignment) { 1528ef27db87SMehdi Amini if (Record[8 + HasTag] > (uint64_t)std::numeric_limits<uint32_t>::max()) 1529ef27db87SMehdi Amini return error("Alignment value is too large"); 1530ef27db87SMehdi Amini AlignInBits = Record[8 + HasTag]; 1531ef27db87SMehdi Amini } 1532ef27db87SMehdi Amini MetadataList.assignValue( 1533ef27db87SMehdi Amini GET_OR_DISTINCT(DILocalVariable, 1534ef27db87SMehdi Amini (Context, getMDOrNull(Record[1 + HasTag]), 1535ef27db87SMehdi Amini getMDString(Record[2 + HasTag]), 1536ef27db87SMehdi Amini getMDOrNull(Record[3 + HasTag]), Record[4 + HasTag], 1537ef27db87SMehdi Amini getDITypeRefOrNull(Record[5 + HasTag]), 1538ef27db87SMehdi Amini Record[6 + HasTag], Flags, AlignInBits)), 1539c05c9db3SIvan Krasin NextMetadataNo); 1540c05c9db3SIvan Krasin NextMetadataNo++; 1541ef27db87SMehdi Amini break; 1542ef27db87SMehdi Amini } 1543ef27db87SMehdi Amini case bitc::METADATA_EXPRESSION: { 1544ef27db87SMehdi Amini if (Record.size() < 1) 1545ef27db87SMehdi Amini return error("Invalid record"); 1546ef27db87SMehdi Amini 1547ef27db87SMehdi Amini IsDistinct = Record[0] & 1; 15486825fb64SAdrian Prantl uint64_t Version = Record[0] >> 1; 1549ef27db87SMehdi Amini auto Elts = MutableArrayRef<uint64_t>(Record).slice(1); 15506825fb64SAdrian Prantl unsigned N = Elts.size(); 15516825fb64SAdrian Prantl // Perform various upgrades. 15526825fb64SAdrian Prantl switch (Version) { 15536825fb64SAdrian Prantl case 0: 1554ef27db87SMehdi Amini if (N >= 3 && Elts[N - 3] == dwarf::DW_OP_bit_piece) 1555ef27db87SMehdi Amini Elts[N - 3] = dwarf::DW_OP_LLVM_fragment; 15566825fb64SAdrian Prantl LLVM_FALLTHROUGH; 15576825fb64SAdrian Prantl case 1: 15586825fb64SAdrian Prantl // Move DW_OP_deref to the end. 15596825fb64SAdrian Prantl if (N && Elts[0] == dwarf::DW_OP_deref) { 15606825fb64SAdrian Prantl auto End = Elts.end(); 15616825fb64SAdrian Prantl if (Elts.size() >= 3 && *std::prev(End, 3) == dwarf::DW_OP_LLVM_fragment) 15626825fb64SAdrian Prantl End = std::prev(End, 3); 15636825fb64SAdrian Prantl std::move(std::next(Elts.begin()), End, Elts.begin()); 15646825fb64SAdrian Prantl *std::prev(End) = dwarf::DW_OP_deref; 15656825fb64SAdrian Prantl } 15666825fb64SAdrian Prantl NeedDeclareExpressionUpgrade = true; 15676825fb64SAdrian Prantl LLVM_FALLTHROUGH; 15686825fb64SAdrian Prantl case 2: 15696825fb64SAdrian Prantl // Up-to-date! 15706825fb64SAdrian Prantl break; 15716825fb64SAdrian Prantl default: 15726825fb64SAdrian Prantl return error("Invalid record"); 15736825fb64SAdrian Prantl } 1574ef27db87SMehdi Amini 1575ef27db87SMehdi Amini MetadataList.assignValue( 15769f926f70SMehdi Amini GET_OR_DISTINCT(DIExpression, (Context, makeArrayRef(Record).slice(1))), 1577c05c9db3SIvan Krasin NextMetadataNo); 1578c05c9db3SIvan Krasin NextMetadataNo++; 1579ef27db87SMehdi Amini break; 1580ef27db87SMehdi Amini } 1581bceaaa96SAdrian Prantl case bitc::METADATA_GLOBAL_VAR_EXPR: { 1582bceaaa96SAdrian Prantl if (Record.size() != 3) 1583bceaaa96SAdrian Prantl return error("Invalid record"); 1584bceaaa96SAdrian Prantl 1585bceaaa96SAdrian Prantl IsDistinct = Record[0]; 1586bceaaa96SAdrian Prantl MetadataList.assignValue(GET_OR_DISTINCT(DIGlobalVariableExpression, 1587bceaaa96SAdrian Prantl (Context, getMDOrNull(Record[1]), 1588bceaaa96SAdrian Prantl getMDOrNull(Record[2]))), 1589c05c9db3SIvan Krasin NextMetadataNo); 1590c05c9db3SIvan Krasin NextMetadataNo++; 1591bceaaa96SAdrian Prantl break; 1592bceaaa96SAdrian Prantl } 1593ef27db87SMehdi Amini case bitc::METADATA_OBJC_PROPERTY: { 1594ef27db87SMehdi Amini if (Record.size() != 8) 1595ef27db87SMehdi Amini return error("Invalid record"); 1596ef27db87SMehdi Amini 1597ef27db87SMehdi Amini IsDistinct = Record[0]; 1598ef27db87SMehdi Amini MetadataList.assignValue( 1599ef27db87SMehdi Amini GET_OR_DISTINCT(DIObjCProperty, 1600ef27db87SMehdi Amini (Context, getMDString(Record[1]), 1601ef27db87SMehdi Amini getMDOrNull(Record[2]), Record[3], 1602ef27db87SMehdi Amini getMDString(Record[4]), getMDString(Record[5]), 1603ef27db87SMehdi Amini Record[6], getDITypeRefOrNull(Record[7]))), 1604c05c9db3SIvan Krasin NextMetadataNo); 1605c05c9db3SIvan Krasin NextMetadataNo++; 1606ef27db87SMehdi Amini break; 1607ef27db87SMehdi Amini } 1608ef27db87SMehdi Amini case bitc::METADATA_IMPORTED_ENTITY: { 1609ef27db87SMehdi Amini if (Record.size() != 6) 1610ef27db87SMehdi Amini return error("Invalid record"); 1611ef27db87SMehdi Amini 1612ef27db87SMehdi Amini IsDistinct = Record[0]; 1613ef27db87SMehdi Amini MetadataList.assignValue( 1614ef27db87SMehdi Amini GET_OR_DISTINCT(DIImportedEntity, 1615ef27db87SMehdi Amini (Context, Record[1], getMDOrNull(Record[2]), 1616ef27db87SMehdi Amini getDITypeRefOrNull(Record[3]), Record[4], 1617ef27db87SMehdi Amini getMDString(Record[5]))), 1618c05c9db3SIvan Krasin NextMetadataNo); 1619c05c9db3SIvan Krasin NextMetadataNo++; 1620ef27db87SMehdi Amini break; 1621ef27db87SMehdi Amini } 1622ef27db87SMehdi Amini case bitc::METADATA_STRING_OLD: { 1623ef27db87SMehdi Amini std::string String(Record.begin(), Record.end()); 1624ef27db87SMehdi Amini 1625ef27db87SMehdi Amini // Test for upgrading !llvm.loop. 1626ef27db87SMehdi Amini HasSeenOldLoopTags |= mayBeOldLoopAttachmentTag(String); 162719ef4fadSMehdi Amini ++NumMDStringLoaded; 1628ef27db87SMehdi Amini Metadata *MD = MDString::get(Context, String); 1629c05c9db3SIvan Krasin MetadataList.assignValue(MD, NextMetadataNo); 1630c05c9db3SIvan Krasin NextMetadataNo++; 1631ef27db87SMehdi Amini break; 1632ef27db87SMehdi Amini } 163319ef4fadSMehdi Amini case bitc::METADATA_STRINGS: { 163419ef4fadSMehdi Amini auto CreateNextMDString = [&](StringRef Str) { 163519ef4fadSMehdi Amini ++NumMDStringLoaded; 1636c05c9db3SIvan Krasin MetadataList.assignValue(MDString::get(Context, Str), NextMetadataNo); 1637c05c9db3SIvan Krasin NextMetadataNo++; 163819ef4fadSMehdi Amini }; 163919ef4fadSMehdi Amini if (Error Err = parseMetadataStrings(Record, Blob, CreateNextMDString)) 1640ef27db87SMehdi Amini return Err; 1641ef27db87SMehdi Amini break; 164219ef4fadSMehdi Amini } 1643ef27db87SMehdi Amini case bitc::METADATA_GLOBAL_DECL_ATTACHMENT: { 1644ef27db87SMehdi Amini if (Record.size() % 2 == 0) 1645ef27db87SMehdi Amini return error("Invalid record"); 1646ef27db87SMehdi Amini unsigned ValueID = Record[0]; 1647ef27db87SMehdi Amini if (ValueID >= ValueList.size()) 1648ef27db87SMehdi Amini return error("Invalid record"); 1649ef27db87SMehdi Amini if (auto *GO = dyn_cast<GlobalObject>(ValueList[ValueID])) 1650ef27db87SMehdi Amini if (Error Err = parseGlobalObjectAttachment( 1651ef27db87SMehdi Amini *GO, ArrayRef<uint64_t>(Record).slice(1))) 1652ef27db87SMehdi Amini return Err; 1653ef27db87SMehdi Amini break; 1654ef27db87SMehdi Amini } 1655ef27db87SMehdi Amini case bitc::METADATA_KIND: { 1656ef27db87SMehdi Amini // Support older bitcode files that had METADATA_KIND records in a 1657ef27db87SMehdi Amini // block with METADATA_BLOCK_ID. 1658ef27db87SMehdi Amini if (Error Err = parseMetadataKindRecord(Record)) 1659ef27db87SMehdi Amini return Err; 1660ef27db87SMehdi Amini break; 1661ef27db87SMehdi Amini } 1662ef27db87SMehdi Amini } 16639f926f70SMehdi Amini return Error::success(); 166419ef4fadSMehdi Amini #undef GET_OR_DISTINCT 1665ef27db87SMehdi Amini } 1666ef27db87SMehdi Amini 1667ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataStrings( 166819ef4fadSMehdi Amini ArrayRef<uint64_t> Record, StringRef Blob, 1669061f4a5fSBenjamin Kramer function_ref<void(StringRef)> CallBack) { 1670ef27db87SMehdi Amini // All the MDStrings in the block are emitted together in a single 1671ef27db87SMehdi Amini // record. The strings are concatenated and stored in a blob along with 1672ef27db87SMehdi Amini // their sizes. 1673ef27db87SMehdi Amini if (Record.size() != 2) 1674ef27db87SMehdi Amini return error("Invalid record: metadata strings layout"); 1675ef27db87SMehdi Amini 1676ef27db87SMehdi Amini unsigned NumStrings = Record[0]; 1677ef27db87SMehdi Amini unsigned StringsOffset = Record[1]; 1678ef27db87SMehdi Amini if (!NumStrings) 1679ef27db87SMehdi Amini return error("Invalid record: metadata strings with no strings"); 1680ef27db87SMehdi Amini if (StringsOffset > Blob.size()) 1681ef27db87SMehdi Amini return error("Invalid record: metadata strings corrupt offset"); 1682ef27db87SMehdi Amini 1683ef27db87SMehdi Amini StringRef Lengths = Blob.slice(0, StringsOffset); 1684ef27db87SMehdi Amini SimpleBitstreamCursor R(Lengths); 1685ef27db87SMehdi Amini 1686ef27db87SMehdi Amini StringRef Strings = Blob.drop_front(StringsOffset); 1687ef27db87SMehdi Amini do { 1688ef27db87SMehdi Amini if (R.AtEndOfStream()) 1689ef27db87SMehdi Amini return error("Invalid record: metadata strings bad length"); 1690ef27db87SMehdi Amini 1691ef27db87SMehdi Amini unsigned Size = R.ReadVBR(6); 1692ef27db87SMehdi Amini if (Strings.size() < Size) 1693ef27db87SMehdi Amini return error("Invalid record: metadata strings truncated chars"); 1694ef27db87SMehdi Amini 169519ef4fadSMehdi Amini CallBack(Strings.slice(0, Size)); 1696ef27db87SMehdi Amini Strings = Strings.drop_front(Size); 1697ef27db87SMehdi Amini } while (--NumStrings); 1698ef27db87SMehdi Amini 1699ef27db87SMehdi Amini return Error::success(); 1700ef27db87SMehdi Amini } 1701ef27db87SMehdi Amini 1702ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseGlobalObjectAttachment( 1703ef27db87SMehdi Amini GlobalObject &GO, ArrayRef<uint64_t> Record) { 1704ef27db87SMehdi Amini assert(Record.size() % 2 == 0); 1705ef27db87SMehdi Amini for (unsigned I = 0, E = Record.size(); I != E; I += 2) { 1706ef27db87SMehdi Amini auto K = MDKindMap.find(Record[I]); 1707ef27db87SMehdi Amini if (K == MDKindMap.end()) 1708ef27db87SMehdi Amini return error("Invalid ID"); 1709ef27db87SMehdi Amini MDNode *MD = MetadataList.getMDNodeFwdRefOrNull(Record[I + 1]); 1710ef27db87SMehdi Amini if (!MD) 1711ef27db87SMehdi Amini return error("Invalid metadata attachment"); 1712ef27db87SMehdi Amini GO.addMetadata(K->second, *MD); 1713ef27db87SMehdi Amini } 1714ef27db87SMehdi Amini return Error::success(); 1715ef27db87SMehdi Amini } 1716ef27db87SMehdi Amini 1717ef27db87SMehdi Amini /// Parse metadata attachments. 1718ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataAttachment( 1719ef27db87SMehdi Amini Function &F, const SmallVectorImpl<Instruction *> &InstructionList) { 1720ef27db87SMehdi Amini if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID)) 1721ef27db87SMehdi Amini return error("Invalid record"); 1722ef27db87SMehdi Amini 1723ef27db87SMehdi Amini SmallVector<uint64_t, 64> Record; 17247b0d1457SMehdi Amini PlaceholderQueue Placeholders; 1725ef27db87SMehdi Amini 1726ef27db87SMehdi Amini while (true) { 1727ef27db87SMehdi Amini BitstreamEntry Entry = Stream.advanceSkippingSubblocks(); 1728ef27db87SMehdi Amini 1729ef27db87SMehdi Amini switch (Entry.Kind) { 1730ef27db87SMehdi Amini case BitstreamEntry::SubBlock: // Handled for us already. 1731ef27db87SMehdi Amini case BitstreamEntry::Error: 1732ef27db87SMehdi Amini return error("Malformed block"); 1733ef27db87SMehdi Amini case BitstreamEntry::EndBlock: 17347b0d1457SMehdi Amini resolveForwardRefsAndPlaceholders(Placeholders); 1735ef27db87SMehdi Amini return Error::success(); 1736ef27db87SMehdi Amini case BitstreamEntry::Record: 1737ef27db87SMehdi Amini // The interesting case. 1738ef27db87SMehdi Amini break; 1739ef27db87SMehdi Amini } 1740ef27db87SMehdi Amini 1741ef27db87SMehdi Amini // Read a metadata attachment record. 1742ef27db87SMehdi Amini Record.clear(); 174319ef4fadSMehdi Amini ++NumMDRecordLoaded; 1744ef27db87SMehdi Amini switch (Stream.readRecord(Entry.ID, Record)) { 1745ef27db87SMehdi Amini default: // Default behavior: ignore. 1746ef27db87SMehdi Amini break; 1747ef27db87SMehdi Amini case bitc::METADATA_ATTACHMENT: { 1748ef27db87SMehdi Amini unsigned RecordLength = Record.size(); 1749ef27db87SMehdi Amini if (Record.empty()) 1750ef27db87SMehdi Amini return error("Invalid record"); 1751ef27db87SMehdi Amini if (RecordLength % 2 == 0) { 1752ef27db87SMehdi Amini // A function attachment. 1753ef27db87SMehdi Amini if (Error Err = parseGlobalObjectAttachment(F, Record)) 1754ef27db87SMehdi Amini return Err; 1755ef27db87SMehdi Amini continue; 1756ef27db87SMehdi Amini } 1757ef27db87SMehdi Amini 1758ef27db87SMehdi Amini // An instruction attachment. 1759ef27db87SMehdi Amini Instruction *Inst = InstructionList[Record[0]]; 1760ef27db87SMehdi Amini for (unsigned i = 1; i != RecordLength; i = i + 2) { 1761ef27db87SMehdi Amini unsigned Kind = Record[i]; 1762ef27db87SMehdi Amini DenseMap<unsigned, unsigned>::iterator I = MDKindMap.find(Kind); 1763ef27db87SMehdi Amini if (I == MDKindMap.end()) 1764ef27db87SMehdi Amini return error("Invalid ID"); 17658662305bSMehdi Amini if (I->second == LLVMContext::MD_tbaa && StripTBAA) 17668662305bSMehdi Amini continue; 17678662305bSMehdi Amini 176819ef4fadSMehdi Amini auto Idx = Record[i + 1]; 176919ef4fadSMehdi Amini if (Idx < (MDStringRef.size() + GlobalMetadataBitPosIndex.size()) && 1770d5549f3dSMehdi Amini !MetadataList.lookup(Idx)) { 177119ef4fadSMehdi Amini // Load the attachment if it is in the lazy-loadable range and hasn't 177219ef4fadSMehdi Amini // been loaded yet. 177319ef4fadSMehdi Amini lazyLoadOneMetadata(Idx, Placeholders); 1774d5549f3dSMehdi Amini resolveForwardRefsAndPlaceholders(Placeholders); 1775d5549f3dSMehdi Amini } 177619ef4fadSMehdi Amini 177719ef4fadSMehdi Amini Metadata *Node = MetadataList.getMetadataFwdRef(Idx); 1778ef27db87SMehdi Amini if (isa<LocalAsMetadata>(Node)) 1779ef27db87SMehdi Amini // Drop the attachment. This used to be legal, but there's no 1780ef27db87SMehdi Amini // upgrade path. 1781ef27db87SMehdi Amini break; 1782ef27db87SMehdi Amini MDNode *MD = dyn_cast_or_null<MDNode>(Node); 1783ef27db87SMehdi Amini if (!MD) 1784ef27db87SMehdi Amini return error("Invalid metadata attachment"); 1785ef27db87SMehdi Amini 1786ef27db87SMehdi Amini if (HasSeenOldLoopTags && I->second == LLVMContext::MD_loop) 1787ef27db87SMehdi Amini MD = upgradeInstructionLoopAttachment(*MD); 1788ef27db87SMehdi Amini 1789ef27db87SMehdi Amini if (I->second == LLVMContext::MD_tbaa) { 1790ef27db87SMehdi Amini assert(!MD->isTemporary() && "should load MDs before attachments"); 1791ef27db87SMehdi Amini MD = UpgradeTBAANode(*MD); 1792ef27db87SMehdi Amini } 1793ef27db87SMehdi Amini Inst->setMetadata(I->second, MD); 1794ef27db87SMehdi Amini } 1795ef27db87SMehdi Amini break; 1796ef27db87SMehdi Amini } 1797ef27db87SMehdi Amini } 1798ef27db87SMehdi Amini } 1799ef27db87SMehdi Amini } 1800ef27db87SMehdi Amini 1801ef27db87SMehdi Amini /// Parse a single METADATA_KIND record, inserting result in MDKindMap. 1802ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataKindRecord( 1803ef27db87SMehdi Amini SmallVectorImpl<uint64_t> &Record) { 1804ef27db87SMehdi Amini if (Record.size() < 2) 1805ef27db87SMehdi Amini return error("Invalid record"); 1806ef27db87SMehdi Amini 1807ef27db87SMehdi Amini unsigned Kind = Record[0]; 1808ef27db87SMehdi Amini SmallString<8> Name(Record.begin() + 1, Record.end()); 1809ef27db87SMehdi Amini 1810ef27db87SMehdi Amini unsigned NewKind = TheModule.getMDKindID(Name.str()); 1811ef27db87SMehdi Amini if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second) 1812ef27db87SMehdi Amini return error("Conflicting METADATA_KIND records"); 1813ef27db87SMehdi Amini return Error::success(); 1814ef27db87SMehdi Amini } 1815ef27db87SMehdi Amini 1816ef27db87SMehdi Amini /// Parse the metadata kinds out of the METADATA_KIND_BLOCK. 1817ef27db87SMehdi Amini Error MetadataLoader::MetadataLoaderImpl::parseMetadataKinds() { 1818ef27db87SMehdi Amini if (Stream.EnterSubBlock(bitc::METADATA_KIND_BLOCK_ID)) 1819ef27db87SMehdi Amini return error("Invalid record"); 1820ef27db87SMehdi Amini 1821ef27db87SMehdi Amini SmallVector<uint64_t, 64> Record; 1822ef27db87SMehdi Amini 1823ef27db87SMehdi Amini // Read all the records. 1824ef27db87SMehdi Amini while (true) { 1825ef27db87SMehdi Amini BitstreamEntry Entry = Stream.advanceSkippingSubblocks(); 1826ef27db87SMehdi Amini 1827ef27db87SMehdi Amini switch (Entry.Kind) { 1828ef27db87SMehdi Amini case BitstreamEntry::SubBlock: // Handled for us already. 1829ef27db87SMehdi Amini case BitstreamEntry::Error: 1830ef27db87SMehdi Amini return error("Malformed block"); 1831ef27db87SMehdi Amini case BitstreamEntry::EndBlock: 1832ef27db87SMehdi Amini return Error::success(); 1833ef27db87SMehdi Amini case BitstreamEntry::Record: 1834ef27db87SMehdi Amini // The interesting case. 1835ef27db87SMehdi Amini break; 1836ef27db87SMehdi Amini } 1837ef27db87SMehdi Amini 1838ef27db87SMehdi Amini // Read a record. 1839ef27db87SMehdi Amini Record.clear(); 184019ef4fadSMehdi Amini ++NumMDRecordLoaded; 1841ef27db87SMehdi Amini unsigned Code = Stream.readRecord(Entry.ID, Record); 1842ef27db87SMehdi Amini switch (Code) { 1843ef27db87SMehdi Amini default: // Default behavior: ignore. 1844ef27db87SMehdi Amini break; 1845ef27db87SMehdi Amini case bitc::METADATA_KIND: { 1846ef27db87SMehdi Amini if (Error Err = parseMetadataKindRecord(Record)) 1847ef27db87SMehdi Amini return Err; 1848ef27db87SMehdi Amini break; 1849ef27db87SMehdi Amini } 1850ef27db87SMehdi Amini } 1851ef27db87SMehdi Amini } 1852ef27db87SMehdi Amini } 1853ef27db87SMehdi Amini 1854ef27db87SMehdi Amini MetadataLoader &MetadataLoader::operator=(MetadataLoader &&RHS) { 1855ef27db87SMehdi Amini Pimpl = std::move(RHS.Pimpl); 1856ef27db87SMehdi Amini return *this; 1857ef27db87SMehdi Amini } 1858ef27db87SMehdi Amini MetadataLoader::MetadataLoader(MetadataLoader &&RHS) 1859ec68dd49SMehdi Amini : Pimpl(std::move(RHS.Pimpl)) {} 1860ef27db87SMehdi Amini 1861ef27db87SMehdi Amini MetadataLoader::~MetadataLoader() = default; 1862ef27db87SMehdi Amini MetadataLoader::MetadataLoader(BitstreamCursor &Stream, Module &TheModule, 1863ef27db87SMehdi Amini BitcodeReaderValueList &ValueList, 1864a61f5e37STeresa Johnson bool IsImporting, 1865ef27db87SMehdi Amini std::function<Type *(unsigned)> getTypeByID) 1866061f4a5fSBenjamin Kramer : Pimpl(llvm::make_unique<MetadataLoaderImpl>( 1867061f4a5fSBenjamin Kramer Stream, TheModule, ValueList, std::move(getTypeByID), IsImporting)) {} 1868ef27db87SMehdi Amini 1869ef27db87SMehdi Amini Error MetadataLoader::parseMetadata(bool ModuleLevel) { 1870ec68dd49SMehdi Amini return Pimpl->parseMetadata(ModuleLevel); 1871ef27db87SMehdi Amini } 1872ef27db87SMehdi Amini 1873ef27db87SMehdi Amini bool MetadataLoader::hasFwdRefs() const { return Pimpl->hasFwdRefs(); } 1874ef27db87SMehdi Amini 1875ef27db87SMehdi Amini /// Return the given metadata, creating a replaceable forward reference if 1876ef27db87SMehdi Amini /// necessary. 18773bb4d01dSMehdi Amini Metadata *MetadataLoader::getMetadataFwdRefOrLoad(unsigned Idx) { 18783bb4d01dSMehdi Amini return Pimpl->getMetadataFwdRefOrLoad(Idx); 1879ef27db87SMehdi Amini } 1880ef27db87SMehdi Amini 1881ef27db87SMehdi Amini MDNode *MetadataLoader::getMDNodeFwdRefOrNull(unsigned Idx) { 1882ef27db87SMehdi Amini return Pimpl->getMDNodeFwdRefOrNull(Idx); 1883ef27db87SMehdi Amini } 1884ef27db87SMehdi Amini 1885ef27db87SMehdi Amini DISubprogram *MetadataLoader::lookupSubprogramForFunction(Function *F) { 1886ef27db87SMehdi Amini return Pimpl->lookupSubprogramForFunction(F); 1887ef27db87SMehdi Amini } 1888ef27db87SMehdi Amini 1889ef27db87SMehdi Amini Error MetadataLoader::parseMetadataAttachment( 1890ef27db87SMehdi Amini Function &F, const SmallVectorImpl<Instruction *> &InstructionList) { 1891ef27db87SMehdi Amini return Pimpl->parseMetadataAttachment(F, InstructionList); 1892ef27db87SMehdi Amini } 1893ef27db87SMehdi Amini 1894ef27db87SMehdi Amini Error MetadataLoader::parseMetadataKinds() { 1895ef27db87SMehdi Amini return Pimpl->parseMetadataKinds(); 1896ef27db87SMehdi Amini } 1897ef27db87SMehdi Amini 18988662305bSMehdi Amini void MetadataLoader::setStripTBAA(bool StripTBAA) { 18998662305bSMehdi Amini return Pimpl->setStripTBAA(StripTBAA); 19008662305bSMehdi Amini } 19018662305bSMehdi Amini 19028662305bSMehdi Amini bool MetadataLoader::isStrippingTBAA() { return Pimpl->isStrippingTBAA(); } 19038662305bSMehdi Amini 1904ef27db87SMehdi Amini unsigned MetadataLoader::size() const { return Pimpl->size(); } 1905ef27db87SMehdi Amini void MetadataLoader::shrinkTo(unsigned N) { return Pimpl->shrinkTo(N); } 19066825fb64SAdrian Prantl 19076825fb64SAdrian Prantl void MetadataLoader::upgradeDebugIntrinsics(Function &F) { 19086825fb64SAdrian Prantl return Pimpl->upgradeDebugIntrinsics(F); 19096825fb64SAdrian Prantl } 1910