159a5afa9SMikhail Glushenkov //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===// 2361e513dSReid Spencer // 3361e513dSReid Spencer // The LLVM Compiler Infrastructure 4361e513dSReid Spencer // 5f3ebc3f3SChris Lattner // This file is distributed under the University of Illinois Open Source 6f3ebc3f3SChris Lattner // License. See LICENSE.TXT for details. 7361e513dSReid Spencer // 8361e513dSReid Spencer //===----------------------------------------------------------------------===// 9361e513dSReid Spencer // 10361e513dSReid Spencer // This file implements the LLVM module linker. 11361e513dSReid Spencer // 12361e513dSReid Spencer //===----------------------------------------------------------------------===// 13361e513dSReid Spencer 149b0ddbbeSReid Spencer #include "llvm/Linker.h" 15361e513dSReid Spencer #include "llvm/Constants.h" 16361e513dSReid Spencer #include "llvm/DerivedTypes.h" 17cbb91408STanya Lattner #include "llvm/Instructions.h" 18361e513dSReid Spencer #include "llvm/Module.h" 1966f02413SBill Wendling #include "llvm/ADT/DenseSet.h" 2023f8d64bSRafael Espindola #include "llvm/ADT/Optional.h" 2166f02413SBill Wendling #include "llvm/ADT/SetVector.h" 2266f02413SBill Wendling #include "llvm/ADT/SmallPtrSet.h" 23b6af2f36SBill Wendling #include "llvm/Support/Debug.h" 24447762daSMichael J. Spencer #include "llvm/Support/Path.h" 25b6af2f36SBill Wendling #include "llvm/Support/raw_ostream.h" 26cbb91408STanya Lattner #include "llvm/Transforms/Utils/Cloning.h" 27a2095034SDan Gohman #include "llvm/Transforms/Utils/ValueMapper.h" 28df39b707SDuncan Sands #include <cctype> 29361e513dSReid Spencer using namespace llvm; 30361e513dSReid Spencer 31b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 32b1ed91f3SChris Lattner // TypeMap implementation. 33b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 34b1ed91f3SChris Lattner 35b1ed91f3SChris Lattner namespace { 36b1ed91f3SChris Lattner class TypeMapTy : public ValueMapTypeRemapper { 37b1ed91f3SChris Lattner /// MappedTypes - This is a mapping from a source type to a destination type 38b1ed91f3SChris Lattner /// to use. 39b1ed91f3SChris Lattner DenseMap<Type*, Type*> MappedTypes; 40b1ed91f3SChris Lattner 41b1ed91f3SChris Lattner /// SpeculativeTypes - When checking to see if two subgraphs are isomorphic, 42b1ed91f3SChris Lattner /// we speculatively add types to MappedTypes, but keep track of them here in 43b1ed91f3SChris Lattner /// case we need to roll back. 44b1ed91f3SChris Lattner SmallVector<Type*, 16> SpeculativeTypes; 45b1ed91f3SChris Lattner 465e3bd972SChris Lattner /// SrcDefinitionsToResolve - This is a list of non-opaque structs in the 475e3bd972SChris Lattner /// source module that are mapped to an opaque struct in the destination 485e3bd972SChris Lattner /// module. 495e3bd972SChris Lattner SmallVector<StructType*, 16> SrcDefinitionsToResolve; 505e3bd972SChris Lattner 515e3bd972SChris Lattner /// DstResolvedOpaqueTypes - This is the set of opaque types in the 525e3bd972SChris Lattner /// destination modules who are getting a body from the source module. 535e3bd972SChris Lattner SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes; 54d48b7783SBill Wendling 55*8c2cc416SBill Wendling public: 56b1ed91f3SChris Lattner /// addTypeMapping - Indicate that the specified type in the destination 57b1ed91f3SChris Lattner /// module is conceptually equivalent to the specified type in the source 58b1ed91f3SChris Lattner /// module. 59b1ed91f3SChris Lattner void addTypeMapping(Type *DstTy, Type *SrcTy); 60b1ed91f3SChris Lattner 61b1ed91f3SChris Lattner /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest 62b1ed91f3SChris Lattner /// module from a type definition in the source module. 63b1ed91f3SChris Lattner void linkDefinedTypeBodies(); 64b1ed91f3SChris Lattner 65b1ed91f3SChris Lattner /// get - Return the mapped type to use for the specified input type from the 66b1ed91f3SChris Lattner /// source module. 67b1ed91f3SChris Lattner Type *get(Type *SrcTy); 68b1ed91f3SChris Lattner 69b1ed91f3SChris Lattner FunctionType *get(FunctionType *T) {return cast<FunctionType>(get((Type*)T));} 70b1ed91f3SChris Lattner 71b6af2f36SBill Wendling /// dump - Dump out the type map for debugging purposes. 72b6af2f36SBill Wendling void dump() const { 73b6af2f36SBill Wendling for (DenseMap<Type*, Type*>::const_iterator 74b6af2f36SBill Wendling I = MappedTypes.begin(), E = MappedTypes.end(); I != E; ++I) { 75b6af2f36SBill Wendling dbgs() << "TypeMap: "; 76b6af2f36SBill Wendling I->first->dump(); 77b6af2f36SBill Wendling dbgs() << " => "; 78b6af2f36SBill Wendling I->second->dump(); 79b6af2f36SBill Wendling dbgs() << '\n'; 80b6af2f36SBill Wendling } 81b6af2f36SBill Wendling } 82b6af2f36SBill Wendling 83b1ed91f3SChris Lattner private: 84b1ed91f3SChris Lattner Type *getImpl(Type *T); 85b1ed91f3SChris Lattner /// remapType - Implement the ValueMapTypeRemapper interface. 86b1ed91f3SChris Lattner Type *remapType(Type *SrcTy) { 87b1ed91f3SChris Lattner return get(SrcTy); 88b1ed91f3SChris Lattner } 89b1ed91f3SChris Lattner 90b1ed91f3SChris Lattner bool areTypesIsomorphic(Type *DstTy, Type *SrcTy); 91b1ed91f3SChris Lattner }; 92b1ed91f3SChris Lattner } 93b1ed91f3SChris Lattner 94b1ed91f3SChris Lattner void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) { 95b1ed91f3SChris Lattner Type *&Entry = MappedTypes[SrcTy]; 96b1ed91f3SChris Lattner if (Entry) return; 97b1ed91f3SChris Lattner 98b1ed91f3SChris Lattner if (DstTy == SrcTy) { 99b1ed91f3SChris Lattner Entry = DstTy; 100b1ed91f3SChris Lattner return; 101b1ed91f3SChris Lattner } 102b1ed91f3SChris Lattner 103b1ed91f3SChris Lattner // Check to see if these types are recursively isomorphic and establish a 104b1ed91f3SChris Lattner // mapping between them if so. 105d48b7783SBill Wendling if (!areTypesIsomorphic(DstTy, SrcTy)) { 106b1ed91f3SChris Lattner // Oops, they aren't isomorphic. Just discard this request by rolling out 107b1ed91f3SChris Lattner // any speculative mappings we've established. 108b1ed91f3SChris Lattner for (unsigned i = 0, e = SpeculativeTypes.size(); i != e; ++i) 109b1ed91f3SChris Lattner MappedTypes.erase(SpeculativeTypes[i]); 110d48b7783SBill Wendling } 111b1ed91f3SChris Lattner SpeculativeTypes.clear(); 112b1ed91f3SChris Lattner } 113b1ed91f3SChris Lattner 114b1ed91f3SChris Lattner /// areTypesIsomorphic - Recursively walk this pair of types, returning true 115b1ed91f3SChris Lattner /// if they are isomorphic, false if they are not. 116b1ed91f3SChris Lattner bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) { 117b1ed91f3SChris Lattner // Two types with differing kinds are clearly not isomorphic. 118b1ed91f3SChris Lattner if (DstTy->getTypeID() != SrcTy->getTypeID()) return false; 119b1ed91f3SChris Lattner 120b1ed91f3SChris Lattner // If we have an entry in the MappedTypes table, then we have our answer. 121b1ed91f3SChris Lattner Type *&Entry = MappedTypes[SrcTy]; 122b1ed91f3SChris Lattner if (Entry) 123b1ed91f3SChris Lattner return Entry == DstTy; 124b1ed91f3SChris Lattner 125b1ed91f3SChris Lattner // Two identical types are clearly isomorphic. Remember this 126b1ed91f3SChris Lattner // non-speculatively. 127b1ed91f3SChris Lattner if (DstTy == SrcTy) { 128b1ed91f3SChris Lattner Entry = DstTy; 129361e513dSReid Spencer return true; 130361e513dSReid Spencer } 131361e513dSReid Spencer 132b1ed91f3SChris Lattner // Okay, we have two types with identical kinds that we haven't seen before. 133361e513dSReid Spencer 134b1ed91f3SChris Lattner // If this is an opaque struct type, special case it. 135b1ed91f3SChris Lattner if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) { 136b1ed91f3SChris Lattner // Mapping an opaque type to any struct, just keep the dest struct. 137b1ed91f3SChris Lattner if (SSTy->isOpaque()) { 138b1ed91f3SChris Lattner Entry = DstTy; 139b1ed91f3SChris Lattner SpeculativeTypes.push_back(SrcTy); 140b1ed91f3SChris Lattner return true; 141361e513dSReid Spencer } 142b1ed91f3SChris Lattner 1435e3bd972SChris Lattner // Mapping a non-opaque source type to an opaque dest. If this is the first 1445e3bd972SChris Lattner // type that we're mapping onto this destination type then we succeed. Keep 1455e3bd972SChris Lattner // the dest, but fill it in later. This doesn't need to be speculative. If 1465e3bd972SChris Lattner // this is the second (different) type that we're trying to map onto the 1475e3bd972SChris Lattner // same opaque type then we fail. 148b1ed91f3SChris Lattner if (cast<StructType>(DstTy)->isOpaque()) { 1495e3bd972SChris Lattner // We can only map one source type onto the opaque destination type. 1505e3bd972SChris Lattner if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy))) 1515e3bd972SChris Lattner return false; 1525e3bd972SChris Lattner SrcDefinitionsToResolve.push_back(SSTy); 153b1ed91f3SChris Lattner Entry = DstTy; 154b1ed91f3SChris Lattner return true; 155b1ed91f3SChris Lattner } 156b1ed91f3SChris Lattner } 157b1ed91f3SChris Lattner 158b1ed91f3SChris Lattner // If the number of subtypes disagree between the two types, then we fail. 159b1ed91f3SChris Lattner if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes()) 160b1ed91f3SChris Lattner return false; 161b1ed91f3SChris Lattner 162b1ed91f3SChris Lattner // Fail if any of the extra properties (e.g. array size) of the type disagree. 163b1ed91f3SChris Lattner if (isa<IntegerType>(DstTy)) 164b1ed91f3SChris Lattner return false; // bitwidth disagrees. 165b1ed91f3SChris Lattner if (PointerType *PT = dyn_cast<PointerType>(DstTy)) { 166b1ed91f3SChris Lattner if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace()) 167b1ed91f3SChris Lattner return false; 168eaf9b762SChris Lattner 169b1ed91f3SChris Lattner } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) { 170b1ed91f3SChris Lattner if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg()) 171b1ed91f3SChris Lattner return false; 172b1ed91f3SChris Lattner } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) { 173b1ed91f3SChris Lattner StructType *SSTy = cast<StructType>(SrcTy); 17444f7ab45SChris Lattner if (DSTy->isLiteral() != SSTy->isLiteral() || 175b1ed91f3SChris Lattner DSTy->isPacked() != SSTy->isPacked()) 176b1ed91f3SChris Lattner return false; 177b1ed91f3SChris Lattner } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) { 178b1ed91f3SChris Lattner if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements()) 179b1ed91f3SChris Lattner return false; 180b1ed91f3SChris Lattner } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) { 181b1ed91f3SChris Lattner if (DVTy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements()) 182361e513dSReid Spencer return false; 183361e513dSReid Spencer } 184361e513dSReid Spencer 185b1ed91f3SChris Lattner // Otherwise, we speculate that these two types will line up and recursively 186b1ed91f3SChris Lattner // check the subelements. 187b1ed91f3SChris Lattner Entry = DstTy; 188b1ed91f3SChris Lattner SpeculativeTypes.push_back(SrcTy); 189eee6f995SChris Lattner 190d48b7783SBill Wendling for (unsigned i = 0, e = SrcTy->getNumContainedTypes(); i != e; ++i) 191d48b7783SBill Wendling if (!areTypesIsomorphic(DstTy->getContainedType(i), 192d48b7783SBill Wendling SrcTy->getContainedType(i))) 193b1ed91f3SChris Lattner return false; 194eee6f995SChris Lattner 195b1ed91f3SChris Lattner // If everything seems to have lined up, then everything is great. 196eee6f995SChris Lattner return true; 197eee6f995SChris Lattner } 198eee6f995SChris Lattner 199b1ed91f3SChris Lattner /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest 200b1ed91f3SChris Lattner /// module from a type definition in the source module. 201b1ed91f3SChris Lattner void TypeMapTy::linkDefinedTypeBodies() { 202b1ed91f3SChris Lattner SmallVector<Type*, 16> Elements; 203b1ed91f3SChris Lattner SmallString<16> TmpName; 204eee6f995SChris Lattner 205b1ed91f3SChris Lattner // Note that processing entries in this loop (calling 'get') can add new 2065e3bd972SChris Lattner // entries to the SrcDefinitionsToResolve vector. 2075e3bd972SChris Lattner while (!SrcDefinitionsToResolve.empty()) { 2085e3bd972SChris Lattner StructType *SrcSTy = SrcDefinitionsToResolve.pop_back_val(); 209b1ed91f3SChris Lattner StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]); 210eee6f995SChris Lattner 211b1ed91f3SChris Lattner // TypeMap is a many-to-one mapping, if there were multiple types that 212b1ed91f3SChris Lattner // provide a body for DstSTy then previous iterations of this loop may have 213b1ed91f3SChris Lattner // already handled it. Just ignore this case. 214b1ed91f3SChris Lattner if (!DstSTy->isOpaque()) continue; 215b1ed91f3SChris Lattner assert(!SrcSTy->isOpaque() && "Not resolving a definition?"); 216b1ed91f3SChris Lattner 217b1ed91f3SChris Lattner // Map the body of the source type over to a new body for the dest type. 218b1ed91f3SChris Lattner Elements.resize(SrcSTy->getNumElements()); 219b1ed91f3SChris Lattner for (unsigned i = 0, e = Elements.size(); i != e; ++i) 220b1ed91f3SChris Lattner Elements[i] = getImpl(SrcSTy->getElementType(i)); 221b1ed91f3SChris Lattner 222b1ed91f3SChris Lattner DstSTy->setBody(Elements, SrcSTy->isPacked()); 223b1ed91f3SChris Lattner 224b1ed91f3SChris Lattner // If DstSTy has no name or has a longer name than STy, then viciously steal 225b1ed91f3SChris Lattner // STy's name. 226b1ed91f3SChris Lattner if (!SrcSTy->hasName()) continue; 227b1ed91f3SChris Lattner StringRef SrcName = SrcSTy->getName(); 228b1ed91f3SChris Lattner 229b1ed91f3SChris Lattner if (!DstSTy->hasName() || DstSTy->getName().size() > SrcName.size()) { 230b1ed91f3SChris Lattner TmpName.insert(TmpName.end(), SrcName.begin(), SrcName.end()); 231b1ed91f3SChris Lattner SrcSTy->setName(""); 232b1ed91f3SChris Lattner DstSTy->setName(TmpName.str()); 233b1ed91f3SChris Lattner TmpName.clear(); 234b1ed91f3SChris Lattner } 235b1ed91f3SChris Lattner } 2365e3bd972SChris Lattner 2375e3bd972SChris Lattner DstResolvedOpaqueTypes.clear(); 238eee6f995SChris Lattner } 239eee6f995SChris Lattner 240d48b7783SBill Wendling 241b1ed91f3SChris Lattner /// get - Return the mapped type to use for the specified input type from the 242b1ed91f3SChris Lattner /// source module. 243b1ed91f3SChris Lattner Type *TypeMapTy::get(Type *Ty) { 244b1ed91f3SChris Lattner Type *Result = getImpl(Ty); 245b1ed91f3SChris Lattner 246b1ed91f3SChris Lattner // If this caused a reference to any struct type, resolve it before returning. 2475e3bd972SChris Lattner if (!SrcDefinitionsToResolve.empty()) 248b1ed91f3SChris Lattner linkDefinedTypeBodies(); 249b1ed91f3SChris Lattner return Result; 250eee6f995SChris Lattner } 251eee6f995SChris Lattner 252b1ed91f3SChris Lattner /// getImpl - This is the recursive version of get(). 253b1ed91f3SChris Lattner Type *TypeMapTy::getImpl(Type *Ty) { 254b1ed91f3SChris Lattner // If we already have an entry for this type, return it. 255b1ed91f3SChris Lattner Type **Entry = &MappedTypes[Ty]; 256b1ed91f3SChris Lattner if (*Entry) return *Entry; 257b1ed91f3SChris Lattner 258b1ed91f3SChris Lattner // If this is not a named struct type, then just map all of the elements and 259b1ed91f3SChris Lattner // then rebuild the type from inside out. 26044f7ab45SChris Lattner if (!isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral()) { 261b1ed91f3SChris Lattner // If there are no element types to map, then the type is itself. This is 262b1ed91f3SChris Lattner // true for the anonymous {} struct, things like 'float', integers, etc. 263b1ed91f3SChris Lattner if (Ty->getNumContainedTypes() == 0) 264b1ed91f3SChris Lattner return *Entry = Ty; 265b1ed91f3SChris Lattner 266b1ed91f3SChris Lattner // Remap all of the elements, keeping track of whether any of them change. 267b1ed91f3SChris Lattner bool AnyChange = false; 268b1ed91f3SChris Lattner SmallVector<Type*, 4> ElementTypes; 269b1ed91f3SChris Lattner ElementTypes.resize(Ty->getNumContainedTypes()); 270b1ed91f3SChris Lattner for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i) { 271b1ed91f3SChris Lattner ElementTypes[i] = getImpl(Ty->getContainedType(i)); 272b1ed91f3SChris Lattner AnyChange |= ElementTypes[i] != Ty->getContainedType(i); 273eee6f995SChris Lattner } 274b1ed91f3SChris Lattner 275b1ed91f3SChris Lattner // If we found our type while recursively processing stuff, just use it. 276b1ed91f3SChris Lattner Entry = &MappedTypes[Ty]; 277b1ed91f3SChris Lattner if (*Entry) return *Entry; 278b1ed91f3SChris Lattner 279b1ed91f3SChris Lattner // If all of the element types mapped directly over, then the type is usable 280b1ed91f3SChris Lattner // as-is. 281b1ed91f3SChris Lattner if (!AnyChange) 282b1ed91f3SChris Lattner return *Entry = Ty; 283b1ed91f3SChris Lattner 284b1ed91f3SChris Lattner // Otherwise, rebuild a modified type. 285b1ed91f3SChris Lattner switch (Ty->getTypeID()) { 286a2886c21SCraig Topper default: llvm_unreachable("unknown derived type to remap"); 287b1ed91f3SChris Lattner case Type::ArrayTyID: 288b1ed91f3SChris Lattner return *Entry = ArrayType::get(ElementTypes[0], 289b1ed91f3SChris Lattner cast<ArrayType>(Ty)->getNumElements()); 290b1ed91f3SChris Lattner case Type::VectorTyID: 291b1ed91f3SChris Lattner return *Entry = VectorType::get(ElementTypes[0], 292b1ed91f3SChris Lattner cast<VectorType>(Ty)->getNumElements()); 293b1ed91f3SChris Lattner case Type::PointerTyID: 294b1ed91f3SChris Lattner return *Entry = PointerType::get(ElementTypes[0], 295b1ed91f3SChris Lattner cast<PointerType>(Ty)->getAddressSpace()); 296b1ed91f3SChris Lattner case Type::FunctionTyID: 297b1ed91f3SChris Lattner return *Entry = FunctionType::get(ElementTypes[0], 298717d7eddSFrits van Bommel makeArrayRef(ElementTypes).slice(1), 299b1ed91f3SChris Lattner cast<FunctionType>(Ty)->isVarArg()); 300b1ed91f3SChris Lattner case Type::StructTyID: 301b1ed91f3SChris Lattner // Note that this is only reached for anonymous structs. 302b1ed91f3SChris Lattner return *Entry = StructType::get(Ty->getContext(), ElementTypes, 303b1ed91f3SChris Lattner cast<StructType>(Ty)->isPacked()); 304b1ed91f3SChris Lattner } 305b1ed91f3SChris Lattner } 306b1ed91f3SChris Lattner 307b1ed91f3SChris Lattner // Otherwise, this is an unmapped named struct. If the struct can be directly 308b1ed91f3SChris Lattner // mapped over, just use it as-is. This happens in a case when the linked-in 309b1ed91f3SChris Lattner // module has something like: 310b1ed91f3SChris Lattner // %T = type {%T*, i32} 311b1ed91f3SChris Lattner // @GV = global %T* null 312b1ed91f3SChris Lattner // where T does not exist at all in the destination module. 313b1ed91f3SChris Lattner // 314b1ed91f3SChris Lattner // The other case we watch for is when the type is not in the destination 315b1ed91f3SChris Lattner // module, but that it has to be rebuilt because it refers to something that 316b1ed91f3SChris Lattner // is already mapped. For example, if the destination module has: 317b1ed91f3SChris Lattner // %A = type { i32 } 318b1ed91f3SChris Lattner // and the source module has something like 319b1ed91f3SChris Lattner // %A' = type { i32 } 320b1ed91f3SChris Lattner // %B = type { %A'* } 321b1ed91f3SChris Lattner // @GV = global %B* null 322b1ed91f3SChris Lattner // then we want to create a new type: "%B = type { %A*}" and have it take the 323b1ed91f3SChris Lattner // pristine "%B" name from the source module. 324b1ed91f3SChris Lattner // 325b1ed91f3SChris Lattner // To determine which case this is, we have to recursively walk the type graph 326b1ed91f3SChris Lattner // speculating that we'll be able to reuse it unmodified. Only if this is 327b1ed91f3SChris Lattner // safe would we map the entire thing over. Because this is an optimization, 328b1ed91f3SChris Lattner // and is not required for the prettiness of the linked module, we just skip 329b1ed91f3SChris Lattner // it and always rebuild a type here. 330b1ed91f3SChris Lattner StructType *STy = cast<StructType>(Ty); 331b1ed91f3SChris Lattner 332b1ed91f3SChris Lattner // If the type is opaque, we can just use it directly. 333b1ed91f3SChris Lattner if (STy->isOpaque()) 334b1ed91f3SChris Lattner return *Entry = STy; 335b1ed91f3SChris Lattner 336b1ed91f3SChris Lattner // Otherwise we create a new type and resolve its body later. This will be 337b1ed91f3SChris Lattner // resolved by the top level of get(). 3385e3bd972SChris Lattner SrcDefinitionsToResolve.push_back(STy); 3395e3bd972SChris Lattner StructType *DTy = StructType::create(STy->getContext()); 3405e3bd972SChris Lattner DstResolvedOpaqueTypes.insert(DTy); 3415e3bd972SChris Lattner return *Entry = DTy; 342b1ed91f3SChris Lattner } 343b1ed91f3SChris Lattner 344d48b7783SBill Wendling 345d48b7783SBill Wendling 346b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 347b1ed91f3SChris Lattner // ModuleLinker implementation. 348b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 349b1ed91f3SChris Lattner 350b1ed91f3SChris Lattner namespace { 351b1ed91f3SChris Lattner /// ModuleLinker - This is an implementation class for the LinkModules 352b1ed91f3SChris Lattner /// function, which is the entrypoint for this file. 353b1ed91f3SChris Lattner class ModuleLinker { 354b1ed91f3SChris Lattner Module *DstM, *SrcM; 355b1ed91f3SChris Lattner 356b1ed91f3SChris Lattner TypeMapTy TypeMap; 357b1ed91f3SChris Lattner 358b1ed91f3SChris Lattner /// ValueMap - Mapping of values from what they used to be in Src, to what 359b1ed91f3SChris Lattner /// they are now in DstM. ValueToValueMapTy is a ValueMap, which involves 360b1ed91f3SChris Lattner /// some overhead due to the use of Value handles which the Linker doesn't 361b1ed91f3SChris Lattner /// actually need, but this allows us to reuse the ValueMapper code. 362b1ed91f3SChris Lattner ValueToValueMapTy ValueMap; 363b1ed91f3SChris Lattner 364b1ed91f3SChris Lattner struct AppendingVarInfo { 365b1ed91f3SChris Lattner GlobalVariable *NewGV; // New aggregate global in dest module. 366b1ed91f3SChris Lattner Constant *DstInit; // Old initializer from dest module. 367b1ed91f3SChris Lattner Constant *SrcInit; // Old initializer from src module. 368b1ed91f3SChris Lattner }; 369b1ed91f3SChris Lattner 370b1ed91f3SChris Lattner std::vector<AppendingVarInfo> AppendingVars; 371b1ed91f3SChris Lattner 372cbb91408STanya Lattner unsigned Mode; // Mode to treat source module. 373cbb91408STanya Lattner 374cbb91408STanya Lattner // Set of items not to link in from source. 375cbb91408STanya Lattner SmallPtrSet<const Value*, 16> DoNotLinkFromSource; 376cbb91408STanya Lattner 3770a48b877STanya Lattner // Vector of functions to lazily link in. 3780a48b877STanya Lattner std::vector<Function*> LazilyLinkFunctions; 3790a48b877STanya Lattner 380b1ed91f3SChris Lattner public: 381b1ed91f3SChris Lattner std::string ErrorMsg; 382b1ed91f3SChris Lattner 383cbb91408STanya Lattner ModuleLinker(Module *dstM, Module *srcM, unsigned mode) 384cbb91408STanya Lattner : DstM(dstM), SrcM(srcM), Mode(mode) { } 385b1ed91f3SChris Lattner 386b1ed91f3SChris Lattner bool run(); 387b1ed91f3SChris Lattner 388b1ed91f3SChris Lattner private: 389b1ed91f3SChris Lattner /// emitError - Helper method for setting a message and returning an error 390b1ed91f3SChris Lattner /// code. 391b1ed91f3SChris Lattner bool emitError(const Twine &Message) { 392b1ed91f3SChris Lattner ErrorMsg = Message.str(); 393b1ed91f3SChris Lattner return true; 394b1ed91f3SChris Lattner } 395b1ed91f3SChris Lattner 396b1ed91f3SChris Lattner /// getLinkageResult - This analyzes the two global values and determines 397b1ed91f3SChris Lattner /// what the result will look like in the destination module. 398b1ed91f3SChris Lattner bool getLinkageResult(GlobalValue *Dest, const GlobalValue *Src, 39923f8d64bSRafael Espindola GlobalValue::LinkageTypes <, 40023f8d64bSRafael Espindola GlobalValue::VisibilityTypes &Vis, 40123f8d64bSRafael Espindola bool &LinkFromSrc); 402b1ed91f3SChris Lattner 403b1ed91f3SChris Lattner /// getLinkedToGlobal - Given a global in the source module, return the 404b1ed91f3SChris Lattner /// global in the destination module that is being linked to, if any. 405b1ed91f3SChris Lattner GlobalValue *getLinkedToGlobal(GlobalValue *SrcGV) { 406b1ed91f3SChris Lattner // If the source has no name it can't link. If it has local linkage, 407b1ed91f3SChris Lattner // there is no name match-up going on. 408b1ed91f3SChris Lattner if (!SrcGV->hasName() || SrcGV->hasLocalLinkage()) 409b1ed91f3SChris Lattner return 0; 410b1ed91f3SChris Lattner 411b1ed91f3SChris Lattner // Otherwise see if we have a match in the destination module's symtab. 412b1ed91f3SChris Lattner GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName()); 413b1ed91f3SChris Lattner if (DGV == 0) return 0; 414b1ed91f3SChris Lattner 415b1ed91f3SChris Lattner // If we found a global with the same name in the dest module, but it has 416b1ed91f3SChris Lattner // internal linkage, we are really not doing any linkage here. 417b1ed91f3SChris Lattner if (DGV->hasLocalLinkage()) 418b1ed91f3SChris Lattner return 0; 419b1ed91f3SChris Lattner 420b1ed91f3SChris Lattner // Otherwise, we do in fact link to the destination global. 421b1ed91f3SChris Lattner return DGV; 422b1ed91f3SChris Lattner } 423b1ed91f3SChris Lattner 424b1ed91f3SChris Lattner void computeTypeMapping(); 42566f02413SBill Wendling bool categorizeModuleFlagNodes(const NamedMDNode *ModFlags, 42666f02413SBill Wendling DenseMap<MDString*, MDNode*> &ErrorNode, 42766f02413SBill Wendling DenseMap<MDString*, MDNode*> &WarningNode, 42866f02413SBill Wendling DenseMap<MDString*, MDNode*> &OverrideNode, 42966f02413SBill Wendling DenseMap<MDString*, 43066f02413SBill Wendling SmallSetVector<MDNode*, 8> > &RequireNodes, 43166f02413SBill Wendling SmallSetVector<MDString*, 16> &SeenIDs); 432b1ed91f3SChris Lattner 433b1ed91f3SChris Lattner bool linkAppendingVarProto(GlobalVariable *DstGV, GlobalVariable *SrcGV); 434b1ed91f3SChris Lattner bool linkGlobalProto(GlobalVariable *SrcGV); 435b1ed91f3SChris Lattner bool linkFunctionProto(Function *SrcF); 436b1ed91f3SChris Lattner bool linkAliasProto(GlobalAlias *SrcA); 43766f02413SBill Wendling bool linkModuleFlagsMetadata(); 438b1ed91f3SChris Lattner 439b1ed91f3SChris Lattner void linkAppendingVarInit(const AppendingVarInfo &AVI); 440b1ed91f3SChris Lattner void linkGlobalInits(); 441b1ed91f3SChris Lattner void linkFunctionBody(Function *Dst, Function *Src); 442b1ed91f3SChris Lattner void linkAliasBodies(); 443b1ed91f3SChris Lattner void linkNamedMDNodes(); 444eee6f995SChris Lattner }; 445d48b7783SBill Wendling } 446d48b7783SBill Wendling 447b1ed91f3SChris Lattner /// forceRenaming - The LLVM SymbolTable class autorenames globals that conflict 44890246aa7SReid Spencer /// in the symbol table. This is good for all clients except for us. Go 44990246aa7SReid Spencer /// through the trouble to force this back. 450b1ed91f3SChris Lattner static void forceRenaming(GlobalValue *GV, StringRef Name) { 451b1ed91f3SChris Lattner // If the global doesn't force its name or if it already has the right name, 452b1ed91f3SChris Lattner // there is nothing for us to do. 453b1ed91f3SChris Lattner if (GV->hasLocalLinkage() || GV->getName() == Name) 454b1ed91f3SChris Lattner return; 455b1ed91f3SChris Lattner 456b1ed91f3SChris Lattner Module *M = GV->getParent(); 457361e513dSReid Spencer 458361e513dSReid Spencer // If there is a conflict, rename the conflict. 459b1ed91f3SChris Lattner if (GlobalValue *ConflictGV = M->getNamedValue(Name)) { 4602a8d2e0eSChris Lattner GV->takeName(ConflictGV); 461361e513dSReid Spencer ConflictGV->setName(Name); // This will cause ConflictGV to get renamed 462b1ed91f3SChris Lattner assert(ConflictGV->getName() != Name && "forceRenaming didn't work"); 4632a8d2e0eSChris Lattner } else { 4642a8d2e0eSChris Lattner GV->setName(Name); // Force the name back 4653aaaa0b2SReid Spencer } 4663aaaa0b2SReid Spencer } 4673aaaa0b2SReid Spencer 468b6af2f36SBill Wendling /// copyGVAttributes - copy additional attributes (those not needed to construct 4693aaaa0b2SReid Spencer /// a GlobalValue) from the SrcGV to the DestGV. 470b6af2f36SBill Wendling static void copyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) { 471dd7daee8SDuncan Sands // Use the maximum alignment, rather than just copying the alignment of SrcGV. 472dd7daee8SDuncan Sands unsigned Alignment = std::max(DestGV->getAlignment(), SrcGV->getAlignment()); 473dd7daee8SDuncan Sands DestGV->copyAttributesFrom(SrcGV); 474dd7daee8SDuncan Sands DestGV->setAlignment(Alignment); 475b1ed91f3SChris Lattner 476b1ed91f3SChris Lattner forceRenaming(DestGV, SrcGV->getName()); 477361e513dSReid Spencer } 478361e513dSReid Spencer 47923f8d64bSRafael Espindola static bool isLessConstraining(GlobalValue::VisibilityTypes a, 48023f8d64bSRafael Espindola GlobalValue::VisibilityTypes b) { 48123f8d64bSRafael Espindola if (a == GlobalValue::HiddenVisibility) 48223f8d64bSRafael Espindola return false; 48323f8d64bSRafael Espindola if (b == GlobalValue::HiddenVisibility) 48423f8d64bSRafael Espindola return true; 48523f8d64bSRafael Espindola if (a == GlobalValue::ProtectedVisibility) 48623f8d64bSRafael Espindola return false; 48723f8d64bSRafael Espindola if (b == GlobalValue::ProtectedVisibility) 48823f8d64bSRafael Espindola return true; 48923f8d64bSRafael Espindola return false; 49023f8d64bSRafael Espindola } 49123f8d64bSRafael Espindola 492b1ed91f3SChris Lattner /// getLinkageResult - This analyzes the two global values and determines what 493fc61de39SChris Lattner /// the result will look like in the destination module. In particular, it 49423f8d64bSRafael Espindola /// computes the resultant linkage type and visibility, computes whether the 49523f8d64bSRafael Espindola /// global in the source should be copied over to the destination (replacing 49623f8d64bSRafael Espindola /// the existing one), and computes whether this linkage is an error or not. 497b1ed91f3SChris Lattner bool ModuleLinker::getLinkageResult(GlobalValue *Dest, const GlobalValue *Src, 498b1ed91f3SChris Lattner GlobalValue::LinkageTypes <, 49923f8d64bSRafael Espindola GlobalValue::VisibilityTypes &Vis, 500b1ed91f3SChris Lattner bool &LinkFromSrc) { 501b1ed91f3SChris Lattner assert(Dest && "Must have two globals being queried"); 502b1ed91f3SChris Lattner assert(!Src->hasLocalLinkage() && 503fc61de39SChris Lattner "If Src has internal linkage, Dest shouldn't be set!"); 504b1ed91f3SChris Lattner 5058bb15d82SPeter Collingbourne bool SrcIsDeclaration = Src->isDeclaration() && !Src->isMaterializable(); 5060c134b52SChris Lattner bool DestIsDeclaration = Dest->isDeclaration(); 507b1ed91f3SChris Lattner 508b1ed91f3SChris Lattner if (SrcIsDeclaration) { 5091f93c50aSAnton Korobeynikov // If Src is external or if both Src & Dest are external.. Just link the 510fc61de39SChris Lattner // external globals, we aren't adding anything. 511d61d39ecSAnton Korobeynikov if (Src->hasDLLImportLinkage()) { 51212c94949SAnton Korobeynikov // If one of GVs has DLLImport linkage, result should be dllimport'ed. 513b1ed91f3SChris Lattner if (DestIsDeclaration) { 514d61d39ecSAnton Korobeynikov LinkFromSrc = true; 515d61d39ecSAnton Korobeynikov LT = Src->getLinkage(); 516d61d39ecSAnton Korobeynikov } 517e06036d2SAndrew Lenharth } else if (Dest->hasExternalWeakLinkage()) { 51812da8ce3SDuncan Sands // If the Dest is weak, use the source linkage. 519e06036d2SAndrew Lenharth LinkFromSrc = true; 520e06036d2SAndrew Lenharth LT = Src->getLinkage(); 521d61d39ecSAnton Korobeynikov } else { 522fc61de39SChris Lattner LinkFromSrc = false; 523fc61de39SChris Lattner LT = Dest->getLinkage(); 524d61d39ecSAnton Korobeynikov } 525b1ed91f3SChris Lattner } else if (DestIsDeclaration && !Dest->hasDLLImportLinkage()) { 526fc61de39SChris Lattner // If Dest is external but Src is not: 527fc61de39SChris Lattner LinkFromSrc = true; 528fc61de39SChris Lattner LT = Src->getLinkage(); 529d725c991SDuncan Sands } else if (Src->isWeakForLinker()) { 530ce4396bcSDale Johannesen // At this point we know that Dest has LinkOnce, External*, Weak, Common, 531ce4396bcSDale Johannesen // or DLL* linkage. 532184f1be4SChris Lattner if (Dest->hasExternalWeakLinkage() || 533184f1be4SChris Lattner Dest->hasAvailableExternallyLinkage() || 534184f1be4SChris Lattner (Dest->hasLinkOnceLinkage() && 535184f1be4SChris Lattner (Src->hasWeakLinkage() || Src->hasCommonLinkage()))) { 536fc61de39SChris Lattner LinkFromSrc = true; 537fc61de39SChris Lattner LT = Src->getLinkage(); 538fc61de39SChris Lattner } else { 539fc61de39SChris Lattner LinkFromSrc = false; 540fc61de39SChris Lattner LT = Dest->getLinkage(); 541fc61de39SChris Lattner } 542d725c991SDuncan Sands } else if (Dest->isWeakForLinker()) { 54312c94949SAnton Korobeynikov // At this point we know that Src has External* or DLL* linkage. 54412c94949SAnton Korobeynikov if (Src->hasExternalWeakLinkage()) { 54512c94949SAnton Korobeynikov LinkFromSrc = false; 54612c94949SAnton Korobeynikov LT = Dest->getLinkage(); 54712c94949SAnton Korobeynikov } else { 548fc61de39SChris Lattner LinkFromSrc = true; 549fc61de39SChris Lattner LT = GlobalValue::ExternalLinkage; 55012c94949SAnton Korobeynikov } 551fc61de39SChris Lattner } else { 552b1ed91f3SChris Lattner assert((Dest->hasExternalLinkage() || Dest->hasDLLImportLinkage() || 553b1ed91f3SChris Lattner Dest->hasDLLExportLinkage() || Dest->hasExternalWeakLinkage()) && 554b1ed91f3SChris Lattner (Src->hasExternalLinkage() || Src->hasDLLImportLinkage() || 555b1ed91f3SChris Lattner Src->hasDLLExportLinkage() || Src->hasExternalWeakLinkage()) && 556fc61de39SChris Lattner "Unexpected linkage type!"); 557b1ed91f3SChris Lattner return emitError("Linking globals named '" + Src->getName() + 558fc61de39SChris Lattner "': symbol multiply defined!"); 559fc61de39SChris Lattner } 56031fc4f95SAnton Korobeynikov 56123f8d64bSRafael Espindola // Compute the visibility. We follow the rules in the System V Application 56223f8d64bSRafael Espindola // Binary Interface. 56323f8d64bSRafael Espindola Vis = isLessConstraining(Src->getVisibility(), Dest->getVisibility()) ? 56423f8d64bSRafael Espindola Dest->getVisibility() : Src->getVisibility(); 565fc61de39SChris Lattner return false; 566fc61de39SChris Lattner } 567361e513dSReid Spencer 568b1ed91f3SChris Lattner /// computeTypeMapping - Loop over all of the linked values to compute type 569b1ed91f3SChris Lattner /// mappings. For example, if we link "extern Foo *x" and "Foo *x = NULL", then 570b1ed91f3SChris Lattner /// we have two struct types 'Foo' but one got renamed when the module was 571b1ed91f3SChris Lattner /// loaded into the same LLVMContext. 572b1ed91f3SChris Lattner void ModuleLinker::computeTypeMapping() { 573b1ed91f3SChris Lattner // Incorporate globals. 574b1ed91f3SChris Lattner for (Module::global_iterator I = SrcM->global_begin(), 575b1ed91f3SChris Lattner E = SrcM->global_end(); I != E; ++I) { 576b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(I); 577b1ed91f3SChris Lattner if (DGV == 0) continue; 578b1ed91f3SChris Lattner 579b1ed91f3SChris Lattner if (!DGV->hasAppendingLinkage() || !I->hasAppendingLinkage()) { 580b1ed91f3SChris Lattner TypeMap.addTypeMapping(DGV->getType(), I->getType()); 581b1ed91f3SChris Lattner continue; 5825c310be0SDevang Patel } 5835c310be0SDevang Patel 584b1ed91f3SChris Lattner // Unify the element type of appending arrays. 585b1ed91f3SChris Lattner ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType()); 586b1ed91f3SChris Lattner ArrayType *SAT = cast<ArrayType>(I->getType()->getElementType()); 587b1ed91f3SChris Lattner TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType()); 588b1ed91f3SChris Lattner } 58934fc5a0eSChris Lattner 590b1ed91f3SChris Lattner // Incorporate functions. 591b1ed91f3SChris Lattner for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) { 592b1ed91f3SChris Lattner if (GlobalValue *DGV = getLinkedToGlobal(I)) 593b1ed91f3SChris Lattner TypeMap.addTypeMapping(DGV->getType(), I->getType()); 594b1ed91f3SChris Lattner } 595e79f4c77SAnton Korobeynikov 596d48b7783SBill Wendling // Incorporate types by name, scanning all the types in the source module. 597d48b7783SBill Wendling // At this point, the destination module may have a type "%foo = { i32 }" for 5982b3f61afSBill Wendling // example. When the source module got loaded into the same LLVMContext, if 5992b3f61afSBill Wendling // it had the same type, it would have been renamed to "%foo.42 = { i32 }". 600d48b7783SBill Wendling // Though it isn't required for correctness, attempt to link these up to clean 601d48b7783SBill Wendling // up the IR. 6022b3f61afSBill Wendling std::vector<StructType*> SrcStructTypes; 6032b3f61afSBill Wendling SrcM->findUsedStructTypes(SrcStructTypes); 6042b3f61afSBill Wendling 6052b3f61afSBill Wendling SmallPtrSet<StructType*, 32> SrcStructTypesSet(SrcStructTypes.begin(), 6062b3f61afSBill Wendling SrcStructTypes.end()); 6072b3f61afSBill Wendling 6082b3f61afSBill Wendling for (unsigned i = 0, e = SrcStructTypes.size(); i != e; ++i) { 6092b3f61afSBill Wendling StructType *ST = SrcStructTypes[i]; 6102b3f61afSBill Wendling if (!ST->hasName()) continue; 6112b3f61afSBill Wendling 6122b3f61afSBill Wendling // Check to see if there is a dot in the name followed by a digit. 613d48b7783SBill Wendling size_t DotPos = ST->getName().rfind('.'); 614d48b7783SBill Wendling if (DotPos == 0 || DotPos == StringRef::npos || 615d48b7783SBill Wendling ST->getName().back() == '.' || !isdigit(ST->getName()[DotPos+1])) 616d48b7783SBill Wendling continue; 6172b3f61afSBill Wendling 6182b3f61afSBill Wendling // Check to see if the destination module has a struct with the prefix name. 619d48b7783SBill Wendling if (StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos))) 6202b3f61afSBill Wendling // Don't use it if this actually came from the source module. They're in 6212b3f61afSBill Wendling // the same LLVMContext after all. 6222b3f61afSBill Wendling if (!SrcStructTypesSet.count(DST)) 6232b3f61afSBill Wendling TypeMap.addTypeMapping(DST, ST); 6242b3f61afSBill Wendling } 6252b3f61afSBill Wendling 626b1ed91f3SChris Lattner // Don't bother incorporating aliases, they aren't generally typed well. 627361e513dSReid Spencer 628b1ed91f3SChris Lattner // Now that we have discovered all of the type equivalences, get a body for 629b1ed91f3SChris Lattner // any 'opaque' types in the dest module that are now resolved. 630b1ed91f3SChris Lattner TypeMap.linkDefinedTypeBodies(); 631b1ed91f3SChris Lattner } 632c08e7a00SChris Lattner 633b1ed91f3SChris Lattner /// linkAppendingVarProto - If there were any appending global variables, link 634b1ed91f3SChris Lattner /// them together now. Return true on error. 635b1ed91f3SChris Lattner bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV, 636b1ed91f3SChris Lattner GlobalVariable *SrcGV) { 637d48b7783SBill Wendling 638b1ed91f3SChris Lattner if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage()) 639b1ed91f3SChris Lattner return emitError("Linking globals named '" + SrcGV->getName() + 640b1ed91f3SChris Lattner "': can only link appending global with another appending global!"); 641361e513dSReid Spencer 642b1ed91f3SChris Lattner ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType()); 643b1ed91f3SChris Lattner ArrayType *SrcTy = 644b1ed91f3SChris Lattner cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType())); 645b1ed91f3SChris Lattner Type *EltTy = DstTy->getElementType(); 646b1ed91f3SChris Lattner 647b1ed91f3SChris Lattner // Check to see that they two arrays agree on type. 648b1ed91f3SChris Lattner if (EltTy != SrcTy->getElementType()) 649b1ed91f3SChris Lattner return emitError("Appending variables with different element types!"); 650b1ed91f3SChris Lattner if (DstGV->isConstant() != SrcGV->isConstant()) 651b1ed91f3SChris Lattner return emitError("Appending variables linked with different const'ness!"); 652b1ed91f3SChris Lattner 653b1ed91f3SChris Lattner if (DstGV->getAlignment() != SrcGV->getAlignment()) 654b1ed91f3SChris Lattner return emitError( 655b1ed91f3SChris Lattner "Appending variables with different alignment need to be linked!"); 656b1ed91f3SChris Lattner 657b1ed91f3SChris Lattner if (DstGV->getVisibility() != SrcGV->getVisibility()) 658b1ed91f3SChris Lattner return emitError( 659b1ed91f3SChris Lattner "Appending variables with different visibility need to be linked!"); 660b1ed91f3SChris Lattner 661b1ed91f3SChris Lattner if (DstGV->getSection() != SrcGV->getSection()) 662b1ed91f3SChris Lattner return emitError( 663b1ed91f3SChris Lattner "Appending variables with different section name need to be linked!"); 664b1ed91f3SChris Lattner 665b1ed91f3SChris Lattner uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements(); 666b1ed91f3SChris Lattner ArrayType *NewType = ArrayType::get(EltTy, NewSize); 667b1ed91f3SChris Lattner 668b1ed91f3SChris Lattner // Create the new global variable. 669b1ed91f3SChris Lattner GlobalVariable *NG = 670b1ed91f3SChris Lattner new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(), 671b1ed91f3SChris Lattner DstGV->getLinkage(), /*init*/0, /*name*/"", DstGV, 672b1ed91f3SChris Lattner DstGV->isThreadLocal(), 673b1ed91f3SChris Lattner DstGV->getType()->getAddressSpace()); 674b1ed91f3SChris Lattner 675b1ed91f3SChris Lattner // Propagate alignment, visibility and section info. 676b6af2f36SBill Wendling copyGVAttributes(NG, DstGV); 677b1ed91f3SChris Lattner 678b1ed91f3SChris Lattner AppendingVarInfo AVI; 679b1ed91f3SChris Lattner AVI.NewGV = NG; 680b1ed91f3SChris Lattner AVI.DstInit = DstGV->getInitializer(); 681b1ed91f3SChris Lattner AVI.SrcInit = SrcGV->getInitializer(); 682b1ed91f3SChris Lattner AppendingVars.push_back(AVI); 683b1ed91f3SChris Lattner 684b1ed91f3SChris Lattner // Replace any uses of the two global variables with uses of the new 685b1ed91f3SChris Lattner // global. 686b1ed91f3SChris Lattner ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType())); 687b1ed91f3SChris Lattner 688b1ed91f3SChris Lattner DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType())); 689b1ed91f3SChris Lattner DstGV->eraseFromParent(); 690b1ed91f3SChris Lattner 691cbb91408STanya Lattner // Track the source variable so we don't try to link it. 692cbb91408STanya Lattner DoNotLinkFromSource.insert(SrcGV); 693cbb91408STanya Lattner 694b1ed91f3SChris Lattner return false; 695b1ed91f3SChris Lattner } 696b1ed91f3SChris Lattner 697b1ed91f3SChris Lattner /// linkGlobalProto - Loop through the global variables in the src module and 698b1ed91f3SChris Lattner /// merge them into the dest module. 699b1ed91f3SChris Lattner bool ModuleLinker::linkGlobalProto(GlobalVariable *SGV) { 700b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(SGV); 70123f8d64bSRafael Espindola llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 702b1ed91f3SChris Lattner 703b1ed91f3SChris Lattner if (DGV) { 704b1ed91f3SChris Lattner // Concatenation of appending linkage variables is magic and handled later. 705b1ed91f3SChris Lattner if (DGV->hasAppendingLinkage() || SGV->hasAppendingLinkage()) 706b1ed91f3SChris Lattner return linkAppendingVarProto(cast<GlobalVariable>(DGV), SGV); 707b1ed91f3SChris Lattner 708b1ed91f3SChris Lattner // Determine whether linkage of these two globals follows the source 709b1ed91f3SChris Lattner // module's definition or the destination module's definition. 7101b9633d7SChris Lattner GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 71123f8d64bSRafael Espindola GlobalValue::VisibilityTypes NV; 7121b9633d7SChris Lattner bool LinkFromSrc = false; 71323f8d64bSRafael Espindola if (getLinkageResult(DGV, SGV, NewLinkage, NV, LinkFromSrc)) 714fc61de39SChris Lattner return true; 71523f8d64bSRafael Espindola NewVisibility = NV; 716361e513dSReid Spencer 717b1ed91f3SChris Lattner // If we're not linking from the source, then keep the definition that we 718b1ed91f3SChris Lattner // have. 719b1ed91f3SChris Lattner if (!LinkFromSrc) { 72034fc5a0eSChris Lattner // Special case for const propagation. 72134fc5a0eSChris Lattner if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV)) 72234fc5a0eSChris Lattner if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant()) 72334fc5a0eSChris Lattner DGVar->setConstant(true); 72434fc5a0eSChris Lattner 72523f8d64bSRafael Espindola // Set calculated linkage and visibility. 72634fc5a0eSChris Lattner DGV->setLinkage(NewLinkage); 72723f8d64bSRafael Espindola DGV->setVisibility(*NewVisibility); 72834fc5a0eSChris Lattner 729b1ed91f3SChris Lattner // Make sure to remember this mapping. 730b1ed91f3SChris Lattner ValueMap[SGV] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGV->getType())); 731b1ed91f3SChris Lattner 732cbb91408STanya Lattner // Track the source global so that we don't attempt to copy it over when 733cbb91408STanya Lattner // processing global initializers. 734cbb91408STanya Lattner DoNotLinkFromSource.insert(SGV); 735cbb91408STanya Lattner 736b1ed91f3SChris Lattner return false; 737361e513dSReid Spencer } 738b1ed91f3SChris Lattner } 739b1ed91f3SChris Lattner 740b1ed91f3SChris Lattner // No linking to be performed or linking from the source: simply create an 741b1ed91f3SChris Lattner // identical version of the symbol over in the dest module... the 742b1ed91f3SChris Lattner // initializer will be filled in later by LinkGlobalInits. 743b1ed91f3SChris Lattner GlobalVariable *NewDGV = 744b1ed91f3SChris Lattner new GlobalVariable(*DstM, TypeMap.get(SGV->getType()->getElementType()), 745b1ed91f3SChris Lattner SGV->isConstant(), SGV->getLinkage(), /*init*/0, 746b1ed91f3SChris Lattner SGV->getName(), /*insertbefore*/0, 747b1ed91f3SChris Lattner SGV->isThreadLocal(), 748b1ed91f3SChris Lattner SGV->getType()->getAddressSpace()); 749b1ed91f3SChris Lattner // Propagate alignment, visibility and section info. 750b6af2f36SBill Wendling copyGVAttributes(NewDGV, SGV); 75123f8d64bSRafael Espindola if (NewVisibility) 75223f8d64bSRafael Espindola NewDGV->setVisibility(*NewVisibility); 753b1ed91f3SChris Lattner 754b1ed91f3SChris Lattner if (DGV) { 755b1ed91f3SChris Lattner DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDGV, DGV->getType())); 756b1ed91f3SChris Lattner DGV->eraseFromParent(); 757b1ed91f3SChris Lattner } 758b1ed91f3SChris Lattner 759b1ed91f3SChris Lattner // Make sure to remember this mapping. 760b1ed91f3SChris Lattner ValueMap[SGV] = NewDGV; 761361e513dSReid Spencer return false; 762361e513dSReid Spencer } 763361e513dSReid Spencer 764b1ed91f3SChris Lattner /// linkFunctionProto - Link the function in the source module into the 765b1ed91f3SChris Lattner /// destination module if needed, setting up mapping information. 766b1ed91f3SChris Lattner bool ModuleLinker::linkFunctionProto(Function *SF) { 767b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(SF); 76823f8d64bSRafael Espindola llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 769dac5fa94SAnton Korobeynikov 770b1ed91f3SChris Lattner if (DGV) { 7710ead7a50SChris Lattner GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 7720ead7a50SChris Lattner bool LinkFromSrc = false; 77323f8d64bSRafael Espindola GlobalValue::VisibilityTypes NV; 77423f8d64bSRafael Espindola if (getLinkageResult(DGV, SF, NewLinkage, NV, LinkFromSrc)) 7750ead7a50SChris Lattner return true; 77623f8d64bSRafael Espindola NewVisibility = NV; 7770ead7a50SChris Lattner 778b1ed91f3SChris Lattner if (!LinkFromSrc) { 7790ead7a50SChris Lattner // Set calculated linkage 7800ead7a50SChris Lattner DGV->setLinkage(NewLinkage); 78123f8d64bSRafael Espindola DGV->setVisibility(*NewVisibility); 78277e8ac4dSChris Lattner 7830ead7a50SChris Lattner // Make sure to remember this mapping. 784b1ed91f3SChris Lattner ValueMap[SF] = ConstantExpr::getBitCast(DGV, TypeMap.get(SF->getType())); 785b1ed91f3SChris Lattner 786cbb91408STanya Lattner // Track the function from the source module so we don't attempt to remap 787cbb91408STanya Lattner // it. 788cbb91408STanya Lattner DoNotLinkFromSource.insert(SF); 789cbb91408STanya Lattner 790b1ed91f3SChris Lattner return false; 791361e513dSReid Spencer } 792b1ed91f3SChris Lattner } 793b1ed91f3SChris Lattner 794b1ed91f3SChris Lattner // If there is no linkage to be performed or we are linking from the source, 795b1ed91f3SChris Lattner // bring SF over. 796b1ed91f3SChris Lattner Function *NewDF = Function::Create(TypeMap.get(SF->getFunctionType()), 797b1ed91f3SChris Lattner SF->getLinkage(), SF->getName(), DstM); 798b6af2f36SBill Wendling copyGVAttributes(NewDF, SF); 79923f8d64bSRafael Espindola if (NewVisibility) 80023f8d64bSRafael Espindola NewDF->setVisibility(*NewVisibility); 801b1ed91f3SChris Lattner 802b1ed91f3SChris Lattner if (DGV) { 803b1ed91f3SChris Lattner // Any uses of DF need to change to NewDF, with cast. 804b1ed91f3SChris Lattner DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDF, DGV->getType())); 805b1ed91f3SChris Lattner DGV->eraseFromParent(); 8060a48b877STanya Lattner } else { 8070a48b877STanya Lattner // Internal, LO_ODR, or LO linkage - stick in set to ignore and lazily link. 8080a48b877STanya Lattner if (SF->hasLocalLinkage() || SF->hasLinkOnceLinkage() || 8090a48b877STanya Lattner SF->hasAvailableExternallyLinkage()) { 8100a48b877STanya Lattner DoNotLinkFromSource.insert(SF); 8110a48b877STanya Lattner LazilyLinkFunctions.push_back(SF); 8120a48b877STanya Lattner } 813b1ed91f3SChris Lattner } 814b1ed91f3SChris Lattner 815b1ed91f3SChris Lattner ValueMap[SF] = NewDF; 816361e513dSReid Spencer return false; 817361e513dSReid Spencer } 818361e513dSReid Spencer 819b1ed91f3SChris Lattner /// LinkAliasProto - Set up prototypes for any aliases that come over from the 820b1ed91f3SChris Lattner /// source module. 821b1ed91f3SChris Lattner bool ModuleLinker::linkAliasProto(GlobalAlias *SGA) { 822b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(SGA); 82323f8d64bSRafael Espindola llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 824b1ed91f3SChris Lattner 825b1ed91f3SChris Lattner if (DGV) { 826b1ed91f3SChris Lattner GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 82723f8d64bSRafael Espindola GlobalValue::VisibilityTypes NV; 828b1ed91f3SChris Lattner bool LinkFromSrc = false; 82923f8d64bSRafael Espindola if (getLinkageResult(DGV, SGA, NewLinkage, NV, LinkFromSrc)) 830b1ed91f3SChris Lattner return true; 83123f8d64bSRafael Espindola NewVisibility = NV; 832b1ed91f3SChris Lattner 833b1ed91f3SChris Lattner if (!LinkFromSrc) { 834b1ed91f3SChris Lattner // Set calculated linkage. 835b1ed91f3SChris Lattner DGV->setLinkage(NewLinkage); 83623f8d64bSRafael Espindola DGV->setVisibility(*NewVisibility); 837b1ed91f3SChris Lattner 838b1ed91f3SChris Lattner // Make sure to remember this mapping. 839b1ed91f3SChris Lattner ValueMap[SGA] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGA->getType())); 840b1ed91f3SChris Lattner 841cbb91408STanya Lattner // Track the alias from the source module so we don't attempt to remap it. 842cbb91408STanya Lattner DoNotLinkFromSource.insert(SGA); 843cbb91408STanya Lattner 844b1ed91f3SChris Lattner return false; 845b1ed91f3SChris Lattner } 846b1ed91f3SChris Lattner } 847b1ed91f3SChris Lattner 848b1ed91f3SChris Lattner // If there is no linkage to be performed or we're linking from the source, 849b1ed91f3SChris Lattner // bring over SGA. 850b1ed91f3SChris Lattner GlobalAlias *NewDA = new GlobalAlias(TypeMap.get(SGA->getType()), 851b1ed91f3SChris Lattner SGA->getLinkage(), SGA->getName(), 852b1ed91f3SChris Lattner /*aliasee*/0, DstM); 853b6af2f36SBill Wendling copyGVAttributes(NewDA, SGA); 85423f8d64bSRafael Espindola if (NewVisibility) 85523f8d64bSRafael Espindola NewDA->setVisibility(*NewVisibility); 856b1ed91f3SChris Lattner 857b1ed91f3SChris Lattner if (DGV) { 858b1ed91f3SChris Lattner // Any uses of DGV need to change to NewDA, with cast. 859b1ed91f3SChris Lattner DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDA, DGV->getType())); 860b1ed91f3SChris Lattner DGV->eraseFromParent(); 861b1ed91f3SChris Lattner } 862b1ed91f3SChris Lattner 863b1ed91f3SChris Lattner ValueMap[SGA] = NewDA; 864b1ed91f3SChris Lattner return false; 865b1ed91f3SChris Lattner } 866b1ed91f3SChris Lattner 86700245f42SChris Lattner static void getArrayElements(Constant *C, SmallVectorImpl<Constant*> &Dest) { 8686705883aSChris Lattner unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements(); 86900245f42SChris Lattner 8706705883aSChris Lattner for (unsigned i = 0; i != NumElements; ++i) 8716705883aSChris Lattner Dest.push_back(C->getAggregateElement(i)); 87200245f42SChris Lattner } 87300245f42SChris Lattner 874b1ed91f3SChris Lattner void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) { 875b1ed91f3SChris Lattner // Merge the initializer. 876b1ed91f3SChris Lattner SmallVector<Constant*, 16> Elements; 87700245f42SChris Lattner getArrayElements(AVI.DstInit, Elements); 878b1ed91f3SChris Lattner 879b1ed91f3SChris Lattner Constant *SrcInit = MapValue(AVI.SrcInit, ValueMap, RF_None, &TypeMap); 88000245f42SChris Lattner getArrayElements(SrcInit, Elements); 88100245f42SChris Lattner 882b1ed91f3SChris Lattner ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType()); 883b1ed91f3SChris Lattner AVI.NewGV->setInitializer(ConstantArray::get(NewType, Elements)); 884b1ed91f3SChris Lattner } 885b1ed91f3SChris Lattner 886b6af2f36SBill Wendling /// linkGlobalInits - Update the initializers in the Dest module now that all 887b6af2f36SBill Wendling /// globals that may be referenced are in Dest. 888b1ed91f3SChris Lattner void ModuleLinker::linkGlobalInits() { 889b1ed91f3SChris Lattner // Loop over all of the globals in the src module, mapping them over as we go 890b1ed91f3SChris Lattner for (Module::const_global_iterator I = SrcM->global_begin(), 891b1ed91f3SChris Lattner E = SrcM->global_end(); I != E; ++I) { 892cbb91408STanya Lattner 893cbb91408STanya Lattner // Only process initialized GV's or ones not already in dest. 894cbb91408STanya Lattner if (!I->hasInitializer() || DoNotLinkFromSource.count(I)) continue; 895b1ed91f3SChris Lattner 896b1ed91f3SChris Lattner // Grab destination global variable. 897b1ed91f3SChris Lattner GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[I]); 898b1ed91f3SChris Lattner // Figure out what the initializer looks like in the dest module. 899b1ed91f3SChris Lattner DGV->setInitializer(MapValue(I->getInitializer(), ValueMap, 900b1ed91f3SChris Lattner RF_None, &TypeMap)); 901b1ed91f3SChris Lattner } 902b1ed91f3SChris Lattner } 903b1ed91f3SChris Lattner 904b6af2f36SBill Wendling /// linkFunctionBody - Copy the source function over into the dest function and 905b6af2f36SBill Wendling /// fix up references to values. At this point we know that Dest is an external 906b6af2f36SBill Wendling /// function, and that Src is not. 907b1ed91f3SChris Lattner void ModuleLinker::linkFunctionBody(Function *Dst, Function *Src) { 908b1ed91f3SChris Lattner assert(Src && Dst && Dst->isDeclaration() && !Src->isDeclaration()); 909361e513dSReid Spencer 9107391dde1SChris Lattner // Go through and convert function arguments over, remembering the mapping. 911b1ed91f3SChris Lattner Function::arg_iterator DI = Dst->arg_begin(); 912531f9e92SChris Lattner for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end(); 913361e513dSReid Spencer I != E; ++I, ++DI) { 914b1ed91f3SChris Lattner DI->setName(I->getName()); // Copy the name over. 915361e513dSReid Spencer 916b1ed91f3SChris Lattner // Add a mapping to our mapping. 91766a6271cSAnton Korobeynikov ValueMap[I] = DI; 918361e513dSReid Spencer } 919361e513dSReid Spencer 920cbb91408STanya Lattner if (Mode == Linker::DestroySource) { 9212f0557d0SChris Lattner // Splice the body of the source function into the dest function. 922b1ed91f3SChris Lattner Dst->getBasicBlockList().splice(Dst->end(), Src->getBasicBlockList()); 923361e513dSReid Spencer 924361e513dSReid Spencer // At this point, all of the instructions and values of the function are now 925361e513dSReid Spencer // copied over. The only problem is that they are still referencing values in 926361e513dSReid Spencer // the Source function as operands. Loop through all of the operands of the 92743f8d164SChris Lattner // functions and patch them up to point to the local versions. 928b1ed91f3SChris Lattner for (Function::iterator BB = Dst->begin(), BE = Dst->end(); BB != BE; ++BB) 92943f8d164SChris Lattner for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) 930b1ed91f3SChris Lattner RemapInstruction(I, ValueMap, RF_IgnoreMissingEntries, &TypeMap); 9317391dde1SChris Lattner 932cbb91408STanya Lattner } else { 933cbb91408STanya Lattner // Clone the body of the function into the dest function. 934cbb91408STanya Lattner SmallVector<ReturnInst*, 8> Returns; // Ignore returns. 9355d44a433SMon P Wang CloneFunctionInto(Dst, Src, ValueMap, false, Returns, "", NULL, &TypeMap); 936cbb91408STanya Lattner } 937cbb91408STanya Lattner 9387391dde1SChris Lattner // There is no need to map the arguments anymore. 93944ab8aefSChris Lattner for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end(); 94044ab8aefSChris Lattner I != E; ++I) 9413aaaa0b2SReid Spencer ValueMap.erase(I); 942cbb91408STanya Lattner 943361e513dSReid Spencer } 944361e513dSReid Spencer 945b6af2f36SBill Wendling /// linkAliasBodies - Insert all of the aliases in Src into the Dest module. 946b1ed91f3SChris Lattner void ModuleLinker::linkAliasBodies() { 947b1ed91f3SChris Lattner for (Module::alias_iterator I = SrcM->alias_begin(), E = SrcM->alias_end(); 948cbb91408STanya Lattner I != E; ++I) { 949cbb91408STanya Lattner if (DoNotLinkFromSource.count(I)) 950cbb91408STanya Lattner continue; 951b1ed91f3SChris Lattner if (Constant *Aliasee = I->getAliasee()) { 952b1ed91f3SChris Lattner GlobalAlias *DA = cast<GlobalAlias>(ValueMap[I]); 953b1ed91f3SChris Lattner DA->setAliasee(MapValue(Aliasee, ValueMap, RF_None, &TypeMap)); 9542c4a34aeSDavid Chisnall } 955b1ed91f3SChris Lattner } 956cbb91408STanya Lattner } 957b1ed91f3SChris Lattner 958b6af2f36SBill Wendling /// linkNamedMDNodes - Insert all of the named MDNodes in Src into the Dest 959b1ed91f3SChris Lattner /// module. 960b1ed91f3SChris Lattner void ModuleLinker::linkNamedMDNodes() { 96166f02413SBill Wendling const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata(); 962b1ed91f3SChris Lattner for (Module::const_named_metadata_iterator I = SrcM->named_metadata_begin(), 963b1ed91f3SChris Lattner E = SrcM->named_metadata_end(); I != E; ++I) { 96466f02413SBill Wendling // Don't link module flags here. Do them separately. 96566f02413SBill Wendling if (&*I == SrcModFlags) continue; 966b1ed91f3SChris Lattner NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(I->getName()); 967b1ed91f3SChris Lattner // Add Src elements into Dest node. 968b1ed91f3SChris Lattner for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) 969b1ed91f3SChris Lattner DestNMD->addOperand(MapValue(I->getOperand(i), ValueMap, 970b1ed91f3SChris Lattner RF_None, &TypeMap)); 971b1ed91f3SChris Lattner } 972b1ed91f3SChris Lattner } 973b1ed91f3SChris Lattner 974b6af2f36SBill Wendling /// categorizeModuleFlagNodes - Categorize the module flags according to their 975b6af2f36SBill Wendling /// type: Error, Warning, Override, and Require. 97666f02413SBill Wendling bool ModuleLinker:: 97766f02413SBill Wendling categorizeModuleFlagNodes(const NamedMDNode *ModFlags, 97866f02413SBill Wendling DenseMap<MDString*, MDNode*> &ErrorNode, 97966f02413SBill Wendling DenseMap<MDString*, MDNode*> &WarningNode, 98066f02413SBill Wendling DenseMap<MDString*, MDNode*> &OverrideNode, 98166f02413SBill Wendling DenseMap<MDString*, 98266f02413SBill Wendling SmallSetVector<MDNode*, 8> > &RequireNodes, 98366f02413SBill Wendling SmallSetVector<MDString*, 16> &SeenIDs) { 98466f02413SBill Wendling bool HasErr = false; 98566f02413SBill Wendling 98666f02413SBill Wendling for (unsigned I = 0, E = ModFlags->getNumOperands(); I != E; ++I) { 98766f02413SBill Wendling MDNode *Op = ModFlags->getOperand(I); 98866f02413SBill Wendling assert(Op->getNumOperands() == 3 && "Invalid module flag metadata!"); 98966f02413SBill Wendling assert(isa<ConstantInt>(Op->getOperand(0)) && 99066f02413SBill Wendling "Module flag's first operand must be an integer!"); 99166f02413SBill Wendling assert(isa<MDString>(Op->getOperand(1)) && 99266f02413SBill Wendling "Module flag's second operand must be an MDString!"); 99366f02413SBill Wendling 99466f02413SBill Wendling ConstantInt *Behavior = cast<ConstantInt>(Op->getOperand(0)); 99566f02413SBill Wendling MDString *ID = cast<MDString>(Op->getOperand(1)); 99666f02413SBill Wendling Value *Val = Op->getOperand(2); 99766f02413SBill Wendling switch (Behavior->getZExtValue()) { 99866f02413SBill Wendling default: 99966f02413SBill Wendling assert(false && "Invalid behavior in module flag metadata!"); 100066f02413SBill Wendling break; 100166f02413SBill Wendling case Module::Error: { 100266f02413SBill Wendling MDNode *&ErrNode = ErrorNode[ID]; 100366f02413SBill Wendling if (!ErrNode) ErrNode = Op; 100466f02413SBill Wendling if (ErrNode->getOperand(2) != Val) 10059273b539SBill Wendling HasErr = emitError("linking module flags '" + ID->getString() + 10069273b539SBill Wendling "': IDs have conflicting values"); 100766f02413SBill Wendling break; 100866f02413SBill Wendling } 100966f02413SBill Wendling case Module::Warning: { 101066f02413SBill Wendling MDNode *&WarnNode = WarningNode[ID]; 101166f02413SBill Wendling if (!WarnNode) WarnNode = Op; 101266f02413SBill Wendling if (WarnNode->getOperand(2) != Val) 10139273b539SBill Wendling errs() << "WARNING: linking module flags '" << ID->getString() 10149273b539SBill Wendling << "': IDs have conflicting values"; 101566f02413SBill Wendling break; 101666f02413SBill Wendling } 101766f02413SBill Wendling case Module::Require: RequireNodes[ID].insert(Op); break; 101866f02413SBill Wendling case Module::Override: { 101966f02413SBill Wendling MDNode *&OvrNode = OverrideNode[ID]; 102066f02413SBill Wendling if (!OvrNode) OvrNode = Op; 102166f02413SBill Wendling if (OvrNode->getOperand(2) != Val) 10229273b539SBill Wendling HasErr = emitError("linking module flags '" + ID->getString() + 10239273b539SBill Wendling "': IDs have conflicting override values"); 102466f02413SBill Wendling break; 102566f02413SBill Wendling } 102666f02413SBill Wendling } 102766f02413SBill Wendling 102866f02413SBill Wendling SeenIDs.insert(ID); 102966f02413SBill Wendling } 103066f02413SBill Wendling 103166f02413SBill Wendling return HasErr; 103266f02413SBill Wendling } 103366f02413SBill Wendling 103466f02413SBill Wendling /// linkModuleFlagsMetadata - Merge the linker flags in Src into the Dest 103566f02413SBill Wendling /// module. 103666f02413SBill Wendling bool ModuleLinker::linkModuleFlagsMetadata() { 103766f02413SBill Wendling const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata(); 103866f02413SBill Wendling if (!SrcModFlags) return false; 103966f02413SBill Wendling 104066f02413SBill Wendling NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata(); 104166f02413SBill Wendling 104266f02413SBill Wendling // If the destination module doesn't have module flags yet, then just copy 104366f02413SBill Wendling // over the source module's flags. 104466f02413SBill Wendling if (DstModFlags->getNumOperands() == 0) { 104566f02413SBill Wendling for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) 104666f02413SBill Wendling DstModFlags->addOperand(SrcModFlags->getOperand(I)); 104766f02413SBill Wendling 104866f02413SBill Wendling return false; 104966f02413SBill Wendling } 105066f02413SBill Wendling 105166f02413SBill Wendling bool HasErr = false; 105266f02413SBill Wendling 105366f02413SBill Wendling // Otherwise, we have to merge them based on their behaviors. First, 105466f02413SBill Wendling // categorize all of the nodes in the modules' module flags. If an error or 105566f02413SBill Wendling // warning occurs, then emit the appropriate message(s). 105666f02413SBill Wendling DenseMap<MDString*, MDNode*> ErrorNode; 105766f02413SBill Wendling DenseMap<MDString*, MDNode*> WarningNode; 105866f02413SBill Wendling DenseMap<MDString*, MDNode*> OverrideNode; 105966f02413SBill Wendling DenseMap<MDString*, SmallSetVector<MDNode*, 8> > RequireNodes; 106066f02413SBill Wendling SmallSetVector<MDString*, 16> SeenIDs; 106166f02413SBill Wendling 106266f02413SBill Wendling HasErr |= categorizeModuleFlagNodes(SrcModFlags, ErrorNode, WarningNode, 106366f02413SBill Wendling OverrideNode, RequireNodes, SeenIDs); 106466f02413SBill Wendling HasErr |= categorizeModuleFlagNodes(DstModFlags, ErrorNode, WarningNode, 106566f02413SBill Wendling OverrideNode, RequireNodes, SeenIDs); 106666f02413SBill Wendling 106766f02413SBill Wendling // Check that there isn't both an error and warning node for a flag. 106866f02413SBill Wendling for (SmallSetVector<MDString*, 16>::iterator 106966f02413SBill Wendling I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) { 107066f02413SBill Wendling MDString *ID = *I; 107166f02413SBill Wendling if (ErrorNode[ID] && WarningNode[ID]) 10729273b539SBill Wendling HasErr = emitError("linking module flags '" + ID->getString() + 107366f02413SBill Wendling "': IDs have conflicting behaviors"); 107466f02413SBill Wendling } 107566f02413SBill Wendling 107666f02413SBill Wendling // Early exit if we had an error. 107766f02413SBill Wendling if (HasErr) return true; 107866f02413SBill Wendling 107966f02413SBill Wendling // Get the destination's module flags ready for new operands. 108066f02413SBill Wendling DstModFlags->dropAllReferences(); 108166f02413SBill Wendling 108266f02413SBill Wendling // Add all of the module flags to the destination module. 108366f02413SBill Wendling DenseMap<MDString*, SmallVector<MDNode*, 4> > AddedNodes; 108466f02413SBill Wendling for (SmallSetVector<MDString*, 16>::iterator 108566f02413SBill Wendling I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) { 108666f02413SBill Wendling MDString *ID = *I; 108766f02413SBill Wendling if (OverrideNode[ID]) { 108866f02413SBill Wendling DstModFlags->addOperand(OverrideNode[ID]); 108966f02413SBill Wendling AddedNodes[ID].push_back(OverrideNode[ID]); 109066f02413SBill Wendling } else if (ErrorNode[ID]) { 109166f02413SBill Wendling DstModFlags->addOperand(ErrorNode[ID]); 109266f02413SBill Wendling AddedNodes[ID].push_back(ErrorNode[ID]); 109366f02413SBill Wendling } else if (WarningNode[ID]) { 109466f02413SBill Wendling DstModFlags->addOperand(WarningNode[ID]); 109566f02413SBill Wendling AddedNodes[ID].push_back(WarningNode[ID]); 109666f02413SBill Wendling } 109766f02413SBill Wendling 109866f02413SBill Wendling for (SmallSetVector<MDNode*, 8>::iterator 109966f02413SBill Wendling II = RequireNodes[ID].begin(), IE = RequireNodes[ID].end(); 110066f02413SBill Wendling II != IE; ++II) 110166f02413SBill Wendling DstModFlags->addOperand(*II); 110266f02413SBill Wendling } 110366f02413SBill Wendling 110466f02413SBill Wendling // Now check that all of the requirements have been satisfied. 110566f02413SBill Wendling for (SmallSetVector<MDString*, 16>::iterator 110666f02413SBill Wendling I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) { 110766f02413SBill Wendling MDString *ID = *I; 110866f02413SBill Wendling SmallSetVector<MDNode*, 8> &Set = RequireNodes[ID]; 110966f02413SBill Wendling 111066f02413SBill Wendling for (SmallSetVector<MDNode*, 8>::iterator 111166f02413SBill Wendling II = Set.begin(), IE = Set.end(); II != IE; ++II) { 111266f02413SBill Wendling MDNode *Node = *II; 111366f02413SBill Wendling assert(isa<MDNode>(Node->getOperand(2)) && 111466f02413SBill Wendling "Module flag's third operand must be an MDNode!"); 111566f02413SBill Wendling MDNode *Val = cast<MDNode>(Node->getOperand(2)); 111666f02413SBill Wendling 111766f02413SBill Wendling MDString *ReqID = cast<MDString>(Val->getOperand(0)); 111866f02413SBill Wendling Value *ReqVal = Val->getOperand(1); 111966f02413SBill Wendling 112066f02413SBill Wendling bool HasValue = false; 112166f02413SBill Wendling for (SmallVectorImpl<MDNode*>::iterator 112266f02413SBill Wendling RI = AddedNodes[ReqID].begin(), RE = AddedNodes[ReqID].end(); 112366f02413SBill Wendling RI != RE; ++RI) { 112466f02413SBill Wendling MDNode *ReqNode = *RI; 112566f02413SBill Wendling if (ReqNode->getOperand(2) == ReqVal) { 112666f02413SBill Wendling HasValue = true; 112766f02413SBill Wendling break; 112866f02413SBill Wendling } 112966f02413SBill Wendling } 113066f02413SBill Wendling 113166f02413SBill Wendling if (!HasValue) 11329273b539SBill Wendling HasErr = emitError("linking module flags '" + ReqID->getString() + 11339273b539SBill Wendling "': does not have the required value"); 113466f02413SBill Wendling } 113566f02413SBill Wendling } 113666f02413SBill Wendling 113766f02413SBill Wendling return HasErr; 113866f02413SBill Wendling } 113966f02413SBill Wendling 1140b1ed91f3SChris Lattner bool ModuleLinker::run() { 114166f02413SBill Wendling assert(DstM && "Null destination module"); 114266f02413SBill Wendling assert(SrcM && "Null source module"); 1143b1ed91f3SChris Lattner 1144b1ed91f3SChris Lattner // Inherit the target data from the source module if the destination module 1145b1ed91f3SChris Lattner // doesn't have one already. 1146b1ed91f3SChris Lattner if (DstM->getDataLayout().empty() && !SrcM->getDataLayout().empty()) 1147b1ed91f3SChris Lattner DstM->setDataLayout(SrcM->getDataLayout()); 1148b1ed91f3SChris Lattner 1149b1ed91f3SChris Lattner // Copy the target triple from the source to dest if the dest's is empty. 1150b1ed91f3SChris Lattner if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty()) 1151b1ed91f3SChris Lattner DstM->setTargetTriple(SrcM->getTargetTriple()); 1152b1ed91f3SChris Lattner 1153b1ed91f3SChris Lattner if (!SrcM->getDataLayout().empty() && !DstM->getDataLayout().empty() && 1154b1ed91f3SChris Lattner SrcM->getDataLayout() != DstM->getDataLayout()) 1155b1ed91f3SChris Lattner errs() << "WARNING: Linking two modules of different data layouts!\n"; 1156b1ed91f3SChris Lattner if (!SrcM->getTargetTriple().empty() && 1157b1ed91f3SChris Lattner DstM->getTargetTriple() != SrcM->getTargetTriple()) { 1158b1ed91f3SChris Lattner errs() << "WARNING: Linking two modules of different target triples: "; 1159b1ed91f3SChris Lattner if (!SrcM->getModuleIdentifier().empty()) 1160b1ed91f3SChris Lattner errs() << SrcM->getModuleIdentifier() << ": "; 1161b1ed91f3SChris Lattner errs() << "'" << SrcM->getTargetTriple() << "' and '" 1162b1ed91f3SChris Lattner << DstM->getTargetTriple() << "'\n"; 1163b1ed91f3SChris Lattner } 1164b1ed91f3SChris Lattner 1165b1ed91f3SChris Lattner // Append the module inline asm string. 1166b1ed91f3SChris Lattner if (!SrcM->getModuleInlineAsm().empty()) { 1167b1ed91f3SChris Lattner if (DstM->getModuleInlineAsm().empty()) 1168b1ed91f3SChris Lattner DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm()); 1169b1ed91f3SChris Lattner else 1170b1ed91f3SChris Lattner DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+ 1171b1ed91f3SChris Lattner SrcM->getModuleInlineAsm()); 1172b1ed91f3SChris Lattner } 1173b1ed91f3SChris Lattner 1174b1ed91f3SChris Lattner // Update the destination module's dependent libraries list with the libraries 1175b1ed91f3SChris Lattner // from the source module. There's no opportunity for duplicates here as the 1176b1ed91f3SChris Lattner // Module ensures that duplicate insertions are discarded. 1177b1ed91f3SChris Lattner for (Module::lib_iterator SI = SrcM->lib_begin(), SE = SrcM->lib_end(); 1178b1ed91f3SChris Lattner SI != SE; ++SI) 1179b1ed91f3SChris Lattner DstM->addLibrary(*SI); 1180b1ed91f3SChris Lattner 1181b1ed91f3SChris Lattner // If the source library's module id is in the dependent library list of the 1182b1ed91f3SChris Lattner // destination library, remove it since that module is now linked in. 1183b1ed91f3SChris Lattner StringRef ModuleId = SrcM->getModuleIdentifier(); 1184b1ed91f3SChris Lattner if (!ModuleId.empty()) 1185b1ed91f3SChris Lattner DstM->removeLibrary(sys::path::stem(ModuleId)); 1186b1ed91f3SChris Lattner 1187b1ed91f3SChris Lattner // Loop over all of the linked values to compute type mappings. 1188b1ed91f3SChris Lattner computeTypeMapping(); 1189b1ed91f3SChris Lattner 1190b1ed91f3SChris Lattner // Insert all of the globals in src into the DstM module... without linking 1191b1ed91f3SChris Lattner // initializers (which could refer to functions not yet mapped over). 1192b1ed91f3SChris Lattner for (Module::global_iterator I = SrcM->global_begin(), 1193b1ed91f3SChris Lattner E = SrcM->global_end(); I != E; ++I) 1194b1ed91f3SChris Lattner if (linkGlobalProto(I)) 1195b1ed91f3SChris Lattner return true; 1196b1ed91f3SChris Lattner 1197b1ed91f3SChris Lattner // Link the functions together between the two modules, without doing function 1198b1ed91f3SChris Lattner // bodies... this just adds external function prototypes to the DstM 1199b1ed91f3SChris Lattner // function... We do this so that when we begin processing function bodies, 1200b1ed91f3SChris Lattner // all of the global values that may be referenced are available in our 1201b1ed91f3SChris Lattner // ValueMap. 1202b1ed91f3SChris Lattner for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) 1203b1ed91f3SChris Lattner if (linkFunctionProto(I)) 1204b1ed91f3SChris Lattner return true; 1205b1ed91f3SChris Lattner 1206b1ed91f3SChris Lattner // If there were any aliases, link them now. 1207b1ed91f3SChris Lattner for (Module::alias_iterator I = SrcM->alias_begin(), 1208b1ed91f3SChris Lattner E = SrcM->alias_end(); I != E; ++I) 1209b1ed91f3SChris Lattner if (linkAliasProto(I)) 1210b1ed91f3SChris Lattner return true; 1211b1ed91f3SChris Lattner 1212b1ed91f3SChris Lattner for (unsigned i = 0, e = AppendingVars.size(); i != e; ++i) 1213b1ed91f3SChris Lattner linkAppendingVarInit(AppendingVars[i]); 1214b1ed91f3SChris Lattner 1215b1ed91f3SChris Lattner // Update the initializers in the DstM module now that all globals that may 1216b1ed91f3SChris Lattner // be referenced are in DstM. 1217b1ed91f3SChris Lattner linkGlobalInits(); 1218b1ed91f3SChris Lattner 1219b1ed91f3SChris Lattner // Link in the function bodies that are defined in the source module into 1220b1ed91f3SChris Lattner // DstM. 1221b1ed91f3SChris Lattner for (Module::iterator SF = SrcM->begin(), E = SrcM->end(); SF != E; ++SF) { 1222ea166d44STanya Lattner // Skip if not linking from source. 1223ea166d44STanya Lattner if (DoNotLinkFromSource.count(SF)) continue; 1224ea166d44STanya Lattner 1225ea166d44STanya Lattner // Skip if no body (function is external) or materialize. 1226ea166d44STanya Lattner if (SF->isDeclaration()) { 1227ea166d44STanya Lattner if (!SF->isMaterializable()) 1228ea166d44STanya Lattner continue; 1229ea166d44STanya Lattner if (SF->Materialize(&ErrorMsg)) 1230ea166d44STanya Lattner return true; 1231ea166d44STanya Lattner } 1232b1ed91f3SChris Lattner 1233b1ed91f3SChris Lattner linkFunctionBody(cast<Function>(ValueMap[SF]), SF); 1234b1ed91f3SChris Lattner } 1235b1ed91f3SChris Lattner 1236b1ed91f3SChris Lattner // Resolve all uses of aliases with aliasees. 1237b1ed91f3SChris Lattner linkAliasBodies(); 1238b1ed91f3SChris Lattner 123966f02413SBill Wendling // Remap all of the named MDNodes in Src into the DstM module. We do this 12406ddbb2e2SDevang Patel // after linking GlobalValues so that MDNodes that reference GlobalValues 12416ddbb2e2SDevang Patel // are properly remapped. 12426ddbb2e2SDevang Patel linkNamedMDNodes(); 12436ddbb2e2SDevang Patel 124466f02413SBill Wendling // Merge the module flags into the DstM module. 124566f02413SBill Wendling if (linkModuleFlagsMetadata()) 124666f02413SBill Wendling return true; 124766f02413SBill Wendling 12480a48b877STanya Lattner // Process vector of lazily linked in functions. 12490a48b877STanya Lattner bool LinkedInAnyFunctions; 12500a48b877STanya Lattner do { 12510a48b877STanya Lattner LinkedInAnyFunctions = false; 12520a48b877STanya Lattner 12530a48b877STanya Lattner for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(), 12540a48b877STanya Lattner E = LazilyLinkFunctions.end(); I != E; ++I) { 12550a48b877STanya Lattner if (!*I) 12560a48b877STanya Lattner continue; 12570a48b877STanya Lattner 12580a48b877STanya Lattner Function *SF = *I; 12590a48b877STanya Lattner Function *DF = cast<Function>(ValueMap[SF]); 12600a48b877STanya Lattner 12610a48b877STanya Lattner if (!DF->use_empty()) { 12620a48b877STanya Lattner 12630a48b877STanya Lattner // Materialize if necessary. 12640a48b877STanya Lattner if (SF->isDeclaration()) { 12650a48b877STanya Lattner if (!SF->isMaterializable()) 12660a48b877STanya Lattner continue; 12670a48b877STanya Lattner if (SF->Materialize(&ErrorMsg)) 12680a48b877STanya Lattner return true; 12690a48b877STanya Lattner } 12700a48b877STanya Lattner 12710a48b877STanya Lattner // Link in function body. 12720a48b877STanya Lattner linkFunctionBody(DF, SF); 12730a48b877STanya Lattner 12740a48b877STanya Lattner // "Remove" from vector by setting the element to 0. 12750a48b877STanya Lattner *I = 0; 12760a48b877STanya Lattner 12770a48b877STanya Lattner // Set flag to indicate we may have more functions to lazily link in 12780a48b877STanya Lattner // since we linked in a function. 12790a48b877STanya Lattner LinkedInAnyFunctions = true; 12800a48b877STanya Lattner } 12810a48b877STanya Lattner } 12820a48b877STanya Lattner } while (LinkedInAnyFunctions); 12830a48b877STanya Lattner 12840a48b877STanya Lattner // Remove any prototypes of functions that were not actually linked in. 12850a48b877STanya Lattner for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(), 12860a48b877STanya Lattner E = LazilyLinkFunctions.end(); I != E; ++I) { 12870a48b877STanya Lattner if (!*I) 12880a48b877STanya Lattner continue; 12890a48b877STanya Lattner 12900a48b877STanya Lattner Function *SF = *I; 12910a48b877STanya Lattner Function *DF = cast<Function>(ValueMap[SF]); 12920a48b877STanya Lattner if (DF->use_empty()) 12930a48b877STanya Lattner DF->eraseFromParent(); 12940a48b877STanya Lattner } 12950a48b877STanya Lattner 1296b1ed91f3SChris Lattner // Now that all of the types from the source are used, resolve any structs 1297b1ed91f3SChris Lattner // copied over to the dest that didn't exist there. 1298b1ed91f3SChris Lattner TypeMap.linkDefinedTypeBodies(); 12992609888fSAnton Korobeynikov 13002609888fSAnton Korobeynikov return false; 13012609888fSAnton Korobeynikov } 1302361e513dSReid Spencer 1303b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 1304b1ed91f3SChris Lattner // LinkModules entrypoint. 1305b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 1306b1ed91f3SChris Lattner 1307b6af2f36SBill Wendling /// LinkModules - This function links two modules together, with the resulting 1308b6af2f36SBill Wendling /// left module modified to be the composite of the two input modules. If an 1309b6af2f36SBill Wendling /// error occurs, true is returned and ErrorMsg (if not null) is set to indicate 1310b6af2f36SBill Wendling /// the problem. Upon failure, the Dest module could be in a modified state, 1311b6af2f36SBill Wendling /// and shouldn't be relied on to be consistent. 1312cbb91408STanya Lattner bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Mode, 1313cbb91408STanya Lattner std::string *ErrorMsg) { 1314cbb91408STanya Lattner ModuleLinker TheLinker(Dest, Src, Mode); 1315b1ed91f3SChris Lattner if (TheLinker.run()) { 1316b1ed91f3SChris Lattner if (ErrorMsg) *ErrorMsg = TheLinker.ErrorMsg; 1317d3ba7d9bSReid Spencer return true; 1318361e513dSReid Spencer } 1319361e513dSReid Spencer 1320361e513dSReid Spencer return false; 1321361e513dSReid Spencer } 1322