1 //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file implements the LLVM module linker. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/Linker.h" 15 #include "llvm-c/Linker.h" 16 #include "llvm/ADT/Optional.h" 17 #include "llvm/ADT/SetVector.h" 18 #include "llvm/ADT/SmallString.h" 19 #include "llvm/IR/Constants.h" 20 #include "llvm/IR/Module.h" 21 #include "llvm/IR/TypeFinder.h" 22 #include "llvm/Support/Debug.h" 23 #include "llvm/Support/raw_ostream.h" 24 #include "llvm/Transforms/Utils/Cloning.h" 25 using namespace llvm; 26 27 //===----------------------------------------------------------------------===// 28 // TypeMap implementation. 29 //===----------------------------------------------------------------------===// 30 31 namespace { 32 typedef SmallPtrSet<StructType*, 32> TypeSet; 33 34 class TypeMapTy : public ValueMapTypeRemapper { 35 /// MappedTypes - This is a mapping from a source type to a destination type 36 /// to use. 37 DenseMap<Type*, Type*> MappedTypes; 38 39 /// SpeculativeTypes - When checking to see if two subgraphs are isomorphic, 40 /// we speculatively add types to MappedTypes, but keep track of them here in 41 /// case we need to roll back. 42 SmallVector<Type*, 16> SpeculativeTypes; 43 44 /// SrcDefinitionsToResolve - This is a list of non-opaque structs in the 45 /// source module that are mapped to an opaque struct in the destination 46 /// module. 47 SmallVector<StructType*, 16> SrcDefinitionsToResolve; 48 49 /// DstResolvedOpaqueTypes - This is the set of opaque types in the 50 /// destination modules who are getting a body from the source module. 51 SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes; 52 53 public: 54 TypeMapTy(TypeSet &Set) : DstStructTypesSet(Set) {} 55 56 TypeSet &DstStructTypesSet; 57 /// addTypeMapping - Indicate that the specified type in the destination 58 /// module is conceptually equivalent to the specified type in the source 59 /// module. 60 void addTypeMapping(Type *DstTy, Type *SrcTy); 61 62 /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest 63 /// module from a type definition in the source module. 64 void linkDefinedTypeBodies(); 65 66 /// get - Return the mapped type to use for the specified input type from the 67 /// source module. 68 Type *get(Type *SrcTy); 69 70 FunctionType *get(FunctionType *T) {return cast<FunctionType>(get((Type*)T));} 71 72 /// dump - Dump out the type map for debugging purposes. 73 void dump() const { 74 for (DenseMap<Type*, Type*>::const_iterator 75 I = MappedTypes.begin(), E = MappedTypes.end(); I != E; ++I) { 76 dbgs() << "TypeMap: "; 77 I->first->dump(); 78 dbgs() << " => "; 79 I->second->dump(); 80 dbgs() << '\n'; 81 } 82 } 83 84 private: 85 Type *getImpl(Type *T); 86 /// remapType - Implement the ValueMapTypeRemapper interface. 87 Type *remapType(Type *SrcTy) { 88 return get(SrcTy); 89 } 90 91 bool areTypesIsomorphic(Type *DstTy, Type *SrcTy); 92 }; 93 } 94 95 void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) { 96 Type *&Entry = MappedTypes[SrcTy]; 97 if (Entry) return; 98 99 if (DstTy == SrcTy) { 100 Entry = DstTy; 101 return; 102 } 103 104 // Check to see if these types are recursively isomorphic and establish a 105 // mapping between them if so. 106 if (!areTypesIsomorphic(DstTy, SrcTy)) { 107 // Oops, they aren't isomorphic. Just discard this request by rolling out 108 // any speculative mappings we've established. 109 for (unsigned i = 0, e = SpeculativeTypes.size(); i != e; ++i) 110 MappedTypes.erase(SpeculativeTypes[i]); 111 } 112 SpeculativeTypes.clear(); 113 } 114 115 /// areTypesIsomorphic - Recursively walk this pair of types, returning true 116 /// if they are isomorphic, false if they are not. 117 bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) { 118 // Two types with differing kinds are clearly not isomorphic. 119 if (DstTy->getTypeID() != SrcTy->getTypeID()) return false; 120 121 // If we have an entry in the MappedTypes table, then we have our answer. 122 Type *&Entry = MappedTypes[SrcTy]; 123 if (Entry) 124 return Entry == DstTy; 125 126 // Two identical types are clearly isomorphic. Remember this 127 // non-speculatively. 128 if (DstTy == SrcTy) { 129 Entry = DstTy; 130 return true; 131 } 132 133 // Okay, we have two types with identical kinds that we haven't seen before. 134 135 // If this is an opaque struct type, special case it. 136 if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) { 137 // Mapping an opaque type to any struct, just keep the dest struct. 138 if (SSTy->isOpaque()) { 139 Entry = DstTy; 140 SpeculativeTypes.push_back(SrcTy); 141 return true; 142 } 143 144 // Mapping a non-opaque source type to an opaque dest. If this is the first 145 // type that we're mapping onto this destination type then we succeed. Keep 146 // the dest, but fill it in later. This doesn't need to be speculative. If 147 // this is the second (different) type that we're trying to map onto the 148 // same opaque type then we fail. 149 if (cast<StructType>(DstTy)->isOpaque()) { 150 // We can only map one source type onto the opaque destination type. 151 if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy))) 152 return false; 153 SrcDefinitionsToResolve.push_back(SSTy); 154 Entry = DstTy; 155 return true; 156 } 157 } 158 159 // If the number of subtypes disagree between the two types, then we fail. 160 if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes()) 161 return false; 162 163 // Fail if any of the extra properties (e.g. array size) of the type disagree. 164 if (isa<IntegerType>(DstTy)) 165 return false; // bitwidth disagrees. 166 if (PointerType *PT = dyn_cast<PointerType>(DstTy)) { 167 if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace()) 168 return false; 169 170 } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) { 171 if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg()) 172 return false; 173 } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) { 174 StructType *SSTy = cast<StructType>(SrcTy); 175 if (DSTy->isLiteral() != SSTy->isLiteral() || 176 DSTy->isPacked() != SSTy->isPacked()) 177 return false; 178 } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) { 179 if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements()) 180 return false; 181 } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) { 182 if (DVTy->getNumElements() != cast<VectorType>(SrcTy)->getNumElements()) 183 return false; 184 } 185 186 // Otherwise, we speculate that these two types will line up and recursively 187 // check the subelements. 188 Entry = DstTy; 189 SpeculativeTypes.push_back(SrcTy); 190 191 for (unsigned i = 0, e = SrcTy->getNumContainedTypes(); i != e; ++i) 192 if (!areTypesIsomorphic(DstTy->getContainedType(i), 193 SrcTy->getContainedType(i))) 194 return false; 195 196 // If everything seems to have lined up, then everything is great. 197 return true; 198 } 199 200 /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest 201 /// module from a type definition in the source module. 202 void TypeMapTy::linkDefinedTypeBodies() { 203 SmallVector<Type*, 16> Elements; 204 SmallString<16> TmpName; 205 206 // Note that processing entries in this loop (calling 'get') can add new 207 // entries to the SrcDefinitionsToResolve vector. 208 while (!SrcDefinitionsToResolve.empty()) { 209 StructType *SrcSTy = SrcDefinitionsToResolve.pop_back_val(); 210 StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]); 211 212 // TypeMap is a many-to-one mapping, if there were multiple types that 213 // provide a body for DstSTy then previous iterations of this loop may have 214 // already handled it. Just ignore this case. 215 if (!DstSTy->isOpaque()) continue; 216 assert(!SrcSTy->isOpaque() && "Not resolving a definition?"); 217 218 // Map the body of the source type over to a new body for the dest type. 219 Elements.resize(SrcSTy->getNumElements()); 220 for (unsigned i = 0, e = Elements.size(); i != e; ++i) 221 Elements[i] = getImpl(SrcSTy->getElementType(i)); 222 223 DstSTy->setBody(Elements, SrcSTy->isPacked()); 224 225 // If DstSTy has no name or has a longer name than STy, then viciously steal 226 // STy's name. 227 if (!SrcSTy->hasName()) continue; 228 StringRef SrcName = SrcSTy->getName(); 229 230 if (!DstSTy->hasName() || DstSTy->getName().size() > SrcName.size()) { 231 TmpName.insert(TmpName.end(), SrcName.begin(), SrcName.end()); 232 SrcSTy->setName(""); 233 DstSTy->setName(TmpName.str()); 234 TmpName.clear(); 235 } 236 } 237 238 DstResolvedOpaqueTypes.clear(); 239 } 240 241 /// get - Return the mapped type to use for the specified input type from the 242 /// source module. 243 Type *TypeMapTy::get(Type *Ty) { 244 Type *Result = getImpl(Ty); 245 246 // If this caused a reference to any struct type, resolve it before returning. 247 if (!SrcDefinitionsToResolve.empty()) 248 linkDefinedTypeBodies(); 249 return Result; 250 } 251 252 /// getImpl - This is the recursive version of get(). 253 Type *TypeMapTy::getImpl(Type *Ty) { 254 // If we already have an entry for this type, return it. 255 Type **Entry = &MappedTypes[Ty]; 256 if (*Entry) return *Entry; 257 258 // If this is not a named struct type, then just map all of the elements and 259 // then rebuild the type from inside out. 260 if (!isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral()) { 261 // If there are no element types to map, then the type is itself. This is 262 // true for the anonymous {} struct, things like 'float', integers, etc. 263 if (Ty->getNumContainedTypes() == 0) 264 return *Entry = Ty; 265 266 // Remap all of the elements, keeping track of whether any of them change. 267 bool AnyChange = false; 268 SmallVector<Type*, 4> ElementTypes; 269 ElementTypes.resize(Ty->getNumContainedTypes()); 270 for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i) { 271 ElementTypes[i] = getImpl(Ty->getContainedType(i)); 272 AnyChange |= ElementTypes[i] != Ty->getContainedType(i); 273 } 274 275 // If we found our type while recursively processing stuff, just use it. 276 Entry = &MappedTypes[Ty]; 277 if (*Entry) return *Entry; 278 279 // If all of the element types mapped directly over, then the type is usable 280 // as-is. 281 if (!AnyChange) 282 return *Entry = Ty; 283 284 // Otherwise, rebuild a modified type. 285 switch (Ty->getTypeID()) { 286 default: llvm_unreachable("unknown derived type to remap"); 287 case Type::ArrayTyID: 288 return *Entry = ArrayType::get(ElementTypes[0], 289 cast<ArrayType>(Ty)->getNumElements()); 290 case Type::VectorTyID: 291 return *Entry = VectorType::get(ElementTypes[0], 292 cast<VectorType>(Ty)->getNumElements()); 293 case Type::PointerTyID: 294 return *Entry = PointerType::get(ElementTypes[0], 295 cast<PointerType>(Ty)->getAddressSpace()); 296 case Type::FunctionTyID: 297 return *Entry = FunctionType::get(ElementTypes[0], 298 makeArrayRef(ElementTypes).slice(1), 299 cast<FunctionType>(Ty)->isVarArg()); 300 case Type::StructTyID: 301 // Note that this is only reached for anonymous structs. 302 return *Entry = StructType::get(Ty->getContext(), ElementTypes, 303 cast<StructType>(Ty)->isPacked()); 304 } 305 } 306 307 // Otherwise, this is an unmapped named struct. If the struct can be directly 308 // mapped over, just use it as-is. This happens in a case when the linked-in 309 // module has something like: 310 // %T = type {%T*, i32} 311 // @GV = global %T* null 312 // where T does not exist at all in the destination module. 313 // 314 // The other case we watch for is when the type is not in the destination 315 // module, but that it has to be rebuilt because it refers to something that 316 // is already mapped. For example, if the destination module has: 317 // %A = type { i32 } 318 // and the source module has something like 319 // %A' = type { i32 } 320 // %B = type { %A'* } 321 // @GV = global %B* null 322 // then we want to create a new type: "%B = type { %A*}" and have it take the 323 // pristine "%B" name from the source module. 324 // 325 // To determine which case this is, we have to recursively walk the type graph 326 // speculating that we'll be able to reuse it unmodified. Only if this is 327 // safe would we map the entire thing over. Because this is an optimization, 328 // and is not required for the prettiness of the linked module, we just skip 329 // it and always rebuild a type here. 330 StructType *STy = cast<StructType>(Ty); 331 332 // If the type is opaque, we can just use it directly. 333 if (STy->isOpaque()) { 334 // A named structure type from src module is used. Add it to the Set of 335 // identified structs in the destination module. 336 DstStructTypesSet.insert(STy); 337 return *Entry = STy; 338 } 339 340 // Otherwise we create a new type and resolve its body later. This will be 341 // resolved by the top level of get(). 342 SrcDefinitionsToResolve.push_back(STy); 343 StructType *DTy = StructType::create(STy->getContext()); 344 // A new identified structure type was created. Add it to the set of 345 // identified structs in the destination module. 346 DstStructTypesSet.insert(DTy); 347 DstResolvedOpaqueTypes.insert(DTy); 348 return *Entry = DTy; 349 } 350 351 //===----------------------------------------------------------------------===// 352 // ModuleLinker implementation. 353 //===----------------------------------------------------------------------===// 354 355 namespace { 356 class ModuleLinker; 357 358 /// ValueMaterializerTy - Creates prototypes for functions that are lazily 359 /// linked on the fly. This speeds up linking for modules with many 360 /// lazily linked functions of which few get used. 361 class ValueMaterializerTy : public ValueMaterializer { 362 TypeMapTy &TypeMap; 363 Module *DstM; 364 std::vector<Function*> &LazilyLinkFunctions; 365 public: 366 ValueMaterializerTy(TypeMapTy &TypeMap, Module *DstM, 367 std::vector<Function*> &LazilyLinkFunctions) : 368 ValueMaterializer(), TypeMap(TypeMap), DstM(DstM), 369 LazilyLinkFunctions(LazilyLinkFunctions) { 370 } 371 372 virtual Value *materializeValueFor(Value *V); 373 }; 374 375 /// ModuleLinker - This is an implementation class for the LinkModules 376 /// function, which is the entrypoint for this file. 377 class ModuleLinker { 378 Module *DstM, *SrcM; 379 380 TypeMapTy TypeMap; 381 ValueMaterializerTy ValMaterializer; 382 383 /// ValueMap - Mapping of values from what they used to be in Src, to what 384 /// they are now in DstM. ValueToValueMapTy is a ValueMap, which involves 385 /// some overhead due to the use of Value handles which the Linker doesn't 386 /// actually need, but this allows us to reuse the ValueMapper code. 387 ValueToValueMapTy ValueMap; 388 389 struct AppendingVarInfo { 390 GlobalVariable *NewGV; // New aggregate global in dest module. 391 Constant *DstInit; // Old initializer from dest module. 392 Constant *SrcInit; // Old initializer from src module. 393 }; 394 395 std::vector<AppendingVarInfo> AppendingVars; 396 397 unsigned Mode; // Mode to treat source module. 398 399 // Set of items not to link in from source. 400 SmallPtrSet<const Value*, 16> DoNotLinkFromSource; 401 402 // Vector of functions to lazily link in. 403 std::vector<Function*> LazilyLinkFunctions; 404 405 public: 406 std::string ErrorMsg; 407 408 ModuleLinker(Module *dstM, TypeSet &Set, Module *srcM, unsigned mode) 409 : DstM(dstM), SrcM(srcM), TypeMap(Set), 410 ValMaterializer(TypeMap, DstM, LazilyLinkFunctions), 411 Mode(mode) { } 412 413 bool run(); 414 415 private: 416 /// emitError - Helper method for setting a message and returning an error 417 /// code. 418 bool emitError(const Twine &Message) { 419 ErrorMsg = Message.str(); 420 return true; 421 } 422 423 /// getLinkageResult - This analyzes the two global values and determines 424 /// what the result will look like in the destination module. 425 bool getLinkageResult(GlobalValue *Dest, const GlobalValue *Src, 426 GlobalValue::LinkageTypes <, 427 GlobalValue::VisibilityTypes &Vis, 428 bool &LinkFromSrc); 429 430 /// getLinkedToGlobal - Given a global in the source module, return the 431 /// global in the destination module that is being linked to, if any. 432 GlobalValue *getLinkedToGlobal(GlobalValue *SrcGV) { 433 // If the source has no name it can't link. If it has local linkage, 434 // there is no name match-up going on. 435 if (!SrcGV->hasName() || SrcGV->hasLocalLinkage()) 436 return 0; 437 438 // Otherwise see if we have a match in the destination module's symtab. 439 GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName()); 440 if (DGV == 0) return 0; 441 442 // If we found a global with the same name in the dest module, but it has 443 // internal linkage, we are really not doing any linkage here. 444 if (DGV->hasLocalLinkage()) 445 return 0; 446 447 // Otherwise, we do in fact link to the destination global. 448 return DGV; 449 } 450 451 void computeTypeMapping(); 452 453 bool linkAppendingVarProto(GlobalVariable *DstGV, GlobalVariable *SrcGV); 454 bool linkGlobalProto(GlobalVariable *SrcGV); 455 bool linkFunctionProto(Function *SrcF); 456 bool linkAliasProto(GlobalAlias *SrcA); 457 bool linkModuleFlagsMetadata(); 458 459 void linkAppendingVarInit(const AppendingVarInfo &AVI); 460 void linkGlobalInits(); 461 void linkFunctionBody(Function *Dst, Function *Src); 462 void linkAliasBodies(); 463 void linkNamedMDNodes(); 464 }; 465 } 466 467 /// forceRenaming - The LLVM SymbolTable class autorenames globals that conflict 468 /// in the symbol table. This is good for all clients except for us. Go 469 /// through the trouble to force this back. 470 static void forceRenaming(GlobalValue *GV, StringRef Name) { 471 // If the global doesn't force its name or if it already has the right name, 472 // there is nothing for us to do. 473 if (GV->hasLocalLinkage() || GV->getName() == Name) 474 return; 475 476 Module *M = GV->getParent(); 477 478 // If there is a conflict, rename the conflict. 479 if (GlobalValue *ConflictGV = M->getNamedValue(Name)) { 480 GV->takeName(ConflictGV); 481 ConflictGV->setName(Name); // This will cause ConflictGV to get renamed 482 assert(ConflictGV->getName() != Name && "forceRenaming didn't work"); 483 } else { 484 GV->setName(Name); // Force the name back 485 } 486 } 487 488 /// copyGVAttributes - copy additional attributes (those not needed to construct 489 /// a GlobalValue) from the SrcGV to the DestGV. 490 static void copyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) { 491 // Use the maximum alignment, rather than just copying the alignment of SrcGV. 492 unsigned Alignment = std::max(DestGV->getAlignment(), SrcGV->getAlignment()); 493 DestGV->copyAttributesFrom(SrcGV); 494 DestGV->setAlignment(Alignment); 495 496 forceRenaming(DestGV, SrcGV->getName()); 497 } 498 499 static bool isLessConstraining(GlobalValue::VisibilityTypes a, 500 GlobalValue::VisibilityTypes b) { 501 if (a == GlobalValue::HiddenVisibility) 502 return false; 503 if (b == GlobalValue::HiddenVisibility) 504 return true; 505 if (a == GlobalValue::ProtectedVisibility) 506 return false; 507 if (b == GlobalValue::ProtectedVisibility) 508 return true; 509 return false; 510 } 511 512 Value *ValueMaterializerTy::materializeValueFor(Value *V) { 513 Function *SF = dyn_cast<Function>(V); 514 if (!SF) 515 return NULL; 516 517 Function *DF = Function::Create(TypeMap.get(SF->getFunctionType()), 518 SF->getLinkage(), SF->getName(), DstM); 519 copyGVAttributes(DF, SF); 520 521 LazilyLinkFunctions.push_back(SF); 522 return DF; 523 } 524 525 526 /// getLinkageResult - This analyzes the two global values and determines what 527 /// the result will look like in the destination module. In particular, it 528 /// computes the resultant linkage type and visibility, computes whether the 529 /// global in the source should be copied over to the destination (replacing 530 /// the existing one), and computes whether this linkage is an error or not. 531 bool ModuleLinker::getLinkageResult(GlobalValue *Dest, const GlobalValue *Src, 532 GlobalValue::LinkageTypes <, 533 GlobalValue::VisibilityTypes &Vis, 534 bool &LinkFromSrc) { 535 assert(Dest && "Must have two globals being queried"); 536 assert(!Src->hasLocalLinkage() && 537 "If Src has internal linkage, Dest shouldn't be set!"); 538 539 bool SrcIsDeclaration = Src->isDeclaration() && !Src->isMaterializable(); 540 bool DestIsDeclaration = Dest->isDeclaration(); 541 542 if (SrcIsDeclaration) { 543 // If Src is external or if both Src & Dest are external.. Just link the 544 // external globals, we aren't adding anything. 545 if (Src->hasDLLImportLinkage()) { 546 // If one of GVs has DLLImport linkage, result should be dllimport'ed. 547 if (DestIsDeclaration) { 548 LinkFromSrc = true; 549 LT = Src->getLinkage(); 550 } 551 } else if (Dest->hasExternalWeakLinkage()) { 552 // If the Dest is weak, use the source linkage. 553 LinkFromSrc = true; 554 LT = Src->getLinkage(); 555 } else { 556 LinkFromSrc = false; 557 LT = Dest->getLinkage(); 558 } 559 } else if (DestIsDeclaration && !Dest->hasDLLImportLinkage()) { 560 // If Dest is external but Src is not: 561 LinkFromSrc = true; 562 LT = Src->getLinkage(); 563 } else if (Src->isWeakForLinker()) { 564 // At this point we know that Dest has LinkOnce, External*, Weak, Common, 565 // or DLL* linkage. 566 if (Dest->hasExternalWeakLinkage() || 567 Dest->hasAvailableExternallyLinkage() || 568 (Dest->hasLinkOnceLinkage() && 569 (Src->hasWeakLinkage() || Src->hasCommonLinkage()))) { 570 LinkFromSrc = true; 571 LT = Src->getLinkage(); 572 } else { 573 LinkFromSrc = false; 574 LT = Dest->getLinkage(); 575 } 576 } else if (Dest->isWeakForLinker()) { 577 // At this point we know that Src has External* or DLL* linkage. 578 if (Src->hasExternalWeakLinkage()) { 579 LinkFromSrc = false; 580 LT = Dest->getLinkage(); 581 } else { 582 LinkFromSrc = true; 583 LT = GlobalValue::ExternalLinkage; 584 } 585 } else { 586 assert((Dest->hasExternalLinkage() || Dest->hasDLLImportLinkage() || 587 Dest->hasDLLExportLinkage() || Dest->hasExternalWeakLinkage()) && 588 (Src->hasExternalLinkage() || Src->hasDLLImportLinkage() || 589 Src->hasDLLExportLinkage() || Src->hasExternalWeakLinkage()) && 590 "Unexpected linkage type!"); 591 return emitError("Linking globals named '" + Src->getName() + 592 "': symbol multiply defined!"); 593 } 594 595 // Compute the visibility. We follow the rules in the System V Application 596 // Binary Interface. 597 Vis = isLessConstraining(Src->getVisibility(), Dest->getVisibility()) ? 598 Dest->getVisibility() : Src->getVisibility(); 599 return false; 600 } 601 602 /// computeTypeMapping - Loop over all of the linked values to compute type 603 /// mappings. For example, if we link "extern Foo *x" and "Foo *x = NULL", then 604 /// we have two struct types 'Foo' but one got renamed when the module was 605 /// loaded into the same LLVMContext. 606 void ModuleLinker::computeTypeMapping() { 607 // Incorporate globals. 608 for (Module::global_iterator I = SrcM->global_begin(), 609 E = SrcM->global_end(); I != E; ++I) { 610 GlobalValue *DGV = getLinkedToGlobal(I); 611 if (DGV == 0) continue; 612 613 if (!DGV->hasAppendingLinkage() || !I->hasAppendingLinkage()) { 614 TypeMap.addTypeMapping(DGV->getType(), I->getType()); 615 continue; 616 } 617 618 // Unify the element type of appending arrays. 619 ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType()); 620 ArrayType *SAT = cast<ArrayType>(I->getType()->getElementType()); 621 TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType()); 622 } 623 624 // Incorporate functions. 625 for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) { 626 if (GlobalValue *DGV = getLinkedToGlobal(I)) 627 TypeMap.addTypeMapping(DGV->getType(), I->getType()); 628 } 629 630 // Incorporate types by name, scanning all the types in the source module. 631 // At this point, the destination module may have a type "%foo = { i32 }" for 632 // example. When the source module got loaded into the same LLVMContext, if 633 // it had the same type, it would have been renamed to "%foo.42 = { i32 }". 634 TypeFinder SrcStructTypes; 635 SrcStructTypes.run(*SrcM, true); 636 SmallPtrSet<StructType*, 32> SrcStructTypesSet(SrcStructTypes.begin(), 637 SrcStructTypes.end()); 638 639 for (unsigned i = 0, e = SrcStructTypes.size(); i != e; ++i) { 640 StructType *ST = SrcStructTypes[i]; 641 if (!ST->hasName()) continue; 642 643 // Check to see if there is a dot in the name followed by a digit. 644 size_t DotPos = ST->getName().rfind('.'); 645 if (DotPos == 0 || DotPos == StringRef::npos || 646 ST->getName().back() == '.' || 647 !isdigit(static_cast<unsigned char>(ST->getName()[DotPos+1]))) 648 continue; 649 650 // Check to see if the destination module has a struct with the prefix name. 651 if (StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos))) 652 // Don't use it if this actually came from the source module. They're in 653 // the same LLVMContext after all. Also don't use it unless the type is 654 // actually used in the destination module. This can happen in situations 655 // like this: 656 // 657 // Module A Module B 658 // -------- -------- 659 // %Z = type { %A } %B = type { %C.1 } 660 // %A = type { %B.1, [7 x i8] } %C.1 = type { i8* } 661 // %B.1 = type { %C } %A.2 = type { %B.3, [5 x i8] } 662 // %C = type { i8* } %B.3 = type { %C.1 } 663 // 664 // When we link Module B with Module A, the '%B' in Module B is 665 // used. However, that would then use '%C.1'. But when we process '%C.1', 666 // we prefer to take the '%C' version. So we are then left with both 667 // '%C.1' and '%C' being used for the same types. This leads to some 668 // variables using one type and some using the other. 669 if (!SrcStructTypesSet.count(DST) && TypeMap.DstStructTypesSet.count(DST)) 670 TypeMap.addTypeMapping(DST, ST); 671 } 672 673 // Don't bother incorporating aliases, they aren't generally typed well. 674 675 // Now that we have discovered all of the type equivalences, get a body for 676 // any 'opaque' types in the dest module that are now resolved. 677 TypeMap.linkDefinedTypeBodies(); 678 } 679 680 /// linkAppendingVarProto - If there were any appending global variables, link 681 /// them together now. Return true on error. 682 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV, 683 GlobalVariable *SrcGV) { 684 685 if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage()) 686 return emitError("Linking globals named '" + SrcGV->getName() + 687 "': can only link appending global with another appending global!"); 688 689 ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType()); 690 ArrayType *SrcTy = 691 cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType())); 692 Type *EltTy = DstTy->getElementType(); 693 694 // Check to see that they two arrays agree on type. 695 if (EltTy != SrcTy->getElementType()) 696 return emitError("Appending variables with different element types!"); 697 if (DstGV->isConstant() != SrcGV->isConstant()) 698 return emitError("Appending variables linked with different const'ness!"); 699 700 if (DstGV->getAlignment() != SrcGV->getAlignment()) 701 return emitError( 702 "Appending variables with different alignment need to be linked!"); 703 704 if (DstGV->getVisibility() != SrcGV->getVisibility()) 705 return emitError( 706 "Appending variables with different visibility need to be linked!"); 707 708 if (DstGV->hasUnnamedAddr() != SrcGV->hasUnnamedAddr()) 709 return emitError( 710 "Appending variables with different unnamed_addr need to be linked!"); 711 712 if (DstGV->getSection() != SrcGV->getSection()) 713 return emitError( 714 "Appending variables with different section name need to be linked!"); 715 716 uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements(); 717 ArrayType *NewType = ArrayType::get(EltTy, NewSize); 718 719 // Create the new global variable. 720 GlobalVariable *NG = 721 new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(), 722 DstGV->getLinkage(), /*init*/0, /*name*/"", DstGV, 723 DstGV->getThreadLocalMode(), 724 DstGV->getType()->getAddressSpace()); 725 726 // Propagate alignment, visibility and section info. 727 copyGVAttributes(NG, DstGV); 728 729 AppendingVarInfo AVI; 730 AVI.NewGV = NG; 731 AVI.DstInit = DstGV->getInitializer(); 732 AVI.SrcInit = SrcGV->getInitializer(); 733 AppendingVars.push_back(AVI); 734 735 // Replace any uses of the two global variables with uses of the new 736 // global. 737 ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType())); 738 739 DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType())); 740 DstGV->eraseFromParent(); 741 742 // Track the source variable so we don't try to link it. 743 DoNotLinkFromSource.insert(SrcGV); 744 745 return false; 746 } 747 748 /// linkGlobalProto - Loop through the global variables in the src module and 749 /// merge them into the dest module. 750 bool ModuleLinker::linkGlobalProto(GlobalVariable *SGV) { 751 GlobalValue *DGV = getLinkedToGlobal(SGV); 752 llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 753 bool HasUnnamedAddr = SGV->hasUnnamedAddr(); 754 755 if (DGV) { 756 // Concatenation of appending linkage variables is magic and handled later. 757 if (DGV->hasAppendingLinkage() || SGV->hasAppendingLinkage()) 758 return linkAppendingVarProto(cast<GlobalVariable>(DGV), SGV); 759 760 // Determine whether linkage of these two globals follows the source 761 // module's definition or the destination module's definition. 762 GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 763 GlobalValue::VisibilityTypes NV; 764 bool LinkFromSrc = false; 765 if (getLinkageResult(DGV, SGV, NewLinkage, NV, LinkFromSrc)) 766 return true; 767 NewVisibility = NV; 768 HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr(); 769 770 // If we're not linking from the source, then keep the definition that we 771 // have. 772 if (!LinkFromSrc) { 773 // Special case for const propagation. 774 if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV)) 775 if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant()) 776 DGVar->setConstant(true); 777 778 // Set calculated linkage, visibility and unnamed_addr. 779 DGV->setLinkage(NewLinkage); 780 DGV->setVisibility(*NewVisibility); 781 DGV->setUnnamedAddr(HasUnnamedAddr); 782 783 // Make sure to remember this mapping. 784 ValueMap[SGV] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGV->getType())); 785 786 // Track the source global so that we don't attempt to copy it over when 787 // processing global initializers. 788 DoNotLinkFromSource.insert(SGV); 789 790 return false; 791 } 792 } 793 794 // No linking to be performed or linking from the source: simply create an 795 // identical version of the symbol over in the dest module... the 796 // initializer will be filled in later by LinkGlobalInits. 797 GlobalVariable *NewDGV = 798 new GlobalVariable(*DstM, TypeMap.get(SGV->getType()->getElementType()), 799 SGV->isConstant(), SGV->getLinkage(), /*init*/0, 800 SGV->getName(), /*insertbefore*/0, 801 SGV->getThreadLocalMode(), 802 SGV->getType()->getAddressSpace()); 803 // Propagate alignment, visibility and section info. 804 copyGVAttributes(NewDGV, SGV); 805 if (NewVisibility) 806 NewDGV->setVisibility(*NewVisibility); 807 NewDGV->setUnnamedAddr(HasUnnamedAddr); 808 809 if (DGV) { 810 DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDGV, DGV->getType())); 811 DGV->eraseFromParent(); 812 } 813 814 // Make sure to remember this mapping. 815 ValueMap[SGV] = NewDGV; 816 return false; 817 } 818 819 /// linkFunctionProto - Link the function in the source module into the 820 /// destination module if needed, setting up mapping information. 821 bool ModuleLinker::linkFunctionProto(Function *SF) { 822 GlobalValue *DGV = getLinkedToGlobal(SF); 823 llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 824 bool HasUnnamedAddr = SF->hasUnnamedAddr(); 825 826 if (DGV) { 827 GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 828 bool LinkFromSrc = false; 829 GlobalValue::VisibilityTypes NV; 830 if (getLinkageResult(DGV, SF, NewLinkage, NV, LinkFromSrc)) 831 return true; 832 NewVisibility = NV; 833 HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr(); 834 835 if (!LinkFromSrc) { 836 // Set calculated linkage 837 DGV->setLinkage(NewLinkage); 838 DGV->setVisibility(*NewVisibility); 839 DGV->setUnnamedAddr(HasUnnamedAddr); 840 841 // Make sure to remember this mapping. 842 ValueMap[SF] = ConstantExpr::getBitCast(DGV, TypeMap.get(SF->getType())); 843 844 // Track the function from the source module so we don't attempt to remap 845 // it. 846 DoNotLinkFromSource.insert(SF); 847 848 return false; 849 } 850 } 851 852 // If the function is to be lazily linked, don't create it just yet. 853 // The ValueMaterializerTy will deal with creating it if it's used. 854 if (!DGV && (SF->hasLocalLinkage() || SF->hasLinkOnceLinkage() || 855 SF->hasAvailableExternallyLinkage())) { 856 DoNotLinkFromSource.insert(SF); 857 return false; 858 } 859 860 // If there is no linkage to be performed or we are linking from the source, 861 // bring SF over. 862 Function *NewDF = Function::Create(TypeMap.get(SF->getFunctionType()), 863 SF->getLinkage(), SF->getName(), DstM); 864 copyGVAttributes(NewDF, SF); 865 if (NewVisibility) 866 NewDF->setVisibility(*NewVisibility); 867 NewDF->setUnnamedAddr(HasUnnamedAddr); 868 869 if (DGV) { 870 // Any uses of DF need to change to NewDF, with cast. 871 DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDF, DGV->getType())); 872 DGV->eraseFromParent(); 873 } 874 875 ValueMap[SF] = NewDF; 876 return false; 877 } 878 879 /// LinkAliasProto - Set up prototypes for any aliases that come over from the 880 /// source module. 881 bool ModuleLinker::linkAliasProto(GlobalAlias *SGA) { 882 GlobalValue *DGV = getLinkedToGlobal(SGA); 883 llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility; 884 885 if (DGV) { 886 GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage; 887 GlobalValue::VisibilityTypes NV; 888 bool LinkFromSrc = false; 889 if (getLinkageResult(DGV, SGA, NewLinkage, NV, LinkFromSrc)) 890 return true; 891 NewVisibility = NV; 892 893 if (!LinkFromSrc) { 894 // Set calculated linkage. 895 DGV->setLinkage(NewLinkage); 896 DGV->setVisibility(*NewVisibility); 897 898 // Make sure to remember this mapping. 899 ValueMap[SGA] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGA->getType())); 900 901 // Track the alias from the source module so we don't attempt to remap it. 902 DoNotLinkFromSource.insert(SGA); 903 904 return false; 905 } 906 } 907 908 // If there is no linkage to be performed or we're linking from the source, 909 // bring over SGA. 910 GlobalAlias *NewDA = new GlobalAlias(TypeMap.get(SGA->getType()), 911 SGA->getLinkage(), SGA->getName(), 912 /*aliasee*/0, DstM); 913 copyGVAttributes(NewDA, SGA); 914 if (NewVisibility) 915 NewDA->setVisibility(*NewVisibility); 916 917 if (DGV) { 918 // Any uses of DGV need to change to NewDA, with cast. 919 DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDA, DGV->getType())); 920 DGV->eraseFromParent(); 921 } 922 923 ValueMap[SGA] = NewDA; 924 return false; 925 } 926 927 static void getArrayElements(Constant *C, SmallVectorImpl<Constant*> &Dest) { 928 unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements(); 929 930 for (unsigned i = 0; i != NumElements; ++i) 931 Dest.push_back(C->getAggregateElement(i)); 932 } 933 934 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) { 935 // Merge the initializer. 936 SmallVector<Constant*, 16> Elements; 937 getArrayElements(AVI.DstInit, Elements); 938 939 Constant *SrcInit = MapValue(AVI.SrcInit, ValueMap, RF_None, &TypeMap, &ValMaterializer); 940 getArrayElements(SrcInit, Elements); 941 942 ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType()); 943 AVI.NewGV->setInitializer(ConstantArray::get(NewType, Elements)); 944 } 945 946 /// linkGlobalInits - Update the initializers in the Dest module now that all 947 /// globals that may be referenced are in Dest. 948 void ModuleLinker::linkGlobalInits() { 949 // Loop over all of the globals in the src module, mapping them over as we go 950 for (Module::const_global_iterator I = SrcM->global_begin(), 951 E = SrcM->global_end(); I != E; ++I) { 952 953 // Only process initialized GV's or ones not already in dest. 954 if (!I->hasInitializer() || DoNotLinkFromSource.count(I)) continue; 955 956 // Grab destination global variable. 957 GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[I]); 958 // Figure out what the initializer looks like in the dest module. 959 DGV->setInitializer(MapValue(I->getInitializer(), ValueMap, 960 RF_None, &TypeMap, &ValMaterializer)); 961 } 962 } 963 964 /// linkFunctionBody - Copy the source function over into the dest function and 965 /// fix up references to values. At this point we know that Dest is an external 966 /// function, and that Src is not. 967 void ModuleLinker::linkFunctionBody(Function *Dst, Function *Src) { 968 assert(Src && Dst && Dst->isDeclaration() && !Src->isDeclaration()); 969 970 // Go through and convert function arguments over, remembering the mapping. 971 Function::arg_iterator DI = Dst->arg_begin(); 972 for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end(); 973 I != E; ++I, ++DI) { 974 DI->setName(I->getName()); // Copy the name over. 975 976 // Add a mapping to our mapping. 977 ValueMap[I] = DI; 978 } 979 980 if (Mode == Linker::DestroySource) { 981 // Splice the body of the source function into the dest function. 982 Dst->getBasicBlockList().splice(Dst->end(), Src->getBasicBlockList()); 983 984 // At this point, all of the instructions and values of the function are now 985 // copied over. The only problem is that they are still referencing values in 986 // the Source function as operands. Loop through all of the operands of the 987 // functions and patch them up to point to the local versions. 988 for (Function::iterator BB = Dst->begin(), BE = Dst->end(); BB != BE; ++BB) 989 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) 990 RemapInstruction(I, ValueMap, RF_IgnoreMissingEntries, 991 &TypeMap, &ValMaterializer); 992 993 } else { 994 // Clone the body of the function into the dest function. 995 SmallVector<ReturnInst*, 8> Returns; // Ignore returns. 996 CloneFunctionInto(Dst, Src, ValueMap, false, Returns, "", NULL, 997 &TypeMap, &ValMaterializer); 998 } 999 1000 // There is no need to map the arguments anymore. 1001 for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end(); 1002 I != E; ++I) 1003 ValueMap.erase(I); 1004 1005 } 1006 1007 /// linkAliasBodies - Insert all of the aliases in Src into the Dest module. 1008 void ModuleLinker::linkAliasBodies() { 1009 for (Module::alias_iterator I = SrcM->alias_begin(), E = SrcM->alias_end(); 1010 I != E; ++I) { 1011 if (DoNotLinkFromSource.count(I)) 1012 continue; 1013 if (Constant *Aliasee = I->getAliasee()) { 1014 GlobalAlias *DA = cast<GlobalAlias>(ValueMap[I]); 1015 DA->setAliasee(MapValue(Aliasee, ValueMap, RF_None, 1016 &TypeMap, &ValMaterializer)); 1017 } 1018 } 1019 } 1020 1021 /// linkNamedMDNodes - Insert all of the named MDNodes in Src into the Dest 1022 /// module. 1023 void ModuleLinker::linkNamedMDNodes() { 1024 const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata(); 1025 for (Module::const_named_metadata_iterator I = SrcM->named_metadata_begin(), 1026 E = SrcM->named_metadata_end(); I != E; ++I) { 1027 // Don't link module flags here. Do them separately. 1028 if (&*I == SrcModFlags) continue; 1029 NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(I->getName()); 1030 // Add Src elements into Dest node. 1031 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) 1032 DestNMD->addOperand(MapValue(I->getOperand(i), ValueMap, 1033 RF_None, &TypeMap, &ValMaterializer)); 1034 } 1035 } 1036 1037 /// linkModuleFlagsMetadata - Merge the linker flags in Src into the Dest 1038 /// module. 1039 bool ModuleLinker::linkModuleFlagsMetadata() { 1040 // If the source module has no module flags, we are done. 1041 const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata(); 1042 if (!SrcModFlags) return false; 1043 1044 // If the destination module doesn't have module flags yet, then just copy 1045 // over the source module's flags. 1046 NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata(); 1047 if (DstModFlags->getNumOperands() == 0) { 1048 for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) 1049 DstModFlags->addOperand(SrcModFlags->getOperand(I)); 1050 1051 return false; 1052 } 1053 1054 // First build a map of the existing module flags and requirements. 1055 DenseMap<MDString*, MDNode*> Flags; 1056 SmallSetVector<MDNode*, 16> Requirements; 1057 for (unsigned I = 0, E = DstModFlags->getNumOperands(); I != E; ++I) { 1058 MDNode *Op = DstModFlags->getOperand(I); 1059 ConstantInt *Behavior = cast<ConstantInt>(Op->getOperand(0)); 1060 MDString *ID = cast<MDString>(Op->getOperand(1)); 1061 1062 if (Behavior->getZExtValue() == Module::Require) { 1063 Requirements.insert(cast<MDNode>(Op->getOperand(2))); 1064 } else { 1065 Flags[ID] = Op; 1066 } 1067 } 1068 1069 // Merge in the flags from the source module, and also collect its set of 1070 // requirements. 1071 bool HasErr = false; 1072 for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) { 1073 MDNode *SrcOp = SrcModFlags->getOperand(I); 1074 ConstantInt *SrcBehavior = cast<ConstantInt>(SrcOp->getOperand(0)); 1075 MDString *ID = cast<MDString>(SrcOp->getOperand(1)); 1076 MDNode *DstOp = Flags.lookup(ID); 1077 unsigned SrcBehaviorValue = SrcBehavior->getZExtValue(); 1078 1079 // If this is a requirement, add it and continue. 1080 if (SrcBehaviorValue == Module::Require) { 1081 // If the destination module does not already have this requirement, add 1082 // it. 1083 if (Requirements.insert(cast<MDNode>(SrcOp->getOperand(2)))) { 1084 DstModFlags->addOperand(SrcOp); 1085 } 1086 continue; 1087 } 1088 1089 // If there is no existing flag with this ID, just add it. 1090 if (!DstOp) { 1091 Flags[ID] = SrcOp; 1092 DstModFlags->addOperand(SrcOp); 1093 continue; 1094 } 1095 1096 // Otherwise, perform a merge. 1097 ConstantInt *DstBehavior = cast<ConstantInt>(DstOp->getOperand(0)); 1098 unsigned DstBehaviorValue = DstBehavior->getZExtValue(); 1099 1100 // If either flag has override behavior, handle it first. 1101 if (DstBehaviorValue == Module::Override) { 1102 // Diagnose inconsistent flags which both have override behavior. 1103 if (SrcBehaviorValue == Module::Override && 1104 SrcOp->getOperand(2) != DstOp->getOperand(2)) { 1105 HasErr |= emitError("linking module flags '" + ID->getString() + 1106 "': IDs have conflicting override values"); 1107 } 1108 continue; 1109 } else if (SrcBehaviorValue == Module::Override) { 1110 // Update the destination flag to that of the source. 1111 DstOp->replaceOperandWith(0, SrcBehavior); 1112 DstOp->replaceOperandWith(2, SrcOp->getOperand(2)); 1113 continue; 1114 } 1115 1116 // Diagnose inconsistent merge behavior types. 1117 if (SrcBehaviorValue != DstBehaviorValue) { 1118 HasErr |= emitError("linking module flags '" + ID->getString() + 1119 "': IDs have conflicting behaviors"); 1120 continue; 1121 } 1122 1123 // Perform the merge for standard behavior types. 1124 switch (SrcBehaviorValue) { 1125 case Module::Require: 1126 case Module::Override: assert(0 && "not possible"); break; 1127 case Module::Error: { 1128 // Emit an error if the values differ. 1129 if (SrcOp->getOperand(2) != DstOp->getOperand(2)) { 1130 HasErr |= emitError("linking module flags '" + ID->getString() + 1131 "': IDs have conflicting values"); 1132 } 1133 continue; 1134 } 1135 case Module::Warning: { 1136 // Emit a warning if the values differ. 1137 if (SrcOp->getOperand(2) != DstOp->getOperand(2)) { 1138 errs() << "WARNING: linking module flags '" << ID->getString() 1139 << "': IDs have conflicting values"; 1140 } 1141 continue; 1142 } 1143 case Module::Append: { 1144 MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2)); 1145 MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2)); 1146 unsigned NumOps = DstValue->getNumOperands() + SrcValue->getNumOperands(); 1147 Value **VP, **Values = VP = new Value*[NumOps]; 1148 for (unsigned i = 0, e = DstValue->getNumOperands(); i != e; ++i, ++VP) 1149 *VP = DstValue->getOperand(i); 1150 for (unsigned i = 0, e = SrcValue->getNumOperands(); i != e; ++i, ++VP) 1151 *VP = SrcValue->getOperand(i); 1152 DstOp->replaceOperandWith(2, MDNode::get(DstM->getContext(), 1153 ArrayRef<Value*>(Values, 1154 NumOps))); 1155 delete[] Values; 1156 break; 1157 } 1158 case Module::AppendUnique: { 1159 SmallSetVector<Value*, 16> Elts; 1160 MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2)); 1161 MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2)); 1162 for (unsigned i = 0, e = DstValue->getNumOperands(); i != e; ++i) 1163 Elts.insert(DstValue->getOperand(i)); 1164 for (unsigned i = 0, e = SrcValue->getNumOperands(); i != e; ++i) 1165 Elts.insert(SrcValue->getOperand(i)); 1166 DstOp->replaceOperandWith(2, MDNode::get(DstM->getContext(), 1167 ArrayRef<Value*>(Elts.begin(), 1168 Elts.end()))); 1169 break; 1170 } 1171 } 1172 } 1173 1174 // Check all of the requirements. 1175 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) { 1176 MDNode *Requirement = Requirements[I]; 1177 MDString *Flag = cast<MDString>(Requirement->getOperand(0)); 1178 Value *ReqValue = Requirement->getOperand(1); 1179 1180 MDNode *Op = Flags[Flag]; 1181 if (!Op || Op->getOperand(2) != ReqValue) { 1182 HasErr |= emitError("linking module flags '" + Flag->getString() + 1183 "': does not have the required value"); 1184 continue; 1185 } 1186 } 1187 1188 return HasErr; 1189 } 1190 1191 bool ModuleLinker::run() { 1192 assert(DstM && "Null destination module"); 1193 assert(SrcM && "Null source module"); 1194 1195 // Inherit the target data from the source module if the destination module 1196 // doesn't have one already. 1197 if (DstM->getDataLayout().empty() && !SrcM->getDataLayout().empty()) 1198 DstM->setDataLayout(SrcM->getDataLayout()); 1199 1200 // Copy the target triple from the source to dest if the dest's is empty. 1201 if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty()) 1202 DstM->setTargetTriple(SrcM->getTargetTriple()); 1203 1204 if (!SrcM->getDataLayout().empty() && !DstM->getDataLayout().empty() && 1205 SrcM->getDataLayout() != DstM->getDataLayout()) 1206 errs() << "WARNING: Linking two modules of different data layouts!\n"; 1207 if (!SrcM->getTargetTriple().empty() && 1208 DstM->getTargetTriple() != SrcM->getTargetTriple()) { 1209 errs() << "WARNING: Linking two modules of different target triples: "; 1210 if (!SrcM->getModuleIdentifier().empty()) 1211 errs() << SrcM->getModuleIdentifier() << ": "; 1212 errs() << "'" << SrcM->getTargetTriple() << "' and '" 1213 << DstM->getTargetTriple() << "'\n"; 1214 } 1215 1216 // Append the module inline asm string. 1217 if (!SrcM->getModuleInlineAsm().empty()) { 1218 if (DstM->getModuleInlineAsm().empty()) 1219 DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm()); 1220 else 1221 DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+ 1222 SrcM->getModuleInlineAsm()); 1223 } 1224 1225 // Loop over all of the linked values to compute type mappings. 1226 computeTypeMapping(); 1227 1228 // Insert all of the globals in src into the DstM module... without linking 1229 // initializers (which could refer to functions not yet mapped over). 1230 for (Module::global_iterator I = SrcM->global_begin(), 1231 E = SrcM->global_end(); I != E; ++I) 1232 if (linkGlobalProto(I)) 1233 return true; 1234 1235 // Link the functions together between the two modules, without doing function 1236 // bodies... this just adds external function prototypes to the DstM 1237 // function... We do this so that when we begin processing function bodies, 1238 // all of the global values that may be referenced are available in our 1239 // ValueMap. 1240 for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) 1241 if (linkFunctionProto(I)) 1242 return true; 1243 1244 // If there were any aliases, link them now. 1245 for (Module::alias_iterator I = SrcM->alias_begin(), 1246 E = SrcM->alias_end(); I != E; ++I) 1247 if (linkAliasProto(I)) 1248 return true; 1249 1250 for (unsigned i = 0, e = AppendingVars.size(); i != e; ++i) 1251 linkAppendingVarInit(AppendingVars[i]); 1252 1253 // Update the initializers in the DstM module now that all globals that may 1254 // be referenced are in DstM. 1255 linkGlobalInits(); 1256 1257 // Link in the function bodies that are defined in the source module into 1258 // DstM. 1259 for (Module::iterator SF = SrcM->begin(), E = SrcM->end(); SF != E; ++SF) { 1260 // Skip if not linking from source. 1261 if (DoNotLinkFromSource.count(SF)) continue; 1262 1263 Function *DF = cast<Function>(ValueMap[SF]); 1264 if (SF->hasPrefixData()) { 1265 // Link in the prefix data. 1266 DF->setPrefixData(MapValue( 1267 SF->getPrefixData(), ValueMap, RF_None, &TypeMap, &ValMaterializer)); 1268 } 1269 1270 // Skip if no body (function is external) or materialize. 1271 if (SF->isDeclaration()) { 1272 if (!SF->isMaterializable()) 1273 continue; 1274 if (SF->Materialize(&ErrorMsg)) 1275 return true; 1276 } 1277 1278 linkFunctionBody(DF, SF); 1279 SF->Dematerialize(); 1280 } 1281 1282 // Resolve all uses of aliases with aliasees. 1283 linkAliasBodies(); 1284 1285 // Remap all of the named MDNodes in Src into the DstM module. We do this 1286 // after linking GlobalValues so that MDNodes that reference GlobalValues 1287 // are properly remapped. 1288 linkNamedMDNodes(); 1289 1290 // Merge the module flags into the DstM module. 1291 if (linkModuleFlagsMetadata()) 1292 return true; 1293 1294 // Process vector of lazily linked in functions. 1295 bool LinkedInAnyFunctions; 1296 do { 1297 LinkedInAnyFunctions = false; 1298 1299 for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(), 1300 E = LazilyLinkFunctions.end(); I != E; ++I) { 1301 Function *SF = *I; 1302 if (!SF) 1303 continue; 1304 1305 Function *DF = cast<Function>(ValueMap[SF]); 1306 if (SF->hasPrefixData()) { 1307 // Link in the prefix data. 1308 DF->setPrefixData(MapValue(SF->getPrefixData(), 1309 ValueMap, 1310 RF_None, 1311 &TypeMap, 1312 &ValMaterializer)); 1313 } 1314 1315 // Materialize if necessary. 1316 if (SF->isDeclaration()) { 1317 if (!SF->isMaterializable()) 1318 continue; 1319 if (SF->Materialize(&ErrorMsg)) 1320 return true; 1321 } 1322 1323 // Erase from vector *before* the function body is linked - linkFunctionBody could 1324 // invalidate I. 1325 LazilyLinkFunctions.erase(I); 1326 1327 // Link in function body. 1328 linkFunctionBody(DF, SF); 1329 SF->Dematerialize(); 1330 1331 // Set flag to indicate we may have more functions to lazily link in 1332 // since we linked in a function. 1333 LinkedInAnyFunctions = true; 1334 break; 1335 } 1336 } while (LinkedInAnyFunctions); 1337 1338 // Now that all of the types from the source are used, resolve any structs 1339 // copied over to the dest that didn't exist there. 1340 TypeMap.linkDefinedTypeBodies(); 1341 1342 return false; 1343 } 1344 1345 Linker::Linker(Module *M) : Composite(M) { 1346 TypeFinder StructTypes; 1347 StructTypes.run(*M, true); 1348 IdentifiedStructTypes.insert(StructTypes.begin(), StructTypes.end()); 1349 } 1350 1351 Linker::~Linker() { 1352 } 1353 1354 bool Linker::linkInModule(Module *Src, unsigned Mode, std::string *ErrorMsg) { 1355 ModuleLinker TheLinker(Composite, IdentifiedStructTypes, Src, Mode); 1356 if (TheLinker.run()) { 1357 if (ErrorMsg) 1358 *ErrorMsg = TheLinker.ErrorMsg; 1359 return true; 1360 } 1361 return false; 1362 } 1363 1364 //===----------------------------------------------------------------------===// 1365 // LinkModules entrypoint. 1366 //===----------------------------------------------------------------------===// 1367 1368 /// LinkModules - This function links two modules together, with the resulting 1369 /// Dest module modified to be the composite of the two input modules. If an 1370 /// error occurs, true is returned and ErrorMsg (if not null) is set to indicate 1371 /// the problem. Upon failure, the Dest module could be in a modified state, 1372 /// and shouldn't be relied on to be consistent. 1373 bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Mode, 1374 std::string *ErrorMsg) { 1375 Linker L(Dest); 1376 return L.linkInModule(Src, Mode, ErrorMsg); 1377 } 1378 1379 //===----------------------------------------------------------------------===// 1380 // C API. 1381 //===----------------------------------------------------------------------===// 1382 1383 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src, 1384 LLVMLinkerMode Mode, char **OutMessages) { 1385 std::string Messages; 1386 LLVMBool Result = Linker::LinkModules(unwrap(Dest), unwrap(Src), 1387 Mode, OutMessages? &Messages : 0); 1388 if (OutMessages) 1389 *OutMessages = strdup(Messages.c_str()); 1390 return Result; 1391 } 1392