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 558c2cc416SBill 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 240b1ed91f3SChris Lattner /// get - Return the mapped type to use for the specified input type from the 241b1ed91f3SChris Lattner /// source module. 242b1ed91f3SChris Lattner Type *TypeMapTy::get(Type *Ty) { 243b1ed91f3SChris Lattner Type *Result = getImpl(Ty); 244b1ed91f3SChris Lattner 245b1ed91f3SChris Lattner // If this caused a reference to any struct type, resolve it before returning. 2465e3bd972SChris Lattner if (!SrcDefinitionsToResolve.empty()) 247b1ed91f3SChris Lattner linkDefinedTypeBodies(); 248b1ed91f3SChris Lattner return Result; 249eee6f995SChris Lattner } 250eee6f995SChris Lattner 251b1ed91f3SChris Lattner /// getImpl - This is the recursive version of get(). 252b1ed91f3SChris Lattner Type *TypeMapTy::getImpl(Type *Ty) { 253b1ed91f3SChris Lattner // If we already have an entry for this type, return it. 254b1ed91f3SChris Lattner Type **Entry = &MappedTypes[Ty]; 255b1ed91f3SChris Lattner if (*Entry) return *Entry; 256b1ed91f3SChris Lattner 257b1ed91f3SChris Lattner // If this is not a named struct type, then just map all of the elements and 258b1ed91f3SChris Lattner // then rebuild the type from inside out. 25944f7ab45SChris Lattner if (!isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral()) { 260b1ed91f3SChris Lattner // If there are no element types to map, then the type is itself. This is 261b1ed91f3SChris Lattner // true for the anonymous {} struct, things like 'float', integers, etc. 262b1ed91f3SChris Lattner if (Ty->getNumContainedTypes() == 0) 263b1ed91f3SChris Lattner return *Entry = Ty; 264b1ed91f3SChris Lattner 265b1ed91f3SChris Lattner // Remap all of the elements, keeping track of whether any of them change. 266b1ed91f3SChris Lattner bool AnyChange = false; 267b1ed91f3SChris Lattner SmallVector<Type*, 4> ElementTypes; 268b1ed91f3SChris Lattner ElementTypes.resize(Ty->getNumContainedTypes()); 269b1ed91f3SChris Lattner for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i) { 270b1ed91f3SChris Lattner ElementTypes[i] = getImpl(Ty->getContainedType(i)); 271b1ed91f3SChris Lattner AnyChange |= ElementTypes[i] != Ty->getContainedType(i); 272eee6f995SChris Lattner } 273b1ed91f3SChris Lattner 274b1ed91f3SChris Lattner // If we found our type while recursively processing stuff, just use it. 275b1ed91f3SChris Lattner Entry = &MappedTypes[Ty]; 276b1ed91f3SChris Lattner if (*Entry) return *Entry; 277b1ed91f3SChris Lattner 278b1ed91f3SChris Lattner // If all of the element types mapped directly over, then the type is usable 279b1ed91f3SChris Lattner // as-is. 280b1ed91f3SChris Lattner if (!AnyChange) 281b1ed91f3SChris Lattner return *Entry = Ty; 282b1ed91f3SChris Lattner 283b1ed91f3SChris Lattner // Otherwise, rebuild a modified type. 284b1ed91f3SChris Lattner switch (Ty->getTypeID()) { 285a2886c21SCraig Topper default: llvm_unreachable("unknown derived type to remap"); 286b1ed91f3SChris Lattner case Type::ArrayTyID: 287b1ed91f3SChris Lattner return *Entry = ArrayType::get(ElementTypes[0], 288b1ed91f3SChris Lattner cast<ArrayType>(Ty)->getNumElements()); 289b1ed91f3SChris Lattner case Type::VectorTyID: 290b1ed91f3SChris Lattner return *Entry = VectorType::get(ElementTypes[0], 291b1ed91f3SChris Lattner cast<VectorType>(Ty)->getNumElements()); 292b1ed91f3SChris Lattner case Type::PointerTyID: 293b1ed91f3SChris Lattner return *Entry = PointerType::get(ElementTypes[0], 294b1ed91f3SChris Lattner cast<PointerType>(Ty)->getAddressSpace()); 295b1ed91f3SChris Lattner case Type::FunctionTyID: 296b1ed91f3SChris Lattner return *Entry = FunctionType::get(ElementTypes[0], 297717d7eddSFrits van Bommel makeArrayRef(ElementTypes).slice(1), 298b1ed91f3SChris Lattner cast<FunctionType>(Ty)->isVarArg()); 299b1ed91f3SChris Lattner case Type::StructTyID: 300b1ed91f3SChris Lattner // Note that this is only reached for anonymous structs. 301b1ed91f3SChris Lattner return *Entry = StructType::get(Ty->getContext(), ElementTypes, 302b1ed91f3SChris Lattner cast<StructType>(Ty)->isPacked()); 303b1ed91f3SChris Lattner } 304b1ed91f3SChris Lattner } 305b1ed91f3SChris Lattner 306b1ed91f3SChris Lattner // Otherwise, this is an unmapped named struct. If the struct can be directly 307b1ed91f3SChris Lattner // mapped over, just use it as-is. This happens in a case when the linked-in 308b1ed91f3SChris Lattner // module has something like: 309b1ed91f3SChris Lattner // %T = type {%T*, i32} 310b1ed91f3SChris Lattner // @GV = global %T* null 311b1ed91f3SChris Lattner // where T does not exist at all in the destination module. 312b1ed91f3SChris Lattner // 313b1ed91f3SChris Lattner // The other case we watch for is when the type is not in the destination 314b1ed91f3SChris Lattner // module, but that it has to be rebuilt because it refers to something that 315b1ed91f3SChris Lattner // is already mapped. For example, if the destination module has: 316b1ed91f3SChris Lattner // %A = type { i32 } 317b1ed91f3SChris Lattner // and the source module has something like 318b1ed91f3SChris Lattner // %A' = type { i32 } 319b1ed91f3SChris Lattner // %B = type { %A'* } 320b1ed91f3SChris Lattner // @GV = global %B* null 321b1ed91f3SChris Lattner // then we want to create a new type: "%B = type { %A*}" and have it take the 322b1ed91f3SChris Lattner // pristine "%B" name from the source module. 323b1ed91f3SChris Lattner // 324b1ed91f3SChris Lattner // To determine which case this is, we have to recursively walk the type graph 325b1ed91f3SChris Lattner // speculating that we'll be able to reuse it unmodified. Only if this is 326b1ed91f3SChris Lattner // safe would we map the entire thing over. Because this is an optimization, 327b1ed91f3SChris Lattner // and is not required for the prettiness of the linked module, we just skip 328b1ed91f3SChris Lattner // it and always rebuild a type here. 329b1ed91f3SChris Lattner StructType *STy = cast<StructType>(Ty); 330b1ed91f3SChris Lattner 331b1ed91f3SChris Lattner // If the type is opaque, we can just use it directly. 332b1ed91f3SChris Lattner if (STy->isOpaque()) 333b1ed91f3SChris Lattner return *Entry = STy; 334b1ed91f3SChris Lattner 335b1ed91f3SChris Lattner // Otherwise we create a new type and resolve its body later. This will be 336b1ed91f3SChris Lattner // resolved by the top level of get(). 3375e3bd972SChris Lattner SrcDefinitionsToResolve.push_back(STy); 3385e3bd972SChris Lattner StructType *DTy = StructType::create(STy->getContext()); 3395e3bd972SChris Lattner DstResolvedOpaqueTypes.insert(DTy); 3405e3bd972SChris Lattner return *Entry = DTy; 341b1ed91f3SChris Lattner } 342b1ed91f3SChris Lattner 343b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 344b1ed91f3SChris Lattner // ModuleLinker implementation. 345b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 346b1ed91f3SChris Lattner 347b1ed91f3SChris Lattner namespace { 348b1ed91f3SChris Lattner /// ModuleLinker - This is an implementation class for the LinkModules 349b1ed91f3SChris Lattner /// function, which is the entrypoint for this file. 350b1ed91f3SChris Lattner class ModuleLinker { 351b1ed91f3SChris Lattner Module *DstM, *SrcM; 352b1ed91f3SChris Lattner 353b1ed91f3SChris Lattner TypeMapTy TypeMap; 354b1ed91f3SChris Lattner 355b1ed91f3SChris Lattner /// ValueMap - Mapping of values from what they used to be in Src, to what 356b1ed91f3SChris Lattner /// they are now in DstM. ValueToValueMapTy is a ValueMap, which involves 357b1ed91f3SChris Lattner /// some overhead due to the use of Value handles which the Linker doesn't 358b1ed91f3SChris Lattner /// actually need, but this allows us to reuse the ValueMapper code. 359b1ed91f3SChris Lattner ValueToValueMapTy ValueMap; 360b1ed91f3SChris Lattner 361b1ed91f3SChris Lattner struct AppendingVarInfo { 362b1ed91f3SChris Lattner GlobalVariable *NewGV; // New aggregate global in dest module. 363b1ed91f3SChris Lattner Constant *DstInit; // Old initializer from dest module. 364b1ed91f3SChris Lattner Constant *SrcInit; // Old initializer from src module. 365b1ed91f3SChris Lattner }; 366b1ed91f3SChris Lattner 367b1ed91f3SChris Lattner std::vector<AppendingVarInfo> AppendingVars; 368b1ed91f3SChris Lattner 369cbb91408STanya Lattner unsigned Mode; // Mode to treat source module. 370cbb91408STanya Lattner 371cbb91408STanya Lattner // Set of items not to link in from source. 372cbb91408STanya Lattner SmallPtrSet<const Value*, 16> DoNotLinkFromSource; 373cbb91408STanya Lattner 3740a48b877STanya Lattner // Vector of functions to lazily link in. 3750a48b877STanya Lattner std::vector<Function*> LazilyLinkFunctions; 3760a48b877STanya Lattner 377b1ed91f3SChris Lattner public: 378b1ed91f3SChris Lattner std::string ErrorMsg; 379b1ed91f3SChris Lattner 380cbb91408STanya Lattner ModuleLinker(Module *dstM, Module *srcM, unsigned mode) 381cbb91408STanya Lattner : DstM(dstM), SrcM(srcM), Mode(mode) { } 382b1ed91f3SChris Lattner 383b1ed91f3SChris Lattner bool run(); 384b1ed91f3SChris Lattner 385b1ed91f3SChris Lattner private: 386b1ed91f3SChris Lattner /// emitError - Helper method for setting a message and returning an error 387b1ed91f3SChris Lattner /// code. 388b1ed91f3SChris Lattner bool emitError(const Twine &Message) { 389b1ed91f3SChris Lattner ErrorMsg = Message.str(); 390b1ed91f3SChris Lattner return true; 391b1ed91f3SChris Lattner } 392b1ed91f3SChris Lattner 393b1ed91f3SChris Lattner /// getLinkageResult - This analyzes the two global values and determines 394b1ed91f3SChris Lattner /// what the result will look like in the destination module. 395b1ed91f3SChris Lattner bool getLinkageResult(GlobalValue *Dest, const GlobalValue *Src, 39623f8d64bSRafael Espindola GlobalValue::LinkageTypes <, 39723f8d64bSRafael Espindola GlobalValue::VisibilityTypes &Vis, 39823f8d64bSRafael Espindola bool &LinkFromSrc); 399b1ed91f3SChris Lattner 400b1ed91f3SChris Lattner /// getLinkedToGlobal - Given a global in the source module, return the 401b1ed91f3SChris Lattner /// global in the destination module that is being linked to, if any. 402b1ed91f3SChris Lattner GlobalValue *getLinkedToGlobal(GlobalValue *SrcGV) { 403b1ed91f3SChris Lattner // If the source has no name it can't link. If it has local linkage, 404b1ed91f3SChris Lattner // there is no name match-up going on. 405b1ed91f3SChris Lattner if (!SrcGV->hasName() || SrcGV->hasLocalLinkage()) 406b1ed91f3SChris Lattner return 0; 407b1ed91f3SChris Lattner 408b1ed91f3SChris Lattner // Otherwise see if we have a match in the destination module's symtab. 409b1ed91f3SChris Lattner GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName()); 410b1ed91f3SChris Lattner if (DGV == 0) return 0; 411b1ed91f3SChris Lattner 412b1ed91f3SChris Lattner // If we found a global with the same name in the dest module, but it has 413b1ed91f3SChris Lattner // internal linkage, we are really not doing any linkage here. 414b1ed91f3SChris Lattner if (DGV->hasLocalLinkage()) 415b1ed91f3SChris Lattner return 0; 416b1ed91f3SChris Lattner 417b1ed91f3SChris Lattner // Otherwise, we do in fact link to the destination global. 418b1ed91f3SChris Lattner return DGV; 419b1ed91f3SChris Lattner } 420b1ed91f3SChris Lattner 421b1ed91f3SChris Lattner void computeTypeMapping(); 42266f02413SBill Wendling bool categorizeModuleFlagNodes(const NamedMDNode *ModFlags, 42366f02413SBill Wendling DenseMap<MDString*, MDNode*> &ErrorNode, 42466f02413SBill Wendling DenseMap<MDString*, MDNode*> &WarningNode, 42566f02413SBill Wendling DenseMap<MDString*, MDNode*> &OverrideNode, 42666f02413SBill Wendling DenseMap<MDString*, 42766f02413SBill Wendling SmallSetVector<MDNode*, 8> > &RequireNodes, 42866f02413SBill Wendling SmallSetVector<MDString*, 16> &SeenIDs); 429b1ed91f3SChris Lattner 430b1ed91f3SChris Lattner bool linkAppendingVarProto(GlobalVariable *DstGV, GlobalVariable *SrcGV); 431b1ed91f3SChris Lattner bool linkGlobalProto(GlobalVariable *SrcGV); 432b1ed91f3SChris Lattner bool linkFunctionProto(Function *SrcF); 433b1ed91f3SChris Lattner bool linkAliasProto(GlobalAlias *SrcA); 43466f02413SBill Wendling bool linkModuleFlagsMetadata(); 435b1ed91f3SChris Lattner 436b1ed91f3SChris Lattner void linkAppendingVarInit(const AppendingVarInfo &AVI); 437b1ed91f3SChris Lattner void linkGlobalInits(); 438b1ed91f3SChris Lattner void linkFunctionBody(Function *Dst, Function *Src); 439b1ed91f3SChris Lattner void linkAliasBodies(); 440b1ed91f3SChris Lattner void linkNamedMDNodes(); 441eee6f995SChris Lattner }; 442d48b7783SBill Wendling } 443d48b7783SBill Wendling 444b1ed91f3SChris Lattner /// forceRenaming - The LLVM SymbolTable class autorenames globals that conflict 44590246aa7SReid Spencer /// in the symbol table. This is good for all clients except for us. Go 44690246aa7SReid Spencer /// through the trouble to force this back. 447b1ed91f3SChris Lattner static void forceRenaming(GlobalValue *GV, StringRef Name) { 448b1ed91f3SChris Lattner // If the global doesn't force its name or if it already has the right name, 449b1ed91f3SChris Lattner // there is nothing for us to do. 450b1ed91f3SChris Lattner if (GV->hasLocalLinkage() || GV->getName() == Name) 451b1ed91f3SChris Lattner return; 452b1ed91f3SChris Lattner 453b1ed91f3SChris Lattner Module *M = GV->getParent(); 454361e513dSReid Spencer 455361e513dSReid Spencer // If there is a conflict, rename the conflict. 456b1ed91f3SChris Lattner if (GlobalValue *ConflictGV = M->getNamedValue(Name)) { 4572a8d2e0eSChris Lattner GV->takeName(ConflictGV); 458361e513dSReid Spencer ConflictGV->setName(Name); // This will cause ConflictGV to get renamed 459b1ed91f3SChris Lattner assert(ConflictGV->getName() != Name && "forceRenaming didn't work"); 4602a8d2e0eSChris Lattner } else { 4612a8d2e0eSChris Lattner GV->setName(Name); // Force the name back 4623aaaa0b2SReid Spencer } 4633aaaa0b2SReid Spencer } 4643aaaa0b2SReid Spencer 465b6af2f36SBill Wendling /// copyGVAttributes - copy additional attributes (those not needed to construct 4663aaaa0b2SReid Spencer /// a GlobalValue) from the SrcGV to the DestGV. 467b6af2f36SBill Wendling static void copyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) { 468dd7daee8SDuncan Sands // Use the maximum alignment, rather than just copying the alignment of SrcGV. 469dd7daee8SDuncan Sands unsigned Alignment = std::max(DestGV->getAlignment(), SrcGV->getAlignment()); 470dd7daee8SDuncan Sands DestGV->copyAttributesFrom(SrcGV); 471dd7daee8SDuncan Sands DestGV->setAlignment(Alignment); 472b1ed91f3SChris Lattner 473b1ed91f3SChris Lattner forceRenaming(DestGV, SrcGV->getName()); 474361e513dSReid Spencer } 475361e513dSReid Spencer 47623f8d64bSRafael Espindola static bool isLessConstraining(GlobalValue::VisibilityTypes a, 47723f8d64bSRafael Espindola GlobalValue::VisibilityTypes b) { 47823f8d64bSRafael Espindola if (a == GlobalValue::HiddenVisibility) 47923f8d64bSRafael Espindola return false; 48023f8d64bSRafael Espindola if (b == GlobalValue::HiddenVisibility) 48123f8d64bSRafael Espindola return true; 48223f8d64bSRafael Espindola if (a == GlobalValue::ProtectedVisibility) 48323f8d64bSRafael Espindola return false; 48423f8d64bSRafael Espindola if (b == GlobalValue::ProtectedVisibility) 48523f8d64bSRafael Espindola return true; 48623f8d64bSRafael Espindola return false; 48723f8d64bSRafael Espindola } 48823f8d64bSRafael Espindola 489b1ed91f3SChris Lattner /// getLinkageResult - This analyzes the two global values and determines what 490fc61de39SChris Lattner /// the result will look like in the destination module. In particular, it 49123f8d64bSRafael Espindola /// computes the resultant linkage type and visibility, computes whether the 49223f8d64bSRafael Espindola /// global in the source should be copied over to the destination (replacing 49323f8d64bSRafael Espindola /// the existing one), and computes whether this linkage is an error or not. 494b1ed91f3SChris Lattner bool ModuleLinker::getLinkageResult(GlobalValue *Dest, const GlobalValue *Src, 495b1ed91f3SChris Lattner GlobalValue::LinkageTypes <, 49623f8d64bSRafael Espindola GlobalValue::VisibilityTypes &Vis, 497b1ed91f3SChris Lattner bool &LinkFromSrc) { 498b1ed91f3SChris Lattner assert(Dest && "Must have two globals being queried"); 499b1ed91f3SChris Lattner assert(!Src->hasLocalLinkage() && 500fc61de39SChris Lattner "If Src has internal linkage, Dest shouldn't be set!"); 501b1ed91f3SChris Lattner 5028bb15d82SPeter Collingbourne bool SrcIsDeclaration = Src->isDeclaration() && !Src->isMaterializable(); 5030c134b52SChris Lattner bool DestIsDeclaration = Dest->isDeclaration(); 504b1ed91f3SChris Lattner 505b1ed91f3SChris Lattner if (SrcIsDeclaration) { 5061f93c50aSAnton Korobeynikov // If Src is external or if both Src & Dest are external.. Just link the 507fc61de39SChris Lattner // external globals, we aren't adding anything. 508d61d39ecSAnton Korobeynikov if (Src->hasDLLImportLinkage()) { 50912c94949SAnton Korobeynikov // If one of GVs has DLLImport linkage, result should be dllimport'ed. 510b1ed91f3SChris Lattner if (DestIsDeclaration) { 511d61d39ecSAnton Korobeynikov LinkFromSrc = true; 512d61d39ecSAnton Korobeynikov LT = Src->getLinkage(); 513d61d39ecSAnton Korobeynikov } 514e06036d2SAndrew Lenharth } else if (Dest->hasExternalWeakLinkage()) { 51512da8ce3SDuncan Sands // If the Dest is weak, use the source linkage. 516e06036d2SAndrew Lenharth LinkFromSrc = true; 517e06036d2SAndrew Lenharth LT = Src->getLinkage(); 518d61d39ecSAnton Korobeynikov } else { 519fc61de39SChris Lattner LinkFromSrc = false; 520fc61de39SChris Lattner LT = Dest->getLinkage(); 521d61d39ecSAnton Korobeynikov } 522b1ed91f3SChris Lattner } else if (DestIsDeclaration && !Dest->hasDLLImportLinkage()) { 523fc61de39SChris Lattner // If Dest is external but Src is not: 524fc61de39SChris Lattner LinkFromSrc = true; 525fc61de39SChris Lattner LT = Src->getLinkage(); 526d725c991SDuncan Sands } else if (Src->isWeakForLinker()) { 527ce4396bcSDale Johannesen // At this point we know that Dest has LinkOnce, External*, Weak, Common, 528ce4396bcSDale Johannesen // or DLL* linkage. 529184f1be4SChris Lattner if (Dest->hasExternalWeakLinkage() || 530184f1be4SChris Lattner Dest->hasAvailableExternallyLinkage() || 531184f1be4SChris Lattner (Dest->hasLinkOnceLinkage() && 532184f1be4SChris Lattner (Src->hasWeakLinkage() || Src->hasCommonLinkage()))) { 533fc61de39SChris Lattner LinkFromSrc = true; 534fc61de39SChris Lattner LT = Src->getLinkage(); 535fc61de39SChris Lattner } else { 536fc61de39SChris Lattner LinkFromSrc = false; 537fc61de39SChris Lattner LT = Dest->getLinkage(); 538fc61de39SChris Lattner } 539d725c991SDuncan Sands } else if (Dest->isWeakForLinker()) { 54012c94949SAnton Korobeynikov // At this point we know that Src has External* or DLL* linkage. 54112c94949SAnton Korobeynikov if (Src->hasExternalWeakLinkage()) { 54212c94949SAnton Korobeynikov LinkFromSrc = false; 54312c94949SAnton Korobeynikov LT = Dest->getLinkage(); 54412c94949SAnton Korobeynikov } else { 545fc61de39SChris Lattner LinkFromSrc = true; 546fc61de39SChris Lattner LT = GlobalValue::ExternalLinkage; 54712c94949SAnton Korobeynikov } 548fc61de39SChris Lattner } else { 549b1ed91f3SChris Lattner assert((Dest->hasExternalLinkage() || Dest->hasDLLImportLinkage() || 550b1ed91f3SChris Lattner Dest->hasDLLExportLinkage() || Dest->hasExternalWeakLinkage()) && 551b1ed91f3SChris Lattner (Src->hasExternalLinkage() || Src->hasDLLImportLinkage() || 552b1ed91f3SChris Lattner Src->hasDLLExportLinkage() || Src->hasExternalWeakLinkage()) && 553fc61de39SChris Lattner "Unexpected linkage type!"); 554b1ed91f3SChris Lattner return emitError("Linking globals named '" + Src->getName() + 555fc61de39SChris Lattner "': symbol multiply defined!"); 556fc61de39SChris Lattner } 55731fc4f95SAnton Korobeynikov 55823f8d64bSRafael Espindola // Compute the visibility. We follow the rules in the System V Application 55923f8d64bSRafael Espindola // Binary Interface. 56023f8d64bSRafael Espindola Vis = isLessConstraining(Src->getVisibility(), Dest->getVisibility()) ? 56123f8d64bSRafael Espindola Dest->getVisibility() : Src->getVisibility(); 562fc61de39SChris Lattner return false; 563fc61de39SChris Lattner } 564361e513dSReid Spencer 565b1ed91f3SChris Lattner /// computeTypeMapping - Loop over all of the linked values to compute type 566b1ed91f3SChris Lattner /// mappings. For example, if we link "extern Foo *x" and "Foo *x = NULL", then 567b1ed91f3SChris Lattner /// we have two struct types 'Foo' but one got renamed when the module was 568b1ed91f3SChris Lattner /// loaded into the same LLVMContext. 569b1ed91f3SChris Lattner void ModuleLinker::computeTypeMapping() { 570b1ed91f3SChris Lattner // Incorporate globals. 571b1ed91f3SChris Lattner for (Module::global_iterator I = SrcM->global_begin(), 572b1ed91f3SChris Lattner E = SrcM->global_end(); I != E; ++I) { 573b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(I); 574b1ed91f3SChris Lattner if (DGV == 0) continue; 575b1ed91f3SChris Lattner 576b1ed91f3SChris Lattner if (!DGV->hasAppendingLinkage() || !I->hasAppendingLinkage()) { 577b1ed91f3SChris Lattner TypeMap.addTypeMapping(DGV->getType(), I->getType()); 578b1ed91f3SChris Lattner continue; 5795c310be0SDevang Patel } 5805c310be0SDevang Patel 581b1ed91f3SChris Lattner // Unify the element type of appending arrays. 582b1ed91f3SChris Lattner ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType()); 583b1ed91f3SChris Lattner ArrayType *SAT = cast<ArrayType>(I->getType()->getElementType()); 584b1ed91f3SChris Lattner TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType()); 585b1ed91f3SChris Lattner } 58634fc5a0eSChris Lattner 587b1ed91f3SChris Lattner // Incorporate functions. 588b1ed91f3SChris Lattner for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) { 589b1ed91f3SChris Lattner if (GlobalValue *DGV = getLinkedToGlobal(I)) 590b1ed91f3SChris Lattner TypeMap.addTypeMapping(DGV->getType(), I->getType()); 591b1ed91f3SChris Lattner } 592e79f4c77SAnton Korobeynikov 593d48b7783SBill Wendling // Incorporate types by name, scanning all the types in the source module. 594d48b7783SBill Wendling // At this point, the destination module may have a type "%foo = { i32 }" for 5952b3f61afSBill Wendling // example. When the source module got loaded into the same LLVMContext, if 5962b3f61afSBill Wendling // it had the same type, it would have been renamed to "%foo.42 = { i32 }". 5972b3f61afSBill Wendling std::vector<StructType*> SrcStructTypes; 598*32854e27SBill Wendling SrcM->findUsedStructTypes(SrcStructTypes, true); 5992b3f61afSBill Wendling SmallPtrSet<StructType*, 32> SrcStructTypesSet(SrcStructTypes.begin(), 6002b3f61afSBill Wendling SrcStructTypes.end()); 6012b3f61afSBill Wendling 6028737480dSBill Wendling std::vector<StructType*> DstStructTypes; 603*32854e27SBill Wendling DstM->findUsedStructTypes(DstStructTypes, true); 6048737480dSBill Wendling SmallPtrSet<StructType*, 32> DstStructTypesSet(DstStructTypes.begin(), 6058737480dSBill Wendling DstStructTypes.end()); 6068737480dSBill Wendling 6072b3f61afSBill Wendling for (unsigned i = 0, e = SrcStructTypes.size(); i != e; ++i) { 6082b3f61afSBill Wendling StructType *ST = SrcStructTypes[i]; 6092b3f61afSBill Wendling if (!ST->hasName()) continue; 6102b3f61afSBill Wendling 6112b3f61afSBill Wendling // Check to see if there is a dot in the name followed by a digit. 612d48b7783SBill Wendling size_t DotPos = ST->getName().rfind('.'); 613d48b7783SBill Wendling if (DotPos == 0 || DotPos == StringRef::npos || 614d48b7783SBill Wendling ST->getName().back() == '.' || !isdigit(ST->getName()[DotPos+1])) 615d48b7783SBill Wendling continue; 6162b3f61afSBill Wendling 6172b3f61afSBill Wendling // Check to see if the destination module has a struct with the prefix name. 618d48b7783SBill Wendling if (StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos))) 6192b3f61afSBill Wendling // Don't use it if this actually came from the source module. They're in 6208737480dSBill Wendling // the same LLVMContext after all. Also don't use it unless the type is 6218737480dSBill Wendling // actually used in the destination module. This can happen in situations 6228737480dSBill Wendling // like this: 6238737480dSBill Wendling // 6248737480dSBill Wendling // Module A Module B 6258737480dSBill Wendling // -------- -------- 6268737480dSBill Wendling // %Z = type { %A } %B = type { %C.1 } 6278737480dSBill Wendling // %A = type { %B.1, [7 x i8] } %C.1 = type { i8* } 6288737480dSBill Wendling // %B.1 = type { %C } %A.2 = type { %B.3, [5 x i8] } 6298737480dSBill Wendling // %C = type { i8* } %B.3 = type { %C.1 } 6308737480dSBill Wendling // 6318737480dSBill Wendling // When we link Module B with Module A, the '%B' in Module B is 6328737480dSBill Wendling // used. However, that would then use '%C.1'. But when we process '%C.1', 6338737480dSBill Wendling // we prefer to take the '%C' version. So we are then left with both 6348737480dSBill Wendling // '%C.1' and '%C' being used for the same types. This leads to some 6358737480dSBill Wendling // variables using one type and some using the other. 6368737480dSBill Wendling if (!SrcStructTypesSet.count(DST) && DstStructTypesSet.count(DST)) 6372b3f61afSBill Wendling TypeMap.addTypeMapping(DST, ST); 6382b3f61afSBill Wendling } 6392b3f61afSBill Wendling 640b1ed91f3SChris Lattner // Don't bother incorporating aliases, they aren't generally typed well. 641361e513dSReid Spencer 642b1ed91f3SChris Lattner // Now that we have discovered all of the type equivalences, get a body for 643b1ed91f3SChris Lattner // any 'opaque' types in the dest module that are now resolved. 644b1ed91f3SChris Lattner TypeMap.linkDefinedTypeBodies(); 645b1ed91f3SChris Lattner } 646c08e7a00SChris Lattner 647b1ed91f3SChris Lattner /// linkAppendingVarProto - If there were any appending global variables, link 648b1ed91f3SChris Lattner /// them together now. Return true on error. 649b1ed91f3SChris Lattner bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV, 650b1ed91f3SChris Lattner GlobalVariable *SrcGV) { 651d48b7783SBill Wendling 652b1ed91f3SChris Lattner if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage()) 653b1ed91f3SChris Lattner return emitError("Linking globals named '" + SrcGV->getName() + 654b1ed91f3SChris Lattner "': can only link appending global with another appending global!"); 655361e513dSReid Spencer 656b1ed91f3SChris Lattner ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType()); 657b1ed91f3SChris Lattner ArrayType *SrcTy = 658b1ed91f3SChris Lattner cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType())); 659b1ed91f3SChris Lattner Type *EltTy = DstTy->getElementType(); 660b1ed91f3SChris Lattner 661b1ed91f3SChris Lattner // Check to see that they two arrays agree on type. 662b1ed91f3SChris Lattner if (EltTy != SrcTy->getElementType()) 663b1ed91f3SChris Lattner return emitError("Appending variables with different element types!"); 664b1ed91f3SChris Lattner if (DstGV->isConstant() != SrcGV->isConstant()) 665b1ed91f3SChris Lattner return emitError("Appending variables linked with different const'ness!"); 666b1ed91f3SChris Lattner 667b1ed91f3SChris Lattner if (DstGV->getAlignment() != SrcGV->getAlignment()) 668b1ed91f3SChris Lattner return emitError( 669b1ed91f3SChris Lattner "Appending variables with different alignment need to be linked!"); 670b1ed91f3SChris Lattner 671b1ed91f3SChris Lattner if (DstGV->getVisibility() != SrcGV->getVisibility()) 672b1ed91f3SChris Lattner return emitError( 673b1ed91f3SChris Lattner "Appending variables with different visibility need to be linked!"); 674b1ed91f3SChris Lattner 675b1ed91f3SChris Lattner if (DstGV->getSection() != SrcGV->getSection()) 676b1ed91f3SChris Lattner return emitError( 677b1ed91f3SChris Lattner "Appending variables with different section name need to be linked!"); 678b1ed91f3SChris Lattner 679b1ed91f3SChris Lattner uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements(); 680b1ed91f3SChris Lattner ArrayType *NewType = ArrayType::get(EltTy, NewSize); 681b1ed91f3SChris Lattner 682b1ed91f3SChris Lattner // Create the new global variable. 683b1ed91f3SChris Lattner GlobalVariable *NG = 684b1ed91f3SChris Lattner new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(), 685b1ed91f3SChris Lattner DstGV->getLinkage(), /*init*/0, /*name*/"", DstGV, 686b1ed91f3SChris Lattner DstGV->isThreadLocal(), 687b1ed91f3SChris Lattner DstGV->getType()->getAddressSpace()); 688b1ed91f3SChris Lattner 689b1ed91f3SChris Lattner // Propagate alignment, visibility and section info. 690b6af2f36SBill Wendling copyGVAttributes(NG, DstGV); 691b1ed91f3SChris Lattner 692b1ed91f3SChris Lattner AppendingVarInfo AVI; 693b1ed91f3SChris Lattner AVI.NewGV = NG; 694b1ed91f3SChris Lattner AVI.DstInit = DstGV->getInitializer(); 695b1ed91f3SChris Lattner AVI.SrcInit = SrcGV->getInitializer(); 696b1ed91f3SChris Lattner AppendingVars.push_back(AVI); 697b1ed91f3SChris Lattner 698b1ed91f3SChris Lattner // Replace any uses of the two global variables with uses of the new 699b1ed91f3SChris Lattner // global. 700b1ed91f3SChris Lattner ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType())); 701b1ed91f3SChris Lattner 702b1ed91f3SChris Lattner DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType())); 703b1ed91f3SChris Lattner DstGV->eraseFromParent(); 704b1ed91f3SChris Lattner 705cbb91408STanya Lattner // Track the source variable so we don't try to link it. 706cbb91408STanya Lattner DoNotLinkFromSource.insert(SrcGV); 707cbb91408STanya Lattner 708b1ed91f3SChris Lattner return false; 709b1ed91f3SChris Lattner } 710b1ed91f3SChris Lattner 711b1ed91f3SChris Lattner /// linkGlobalProto - Loop through the global variables in the src module and 712b1ed91f3SChris Lattner /// merge them into the dest module. 713b1ed91f3SChris Lattner bool ModuleLinker::linkGlobalProto(GlobalVariable *SGV) { 714b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(SGV); 71523f8d64bSRafael Espindola llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 716b1ed91f3SChris Lattner 717b1ed91f3SChris Lattner if (DGV) { 718b1ed91f3SChris Lattner // Concatenation of appending linkage variables is magic and handled later. 719b1ed91f3SChris Lattner if (DGV->hasAppendingLinkage() || SGV->hasAppendingLinkage()) 720b1ed91f3SChris Lattner return linkAppendingVarProto(cast<GlobalVariable>(DGV), SGV); 721b1ed91f3SChris Lattner 722b1ed91f3SChris Lattner // Determine whether linkage of these two globals follows the source 723b1ed91f3SChris Lattner // module's definition or the destination module's definition. 7241b9633d7SChris Lattner GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 72523f8d64bSRafael Espindola GlobalValue::VisibilityTypes NV; 7261b9633d7SChris Lattner bool LinkFromSrc = false; 72723f8d64bSRafael Espindola if (getLinkageResult(DGV, SGV, NewLinkage, NV, LinkFromSrc)) 728fc61de39SChris Lattner return true; 72923f8d64bSRafael Espindola NewVisibility = NV; 730361e513dSReid Spencer 731b1ed91f3SChris Lattner // If we're not linking from the source, then keep the definition that we 732b1ed91f3SChris Lattner // have. 733b1ed91f3SChris Lattner if (!LinkFromSrc) { 73434fc5a0eSChris Lattner // Special case for const propagation. 73534fc5a0eSChris Lattner if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV)) 73634fc5a0eSChris Lattner if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant()) 73734fc5a0eSChris Lattner DGVar->setConstant(true); 73834fc5a0eSChris Lattner 73923f8d64bSRafael Espindola // Set calculated linkage and visibility. 74034fc5a0eSChris Lattner DGV->setLinkage(NewLinkage); 74123f8d64bSRafael Espindola DGV->setVisibility(*NewVisibility); 74234fc5a0eSChris Lattner 743b1ed91f3SChris Lattner // Make sure to remember this mapping. 744b1ed91f3SChris Lattner ValueMap[SGV] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGV->getType())); 745b1ed91f3SChris Lattner 746cbb91408STanya Lattner // Track the source global so that we don't attempt to copy it over when 747cbb91408STanya Lattner // processing global initializers. 748cbb91408STanya Lattner DoNotLinkFromSource.insert(SGV); 749cbb91408STanya Lattner 750b1ed91f3SChris Lattner return false; 751361e513dSReid Spencer } 752b1ed91f3SChris Lattner } 753b1ed91f3SChris Lattner 754b1ed91f3SChris Lattner // No linking to be performed or linking from the source: simply create an 755b1ed91f3SChris Lattner // identical version of the symbol over in the dest module... the 756b1ed91f3SChris Lattner // initializer will be filled in later by LinkGlobalInits. 757b1ed91f3SChris Lattner GlobalVariable *NewDGV = 758b1ed91f3SChris Lattner new GlobalVariable(*DstM, TypeMap.get(SGV->getType()->getElementType()), 759b1ed91f3SChris Lattner SGV->isConstant(), SGV->getLinkage(), /*init*/0, 760b1ed91f3SChris Lattner SGV->getName(), /*insertbefore*/0, 761b1ed91f3SChris Lattner SGV->isThreadLocal(), 762b1ed91f3SChris Lattner SGV->getType()->getAddressSpace()); 763b1ed91f3SChris Lattner // Propagate alignment, visibility and section info. 764b6af2f36SBill Wendling copyGVAttributes(NewDGV, SGV); 76523f8d64bSRafael Espindola if (NewVisibility) 76623f8d64bSRafael Espindola NewDGV->setVisibility(*NewVisibility); 767b1ed91f3SChris Lattner 768b1ed91f3SChris Lattner if (DGV) { 769b1ed91f3SChris Lattner DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDGV, DGV->getType())); 770b1ed91f3SChris Lattner DGV->eraseFromParent(); 771b1ed91f3SChris Lattner } 772b1ed91f3SChris Lattner 773b1ed91f3SChris Lattner // Make sure to remember this mapping. 774b1ed91f3SChris Lattner ValueMap[SGV] = NewDGV; 775361e513dSReid Spencer return false; 776361e513dSReid Spencer } 777361e513dSReid Spencer 778b1ed91f3SChris Lattner /// linkFunctionProto - Link the function in the source module into the 779b1ed91f3SChris Lattner /// destination module if needed, setting up mapping information. 780b1ed91f3SChris Lattner bool ModuleLinker::linkFunctionProto(Function *SF) { 781b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(SF); 78223f8d64bSRafael Espindola llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 783dac5fa94SAnton Korobeynikov 784b1ed91f3SChris Lattner if (DGV) { 7850ead7a50SChris Lattner GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 7860ead7a50SChris Lattner bool LinkFromSrc = false; 78723f8d64bSRafael Espindola GlobalValue::VisibilityTypes NV; 78823f8d64bSRafael Espindola if (getLinkageResult(DGV, SF, NewLinkage, NV, LinkFromSrc)) 7890ead7a50SChris Lattner return true; 79023f8d64bSRafael Espindola NewVisibility = NV; 7910ead7a50SChris Lattner 792b1ed91f3SChris Lattner if (!LinkFromSrc) { 7930ead7a50SChris Lattner // Set calculated linkage 7940ead7a50SChris Lattner DGV->setLinkage(NewLinkage); 79523f8d64bSRafael Espindola DGV->setVisibility(*NewVisibility); 79677e8ac4dSChris Lattner 7970ead7a50SChris Lattner // Make sure to remember this mapping. 798b1ed91f3SChris Lattner ValueMap[SF] = ConstantExpr::getBitCast(DGV, TypeMap.get(SF->getType())); 799b1ed91f3SChris Lattner 800cbb91408STanya Lattner // Track the function from the source module so we don't attempt to remap 801cbb91408STanya Lattner // it. 802cbb91408STanya Lattner DoNotLinkFromSource.insert(SF); 803cbb91408STanya Lattner 804b1ed91f3SChris Lattner return false; 805361e513dSReid Spencer } 806b1ed91f3SChris Lattner } 807b1ed91f3SChris Lattner 808b1ed91f3SChris Lattner // If there is no linkage to be performed or we are linking from the source, 809b1ed91f3SChris Lattner // bring SF over. 810b1ed91f3SChris Lattner Function *NewDF = Function::Create(TypeMap.get(SF->getFunctionType()), 811b1ed91f3SChris Lattner SF->getLinkage(), SF->getName(), DstM); 812b6af2f36SBill Wendling copyGVAttributes(NewDF, SF); 81323f8d64bSRafael Espindola if (NewVisibility) 81423f8d64bSRafael Espindola NewDF->setVisibility(*NewVisibility); 815b1ed91f3SChris Lattner 816b1ed91f3SChris Lattner if (DGV) { 817b1ed91f3SChris Lattner // Any uses of DF need to change to NewDF, with cast. 818b1ed91f3SChris Lattner DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDF, DGV->getType())); 819b1ed91f3SChris Lattner DGV->eraseFromParent(); 8200a48b877STanya Lattner } else { 8210a48b877STanya Lattner // Internal, LO_ODR, or LO linkage - stick in set to ignore and lazily link. 8220a48b877STanya Lattner if (SF->hasLocalLinkage() || SF->hasLinkOnceLinkage() || 8230a48b877STanya Lattner SF->hasAvailableExternallyLinkage()) { 8240a48b877STanya Lattner DoNotLinkFromSource.insert(SF); 8250a48b877STanya Lattner LazilyLinkFunctions.push_back(SF); 8260a48b877STanya Lattner } 827b1ed91f3SChris Lattner } 828b1ed91f3SChris Lattner 829b1ed91f3SChris Lattner ValueMap[SF] = NewDF; 830361e513dSReid Spencer return false; 831361e513dSReid Spencer } 832361e513dSReid Spencer 833b1ed91f3SChris Lattner /// LinkAliasProto - Set up prototypes for any aliases that come over from the 834b1ed91f3SChris Lattner /// source module. 835b1ed91f3SChris Lattner bool ModuleLinker::linkAliasProto(GlobalAlias *SGA) { 836b1ed91f3SChris Lattner GlobalValue *DGV = getLinkedToGlobal(SGA); 83723f8d64bSRafael Espindola llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 838b1ed91f3SChris Lattner 839b1ed91f3SChris Lattner if (DGV) { 840b1ed91f3SChris Lattner GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 84123f8d64bSRafael Espindola GlobalValue::VisibilityTypes NV; 842b1ed91f3SChris Lattner bool LinkFromSrc = false; 84323f8d64bSRafael Espindola if (getLinkageResult(DGV, SGA, NewLinkage, NV, LinkFromSrc)) 844b1ed91f3SChris Lattner return true; 84523f8d64bSRafael Espindola NewVisibility = NV; 846b1ed91f3SChris Lattner 847b1ed91f3SChris Lattner if (!LinkFromSrc) { 848b1ed91f3SChris Lattner // Set calculated linkage. 849b1ed91f3SChris Lattner DGV->setLinkage(NewLinkage); 85023f8d64bSRafael Espindola DGV->setVisibility(*NewVisibility); 851b1ed91f3SChris Lattner 852b1ed91f3SChris Lattner // Make sure to remember this mapping. 853b1ed91f3SChris Lattner ValueMap[SGA] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGA->getType())); 854b1ed91f3SChris Lattner 855cbb91408STanya Lattner // Track the alias from the source module so we don't attempt to remap it. 856cbb91408STanya Lattner DoNotLinkFromSource.insert(SGA); 857cbb91408STanya Lattner 858b1ed91f3SChris Lattner return false; 859b1ed91f3SChris Lattner } 860b1ed91f3SChris Lattner } 861b1ed91f3SChris Lattner 862b1ed91f3SChris Lattner // If there is no linkage to be performed or we're linking from the source, 863b1ed91f3SChris Lattner // bring over SGA. 864b1ed91f3SChris Lattner GlobalAlias *NewDA = new GlobalAlias(TypeMap.get(SGA->getType()), 865b1ed91f3SChris Lattner SGA->getLinkage(), SGA->getName(), 866b1ed91f3SChris Lattner /*aliasee*/0, DstM); 867b6af2f36SBill Wendling copyGVAttributes(NewDA, SGA); 86823f8d64bSRafael Espindola if (NewVisibility) 86923f8d64bSRafael Espindola NewDA->setVisibility(*NewVisibility); 870b1ed91f3SChris Lattner 871b1ed91f3SChris Lattner if (DGV) { 872b1ed91f3SChris Lattner // Any uses of DGV need to change to NewDA, with cast. 873b1ed91f3SChris Lattner DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDA, DGV->getType())); 874b1ed91f3SChris Lattner DGV->eraseFromParent(); 875b1ed91f3SChris Lattner } 876b1ed91f3SChris Lattner 877b1ed91f3SChris Lattner ValueMap[SGA] = NewDA; 878b1ed91f3SChris Lattner return false; 879b1ed91f3SChris Lattner } 880b1ed91f3SChris Lattner 88100245f42SChris Lattner static void getArrayElements(Constant *C, SmallVectorImpl<Constant*> &Dest) { 8826705883aSChris Lattner unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements(); 88300245f42SChris Lattner 8846705883aSChris Lattner for (unsigned i = 0; i != NumElements; ++i) 8856705883aSChris Lattner Dest.push_back(C->getAggregateElement(i)); 88600245f42SChris Lattner } 88700245f42SChris Lattner 888b1ed91f3SChris Lattner void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) { 889b1ed91f3SChris Lattner // Merge the initializer. 890b1ed91f3SChris Lattner SmallVector<Constant*, 16> Elements; 89100245f42SChris Lattner getArrayElements(AVI.DstInit, Elements); 892b1ed91f3SChris Lattner 893b1ed91f3SChris Lattner Constant *SrcInit = MapValue(AVI.SrcInit, ValueMap, RF_None, &TypeMap); 89400245f42SChris Lattner getArrayElements(SrcInit, Elements); 89500245f42SChris Lattner 896b1ed91f3SChris Lattner ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType()); 897b1ed91f3SChris Lattner AVI.NewGV->setInitializer(ConstantArray::get(NewType, Elements)); 898b1ed91f3SChris Lattner } 899b1ed91f3SChris Lattner 900b6af2f36SBill Wendling /// linkGlobalInits - Update the initializers in the Dest module now that all 901b6af2f36SBill Wendling /// globals that may be referenced are in Dest. 902b1ed91f3SChris Lattner void ModuleLinker::linkGlobalInits() { 903b1ed91f3SChris Lattner // Loop over all of the globals in the src module, mapping them over as we go 904b1ed91f3SChris Lattner for (Module::const_global_iterator I = SrcM->global_begin(), 905b1ed91f3SChris Lattner E = SrcM->global_end(); I != E; ++I) { 906cbb91408STanya Lattner 907cbb91408STanya Lattner // Only process initialized GV's or ones not already in dest. 908cbb91408STanya Lattner if (!I->hasInitializer() || DoNotLinkFromSource.count(I)) continue; 909b1ed91f3SChris Lattner 910b1ed91f3SChris Lattner // Grab destination global variable. 911b1ed91f3SChris Lattner GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[I]); 912b1ed91f3SChris Lattner // Figure out what the initializer looks like in the dest module. 913b1ed91f3SChris Lattner DGV->setInitializer(MapValue(I->getInitializer(), ValueMap, 914b1ed91f3SChris Lattner RF_None, &TypeMap)); 915b1ed91f3SChris Lattner } 916b1ed91f3SChris Lattner } 917b1ed91f3SChris Lattner 918b6af2f36SBill Wendling /// linkFunctionBody - Copy the source function over into the dest function and 919b6af2f36SBill Wendling /// fix up references to values. At this point we know that Dest is an external 920b6af2f36SBill Wendling /// function, and that Src is not. 921b1ed91f3SChris Lattner void ModuleLinker::linkFunctionBody(Function *Dst, Function *Src) { 922b1ed91f3SChris Lattner assert(Src && Dst && Dst->isDeclaration() && !Src->isDeclaration()); 923361e513dSReid Spencer 9247391dde1SChris Lattner // Go through and convert function arguments over, remembering the mapping. 925b1ed91f3SChris Lattner Function::arg_iterator DI = Dst->arg_begin(); 926531f9e92SChris Lattner for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end(); 927361e513dSReid Spencer I != E; ++I, ++DI) { 928b1ed91f3SChris Lattner DI->setName(I->getName()); // Copy the name over. 929361e513dSReid Spencer 930b1ed91f3SChris Lattner // Add a mapping to our mapping. 93166a6271cSAnton Korobeynikov ValueMap[I] = DI; 932361e513dSReid Spencer } 933361e513dSReid Spencer 934cbb91408STanya Lattner if (Mode == Linker::DestroySource) { 9352f0557d0SChris Lattner // Splice the body of the source function into the dest function. 936b1ed91f3SChris Lattner Dst->getBasicBlockList().splice(Dst->end(), Src->getBasicBlockList()); 937361e513dSReid Spencer 938361e513dSReid Spencer // At this point, all of the instructions and values of the function are now 939361e513dSReid Spencer // copied over. The only problem is that they are still referencing values in 940361e513dSReid Spencer // the Source function as operands. Loop through all of the operands of the 94143f8d164SChris Lattner // functions and patch them up to point to the local versions. 942b1ed91f3SChris Lattner for (Function::iterator BB = Dst->begin(), BE = Dst->end(); BB != BE; ++BB) 94343f8d164SChris Lattner for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) 944b1ed91f3SChris Lattner RemapInstruction(I, ValueMap, RF_IgnoreMissingEntries, &TypeMap); 9457391dde1SChris Lattner 946cbb91408STanya Lattner } else { 947cbb91408STanya Lattner // Clone the body of the function into the dest function. 948cbb91408STanya Lattner SmallVector<ReturnInst*, 8> Returns; // Ignore returns. 9495d44a433SMon P Wang CloneFunctionInto(Dst, Src, ValueMap, false, Returns, "", NULL, &TypeMap); 950cbb91408STanya Lattner } 951cbb91408STanya Lattner 9527391dde1SChris Lattner // There is no need to map the arguments anymore. 95344ab8aefSChris Lattner for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end(); 95444ab8aefSChris Lattner I != E; ++I) 9553aaaa0b2SReid Spencer ValueMap.erase(I); 956cbb91408STanya Lattner 957361e513dSReid Spencer } 958361e513dSReid Spencer 959b6af2f36SBill Wendling /// linkAliasBodies - Insert all of the aliases in Src into the Dest module. 960b1ed91f3SChris Lattner void ModuleLinker::linkAliasBodies() { 961b1ed91f3SChris Lattner for (Module::alias_iterator I = SrcM->alias_begin(), E = SrcM->alias_end(); 962cbb91408STanya Lattner I != E; ++I) { 963cbb91408STanya Lattner if (DoNotLinkFromSource.count(I)) 964cbb91408STanya Lattner continue; 965b1ed91f3SChris Lattner if (Constant *Aliasee = I->getAliasee()) { 966b1ed91f3SChris Lattner GlobalAlias *DA = cast<GlobalAlias>(ValueMap[I]); 967b1ed91f3SChris Lattner DA->setAliasee(MapValue(Aliasee, ValueMap, RF_None, &TypeMap)); 9682c4a34aeSDavid Chisnall } 969b1ed91f3SChris Lattner } 970cbb91408STanya Lattner } 971b1ed91f3SChris Lattner 972b6af2f36SBill Wendling /// linkNamedMDNodes - Insert all of the named MDNodes in Src into the Dest 973b1ed91f3SChris Lattner /// module. 974b1ed91f3SChris Lattner void ModuleLinker::linkNamedMDNodes() { 97566f02413SBill Wendling const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata(); 976b1ed91f3SChris Lattner for (Module::const_named_metadata_iterator I = SrcM->named_metadata_begin(), 977b1ed91f3SChris Lattner E = SrcM->named_metadata_end(); I != E; ++I) { 97866f02413SBill Wendling // Don't link module flags here. Do them separately. 97966f02413SBill Wendling if (&*I == SrcModFlags) continue; 980b1ed91f3SChris Lattner NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(I->getName()); 981b1ed91f3SChris Lattner // Add Src elements into Dest node. 982b1ed91f3SChris Lattner for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) 983b1ed91f3SChris Lattner DestNMD->addOperand(MapValue(I->getOperand(i), ValueMap, 984b1ed91f3SChris Lattner RF_None, &TypeMap)); 985b1ed91f3SChris Lattner } 986b1ed91f3SChris Lattner } 987b1ed91f3SChris Lattner 988b6af2f36SBill Wendling /// categorizeModuleFlagNodes - Categorize the module flags according to their 989b6af2f36SBill Wendling /// type: Error, Warning, Override, and Require. 99066f02413SBill Wendling bool ModuleLinker:: 99166f02413SBill Wendling categorizeModuleFlagNodes(const NamedMDNode *ModFlags, 99266f02413SBill Wendling DenseMap<MDString*, MDNode*> &ErrorNode, 99366f02413SBill Wendling DenseMap<MDString*, MDNode*> &WarningNode, 99466f02413SBill Wendling DenseMap<MDString*, MDNode*> &OverrideNode, 99566f02413SBill Wendling DenseMap<MDString*, 99666f02413SBill Wendling SmallSetVector<MDNode*, 8> > &RequireNodes, 99766f02413SBill Wendling SmallSetVector<MDString*, 16> &SeenIDs) { 99866f02413SBill Wendling bool HasErr = false; 99966f02413SBill Wendling 100066f02413SBill Wendling for (unsigned I = 0, E = ModFlags->getNumOperands(); I != E; ++I) { 100166f02413SBill Wendling MDNode *Op = ModFlags->getOperand(I); 100266f02413SBill Wendling assert(Op->getNumOperands() == 3 && "Invalid module flag metadata!"); 100366f02413SBill Wendling assert(isa<ConstantInt>(Op->getOperand(0)) && 100466f02413SBill Wendling "Module flag's first operand must be an integer!"); 100566f02413SBill Wendling assert(isa<MDString>(Op->getOperand(1)) && 100666f02413SBill Wendling "Module flag's second operand must be an MDString!"); 100766f02413SBill Wendling 100866f02413SBill Wendling ConstantInt *Behavior = cast<ConstantInt>(Op->getOperand(0)); 100966f02413SBill Wendling MDString *ID = cast<MDString>(Op->getOperand(1)); 101066f02413SBill Wendling Value *Val = Op->getOperand(2); 101166f02413SBill Wendling switch (Behavior->getZExtValue()) { 101266f02413SBill Wendling default: 101366f02413SBill Wendling assert(false && "Invalid behavior in module flag metadata!"); 101466f02413SBill Wendling break; 101566f02413SBill Wendling case Module::Error: { 101666f02413SBill Wendling MDNode *&ErrNode = ErrorNode[ID]; 101766f02413SBill Wendling if (!ErrNode) ErrNode = Op; 101866f02413SBill Wendling if (ErrNode->getOperand(2) != Val) 10199273b539SBill Wendling HasErr = emitError("linking module flags '" + ID->getString() + 10209273b539SBill Wendling "': IDs have conflicting values"); 102166f02413SBill Wendling break; 102266f02413SBill Wendling } 102366f02413SBill Wendling case Module::Warning: { 102466f02413SBill Wendling MDNode *&WarnNode = WarningNode[ID]; 102566f02413SBill Wendling if (!WarnNode) WarnNode = Op; 102666f02413SBill Wendling if (WarnNode->getOperand(2) != Val) 10279273b539SBill Wendling errs() << "WARNING: linking module flags '" << ID->getString() 10289273b539SBill Wendling << "': IDs have conflicting values"; 102966f02413SBill Wendling break; 103066f02413SBill Wendling } 103166f02413SBill Wendling case Module::Require: RequireNodes[ID].insert(Op); break; 103266f02413SBill Wendling case Module::Override: { 103366f02413SBill Wendling MDNode *&OvrNode = OverrideNode[ID]; 103466f02413SBill Wendling if (!OvrNode) OvrNode = Op; 103566f02413SBill Wendling if (OvrNode->getOperand(2) != Val) 10369273b539SBill Wendling HasErr = emitError("linking module flags '" + ID->getString() + 10379273b539SBill Wendling "': IDs have conflicting override values"); 103866f02413SBill Wendling break; 103966f02413SBill Wendling } 104066f02413SBill Wendling } 104166f02413SBill Wendling 104266f02413SBill Wendling SeenIDs.insert(ID); 104366f02413SBill Wendling } 104466f02413SBill Wendling 104566f02413SBill Wendling return HasErr; 104666f02413SBill Wendling } 104766f02413SBill Wendling 104866f02413SBill Wendling /// linkModuleFlagsMetadata - Merge the linker flags in Src into the Dest 104966f02413SBill Wendling /// module. 105066f02413SBill Wendling bool ModuleLinker::linkModuleFlagsMetadata() { 105166f02413SBill Wendling const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata(); 105266f02413SBill Wendling if (!SrcModFlags) return false; 105366f02413SBill Wendling 105466f02413SBill Wendling NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata(); 105566f02413SBill Wendling 105666f02413SBill Wendling // If the destination module doesn't have module flags yet, then just copy 105766f02413SBill Wendling // over the source module's flags. 105866f02413SBill Wendling if (DstModFlags->getNumOperands() == 0) { 105966f02413SBill Wendling for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) 106066f02413SBill Wendling DstModFlags->addOperand(SrcModFlags->getOperand(I)); 106166f02413SBill Wendling 106266f02413SBill Wendling return false; 106366f02413SBill Wendling } 106466f02413SBill Wendling 106566f02413SBill Wendling bool HasErr = false; 106666f02413SBill Wendling 106766f02413SBill Wendling // Otherwise, we have to merge them based on their behaviors. First, 106866f02413SBill Wendling // categorize all of the nodes in the modules' module flags. If an error or 106966f02413SBill Wendling // warning occurs, then emit the appropriate message(s). 107066f02413SBill Wendling DenseMap<MDString*, MDNode*> ErrorNode; 107166f02413SBill Wendling DenseMap<MDString*, MDNode*> WarningNode; 107266f02413SBill Wendling DenseMap<MDString*, MDNode*> OverrideNode; 107366f02413SBill Wendling DenseMap<MDString*, SmallSetVector<MDNode*, 8> > RequireNodes; 107466f02413SBill Wendling SmallSetVector<MDString*, 16> SeenIDs; 107566f02413SBill Wendling 107666f02413SBill Wendling HasErr |= categorizeModuleFlagNodes(SrcModFlags, ErrorNode, WarningNode, 107766f02413SBill Wendling OverrideNode, RequireNodes, SeenIDs); 107866f02413SBill Wendling HasErr |= categorizeModuleFlagNodes(DstModFlags, ErrorNode, WarningNode, 107966f02413SBill Wendling OverrideNode, RequireNodes, SeenIDs); 108066f02413SBill Wendling 108166f02413SBill Wendling // Check that there isn't both an error and warning node for a flag. 108266f02413SBill Wendling for (SmallSetVector<MDString*, 16>::iterator 108366f02413SBill Wendling I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) { 108466f02413SBill Wendling MDString *ID = *I; 108566f02413SBill Wendling if (ErrorNode[ID] && WarningNode[ID]) 10869273b539SBill Wendling HasErr = emitError("linking module flags '" + ID->getString() + 108766f02413SBill Wendling "': IDs have conflicting behaviors"); 108866f02413SBill Wendling } 108966f02413SBill Wendling 109066f02413SBill Wendling // Early exit if we had an error. 109166f02413SBill Wendling if (HasErr) return true; 109266f02413SBill Wendling 109366f02413SBill Wendling // Get the destination's module flags ready for new operands. 109466f02413SBill Wendling DstModFlags->dropAllReferences(); 109566f02413SBill Wendling 109666f02413SBill Wendling // Add all of the module flags to the destination module. 109766f02413SBill Wendling DenseMap<MDString*, SmallVector<MDNode*, 4> > AddedNodes; 109866f02413SBill Wendling for (SmallSetVector<MDString*, 16>::iterator 109966f02413SBill Wendling I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) { 110066f02413SBill Wendling MDString *ID = *I; 110166f02413SBill Wendling if (OverrideNode[ID]) { 110266f02413SBill Wendling DstModFlags->addOperand(OverrideNode[ID]); 110366f02413SBill Wendling AddedNodes[ID].push_back(OverrideNode[ID]); 110466f02413SBill Wendling } else if (ErrorNode[ID]) { 110566f02413SBill Wendling DstModFlags->addOperand(ErrorNode[ID]); 110666f02413SBill Wendling AddedNodes[ID].push_back(ErrorNode[ID]); 110766f02413SBill Wendling } else if (WarningNode[ID]) { 110866f02413SBill Wendling DstModFlags->addOperand(WarningNode[ID]); 110966f02413SBill Wendling AddedNodes[ID].push_back(WarningNode[ID]); 111066f02413SBill Wendling } 111166f02413SBill Wendling 111266f02413SBill Wendling for (SmallSetVector<MDNode*, 8>::iterator 111366f02413SBill Wendling II = RequireNodes[ID].begin(), IE = RequireNodes[ID].end(); 111466f02413SBill Wendling II != IE; ++II) 111566f02413SBill Wendling DstModFlags->addOperand(*II); 111666f02413SBill Wendling } 111766f02413SBill Wendling 111866f02413SBill Wendling // Now check that all of the requirements have been satisfied. 111966f02413SBill Wendling for (SmallSetVector<MDString*, 16>::iterator 112066f02413SBill Wendling I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) { 112166f02413SBill Wendling MDString *ID = *I; 112266f02413SBill Wendling SmallSetVector<MDNode*, 8> &Set = RequireNodes[ID]; 112366f02413SBill Wendling 112466f02413SBill Wendling for (SmallSetVector<MDNode*, 8>::iterator 112566f02413SBill Wendling II = Set.begin(), IE = Set.end(); II != IE; ++II) { 112666f02413SBill Wendling MDNode *Node = *II; 112766f02413SBill Wendling assert(isa<MDNode>(Node->getOperand(2)) && 112866f02413SBill Wendling "Module flag's third operand must be an MDNode!"); 112966f02413SBill Wendling MDNode *Val = cast<MDNode>(Node->getOperand(2)); 113066f02413SBill Wendling 113166f02413SBill Wendling MDString *ReqID = cast<MDString>(Val->getOperand(0)); 113266f02413SBill Wendling Value *ReqVal = Val->getOperand(1); 113366f02413SBill Wendling 113466f02413SBill Wendling bool HasValue = false; 113566f02413SBill Wendling for (SmallVectorImpl<MDNode*>::iterator 113666f02413SBill Wendling RI = AddedNodes[ReqID].begin(), RE = AddedNodes[ReqID].end(); 113766f02413SBill Wendling RI != RE; ++RI) { 113866f02413SBill Wendling MDNode *ReqNode = *RI; 113966f02413SBill Wendling if (ReqNode->getOperand(2) == ReqVal) { 114066f02413SBill Wendling HasValue = true; 114166f02413SBill Wendling break; 114266f02413SBill Wendling } 114366f02413SBill Wendling } 114466f02413SBill Wendling 114566f02413SBill Wendling if (!HasValue) 11469273b539SBill Wendling HasErr = emitError("linking module flags '" + ReqID->getString() + 11479273b539SBill Wendling "': does not have the required value"); 114866f02413SBill Wendling } 114966f02413SBill Wendling } 115066f02413SBill Wendling 115166f02413SBill Wendling return HasErr; 115266f02413SBill Wendling } 115366f02413SBill Wendling 1154b1ed91f3SChris Lattner bool ModuleLinker::run() { 115566f02413SBill Wendling assert(DstM && "Null destination module"); 115666f02413SBill Wendling assert(SrcM && "Null source module"); 1157b1ed91f3SChris Lattner 1158b1ed91f3SChris Lattner // Inherit the target data from the source module if the destination module 1159b1ed91f3SChris Lattner // doesn't have one already. 1160b1ed91f3SChris Lattner if (DstM->getDataLayout().empty() && !SrcM->getDataLayout().empty()) 1161b1ed91f3SChris Lattner DstM->setDataLayout(SrcM->getDataLayout()); 1162b1ed91f3SChris Lattner 1163b1ed91f3SChris Lattner // Copy the target triple from the source to dest if the dest's is empty. 1164b1ed91f3SChris Lattner if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty()) 1165b1ed91f3SChris Lattner DstM->setTargetTriple(SrcM->getTargetTriple()); 1166b1ed91f3SChris Lattner 1167b1ed91f3SChris Lattner if (!SrcM->getDataLayout().empty() && !DstM->getDataLayout().empty() && 1168b1ed91f3SChris Lattner SrcM->getDataLayout() != DstM->getDataLayout()) 1169b1ed91f3SChris Lattner errs() << "WARNING: Linking two modules of different data layouts!\n"; 1170b1ed91f3SChris Lattner if (!SrcM->getTargetTriple().empty() && 1171b1ed91f3SChris Lattner DstM->getTargetTriple() != SrcM->getTargetTriple()) { 1172b1ed91f3SChris Lattner errs() << "WARNING: Linking two modules of different target triples: "; 1173b1ed91f3SChris Lattner if (!SrcM->getModuleIdentifier().empty()) 1174b1ed91f3SChris Lattner errs() << SrcM->getModuleIdentifier() << ": "; 1175b1ed91f3SChris Lattner errs() << "'" << SrcM->getTargetTriple() << "' and '" 1176b1ed91f3SChris Lattner << DstM->getTargetTriple() << "'\n"; 1177b1ed91f3SChris Lattner } 1178b1ed91f3SChris Lattner 1179b1ed91f3SChris Lattner // Append the module inline asm string. 1180b1ed91f3SChris Lattner if (!SrcM->getModuleInlineAsm().empty()) { 1181b1ed91f3SChris Lattner if (DstM->getModuleInlineAsm().empty()) 1182b1ed91f3SChris Lattner DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm()); 1183b1ed91f3SChris Lattner else 1184b1ed91f3SChris Lattner DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+ 1185b1ed91f3SChris Lattner SrcM->getModuleInlineAsm()); 1186b1ed91f3SChris Lattner } 1187b1ed91f3SChris Lattner 1188b1ed91f3SChris Lattner // Update the destination module's dependent libraries list with the libraries 1189b1ed91f3SChris Lattner // from the source module. There's no opportunity for duplicates here as the 1190b1ed91f3SChris Lattner // Module ensures that duplicate insertions are discarded. 1191b1ed91f3SChris Lattner for (Module::lib_iterator SI = SrcM->lib_begin(), SE = SrcM->lib_end(); 1192b1ed91f3SChris Lattner SI != SE; ++SI) 1193b1ed91f3SChris Lattner DstM->addLibrary(*SI); 1194b1ed91f3SChris Lattner 1195b1ed91f3SChris Lattner // If the source library's module id is in the dependent library list of the 1196b1ed91f3SChris Lattner // destination library, remove it since that module is now linked in. 1197b1ed91f3SChris Lattner StringRef ModuleId = SrcM->getModuleIdentifier(); 1198b1ed91f3SChris Lattner if (!ModuleId.empty()) 1199b1ed91f3SChris Lattner DstM->removeLibrary(sys::path::stem(ModuleId)); 1200b1ed91f3SChris Lattner 1201b1ed91f3SChris Lattner // Loop over all of the linked values to compute type mappings. 1202b1ed91f3SChris Lattner computeTypeMapping(); 1203b1ed91f3SChris Lattner 1204b1ed91f3SChris Lattner // Insert all of the globals in src into the DstM module... without linking 1205b1ed91f3SChris Lattner // initializers (which could refer to functions not yet mapped over). 1206b1ed91f3SChris Lattner for (Module::global_iterator I = SrcM->global_begin(), 1207b1ed91f3SChris Lattner E = SrcM->global_end(); I != E; ++I) 1208b1ed91f3SChris Lattner if (linkGlobalProto(I)) 1209b1ed91f3SChris Lattner return true; 1210b1ed91f3SChris Lattner 1211b1ed91f3SChris Lattner // Link the functions together between the two modules, without doing function 1212b1ed91f3SChris Lattner // bodies... this just adds external function prototypes to the DstM 1213b1ed91f3SChris Lattner // function... We do this so that when we begin processing function bodies, 1214b1ed91f3SChris Lattner // all of the global values that may be referenced are available in our 1215b1ed91f3SChris Lattner // ValueMap. 1216b1ed91f3SChris Lattner for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) 1217b1ed91f3SChris Lattner if (linkFunctionProto(I)) 1218b1ed91f3SChris Lattner return true; 1219b1ed91f3SChris Lattner 1220b1ed91f3SChris Lattner // If there were any aliases, link them now. 1221b1ed91f3SChris Lattner for (Module::alias_iterator I = SrcM->alias_begin(), 1222b1ed91f3SChris Lattner E = SrcM->alias_end(); I != E; ++I) 1223b1ed91f3SChris Lattner if (linkAliasProto(I)) 1224b1ed91f3SChris Lattner return true; 1225b1ed91f3SChris Lattner 1226b1ed91f3SChris Lattner for (unsigned i = 0, e = AppendingVars.size(); i != e; ++i) 1227b1ed91f3SChris Lattner linkAppendingVarInit(AppendingVars[i]); 1228b1ed91f3SChris Lattner 1229b1ed91f3SChris Lattner // Update the initializers in the DstM module now that all globals that may 1230b1ed91f3SChris Lattner // be referenced are in DstM. 1231b1ed91f3SChris Lattner linkGlobalInits(); 1232b1ed91f3SChris Lattner 1233b1ed91f3SChris Lattner // Link in the function bodies that are defined in the source module into 1234b1ed91f3SChris Lattner // DstM. 1235b1ed91f3SChris Lattner for (Module::iterator SF = SrcM->begin(), E = SrcM->end(); SF != E; ++SF) { 1236ea166d44STanya Lattner // Skip if not linking from source. 1237ea166d44STanya Lattner if (DoNotLinkFromSource.count(SF)) continue; 1238ea166d44STanya Lattner 1239ea166d44STanya Lattner // Skip if no body (function is external) or materialize. 1240ea166d44STanya Lattner if (SF->isDeclaration()) { 1241ea166d44STanya Lattner if (!SF->isMaterializable()) 1242ea166d44STanya Lattner continue; 1243ea166d44STanya Lattner if (SF->Materialize(&ErrorMsg)) 1244ea166d44STanya Lattner return true; 1245ea166d44STanya Lattner } 1246b1ed91f3SChris Lattner 1247b1ed91f3SChris Lattner linkFunctionBody(cast<Function>(ValueMap[SF]), SF); 124800623787SBill Wendling SF->Dematerialize(); 1249b1ed91f3SChris Lattner } 1250b1ed91f3SChris Lattner 1251b1ed91f3SChris Lattner // Resolve all uses of aliases with aliasees. 1252b1ed91f3SChris Lattner linkAliasBodies(); 1253b1ed91f3SChris Lattner 125466f02413SBill Wendling // Remap all of the named MDNodes in Src into the DstM module. We do this 12556ddbb2e2SDevang Patel // after linking GlobalValues so that MDNodes that reference GlobalValues 12566ddbb2e2SDevang Patel // are properly remapped. 12576ddbb2e2SDevang Patel linkNamedMDNodes(); 12586ddbb2e2SDevang Patel 125966f02413SBill Wendling // Merge the module flags into the DstM module. 126066f02413SBill Wendling if (linkModuleFlagsMetadata()) 126166f02413SBill Wendling return true; 126266f02413SBill Wendling 12630a48b877STanya Lattner // Process vector of lazily linked in functions. 12640a48b877STanya Lattner bool LinkedInAnyFunctions; 12650a48b877STanya Lattner do { 12660a48b877STanya Lattner LinkedInAnyFunctions = false; 12670a48b877STanya Lattner 12680a48b877STanya Lattner for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(), 12690a48b877STanya Lattner E = LazilyLinkFunctions.end(); I != E; ++I) { 12700a48b877STanya Lattner if (!*I) 12710a48b877STanya Lattner continue; 12720a48b877STanya Lattner 12730a48b877STanya Lattner Function *SF = *I; 12740a48b877STanya Lattner Function *DF = cast<Function>(ValueMap[SF]); 12750a48b877STanya Lattner 12760a48b877STanya Lattner if (!DF->use_empty()) { 12770a48b877STanya Lattner 12780a48b877STanya Lattner // Materialize if necessary. 12790a48b877STanya Lattner if (SF->isDeclaration()) { 12800a48b877STanya Lattner if (!SF->isMaterializable()) 12810a48b877STanya Lattner continue; 12820a48b877STanya Lattner if (SF->Materialize(&ErrorMsg)) 12830a48b877STanya Lattner return true; 12840a48b877STanya Lattner } 12850a48b877STanya Lattner 12860a48b877STanya Lattner // Link in function body. 12870a48b877STanya Lattner linkFunctionBody(DF, SF); 128800623787SBill Wendling SF->Dematerialize(); 12890a48b877STanya Lattner 12900a48b877STanya Lattner // "Remove" from vector by setting the element to 0. 12910a48b877STanya Lattner *I = 0; 12920a48b877STanya Lattner 12930a48b877STanya Lattner // Set flag to indicate we may have more functions to lazily link in 12940a48b877STanya Lattner // since we linked in a function. 12950a48b877STanya Lattner LinkedInAnyFunctions = true; 12960a48b877STanya Lattner } 12970a48b877STanya Lattner } 12980a48b877STanya Lattner } while (LinkedInAnyFunctions); 12990a48b877STanya Lattner 13000a48b877STanya Lattner // Remove any prototypes of functions that were not actually linked in. 13010a48b877STanya Lattner for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(), 13020a48b877STanya Lattner E = LazilyLinkFunctions.end(); I != E; ++I) { 13030a48b877STanya Lattner if (!*I) 13040a48b877STanya Lattner continue; 13050a48b877STanya Lattner 13060a48b877STanya Lattner Function *SF = *I; 13070a48b877STanya Lattner Function *DF = cast<Function>(ValueMap[SF]); 13080a48b877STanya Lattner if (DF->use_empty()) 13090a48b877STanya Lattner DF->eraseFromParent(); 13100a48b877STanya Lattner } 13110a48b877STanya Lattner 1312b1ed91f3SChris Lattner // Now that all of the types from the source are used, resolve any structs 1313b1ed91f3SChris Lattner // copied over to the dest that didn't exist there. 1314b1ed91f3SChris Lattner TypeMap.linkDefinedTypeBodies(); 13152609888fSAnton Korobeynikov 13162609888fSAnton Korobeynikov return false; 13172609888fSAnton Korobeynikov } 1318361e513dSReid Spencer 1319b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 1320b1ed91f3SChris Lattner // LinkModules entrypoint. 1321b1ed91f3SChris Lattner //===----------------------------------------------------------------------===// 1322b1ed91f3SChris Lattner 1323b6af2f36SBill Wendling /// LinkModules - This function links two modules together, with the resulting 1324b6af2f36SBill Wendling /// left module modified to be the composite of the two input modules. If an 1325b6af2f36SBill Wendling /// error occurs, true is returned and ErrorMsg (if not null) is set to indicate 1326b6af2f36SBill Wendling /// the problem. Upon failure, the Dest module could be in a modified state, 1327b6af2f36SBill Wendling /// and shouldn't be relied on to be consistent. 1328cbb91408STanya Lattner bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Mode, 1329cbb91408STanya Lattner std::string *ErrorMsg) { 1330cbb91408STanya Lattner ModuleLinker TheLinker(Dest, Src, Mode); 1331b1ed91f3SChris Lattner if (TheLinker.run()) { 1332b1ed91f3SChris Lattner if (ErrorMsg) *ErrorMsg = TheLinker.ErrorMsg; 1333d3ba7d9bSReid Spencer return true; 1334361e513dSReid Spencer } 1335361e513dSReid Spencer 1336361e513dSReid Spencer return false; 1337361e513dSReid Spencer } 1338