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"
23c521f541SChris Lattner #include "llvm/Support/raw_ostream.h"
24447762daSMichael J. Spencer #include "llvm/Support/Path.h"
25cbb91408STanya Lattner #include "llvm/Transforms/Utils/Cloning.h"
26a2095034SDan Gohman #include "llvm/Transforms/Utils/ValueMapper.h"
27361e513dSReid Spencer using namespace llvm;
28361e513dSReid Spencer 
29b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
30b1ed91f3SChris Lattner // TypeMap implementation.
31b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
32b1ed91f3SChris Lattner 
33b1ed91f3SChris Lattner namespace {
34b1ed91f3SChris Lattner class TypeMapTy : public ValueMapTypeRemapper {
35b1ed91f3SChris Lattner   /// MappedTypes - This is a mapping from a source type to a destination type
36b1ed91f3SChris Lattner   /// to use.
37b1ed91f3SChris Lattner   DenseMap<Type*, Type*> MappedTypes;
38b1ed91f3SChris Lattner 
39b1ed91f3SChris Lattner   /// SpeculativeTypes - When checking to see if two subgraphs are isomorphic,
40b1ed91f3SChris Lattner   /// we speculatively add types to MappedTypes, but keep track of them here in
41b1ed91f3SChris Lattner   /// case we need to roll back.
42b1ed91f3SChris Lattner   SmallVector<Type*, 16> SpeculativeTypes;
43b1ed91f3SChris Lattner 
445e3bd972SChris Lattner   /// SrcDefinitionsToResolve - This is a list of non-opaque structs in the
455e3bd972SChris Lattner   /// source module that are mapped to an opaque struct in the destination
465e3bd972SChris Lattner   /// module.
475e3bd972SChris Lattner   SmallVector<StructType*, 16> SrcDefinitionsToResolve;
485e3bd972SChris Lattner 
495e3bd972SChris Lattner   /// DstResolvedOpaqueTypes - This is the set of opaque types in the
505e3bd972SChris Lattner   /// destination modules who are getting a body from the source module.
515e3bd972SChris Lattner   SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes;
52b1ed91f3SChris Lattner public:
53b1ed91f3SChris Lattner 
54b1ed91f3SChris Lattner   /// addTypeMapping - Indicate that the specified type in the destination
55b1ed91f3SChris Lattner   /// module is conceptually equivalent to the specified type in the source
56b1ed91f3SChris Lattner   /// module.
57b1ed91f3SChris Lattner   void addTypeMapping(Type *DstTy, Type *SrcTy);
58b1ed91f3SChris Lattner 
59b1ed91f3SChris Lattner   /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest
60b1ed91f3SChris Lattner   /// module from a type definition in the source module.
61b1ed91f3SChris Lattner   void linkDefinedTypeBodies();
62b1ed91f3SChris Lattner 
63b1ed91f3SChris Lattner   /// get - Return the mapped type to use for the specified input type from the
64b1ed91f3SChris Lattner   /// source module.
65b1ed91f3SChris Lattner   Type *get(Type *SrcTy);
66b1ed91f3SChris Lattner 
67b1ed91f3SChris Lattner   FunctionType *get(FunctionType *T) {return cast<FunctionType>(get((Type*)T));}
68b1ed91f3SChris Lattner 
69b1ed91f3SChris Lattner private:
70b1ed91f3SChris Lattner   Type *getImpl(Type *T);
71b1ed91f3SChris Lattner   /// remapType - Implement the ValueMapTypeRemapper interface.
72b1ed91f3SChris Lattner   Type *remapType(Type *SrcTy) {
73b1ed91f3SChris Lattner     return get(SrcTy);
74b1ed91f3SChris Lattner   }
75b1ed91f3SChris Lattner 
76b1ed91f3SChris Lattner   bool areTypesIsomorphic(Type *DstTy, Type *SrcTy);
77b1ed91f3SChris Lattner };
78b1ed91f3SChris Lattner }
79b1ed91f3SChris Lattner 
80b1ed91f3SChris Lattner void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) {
81b1ed91f3SChris Lattner   Type *&Entry = MappedTypes[SrcTy];
82b1ed91f3SChris Lattner   if (Entry) return;
83b1ed91f3SChris Lattner 
84b1ed91f3SChris Lattner   if (DstTy == SrcTy) {
85b1ed91f3SChris Lattner     Entry = DstTy;
86b1ed91f3SChris Lattner     return;
87b1ed91f3SChris Lattner   }
88b1ed91f3SChris Lattner 
89b1ed91f3SChris Lattner   // Check to see if these types are recursively isomorphic and establish a
90b1ed91f3SChris Lattner   // mapping between them if so.
91b1ed91f3SChris Lattner   if (!areTypesIsomorphic(DstTy, SrcTy)) {
92b1ed91f3SChris Lattner     // Oops, they aren't isomorphic.  Just discard this request by rolling out
93b1ed91f3SChris Lattner     // any speculative mappings we've established.
94b1ed91f3SChris Lattner     for (unsigned i = 0, e = SpeculativeTypes.size(); i != e; ++i)
95b1ed91f3SChris Lattner       MappedTypes.erase(SpeculativeTypes[i]);
96b1ed91f3SChris Lattner   }
97b1ed91f3SChris Lattner   SpeculativeTypes.clear();
98b1ed91f3SChris Lattner }
99b1ed91f3SChris Lattner 
100b1ed91f3SChris Lattner /// areTypesIsomorphic - Recursively walk this pair of types, returning true
101b1ed91f3SChris Lattner /// if they are isomorphic, false if they are not.
102b1ed91f3SChris Lattner bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) {
103b1ed91f3SChris Lattner   // Two types with differing kinds are clearly not isomorphic.
104b1ed91f3SChris Lattner   if (DstTy->getTypeID() != SrcTy->getTypeID()) return false;
105b1ed91f3SChris Lattner 
106b1ed91f3SChris Lattner   // If we have an entry in the MappedTypes table, then we have our answer.
107b1ed91f3SChris Lattner   Type *&Entry = MappedTypes[SrcTy];
108b1ed91f3SChris Lattner   if (Entry)
109b1ed91f3SChris Lattner     return Entry == DstTy;
110b1ed91f3SChris Lattner 
111b1ed91f3SChris Lattner   // Two identical types are clearly isomorphic.  Remember this
112b1ed91f3SChris Lattner   // non-speculatively.
113b1ed91f3SChris Lattner   if (DstTy == SrcTy) {
114b1ed91f3SChris Lattner     Entry = DstTy;
115361e513dSReid Spencer     return true;
116361e513dSReid Spencer   }
117361e513dSReid Spencer 
118b1ed91f3SChris Lattner   // Okay, we have two types with identical kinds that we haven't seen before.
119361e513dSReid Spencer 
120b1ed91f3SChris Lattner   // If this is an opaque struct type, special case it.
121b1ed91f3SChris Lattner   if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) {
122b1ed91f3SChris Lattner     // Mapping an opaque type to any struct, just keep the dest struct.
123b1ed91f3SChris Lattner     if (SSTy->isOpaque()) {
124b1ed91f3SChris Lattner       Entry = DstTy;
125b1ed91f3SChris Lattner       SpeculativeTypes.push_back(SrcTy);
126b1ed91f3SChris Lattner       return true;
127361e513dSReid Spencer     }
128b1ed91f3SChris Lattner 
1295e3bd972SChris Lattner     // Mapping a non-opaque source type to an opaque dest.  If this is the first
1305e3bd972SChris Lattner     // type that we're mapping onto this destination type then we succeed.  Keep
1315e3bd972SChris Lattner     // the dest, but fill it in later.  This doesn't need to be speculative.  If
1325e3bd972SChris Lattner     // this is the second (different) type that we're trying to map onto the
1335e3bd972SChris Lattner     // same opaque type then we fail.
134b1ed91f3SChris Lattner     if (cast<StructType>(DstTy)->isOpaque()) {
1355e3bd972SChris Lattner       // We can only map one source type onto the opaque destination type.
1365e3bd972SChris Lattner       if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy)))
1375e3bd972SChris Lattner         return false;
1385e3bd972SChris Lattner       SrcDefinitionsToResolve.push_back(SSTy);
139b1ed91f3SChris Lattner       Entry = DstTy;
140b1ed91f3SChris Lattner       return true;
141b1ed91f3SChris Lattner     }
142b1ed91f3SChris Lattner   }
143b1ed91f3SChris Lattner 
144b1ed91f3SChris Lattner   // If the number of subtypes disagree between the two types, then we fail.
145b1ed91f3SChris Lattner   if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes())
146b1ed91f3SChris Lattner     return false;
147b1ed91f3SChris Lattner 
148b1ed91f3SChris Lattner   // Fail if any of the extra properties (e.g. array size) of the type disagree.
149b1ed91f3SChris Lattner   if (isa<IntegerType>(DstTy))
150b1ed91f3SChris Lattner     return false;  // bitwidth disagrees.
151b1ed91f3SChris Lattner   if (PointerType *PT = dyn_cast<PointerType>(DstTy)) {
152b1ed91f3SChris Lattner     if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace())
153b1ed91f3SChris Lattner       return false;
154eaf9b762SChris Lattner 
155b1ed91f3SChris Lattner   } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) {
156b1ed91f3SChris Lattner     if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg())
157b1ed91f3SChris Lattner       return false;
158b1ed91f3SChris Lattner   } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) {
159b1ed91f3SChris Lattner     StructType *SSTy = cast<StructType>(SrcTy);
16044f7ab45SChris Lattner     if (DSTy->isLiteral() != SSTy->isLiteral() ||
161b1ed91f3SChris Lattner         DSTy->isPacked() != SSTy->isPacked())
162b1ed91f3SChris Lattner       return false;
163b1ed91f3SChris Lattner   } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) {
164b1ed91f3SChris Lattner     if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
165b1ed91f3SChris Lattner       return false;
166b1ed91f3SChris Lattner   } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
167b1ed91f3SChris Lattner     if (DVTy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
168361e513dSReid Spencer       return false;
169361e513dSReid Spencer   }
170361e513dSReid Spencer 
171b1ed91f3SChris Lattner   // Otherwise, we speculate that these two types will line up and recursively
172b1ed91f3SChris Lattner   // check the subelements.
173b1ed91f3SChris Lattner   Entry = DstTy;
174b1ed91f3SChris Lattner   SpeculativeTypes.push_back(SrcTy);
175eee6f995SChris Lattner 
176b1ed91f3SChris Lattner   for (unsigned i = 0, e = SrcTy->getNumContainedTypes(); i != e; ++i)
177b1ed91f3SChris Lattner     if (!areTypesIsomorphic(DstTy->getContainedType(i),
178b1ed91f3SChris Lattner                             SrcTy->getContainedType(i)))
179b1ed91f3SChris Lattner       return false;
180eee6f995SChris Lattner 
181b1ed91f3SChris Lattner   // If everything seems to have lined up, then everything is great.
182eee6f995SChris Lattner   return true;
183eee6f995SChris Lattner }
184eee6f995SChris Lattner 
185b1ed91f3SChris Lattner /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest
186b1ed91f3SChris Lattner /// module from a type definition in the source module.
187b1ed91f3SChris Lattner void TypeMapTy::linkDefinedTypeBodies() {
188b1ed91f3SChris Lattner   SmallVector<Type*, 16> Elements;
189b1ed91f3SChris Lattner   SmallString<16> TmpName;
190eee6f995SChris Lattner 
191b1ed91f3SChris Lattner   // Note that processing entries in this loop (calling 'get') can add new
1925e3bd972SChris Lattner   // entries to the SrcDefinitionsToResolve vector.
1935e3bd972SChris Lattner   while (!SrcDefinitionsToResolve.empty()) {
1945e3bd972SChris Lattner     StructType *SrcSTy = SrcDefinitionsToResolve.pop_back_val();
195b1ed91f3SChris Lattner     StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]);
196eee6f995SChris Lattner 
197b1ed91f3SChris Lattner     // TypeMap is a many-to-one mapping, if there were multiple types that
198b1ed91f3SChris Lattner     // provide a body for DstSTy then previous iterations of this loop may have
199b1ed91f3SChris Lattner     // already handled it.  Just ignore this case.
200b1ed91f3SChris Lattner     if (!DstSTy->isOpaque()) continue;
201b1ed91f3SChris Lattner     assert(!SrcSTy->isOpaque() && "Not resolving a definition?");
202b1ed91f3SChris Lattner 
203b1ed91f3SChris Lattner     // Map the body of the source type over to a new body for the dest type.
204b1ed91f3SChris Lattner     Elements.resize(SrcSTy->getNumElements());
205b1ed91f3SChris Lattner     for (unsigned i = 0, e = Elements.size(); i != e; ++i)
206b1ed91f3SChris Lattner       Elements[i] = getImpl(SrcSTy->getElementType(i));
207b1ed91f3SChris Lattner 
208b1ed91f3SChris Lattner     DstSTy->setBody(Elements, SrcSTy->isPacked());
209b1ed91f3SChris Lattner 
210b1ed91f3SChris Lattner     // If DstSTy has no name or has a longer name than STy, then viciously steal
211b1ed91f3SChris Lattner     // STy's name.
212b1ed91f3SChris Lattner     if (!SrcSTy->hasName()) continue;
213b1ed91f3SChris Lattner     StringRef SrcName = SrcSTy->getName();
214b1ed91f3SChris Lattner 
215b1ed91f3SChris Lattner     if (!DstSTy->hasName() || DstSTy->getName().size() > SrcName.size()) {
216b1ed91f3SChris Lattner       TmpName.insert(TmpName.end(), SrcName.begin(), SrcName.end());
217b1ed91f3SChris Lattner       SrcSTy->setName("");
218b1ed91f3SChris Lattner       DstSTy->setName(TmpName.str());
219b1ed91f3SChris Lattner       TmpName.clear();
220b1ed91f3SChris Lattner     }
221b1ed91f3SChris Lattner   }
2225e3bd972SChris Lattner 
2235e3bd972SChris Lattner   DstResolvedOpaqueTypes.clear();
224eee6f995SChris Lattner }
225eee6f995SChris Lattner 
226b1ed91f3SChris Lattner 
227b1ed91f3SChris Lattner /// get - Return the mapped type to use for the specified input type from the
228b1ed91f3SChris Lattner /// source module.
229b1ed91f3SChris Lattner Type *TypeMapTy::get(Type *Ty) {
230b1ed91f3SChris Lattner   Type *Result = getImpl(Ty);
231b1ed91f3SChris Lattner 
232b1ed91f3SChris Lattner   // If this caused a reference to any struct type, resolve it before returning.
2335e3bd972SChris Lattner   if (!SrcDefinitionsToResolve.empty())
234b1ed91f3SChris Lattner     linkDefinedTypeBodies();
235b1ed91f3SChris Lattner   return Result;
236eee6f995SChris Lattner }
237eee6f995SChris Lattner 
238b1ed91f3SChris Lattner /// getImpl - This is the recursive version of get().
239b1ed91f3SChris Lattner Type *TypeMapTy::getImpl(Type *Ty) {
240b1ed91f3SChris Lattner   // If we already have an entry for this type, return it.
241b1ed91f3SChris Lattner   Type **Entry = &MappedTypes[Ty];
242b1ed91f3SChris Lattner   if (*Entry) return *Entry;
243b1ed91f3SChris Lattner 
244b1ed91f3SChris Lattner   // If this is not a named struct type, then just map all of the elements and
245b1ed91f3SChris Lattner   // then rebuild the type from inside out.
24644f7ab45SChris Lattner   if (!isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral()) {
247b1ed91f3SChris Lattner     // If there are no element types to map, then the type is itself.  This is
248b1ed91f3SChris Lattner     // true for the anonymous {} struct, things like 'float', integers, etc.
249b1ed91f3SChris Lattner     if (Ty->getNumContainedTypes() == 0)
250b1ed91f3SChris Lattner       return *Entry = Ty;
251b1ed91f3SChris Lattner 
252b1ed91f3SChris Lattner     // Remap all of the elements, keeping track of whether any of them change.
253b1ed91f3SChris Lattner     bool AnyChange = false;
254b1ed91f3SChris Lattner     SmallVector<Type*, 4> ElementTypes;
255b1ed91f3SChris Lattner     ElementTypes.resize(Ty->getNumContainedTypes());
256b1ed91f3SChris Lattner     for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i) {
257b1ed91f3SChris Lattner       ElementTypes[i] = getImpl(Ty->getContainedType(i));
258b1ed91f3SChris Lattner       AnyChange |= ElementTypes[i] != Ty->getContainedType(i);
259eee6f995SChris Lattner     }
260b1ed91f3SChris Lattner 
261b1ed91f3SChris Lattner     // If we found our type while recursively processing stuff, just use it.
262b1ed91f3SChris Lattner     Entry = &MappedTypes[Ty];
263b1ed91f3SChris Lattner     if (*Entry) return *Entry;
264b1ed91f3SChris Lattner 
265b1ed91f3SChris Lattner     // If all of the element types mapped directly over, then the type is usable
266b1ed91f3SChris Lattner     // as-is.
267b1ed91f3SChris Lattner     if (!AnyChange)
268b1ed91f3SChris Lattner       return *Entry = Ty;
269b1ed91f3SChris Lattner 
270b1ed91f3SChris Lattner     // Otherwise, rebuild a modified type.
271b1ed91f3SChris Lattner     switch (Ty->getTypeID()) {
272a2886c21SCraig Topper     default: llvm_unreachable("unknown derived type to remap");
273b1ed91f3SChris Lattner     case Type::ArrayTyID:
274b1ed91f3SChris Lattner       return *Entry = ArrayType::get(ElementTypes[0],
275b1ed91f3SChris Lattner                                      cast<ArrayType>(Ty)->getNumElements());
276b1ed91f3SChris Lattner     case Type::VectorTyID:
277b1ed91f3SChris Lattner       return *Entry = VectorType::get(ElementTypes[0],
278b1ed91f3SChris Lattner                                       cast<VectorType>(Ty)->getNumElements());
279b1ed91f3SChris Lattner     case Type::PointerTyID:
280b1ed91f3SChris Lattner       return *Entry = PointerType::get(ElementTypes[0],
281b1ed91f3SChris Lattner                                       cast<PointerType>(Ty)->getAddressSpace());
282b1ed91f3SChris Lattner     case Type::FunctionTyID:
283b1ed91f3SChris Lattner       return *Entry = FunctionType::get(ElementTypes[0],
284717d7eddSFrits van Bommel                                         makeArrayRef(ElementTypes).slice(1),
285b1ed91f3SChris Lattner                                         cast<FunctionType>(Ty)->isVarArg());
286b1ed91f3SChris Lattner     case Type::StructTyID:
287b1ed91f3SChris Lattner       // Note that this is only reached for anonymous structs.
288b1ed91f3SChris Lattner       return *Entry = StructType::get(Ty->getContext(), ElementTypes,
289b1ed91f3SChris Lattner                                       cast<StructType>(Ty)->isPacked());
290b1ed91f3SChris Lattner     }
291b1ed91f3SChris Lattner   }
292b1ed91f3SChris Lattner 
293b1ed91f3SChris Lattner   // Otherwise, this is an unmapped named struct.  If the struct can be directly
294b1ed91f3SChris Lattner   // mapped over, just use it as-is.  This happens in a case when the linked-in
295b1ed91f3SChris Lattner   // module has something like:
296b1ed91f3SChris Lattner   //   %T = type {%T*, i32}
297b1ed91f3SChris Lattner   //   @GV = global %T* null
298b1ed91f3SChris Lattner   // where T does not exist at all in the destination module.
299b1ed91f3SChris Lattner   //
300b1ed91f3SChris Lattner   // The other case we watch for is when the type is not in the destination
301b1ed91f3SChris Lattner   // module, but that it has to be rebuilt because it refers to something that
302b1ed91f3SChris Lattner   // is already mapped.  For example, if the destination module has:
303b1ed91f3SChris Lattner   //  %A = type { i32 }
304b1ed91f3SChris Lattner   // and the source module has something like
305b1ed91f3SChris Lattner   //  %A' = type { i32 }
306b1ed91f3SChris Lattner   //  %B = type { %A'* }
307b1ed91f3SChris Lattner   //  @GV = global %B* null
308b1ed91f3SChris Lattner   // then we want to create a new type: "%B = type { %A*}" and have it take the
309b1ed91f3SChris Lattner   // pristine "%B" name from the source module.
310b1ed91f3SChris Lattner   //
311b1ed91f3SChris Lattner   // To determine which case this is, we have to recursively walk the type graph
312b1ed91f3SChris Lattner   // speculating that we'll be able to reuse it unmodified.  Only if this is
313b1ed91f3SChris Lattner   // safe would we map the entire thing over.  Because this is an optimization,
314b1ed91f3SChris Lattner   // and is not required for the prettiness of the linked module, we just skip
315b1ed91f3SChris Lattner   // it and always rebuild a type here.
316b1ed91f3SChris Lattner   StructType *STy = cast<StructType>(Ty);
317b1ed91f3SChris Lattner 
318b1ed91f3SChris Lattner   // If the type is opaque, we can just use it directly.
319b1ed91f3SChris Lattner   if (STy->isOpaque())
320b1ed91f3SChris Lattner     return *Entry = STy;
321b1ed91f3SChris Lattner 
322b1ed91f3SChris Lattner   // Otherwise we create a new type and resolve its body later.  This will be
323b1ed91f3SChris Lattner   // resolved by the top level of get().
3245e3bd972SChris Lattner   SrcDefinitionsToResolve.push_back(STy);
3255e3bd972SChris Lattner   StructType *DTy = StructType::create(STy->getContext());
3265e3bd972SChris Lattner   DstResolvedOpaqueTypes.insert(DTy);
3275e3bd972SChris Lattner   return *Entry = DTy;
328b1ed91f3SChris Lattner }
329b1ed91f3SChris Lattner 
330b1ed91f3SChris Lattner 
331b1ed91f3SChris Lattner 
332b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
333b1ed91f3SChris Lattner // ModuleLinker implementation.
334b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
335b1ed91f3SChris Lattner 
336b1ed91f3SChris Lattner namespace {
337b1ed91f3SChris Lattner   /// ModuleLinker - This is an implementation class for the LinkModules
338b1ed91f3SChris Lattner   /// function, which is the entrypoint for this file.
339b1ed91f3SChris Lattner   class ModuleLinker {
340b1ed91f3SChris Lattner     Module *DstM, *SrcM;
341b1ed91f3SChris Lattner 
342b1ed91f3SChris Lattner     TypeMapTy TypeMap;
343b1ed91f3SChris Lattner 
344b1ed91f3SChris Lattner     /// ValueMap - Mapping of values from what they used to be in Src, to what
345b1ed91f3SChris Lattner     /// they are now in DstM.  ValueToValueMapTy is a ValueMap, which involves
346b1ed91f3SChris Lattner     /// some overhead due to the use of Value handles which the Linker doesn't
347b1ed91f3SChris Lattner     /// actually need, but this allows us to reuse the ValueMapper code.
348b1ed91f3SChris Lattner     ValueToValueMapTy ValueMap;
349b1ed91f3SChris Lattner 
350b1ed91f3SChris Lattner     struct AppendingVarInfo {
351b1ed91f3SChris Lattner       GlobalVariable *NewGV;  // New aggregate global in dest module.
352b1ed91f3SChris Lattner       Constant *DstInit;      // Old initializer from dest module.
353b1ed91f3SChris Lattner       Constant *SrcInit;      // Old initializer from src module.
354b1ed91f3SChris Lattner     };
355b1ed91f3SChris Lattner 
356b1ed91f3SChris Lattner     std::vector<AppendingVarInfo> AppendingVars;
357b1ed91f3SChris Lattner 
358cbb91408STanya Lattner     unsigned Mode; // Mode to treat source module.
359cbb91408STanya Lattner 
360cbb91408STanya Lattner     // Set of items not to link in from source.
361cbb91408STanya Lattner     SmallPtrSet<const Value*, 16> DoNotLinkFromSource;
362cbb91408STanya Lattner 
3630a48b877STanya Lattner     // Vector of functions to lazily link in.
3640a48b877STanya Lattner     std::vector<Function*> LazilyLinkFunctions;
3650a48b877STanya Lattner 
366b1ed91f3SChris Lattner   public:
367b1ed91f3SChris Lattner     std::string ErrorMsg;
368b1ed91f3SChris Lattner 
369cbb91408STanya Lattner     ModuleLinker(Module *dstM, Module *srcM, unsigned mode)
370cbb91408STanya Lattner       : DstM(dstM), SrcM(srcM), Mode(mode) { }
371b1ed91f3SChris Lattner 
372b1ed91f3SChris Lattner     bool run();
373b1ed91f3SChris Lattner 
374b1ed91f3SChris Lattner   private:
375b1ed91f3SChris Lattner     /// emitError - Helper method for setting a message and returning an error
376b1ed91f3SChris Lattner     /// code.
377b1ed91f3SChris Lattner     bool emitError(const Twine &Message) {
378b1ed91f3SChris Lattner       ErrorMsg = Message.str();
379b1ed91f3SChris Lattner       return true;
380b1ed91f3SChris Lattner     }
381b1ed91f3SChris Lattner 
382b1ed91f3SChris Lattner     /// getLinkageResult - This analyzes the two global values and determines
383b1ed91f3SChris Lattner     /// what the result will look like in the destination module.
384b1ed91f3SChris Lattner     bool getLinkageResult(GlobalValue *Dest, const GlobalValue *Src,
38523f8d64bSRafael Espindola                           GlobalValue::LinkageTypes &LT,
38623f8d64bSRafael Espindola                           GlobalValue::VisibilityTypes &Vis,
38723f8d64bSRafael Espindola                           bool &LinkFromSrc);
388b1ed91f3SChris Lattner 
389b1ed91f3SChris Lattner     /// getLinkedToGlobal - Given a global in the source module, return the
390b1ed91f3SChris Lattner     /// global in the destination module that is being linked to, if any.
391b1ed91f3SChris Lattner     GlobalValue *getLinkedToGlobal(GlobalValue *SrcGV) {
392b1ed91f3SChris Lattner       // If the source has no name it can't link.  If it has local linkage,
393b1ed91f3SChris Lattner       // there is no name match-up going on.
394b1ed91f3SChris Lattner       if (!SrcGV->hasName() || SrcGV->hasLocalLinkage())
395b1ed91f3SChris Lattner         return 0;
396b1ed91f3SChris Lattner 
397b1ed91f3SChris Lattner       // Otherwise see if we have a match in the destination module's symtab.
398b1ed91f3SChris Lattner       GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName());
399b1ed91f3SChris Lattner       if (DGV == 0) return 0;
400b1ed91f3SChris Lattner 
401b1ed91f3SChris Lattner       // If we found a global with the same name in the dest module, but it has
402b1ed91f3SChris Lattner       // internal linkage, we are really not doing any linkage here.
403b1ed91f3SChris Lattner       if (DGV->hasLocalLinkage())
404b1ed91f3SChris Lattner         return 0;
405b1ed91f3SChris Lattner 
406b1ed91f3SChris Lattner       // Otherwise, we do in fact link to the destination global.
407b1ed91f3SChris Lattner       return DGV;
408b1ed91f3SChris Lattner     }
409b1ed91f3SChris Lattner 
410b1ed91f3SChris Lattner     void computeTypeMapping();
41166f02413SBill Wendling     bool categorizeModuleFlagNodes(const NamedMDNode *ModFlags,
41266f02413SBill Wendling                                    DenseMap<MDString*, MDNode*> &ErrorNode,
41366f02413SBill Wendling                                    DenseMap<MDString*, MDNode*> &WarningNode,
41466f02413SBill Wendling                                    DenseMap<MDString*, MDNode*> &OverrideNode,
41566f02413SBill Wendling                                    DenseMap<MDString*,
41666f02413SBill Wendling                                    SmallSetVector<MDNode*, 8> > &RequireNodes,
41766f02413SBill Wendling                                    SmallSetVector<MDString*, 16> &SeenIDs);
418b1ed91f3SChris Lattner 
419b1ed91f3SChris Lattner     bool linkAppendingVarProto(GlobalVariable *DstGV, GlobalVariable *SrcGV);
420b1ed91f3SChris Lattner     bool linkGlobalProto(GlobalVariable *SrcGV);
421b1ed91f3SChris Lattner     bool linkFunctionProto(Function *SrcF);
422b1ed91f3SChris Lattner     bool linkAliasProto(GlobalAlias *SrcA);
42366f02413SBill Wendling     bool linkModuleFlagsMetadata();
424b1ed91f3SChris Lattner 
425b1ed91f3SChris Lattner     void linkAppendingVarInit(const AppendingVarInfo &AVI);
426b1ed91f3SChris Lattner     void linkGlobalInits();
427b1ed91f3SChris Lattner     void linkFunctionBody(Function *Dst, Function *Src);
428b1ed91f3SChris Lattner     void linkAliasBodies();
429b1ed91f3SChris Lattner     void linkNamedMDNodes();
430eee6f995SChris Lattner   };
431eee6f995SChris Lattner }
432eee6f995SChris Lattner 
433eee6f995SChris Lattner 
434361e513dSReid Spencer 
435b1ed91f3SChris Lattner /// forceRenaming - The LLVM SymbolTable class autorenames globals that conflict
43690246aa7SReid Spencer /// in the symbol table.  This is good for all clients except for us.  Go
43790246aa7SReid Spencer /// through the trouble to force this back.
438b1ed91f3SChris Lattner static void forceRenaming(GlobalValue *GV, StringRef Name) {
439b1ed91f3SChris Lattner   // If the global doesn't force its name or if it already has the right name,
440b1ed91f3SChris Lattner   // there is nothing for us to do.
441b1ed91f3SChris Lattner   if (GV->hasLocalLinkage() || GV->getName() == Name)
442b1ed91f3SChris Lattner     return;
443b1ed91f3SChris Lattner 
444b1ed91f3SChris Lattner   Module *M = GV->getParent();
445361e513dSReid Spencer 
446361e513dSReid Spencer   // If there is a conflict, rename the conflict.
447b1ed91f3SChris Lattner   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
4482a8d2e0eSChris Lattner     GV->takeName(ConflictGV);
449361e513dSReid Spencer     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
450b1ed91f3SChris Lattner     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
4512a8d2e0eSChris Lattner   } else {
4522a8d2e0eSChris Lattner     GV->setName(Name);              // Force the name back
4533aaaa0b2SReid Spencer   }
4543aaaa0b2SReid Spencer }
4553aaaa0b2SReid Spencer 
4563aaaa0b2SReid Spencer /// CopyGVAttributes - copy additional attributes (those not needed to construct
4573aaaa0b2SReid Spencer /// a GlobalValue) from the SrcGV to the DestGV.
4583aaaa0b2SReid Spencer static void CopyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) {
459dd7daee8SDuncan Sands   // Use the maximum alignment, rather than just copying the alignment of SrcGV.
460dd7daee8SDuncan Sands   unsigned Alignment = std::max(DestGV->getAlignment(), SrcGV->getAlignment());
461dd7daee8SDuncan Sands   DestGV->copyAttributesFrom(SrcGV);
462dd7daee8SDuncan Sands   DestGV->setAlignment(Alignment);
463b1ed91f3SChris Lattner 
464b1ed91f3SChris Lattner   forceRenaming(DestGV, SrcGV->getName());
465361e513dSReid Spencer }
466361e513dSReid Spencer 
46723f8d64bSRafael Espindola static bool isLessConstraining(GlobalValue::VisibilityTypes a,
46823f8d64bSRafael Espindola                                GlobalValue::VisibilityTypes b) {
46923f8d64bSRafael Espindola   if (a == GlobalValue::HiddenVisibility)
47023f8d64bSRafael Espindola     return false;
47123f8d64bSRafael Espindola   if (b == GlobalValue::HiddenVisibility)
47223f8d64bSRafael Espindola     return true;
47323f8d64bSRafael Espindola   if (a == GlobalValue::ProtectedVisibility)
47423f8d64bSRafael Espindola     return false;
47523f8d64bSRafael Espindola   if (b == GlobalValue::ProtectedVisibility)
47623f8d64bSRafael Espindola     return true;
47723f8d64bSRafael Espindola   return false;
47823f8d64bSRafael Espindola }
47923f8d64bSRafael Espindola 
480b1ed91f3SChris Lattner /// getLinkageResult - This analyzes the two global values and determines what
481fc61de39SChris Lattner /// the result will look like in the destination module.  In particular, it
48223f8d64bSRafael Espindola /// computes the resultant linkage type and visibility, computes whether the
48323f8d64bSRafael Espindola /// global in the source should be copied over to the destination (replacing
48423f8d64bSRafael Espindola /// the existing one), and computes whether this linkage is an error or not.
485b1ed91f3SChris Lattner bool ModuleLinker::getLinkageResult(GlobalValue *Dest, const GlobalValue *Src,
486b1ed91f3SChris Lattner                                     GlobalValue::LinkageTypes &LT,
48723f8d64bSRafael Espindola                                     GlobalValue::VisibilityTypes &Vis,
488b1ed91f3SChris Lattner                                     bool &LinkFromSrc) {
489b1ed91f3SChris Lattner   assert(Dest && "Must have two globals being queried");
490b1ed91f3SChris Lattner   assert(!Src->hasLocalLinkage() &&
491fc61de39SChris Lattner          "If Src has internal linkage, Dest shouldn't be set!");
492b1ed91f3SChris Lattner 
4938bb15d82SPeter Collingbourne   bool SrcIsDeclaration = Src->isDeclaration() && !Src->isMaterializable();
4940c134b52SChris Lattner   bool DestIsDeclaration = Dest->isDeclaration();
495b1ed91f3SChris Lattner 
496b1ed91f3SChris Lattner   if (SrcIsDeclaration) {
4971f93c50aSAnton Korobeynikov     // If Src is external or if both Src & Dest are external..  Just link the
498fc61de39SChris Lattner     // external globals, we aren't adding anything.
499d61d39ecSAnton Korobeynikov     if (Src->hasDLLImportLinkage()) {
50012c94949SAnton Korobeynikov       // If one of GVs has DLLImport linkage, result should be dllimport'ed.
501b1ed91f3SChris Lattner       if (DestIsDeclaration) {
502d61d39ecSAnton Korobeynikov         LinkFromSrc = true;
503d61d39ecSAnton Korobeynikov         LT = Src->getLinkage();
504d61d39ecSAnton Korobeynikov       }
505e06036d2SAndrew Lenharth     } else if (Dest->hasExternalWeakLinkage()) {
50612da8ce3SDuncan Sands       // If the Dest is weak, use the source linkage.
507e06036d2SAndrew Lenharth       LinkFromSrc = true;
508e06036d2SAndrew Lenharth       LT = Src->getLinkage();
509d61d39ecSAnton Korobeynikov     } else {
510fc61de39SChris Lattner       LinkFromSrc = false;
511fc61de39SChris Lattner       LT = Dest->getLinkage();
512d61d39ecSAnton Korobeynikov     }
513b1ed91f3SChris Lattner   } else if (DestIsDeclaration && !Dest->hasDLLImportLinkage()) {
514fc61de39SChris Lattner     // If Dest is external but Src is not:
515fc61de39SChris Lattner     LinkFromSrc = true;
516fc61de39SChris Lattner     LT = Src->getLinkage();
517d725c991SDuncan Sands   } else if (Src->isWeakForLinker()) {
518ce4396bcSDale Johannesen     // At this point we know that Dest has LinkOnce, External*, Weak, Common,
519ce4396bcSDale Johannesen     // or DLL* linkage.
520184f1be4SChris Lattner     if (Dest->hasExternalWeakLinkage() ||
521184f1be4SChris Lattner         Dest->hasAvailableExternallyLinkage() ||
522184f1be4SChris Lattner         (Dest->hasLinkOnceLinkage() &&
523184f1be4SChris Lattner          (Src->hasWeakLinkage() || Src->hasCommonLinkage()))) {
524fc61de39SChris Lattner       LinkFromSrc = true;
525fc61de39SChris Lattner       LT = Src->getLinkage();
526fc61de39SChris Lattner     } else {
527fc61de39SChris Lattner       LinkFromSrc = false;
528fc61de39SChris Lattner       LT = Dest->getLinkage();
529fc61de39SChris Lattner     }
530d725c991SDuncan Sands   } else if (Dest->isWeakForLinker()) {
53112c94949SAnton Korobeynikov     // At this point we know that Src has External* or DLL* linkage.
53212c94949SAnton Korobeynikov     if (Src->hasExternalWeakLinkage()) {
53312c94949SAnton Korobeynikov       LinkFromSrc = false;
53412c94949SAnton Korobeynikov       LT = Dest->getLinkage();
53512c94949SAnton Korobeynikov     } else {
536fc61de39SChris Lattner       LinkFromSrc = true;
537fc61de39SChris Lattner       LT = GlobalValue::ExternalLinkage;
53812c94949SAnton Korobeynikov     }
539fc61de39SChris Lattner   } else {
540b1ed91f3SChris Lattner     assert((Dest->hasExternalLinkage()  || Dest->hasDLLImportLinkage() ||
541b1ed91f3SChris Lattner             Dest->hasDLLExportLinkage() || Dest->hasExternalWeakLinkage()) &&
542b1ed91f3SChris Lattner            (Src->hasExternalLinkage()   || Src->hasDLLImportLinkage() ||
543b1ed91f3SChris Lattner             Src->hasDLLExportLinkage()  || Src->hasExternalWeakLinkage()) &&
544fc61de39SChris Lattner            "Unexpected linkage type!");
545b1ed91f3SChris Lattner     return emitError("Linking globals named '" + Src->getName() +
546fc61de39SChris Lattner                  "': symbol multiply defined!");
547fc61de39SChris Lattner   }
54831fc4f95SAnton Korobeynikov 
54923f8d64bSRafael Espindola   // Compute the visibility. We follow the rules in the System V Application
55023f8d64bSRafael Espindola   // Binary Interface.
55123f8d64bSRafael Espindola   Vis = isLessConstraining(Src->getVisibility(), Dest->getVisibility()) ?
55223f8d64bSRafael Espindola     Dest->getVisibility() : Src->getVisibility();
553fc61de39SChris Lattner   return false;
554fc61de39SChris Lattner }
555361e513dSReid Spencer 
556b1ed91f3SChris Lattner /// computeTypeMapping - Loop over all of the linked values to compute type
557b1ed91f3SChris Lattner /// mappings.  For example, if we link "extern Foo *x" and "Foo *x = NULL", then
558b1ed91f3SChris Lattner /// we have two struct types 'Foo' but one got renamed when the module was
559b1ed91f3SChris Lattner /// loaded into the same LLVMContext.
560b1ed91f3SChris Lattner void ModuleLinker::computeTypeMapping() {
561b1ed91f3SChris Lattner   // Incorporate globals.
562b1ed91f3SChris Lattner   for (Module::global_iterator I = SrcM->global_begin(),
563b1ed91f3SChris Lattner        E = SrcM->global_end(); I != E; ++I) {
564b1ed91f3SChris Lattner     GlobalValue *DGV = getLinkedToGlobal(I);
565b1ed91f3SChris Lattner     if (DGV == 0) continue;
566b1ed91f3SChris Lattner 
567b1ed91f3SChris Lattner     if (!DGV->hasAppendingLinkage() || !I->hasAppendingLinkage()) {
568b1ed91f3SChris Lattner       TypeMap.addTypeMapping(DGV->getType(), I->getType());
569b1ed91f3SChris Lattner       continue;
5705c310be0SDevang Patel     }
5715c310be0SDevang Patel 
572b1ed91f3SChris Lattner     // Unify the element type of appending arrays.
573b1ed91f3SChris Lattner     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
574b1ed91f3SChris Lattner     ArrayType *SAT = cast<ArrayType>(I->getType()->getElementType());
575b1ed91f3SChris Lattner     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
576b1ed91f3SChris Lattner   }
57734fc5a0eSChris Lattner 
578b1ed91f3SChris Lattner   // Incorporate functions.
579b1ed91f3SChris Lattner   for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) {
580b1ed91f3SChris Lattner     if (GlobalValue *DGV = getLinkedToGlobal(I))
581b1ed91f3SChris Lattner       TypeMap.addTypeMapping(DGV->getType(), I->getType());
582b1ed91f3SChris Lattner   }
583e79f4c77SAnton Korobeynikov 
5849eb3f004SChris Lattner   // Incorporate types by name, scanning all the types in the source module.
5859eb3f004SChris Lattner   // At this point, the destination module may have a type "%foo = { i32 }" for
5869eb3f004SChris Lattner   // example.  When the source module got loaded into the same LLVMContext, if
5879eb3f004SChris Lattner   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
5889eb3f004SChris Lattner   // Though it isn't required for correctness, attempt to link these up to clean
5899eb3f004SChris Lattner   // up the IR.
5909eb3f004SChris Lattner   std::vector<StructType*> SrcStructTypes;
5919eb3f004SChris Lattner   SrcM->findUsedStructTypes(SrcStructTypes);
5929eb3f004SChris Lattner 
593eaf9b762SChris Lattner   SmallPtrSet<StructType*, 32> SrcStructTypesSet(SrcStructTypes.begin(),
594eaf9b762SChris Lattner                                                  SrcStructTypes.end());
595eaf9b762SChris Lattner 
5969eb3f004SChris Lattner   for (unsigned i = 0, e = SrcStructTypes.size(); i != e; ++i) {
5979eb3f004SChris Lattner     StructType *ST = SrcStructTypes[i];
5989eb3f004SChris Lattner     if (!ST->hasName()) continue;
5999eb3f004SChris Lattner 
6009eb3f004SChris Lattner     // Check to see if there is a dot in the name followed by a digit.
6019eb3f004SChris Lattner     size_t DotPos = ST->getName().rfind('.');
6029eb3f004SChris Lattner     if (DotPos == 0 || DotPos == StringRef::npos ||
6039eb3f004SChris Lattner         ST->getName().back() == '.' || !isdigit(ST->getName()[DotPos+1]))
6049eb3f004SChris Lattner       continue;
6059eb3f004SChris Lattner 
6069eb3f004SChris Lattner     // Check to see if the destination module has a struct with the prefix name.
6079eb3f004SChris Lattner     if (StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos)))
608eaf9b762SChris Lattner       // Don't use it if this actually came from the source module.  They're in
609eaf9b762SChris Lattner       // the same LLVMContext after all.
610eaf9b762SChris Lattner       if (!SrcStructTypesSet.count(DST))
6119eb3f004SChris Lattner         TypeMap.addTypeMapping(DST, ST);
6129eb3f004SChris Lattner   }
6139eb3f004SChris Lattner 
6149eb3f004SChris Lattner 
615b1ed91f3SChris Lattner   // Don't bother incorporating aliases, they aren't generally typed well.
616361e513dSReid Spencer 
617b1ed91f3SChris Lattner   // Now that we have discovered all of the type equivalences, get a body for
618b1ed91f3SChris Lattner   // any 'opaque' types in the dest module that are now resolved.
619b1ed91f3SChris Lattner   TypeMap.linkDefinedTypeBodies();
620b1ed91f3SChris Lattner }
621c08e7a00SChris Lattner 
622b1ed91f3SChris Lattner /// linkAppendingVarProto - If there were any appending global variables, link
623b1ed91f3SChris Lattner /// them together now.  Return true on error.
624b1ed91f3SChris Lattner bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
625b1ed91f3SChris Lattner                                          GlobalVariable *SrcGV) {
626e79f4c77SAnton Korobeynikov 
627b1ed91f3SChris Lattner   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
628b1ed91f3SChris Lattner     return emitError("Linking globals named '" + SrcGV->getName() +
629b1ed91f3SChris Lattner            "': can only link appending global with another appending global!");
630361e513dSReid Spencer 
631b1ed91f3SChris Lattner   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
632b1ed91f3SChris Lattner   ArrayType *SrcTy =
633b1ed91f3SChris Lattner     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
634b1ed91f3SChris Lattner   Type *EltTy = DstTy->getElementType();
635b1ed91f3SChris Lattner 
636b1ed91f3SChris Lattner   // Check to see that they two arrays agree on type.
637b1ed91f3SChris Lattner   if (EltTy != SrcTy->getElementType())
638b1ed91f3SChris Lattner     return emitError("Appending variables with different element types!");
639b1ed91f3SChris Lattner   if (DstGV->isConstant() != SrcGV->isConstant())
640b1ed91f3SChris Lattner     return emitError("Appending variables linked with different const'ness!");
641b1ed91f3SChris Lattner 
642b1ed91f3SChris Lattner   if (DstGV->getAlignment() != SrcGV->getAlignment())
643b1ed91f3SChris Lattner     return emitError(
644b1ed91f3SChris Lattner              "Appending variables with different alignment need to be linked!");
645b1ed91f3SChris Lattner 
646b1ed91f3SChris Lattner   if (DstGV->getVisibility() != SrcGV->getVisibility())
647b1ed91f3SChris Lattner     return emitError(
648b1ed91f3SChris Lattner             "Appending variables with different visibility need to be linked!");
649b1ed91f3SChris Lattner 
650b1ed91f3SChris Lattner   if (DstGV->getSection() != SrcGV->getSection())
651b1ed91f3SChris Lattner     return emitError(
652b1ed91f3SChris Lattner           "Appending variables with different section name need to be linked!");
653b1ed91f3SChris Lattner 
654b1ed91f3SChris Lattner   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
655b1ed91f3SChris Lattner   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
656b1ed91f3SChris Lattner 
657b1ed91f3SChris Lattner   // Create the new global variable.
658b1ed91f3SChris Lattner   GlobalVariable *NG =
659b1ed91f3SChris Lattner     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
660b1ed91f3SChris Lattner                        DstGV->getLinkage(), /*init*/0, /*name*/"", DstGV,
661b1ed91f3SChris Lattner                        DstGV->isThreadLocal(),
662b1ed91f3SChris Lattner                        DstGV->getType()->getAddressSpace());
663b1ed91f3SChris Lattner 
664b1ed91f3SChris Lattner   // Propagate alignment, visibility and section info.
665b1ed91f3SChris Lattner   CopyGVAttributes(NG, DstGV);
666b1ed91f3SChris Lattner 
667b1ed91f3SChris Lattner   AppendingVarInfo AVI;
668b1ed91f3SChris Lattner   AVI.NewGV = NG;
669b1ed91f3SChris Lattner   AVI.DstInit = DstGV->getInitializer();
670b1ed91f3SChris Lattner   AVI.SrcInit = SrcGV->getInitializer();
671b1ed91f3SChris Lattner   AppendingVars.push_back(AVI);
672b1ed91f3SChris Lattner 
673b1ed91f3SChris Lattner   // Replace any uses of the two global variables with uses of the new
674b1ed91f3SChris Lattner   // global.
675b1ed91f3SChris Lattner   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
676b1ed91f3SChris Lattner 
677b1ed91f3SChris Lattner   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
678b1ed91f3SChris Lattner   DstGV->eraseFromParent();
679b1ed91f3SChris Lattner 
680cbb91408STanya Lattner   // Track the source variable so we don't try to link it.
681cbb91408STanya Lattner   DoNotLinkFromSource.insert(SrcGV);
682cbb91408STanya Lattner 
683b1ed91f3SChris Lattner   return false;
684b1ed91f3SChris Lattner }
685b1ed91f3SChris Lattner 
686b1ed91f3SChris Lattner /// linkGlobalProto - Loop through the global variables in the src module and
687b1ed91f3SChris Lattner /// merge them into the dest module.
688b1ed91f3SChris Lattner bool ModuleLinker::linkGlobalProto(GlobalVariable *SGV) {
689b1ed91f3SChris Lattner   GlobalValue *DGV = getLinkedToGlobal(SGV);
69023f8d64bSRafael Espindola   llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility;
691b1ed91f3SChris Lattner 
692b1ed91f3SChris Lattner   if (DGV) {
693b1ed91f3SChris Lattner     // Concatenation of appending linkage variables is magic and handled later.
694b1ed91f3SChris Lattner     if (DGV->hasAppendingLinkage() || SGV->hasAppendingLinkage())
695b1ed91f3SChris Lattner       return linkAppendingVarProto(cast<GlobalVariable>(DGV), SGV);
696b1ed91f3SChris Lattner 
697b1ed91f3SChris Lattner     // Determine whether linkage of these two globals follows the source
698b1ed91f3SChris Lattner     // module's definition or the destination module's definition.
6991b9633d7SChris Lattner     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
70023f8d64bSRafael Espindola     GlobalValue::VisibilityTypes NV;
7011b9633d7SChris Lattner     bool LinkFromSrc = false;
70223f8d64bSRafael Espindola     if (getLinkageResult(DGV, SGV, NewLinkage, NV, LinkFromSrc))
703fc61de39SChris Lattner       return true;
70423f8d64bSRafael Espindola     NewVisibility = NV;
705361e513dSReid Spencer 
706b1ed91f3SChris Lattner     // If we're not linking from the source, then keep the definition that we
707b1ed91f3SChris Lattner     // have.
708b1ed91f3SChris Lattner     if (!LinkFromSrc) {
70934fc5a0eSChris Lattner       // Special case for const propagation.
71034fc5a0eSChris Lattner       if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV))
71134fc5a0eSChris Lattner         if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant())
71234fc5a0eSChris Lattner           DGVar->setConstant(true);
71334fc5a0eSChris Lattner 
71423f8d64bSRafael Espindola       // Set calculated linkage and visibility.
71534fc5a0eSChris Lattner       DGV->setLinkage(NewLinkage);
71623f8d64bSRafael Espindola       DGV->setVisibility(*NewVisibility);
71734fc5a0eSChris Lattner 
718b1ed91f3SChris Lattner       // Make sure to remember this mapping.
719b1ed91f3SChris Lattner       ValueMap[SGV] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGV->getType()));
720b1ed91f3SChris Lattner 
721cbb91408STanya Lattner       // Track the source global so that we don't attempt to copy it over when
722cbb91408STanya Lattner       // processing global initializers.
723cbb91408STanya Lattner       DoNotLinkFromSource.insert(SGV);
724cbb91408STanya Lattner 
725b1ed91f3SChris Lattner       return false;
726361e513dSReid Spencer     }
727b1ed91f3SChris Lattner   }
728b1ed91f3SChris Lattner 
729b1ed91f3SChris Lattner   // No linking to be performed or linking from the source: simply create an
730b1ed91f3SChris Lattner   // identical version of the symbol over in the dest module... the
731b1ed91f3SChris Lattner   // initializer will be filled in later by LinkGlobalInits.
732b1ed91f3SChris Lattner   GlobalVariable *NewDGV =
733b1ed91f3SChris Lattner     new GlobalVariable(*DstM, TypeMap.get(SGV->getType()->getElementType()),
734b1ed91f3SChris Lattner                        SGV->isConstant(), SGV->getLinkage(), /*init*/0,
735b1ed91f3SChris Lattner                        SGV->getName(), /*insertbefore*/0,
736b1ed91f3SChris Lattner                        SGV->isThreadLocal(),
737b1ed91f3SChris Lattner                        SGV->getType()->getAddressSpace());
738b1ed91f3SChris Lattner   // Propagate alignment, visibility and section info.
739b1ed91f3SChris Lattner   CopyGVAttributes(NewDGV, SGV);
74023f8d64bSRafael Espindola   if (NewVisibility)
74123f8d64bSRafael Espindola     NewDGV->setVisibility(*NewVisibility);
742b1ed91f3SChris Lattner 
743b1ed91f3SChris Lattner   if (DGV) {
744b1ed91f3SChris Lattner     DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDGV, DGV->getType()));
745b1ed91f3SChris Lattner     DGV->eraseFromParent();
746b1ed91f3SChris Lattner   }
747b1ed91f3SChris Lattner 
748b1ed91f3SChris Lattner   // Make sure to remember this mapping.
749b1ed91f3SChris Lattner   ValueMap[SGV] = NewDGV;
750361e513dSReid Spencer   return false;
751361e513dSReid Spencer }
752361e513dSReid Spencer 
753b1ed91f3SChris Lattner /// linkFunctionProto - Link the function in the source module into the
754b1ed91f3SChris Lattner /// destination module if needed, setting up mapping information.
755b1ed91f3SChris Lattner bool ModuleLinker::linkFunctionProto(Function *SF) {
756b1ed91f3SChris Lattner   GlobalValue *DGV = getLinkedToGlobal(SF);
75723f8d64bSRafael Espindola   llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility;
758dac5fa94SAnton Korobeynikov 
759b1ed91f3SChris Lattner   if (DGV) {
7600ead7a50SChris Lattner     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
7610ead7a50SChris Lattner     bool LinkFromSrc = false;
76223f8d64bSRafael Espindola     GlobalValue::VisibilityTypes NV;
76323f8d64bSRafael Espindola     if (getLinkageResult(DGV, SF, NewLinkage, NV, LinkFromSrc))
7640ead7a50SChris Lattner       return true;
76523f8d64bSRafael Espindola     NewVisibility = NV;
7660ead7a50SChris Lattner 
767b1ed91f3SChris Lattner     if (!LinkFromSrc) {
7680ead7a50SChris Lattner       // Set calculated linkage
7690ead7a50SChris Lattner       DGV->setLinkage(NewLinkage);
77023f8d64bSRafael Espindola       DGV->setVisibility(*NewVisibility);
77177e8ac4dSChris Lattner 
7720ead7a50SChris Lattner       // Make sure to remember this mapping.
773b1ed91f3SChris Lattner       ValueMap[SF] = ConstantExpr::getBitCast(DGV, TypeMap.get(SF->getType()));
774b1ed91f3SChris Lattner 
775cbb91408STanya Lattner       // Track the function from the source module so we don't attempt to remap
776cbb91408STanya Lattner       // it.
777cbb91408STanya Lattner       DoNotLinkFromSource.insert(SF);
778cbb91408STanya Lattner 
779b1ed91f3SChris Lattner       return false;
780361e513dSReid Spencer     }
781b1ed91f3SChris Lattner   }
782b1ed91f3SChris Lattner 
783b1ed91f3SChris Lattner   // If there is no linkage to be performed or we are linking from the source,
784b1ed91f3SChris Lattner   // bring SF over.
785b1ed91f3SChris Lattner   Function *NewDF = Function::Create(TypeMap.get(SF->getFunctionType()),
786b1ed91f3SChris Lattner                                      SF->getLinkage(), SF->getName(), DstM);
787b1ed91f3SChris Lattner   CopyGVAttributes(NewDF, SF);
78823f8d64bSRafael Espindola   if (NewVisibility)
78923f8d64bSRafael Espindola     NewDF->setVisibility(*NewVisibility);
790b1ed91f3SChris Lattner 
791b1ed91f3SChris Lattner   if (DGV) {
792b1ed91f3SChris Lattner     // Any uses of DF need to change to NewDF, with cast.
793b1ed91f3SChris Lattner     DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDF, DGV->getType()));
794b1ed91f3SChris Lattner     DGV->eraseFromParent();
7950a48b877STanya Lattner   } else {
7960a48b877STanya Lattner     // Internal, LO_ODR, or LO linkage - stick in set to ignore and lazily link.
7970a48b877STanya Lattner     if (SF->hasLocalLinkage() || SF->hasLinkOnceLinkage() ||
7980a48b877STanya Lattner         SF->hasAvailableExternallyLinkage()) {
7990a48b877STanya Lattner       DoNotLinkFromSource.insert(SF);
8000a48b877STanya Lattner       LazilyLinkFunctions.push_back(SF);
8010a48b877STanya Lattner     }
802b1ed91f3SChris Lattner   }
803b1ed91f3SChris Lattner 
804b1ed91f3SChris Lattner   ValueMap[SF] = NewDF;
805361e513dSReid Spencer   return false;
806361e513dSReid Spencer }
807361e513dSReid Spencer 
808b1ed91f3SChris Lattner /// LinkAliasProto - Set up prototypes for any aliases that come over from the
809b1ed91f3SChris Lattner /// source module.
810b1ed91f3SChris Lattner bool ModuleLinker::linkAliasProto(GlobalAlias *SGA) {
811b1ed91f3SChris Lattner   GlobalValue *DGV = getLinkedToGlobal(SGA);
81223f8d64bSRafael Espindola   llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility;
813b1ed91f3SChris Lattner 
814b1ed91f3SChris Lattner   if (DGV) {
815b1ed91f3SChris Lattner     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
81623f8d64bSRafael Espindola     GlobalValue::VisibilityTypes NV;
817b1ed91f3SChris Lattner     bool LinkFromSrc = false;
81823f8d64bSRafael Espindola     if (getLinkageResult(DGV, SGA, NewLinkage, NV, LinkFromSrc))
819b1ed91f3SChris Lattner       return true;
82023f8d64bSRafael Espindola     NewVisibility = NV;
821b1ed91f3SChris Lattner 
822b1ed91f3SChris Lattner     if (!LinkFromSrc) {
823b1ed91f3SChris Lattner       // Set calculated linkage.
824b1ed91f3SChris Lattner       DGV->setLinkage(NewLinkage);
82523f8d64bSRafael Espindola       DGV->setVisibility(*NewVisibility);
826b1ed91f3SChris Lattner 
827b1ed91f3SChris Lattner       // Make sure to remember this mapping.
828b1ed91f3SChris Lattner       ValueMap[SGA] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGA->getType()));
829b1ed91f3SChris Lattner 
830cbb91408STanya Lattner       // Track the alias from the source module so we don't attempt to remap it.
831cbb91408STanya Lattner       DoNotLinkFromSource.insert(SGA);
832cbb91408STanya Lattner 
833b1ed91f3SChris Lattner       return false;
834b1ed91f3SChris Lattner     }
835b1ed91f3SChris Lattner   }
836b1ed91f3SChris Lattner 
837b1ed91f3SChris Lattner   // If there is no linkage to be performed or we're linking from the source,
838b1ed91f3SChris Lattner   // bring over SGA.
839b1ed91f3SChris Lattner   GlobalAlias *NewDA = new GlobalAlias(TypeMap.get(SGA->getType()),
840b1ed91f3SChris Lattner                                        SGA->getLinkage(), SGA->getName(),
841b1ed91f3SChris Lattner                                        /*aliasee*/0, DstM);
842b1ed91f3SChris Lattner   CopyGVAttributes(NewDA, SGA);
84323f8d64bSRafael Espindola   if (NewVisibility)
84423f8d64bSRafael Espindola     NewDA->setVisibility(*NewVisibility);
845b1ed91f3SChris Lattner 
846b1ed91f3SChris Lattner   if (DGV) {
847b1ed91f3SChris Lattner     // Any uses of DGV need to change to NewDA, with cast.
848b1ed91f3SChris Lattner     DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDA, DGV->getType()));
849b1ed91f3SChris Lattner     DGV->eraseFromParent();
850b1ed91f3SChris Lattner   }
851b1ed91f3SChris Lattner 
852b1ed91f3SChris Lattner   ValueMap[SGA] = NewDA;
853b1ed91f3SChris Lattner   return false;
854b1ed91f3SChris Lattner }
855b1ed91f3SChris Lattner 
85600245f42SChris Lattner static void getArrayElements(Constant *C, SmallVectorImpl<Constant*> &Dest) {
8576705883aSChris Lattner   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
85800245f42SChris Lattner 
8596705883aSChris Lattner   for (unsigned i = 0; i != NumElements; ++i)
8606705883aSChris Lattner     Dest.push_back(C->getAggregateElement(i));
86100245f42SChris Lattner }
86200245f42SChris Lattner 
863b1ed91f3SChris Lattner void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
864b1ed91f3SChris Lattner   // Merge the initializer.
865b1ed91f3SChris Lattner   SmallVector<Constant*, 16> Elements;
86600245f42SChris Lattner   getArrayElements(AVI.DstInit, Elements);
867b1ed91f3SChris Lattner 
868b1ed91f3SChris Lattner   Constant *SrcInit = MapValue(AVI.SrcInit, ValueMap, RF_None, &TypeMap);
86900245f42SChris Lattner   getArrayElements(SrcInit, Elements);
87000245f42SChris Lattner 
871b1ed91f3SChris Lattner   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
872b1ed91f3SChris Lattner   AVI.NewGV->setInitializer(ConstantArray::get(NewType, Elements));
873b1ed91f3SChris Lattner }
874b1ed91f3SChris Lattner 
875b1ed91f3SChris Lattner 
876b1ed91f3SChris Lattner // linkGlobalInits - Update the initializers in the Dest module now that all
877b1ed91f3SChris Lattner // globals that may be referenced are in Dest.
878b1ed91f3SChris Lattner void ModuleLinker::linkGlobalInits() {
879b1ed91f3SChris Lattner   // Loop over all of the globals in the src module, mapping them over as we go
880b1ed91f3SChris Lattner   for (Module::const_global_iterator I = SrcM->global_begin(),
881b1ed91f3SChris Lattner        E = SrcM->global_end(); I != E; ++I) {
882cbb91408STanya Lattner 
883cbb91408STanya Lattner     // Only process initialized GV's or ones not already in dest.
884cbb91408STanya Lattner     if (!I->hasInitializer() || DoNotLinkFromSource.count(I)) continue;
885b1ed91f3SChris Lattner 
886b1ed91f3SChris Lattner     // Grab destination global variable.
887b1ed91f3SChris Lattner     GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[I]);
888b1ed91f3SChris Lattner     // Figure out what the initializer looks like in the dest module.
889b1ed91f3SChris Lattner     DGV->setInitializer(MapValue(I->getInitializer(), ValueMap,
890b1ed91f3SChris Lattner                                  RF_None, &TypeMap));
891b1ed91f3SChris Lattner   }
892b1ed91f3SChris Lattner }
893b1ed91f3SChris Lattner 
894b1ed91f3SChris Lattner // linkFunctionBody - Copy the source function over into the dest function and
895361e513dSReid Spencer // fix up references to values.  At this point we know that Dest is an external
896361e513dSReid Spencer // function, and that Src is not.
897b1ed91f3SChris Lattner void ModuleLinker::linkFunctionBody(Function *Dst, Function *Src) {
898b1ed91f3SChris Lattner   assert(Src && Dst && Dst->isDeclaration() && !Src->isDeclaration());
899361e513dSReid Spencer 
9007391dde1SChris Lattner   // Go through and convert function arguments over, remembering the mapping.
901b1ed91f3SChris Lattner   Function::arg_iterator DI = Dst->arg_begin();
902531f9e92SChris Lattner   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
903361e513dSReid Spencer        I != E; ++I, ++DI) {
904b1ed91f3SChris Lattner     DI->setName(I->getName());  // Copy the name over.
905361e513dSReid Spencer 
906b1ed91f3SChris Lattner     // Add a mapping to our mapping.
90766a6271cSAnton Korobeynikov     ValueMap[I] = DI;
908361e513dSReid Spencer   }
909361e513dSReid Spencer 
910cbb91408STanya Lattner   if (Mode == Linker::DestroySource) {
9112f0557d0SChris Lattner     // Splice the body of the source function into the dest function.
912b1ed91f3SChris Lattner     Dst->getBasicBlockList().splice(Dst->end(), Src->getBasicBlockList());
913361e513dSReid Spencer 
914361e513dSReid Spencer     // At this point, all of the instructions and values of the function are now
915361e513dSReid Spencer     // copied over.  The only problem is that they are still referencing values in
916361e513dSReid Spencer     // the Source function as operands.  Loop through all of the operands of the
91743f8d164SChris Lattner     // functions and patch them up to point to the local versions.
918b1ed91f3SChris Lattner     for (Function::iterator BB = Dst->begin(), BE = Dst->end(); BB != BE; ++BB)
91943f8d164SChris Lattner       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
920b1ed91f3SChris Lattner         RemapInstruction(I, ValueMap, RF_IgnoreMissingEntries, &TypeMap);
9217391dde1SChris Lattner 
922cbb91408STanya Lattner   } else {
923cbb91408STanya Lattner     // Clone the body of the function into the dest function.
924cbb91408STanya Lattner     SmallVector<ReturnInst*, 8> Returns; // Ignore returns.
9255d44a433SMon P Wang     CloneFunctionInto(Dst, Src, ValueMap, false, Returns, "", NULL, &TypeMap);
926cbb91408STanya Lattner   }
927cbb91408STanya Lattner 
9287391dde1SChris Lattner   // There is no need to map the arguments anymore.
92944ab8aefSChris Lattner   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
93044ab8aefSChris Lattner        I != E; ++I)
9313aaaa0b2SReid Spencer     ValueMap.erase(I);
932cbb91408STanya Lattner 
933361e513dSReid Spencer }
934361e513dSReid Spencer 
935361e513dSReid Spencer 
936b1ed91f3SChris Lattner void ModuleLinker::linkAliasBodies() {
937b1ed91f3SChris Lattner   for (Module::alias_iterator I = SrcM->alias_begin(), E = SrcM->alias_end();
938cbb91408STanya Lattner        I != E; ++I) {
939cbb91408STanya Lattner     if (DoNotLinkFromSource.count(I))
940cbb91408STanya Lattner       continue;
941b1ed91f3SChris Lattner     if (Constant *Aliasee = I->getAliasee()) {
942b1ed91f3SChris Lattner       GlobalAlias *DA = cast<GlobalAlias>(ValueMap[I]);
943b1ed91f3SChris Lattner       DA->setAliasee(MapValue(Aliasee, ValueMap, RF_None, &TypeMap));
9442c4a34aeSDavid Chisnall     }
945b1ed91f3SChris Lattner   }
946cbb91408STanya Lattner }
947b1ed91f3SChris Lattner 
948b1ed91f3SChris Lattner /// linkNamedMDNodes - Insert all of the named mdnodes in Src into the Dest
949b1ed91f3SChris Lattner /// module.
950b1ed91f3SChris Lattner void ModuleLinker::linkNamedMDNodes() {
95166f02413SBill Wendling   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
952b1ed91f3SChris Lattner   for (Module::const_named_metadata_iterator I = SrcM->named_metadata_begin(),
953b1ed91f3SChris Lattner        E = SrcM->named_metadata_end(); I != E; ++I) {
95466f02413SBill Wendling     // Don't link module flags here. Do them separately.
95566f02413SBill Wendling     if (&*I == SrcModFlags) continue;
956b1ed91f3SChris Lattner     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(I->getName());
957b1ed91f3SChris Lattner     // Add Src elements into Dest node.
958b1ed91f3SChris Lattner     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
959b1ed91f3SChris Lattner       DestNMD->addOperand(MapValue(I->getOperand(i), ValueMap,
960b1ed91f3SChris Lattner                                    RF_None, &TypeMap));
961b1ed91f3SChris Lattner   }
962b1ed91f3SChris Lattner }
963b1ed91f3SChris Lattner 
96466f02413SBill Wendling /// categorizeModuleFlagNodes -
96566f02413SBill Wendling bool ModuleLinker::
96666f02413SBill Wendling categorizeModuleFlagNodes(const NamedMDNode *ModFlags,
96766f02413SBill Wendling                           DenseMap<MDString*, MDNode*> &ErrorNode,
96866f02413SBill Wendling                           DenseMap<MDString*, MDNode*> &WarningNode,
96966f02413SBill Wendling                           DenseMap<MDString*, MDNode*> &OverrideNode,
97066f02413SBill Wendling                           DenseMap<MDString*,
97166f02413SBill Wendling                             SmallSetVector<MDNode*, 8> > &RequireNodes,
97266f02413SBill Wendling                           SmallSetVector<MDString*, 16> &SeenIDs) {
97366f02413SBill Wendling   bool HasErr = false;
97466f02413SBill Wendling 
97566f02413SBill Wendling   for (unsigned I = 0, E = ModFlags->getNumOperands(); I != E; ++I) {
97666f02413SBill Wendling     MDNode *Op = ModFlags->getOperand(I);
97766f02413SBill Wendling     assert(Op->getNumOperands() == 3 && "Invalid module flag metadata!");
97866f02413SBill Wendling     assert(isa<ConstantInt>(Op->getOperand(0)) &&
97966f02413SBill Wendling            "Module flag's first operand must be an integer!");
98066f02413SBill Wendling     assert(isa<MDString>(Op->getOperand(1)) &&
98166f02413SBill Wendling            "Module flag's second operand must be an MDString!");
98266f02413SBill Wendling 
98366f02413SBill Wendling     ConstantInt *Behavior = cast<ConstantInt>(Op->getOperand(0));
98466f02413SBill Wendling     MDString *ID = cast<MDString>(Op->getOperand(1));
98566f02413SBill Wendling     Value *Val = Op->getOperand(2);
98666f02413SBill Wendling     switch (Behavior->getZExtValue()) {
98766f02413SBill Wendling     default:
98866f02413SBill Wendling       assert(false && "Invalid behavior in module flag metadata!");
98966f02413SBill Wendling       break;
99066f02413SBill Wendling     case Module::Error: {
99166f02413SBill Wendling       MDNode *&ErrNode = ErrorNode[ID];
99266f02413SBill Wendling       if (!ErrNode) ErrNode = Op;
99366f02413SBill Wendling       if (ErrNode->getOperand(2) != Val)
994*9273b539SBill Wendling         HasErr = emitError("linking module flags '" + ID->getString() +
995*9273b539SBill Wendling                            "': IDs have conflicting values");
99666f02413SBill Wendling       break;
99766f02413SBill Wendling     }
99866f02413SBill Wendling     case Module::Warning: {
99966f02413SBill Wendling       MDNode *&WarnNode = WarningNode[ID];
100066f02413SBill Wendling       if (!WarnNode) WarnNode = Op;
100166f02413SBill Wendling       if (WarnNode->getOperand(2) != Val)
1002*9273b539SBill Wendling         errs() << "WARNING: linking module flags '" << ID->getString()
1003*9273b539SBill Wendling                << "': IDs have conflicting values";
100466f02413SBill Wendling       break;
100566f02413SBill Wendling     }
100666f02413SBill Wendling     case Module::Require:  RequireNodes[ID].insert(Op);     break;
100766f02413SBill Wendling     case Module::Override: {
100866f02413SBill Wendling       MDNode *&OvrNode = OverrideNode[ID];
100966f02413SBill Wendling       if (!OvrNode) OvrNode = Op;
101066f02413SBill Wendling       if (OvrNode->getOperand(2) != Val)
1011*9273b539SBill Wendling         HasErr = emitError("linking module flags '" + ID->getString() +
1012*9273b539SBill Wendling                            "': IDs have conflicting override values");
101366f02413SBill Wendling       break;
101466f02413SBill Wendling     }
101566f02413SBill Wendling     }
101666f02413SBill Wendling 
101766f02413SBill Wendling     SeenIDs.insert(ID);
101866f02413SBill Wendling   }
101966f02413SBill Wendling 
102066f02413SBill Wendling   return HasErr;
102166f02413SBill Wendling }
102266f02413SBill Wendling 
102366f02413SBill Wendling /// linkModuleFlagsMetadata - Merge the linker flags in Src into the Dest
102466f02413SBill Wendling /// module.
102566f02413SBill Wendling bool ModuleLinker::linkModuleFlagsMetadata() {
102666f02413SBill Wendling   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
102766f02413SBill Wendling   if (!SrcModFlags) return false;
102866f02413SBill Wendling 
102966f02413SBill Wendling   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
103066f02413SBill Wendling 
103166f02413SBill Wendling   // If the destination module doesn't have module flags yet, then just copy
103266f02413SBill Wendling   // over the source module's flags.
103366f02413SBill Wendling   if (DstModFlags->getNumOperands() == 0) {
103466f02413SBill Wendling     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
103566f02413SBill Wendling       DstModFlags->addOperand(SrcModFlags->getOperand(I));
103666f02413SBill Wendling 
103766f02413SBill Wendling     return false;
103866f02413SBill Wendling   }
103966f02413SBill Wendling 
104066f02413SBill Wendling   bool HasErr = false;
104166f02413SBill Wendling 
104266f02413SBill Wendling   // Otherwise, we have to merge them based on their behaviors. First,
104366f02413SBill Wendling   // categorize all of the nodes in the modules' module flags. If an error or
104466f02413SBill Wendling   // warning occurs, then emit the appropriate message(s).
104566f02413SBill Wendling   DenseMap<MDString*, MDNode*> ErrorNode;
104666f02413SBill Wendling   DenseMap<MDString*, MDNode*> WarningNode;
104766f02413SBill Wendling   DenseMap<MDString*, MDNode*> OverrideNode;
104866f02413SBill Wendling   DenseMap<MDString*, SmallSetVector<MDNode*, 8> > RequireNodes;
104966f02413SBill Wendling   SmallSetVector<MDString*, 16> SeenIDs;
105066f02413SBill Wendling 
105166f02413SBill Wendling   HasErr |= categorizeModuleFlagNodes(SrcModFlags, ErrorNode, WarningNode,
105266f02413SBill Wendling                                       OverrideNode, RequireNodes, SeenIDs);
105366f02413SBill Wendling   HasErr |= categorizeModuleFlagNodes(DstModFlags, ErrorNode, WarningNode,
105466f02413SBill Wendling                                       OverrideNode, RequireNodes, SeenIDs);
105566f02413SBill Wendling 
105666f02413SBill Wendling   // Check that there isn't both an error and warning node for a flag.
105766f02413SBill Wendling   for (SmallSetVector<MDString*, 16>::iterator
105866f02413SBill Wendling          I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) {
105966f02413SBill Wendling     MDString *ID = *I;
106066f02413SBill Wendling     if (ErrorNode[ID] && WarningNode[ID])
1061*9273b539SBill Wendling       HasErr = emitError("linking module flags '" + ID->getString() +
106266f02413SBill Wendling                          "': IDs have conflicting behaviors");
106366f02413SBill Wendling   }
106466f02413SBill Wendling 
106566f02413SBill Wendling   // Early exit if we had an error.
106666f02413SBill Wendling   if (HasErr) return true;
106766f02413SBill Wendling 
106866f02413SBill Wendling   // Get the destination's module flags ready for new operands.
106966f02413SBill Wendling   DstModFlags->dropAllReferences();
107066f02413SBill Wendling 
107166f02413SBill Wendling   // Add all of the module flags to the destination module.
107266f02413SBill Wendling   DenseMap<MDString*, SmallVector<MDNode*, 4> > AddedNodes;
107366f02413SBill Wendling   for (SmallSetVector<MDString*, 16>::iterator
107466f02413SBill Wendling          I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) {
107566f02413SBill Wendling     MDString *ID = *I;
107666f02413SBill Wendling     if (OverrideNode[ID]) {
107766f02413SBill Wendling       DstModFlags->addOperand(OverrideNode[ID]);
107866f02413SBill Wendling       AddedNodes[ID].push_back(OverrideNode[ID]);
107966f02413SBill Wendling     } else if (ErrorNode[ID]) {
108066f02413SBill Wendling       DstModFlags->addOperand(ErrorNode[ID]);
108166f02413SBill Wendling       AddedNodes[ID].push_back(ErrorNode[ID]);
108266f02413SBill Wendling     } else if (WarningNode[ID]) {
108366f02413SBill Wendling       DstModFlags->addOperand(WarningNode[ID]);
108466f02413SBill Wendling       AddedNodes[ID].push_back(WarningNode[ID]);
108566f02413SBill Wendling     }
108666f02413SBill Wendling 
108766f02413SBill Wendling     for (SmallSetVector<MDNode*, 8>::iterator
108866f02413SBill Wendling            II = RequireNodes[ID].begin(), IE = RequireNodes[ID].end();
108966f02413SBill Wendling          II != IE; ++II)
109066f02413SBill Wendling       DstModFlags->addOperand(*II);
109166f02413SBill Wendling   }
109266f02413SBill Wendling 
109366f02413SBill Wendling   // Now check that all of the requirements have been satisfied.
109466f02413SBill Wendling   for (SmallSetVector<MDString*, 16>::iterator
109566f02413SBill Wendling          I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) {
109666f02413SBill Wendling     MDString *ID = *I;
109766f02413SBill Wendling     SmallSetVector<MDNode*, 8> &Set = RequireNodes[ID];
109866f02413SBill Wendling 
109966f02413SBill Wendling     for (SmallSetVector<MDNode*, 8>::iterator
110066f02413SBill Wendling            II = Set.begin(), IE = Set.end(); II != IE; ++II) {
110166f02413SBill Wendling       MDNode *Node = *II;
110266f02413SBill Wendling       assert(isa<MDNode>(Node->getOperand(2)) &&
110366f02413SBill Wendling              "Module flag's third operand must be an MDNode!");
110466f02413SBill Wendling       MDNode *Val = cast<MDNode>(Node->getOperand(2));
110566f02413SBill Wendling 
110666f02413SBill Wendling       MDString *ReqID = cast<MDString>(Val->getOperand(0));
110766f02413SBill Wendling       Value *ReqVal = Val->getOperand(1);
110866f02413SBill Wendling 
110966f02413SBill Wendling       bool HasValue = false;
111066f02413SBill Wendling       for (SmallVectorImpl<MDNode*>::iterator
111166f02413SBill Wendling              RI = AddedNodes[ReqID].begin(), RE = AddedNodes[ReqID].end();
111266f02413SBill Wendling            RI != RE; ++RI) {
111366f02413SBill Wendling         MDNode *ReqNode = *RI;
111466f02413SBill Wendling         if (ReqNode->getOperand(2) == ReqVal) {
111566f02413SBill Wendling           HasValue = true;
111666f02413SBill Wendling           break;
111766f02413SBill Wendling         }
111866f02413SBill Wendling       }
111966f02413SBill Wendling 
112066f02413SBill Wendling       if (!HasValue)
1121*9273b539SBill Wendling         HasErr = emitError("linking module flags '" + ReqID->getString() +
1122*9273b539SBill Wendling                            "': does not have the required value");
112366f02413SBill Wendling     }
112466f02413SBill Wendling   }
112566f02413SBill Wendling 
112666f02413SBill Wendling   return HasErr;
112766f02413SBill Wendling }
112866f02413SBill Wendling 
1129b1ed91f3SChris Lattner bool ModuleLinker::run() {
113066f02413SBill Wendling   assert(DstM && "Null destination module");
113166f02413SBill Wendling   assert(SrcM && "Null source module");
1132b1ed91f3SChris Lattner 
1133b1ed91f3SChris Lattner   // Inherit the target data from the source module if the destination module
1134b1ed91f3SChris Lattner   // doesn't have one already.
1135b1ed91f3SChris Lattner   if (DstM->getDataLayout().empty() && !SrcM->getDataLayout().empty())
1136b1ed91f3SChris Lattner     DstM->setDataLayout(SrcM->getDataLayout());
1137b1ed91f3SChris Lattner 
1138b1ed91f3SChris Lattner   // Copy the target triple from the source to dest if the dest's is empty.
1139b1ed91f3SChris Lattner   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1140b1ed91f3SChris Lattner     DstM->setTargetTriple(SrcM->getTargetTriple());
1141b1ed91f3SChris Lattner 
1142b1ed91f3SChris Lattner   if (!SrcM->getDataLayout().empty() && !DstM->getDataLayout().empty() &&
1143b1ed91f3SChris Lattner       SrcM->getDataLayout() != DstM->getDataLayout())
1144b1ed91f3SChris Lattner     errs() << "WARNING: Linking two modules of different data layouts!\n";
1145b1ed91f3SChris Lattner   if (!SrcM->getTargetTriple().empty() &&
1146b1ed91f3SChris Lattner       DstM->getTargetTriple() != SrcM->getTargetTriple()) {
1147b1ed91f3SChris Lattner     errs() << "WARNING: Linking two modules of different target triples: ";
1148b1ed91f3SChris Lattner     if (!SrcM->getModuleIdentifier().empty())
1149b1ed91f3SChris Lattner       errs() << SrcM->getModuleIdentifier() << ": ";
1150b1ed91f3SChris Lattner     errs() << "'" << SrcM->getTargetTriple() << "' and '"
1151b1ed91f3SChris Lattner            << DstM->getTargetTriple() << "'\n";
1152b1ed91f3SChris Lattner   }
1153b1ed91f3SChris Lattner 
1154b1ed91f3SChris Lattner   // Append the module inline asm string.
1155b1ed91f3SChris Lattner   if (!SrcM->getModuleInlineAsm().empty()) {
1156b1ed91f3SChris Lattner     if (DstM->getModuleInlineAsm().empty())
1157b1ed91f3SChris Lattner       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1158b1ed91f3SChris Lattner     else
1159b1ed91f3SChris Lattner       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1160b1ed91f3SChris Lattner                                SrcM->getModuleInlineAsm());
1161b1ed91f3SChris Lattner   }
1162b1ed91f3SChris Lattner 
1163b1ed91f3SChris Lattner   // Update the destination module's dependent libraries list with the libraries
1164b1ed91f3SChris Lattner   // from the source module. There's no opportunity for duplicates here as the
1165b1ed91f3SChris Lattner   // Module ensures that duplicate insertions are discarded.
1166b1ed91f3SChris Lattner   for (Module::lib_iterator SI = SrcM->lib_begin(), SE = SrcM->lib_end();
1167b1ed91f3SChris Lattner        SI != SE; ++SI)
1168b1ed91f3SChris Lattner     DstM->addLibrary(*SI);
1169b1ed91f3SChris Lattner 
1170b1ed91f3SChris Lattner   // If the source library's module id is in the dependent library list of the
1171b1ed91f3SChris Lattner   // destination library, remove it since that module is now linked in.
1172b1ed91f3SChris Lattner   StringRef ModuleId = SrcM->getModuleIdentifier();
1173b1ed91f3SChris Lattner   if (!ModuleId.empty())
1174b1ed91f3SChris Lattner     DstM->removeLibrary(sys::path::stem(ModuleId));
1175b1ed91f3SChris Lattner 
1176b1ed91f3SChris Lattner   // Loop over all of the linked values to compute type mappings.
1177b1ed91f3SChris Lattner   computeTypeMapping();
1178b1ed91f3SChris Lattner 
1179b1ed91f3SChris Lattner   // Insert all of the globals in src into the DstM module... without linking
1180b1ed91f3SChris Lattner   // initializers (which could refer to functions not yet mapped over).
1181b1ed91f3SChris Lattner   for (Module::global_iterator I = SrcM->global_begin(),
1182b1ed91f3SChris Lattner        E = SrcM->global_end(); I != E; ++I)
1183b1ed91f3SChris Lattner     if (linkGlobalProto(I))
1184b1ed91f3SChris Lattner       return true;
1185b1ed91f3SChris Lattner 
1186b1ed91f3SChris Lattner   // Link the functions together between the two modules, without doing function
1187b1ed91f3SChris Lattner   // bodies... this just adds external function prototypes to the DstM
1188b1ed91f3SChris Lattner   // function...  We do this so that when we begin processing function bodies,
1189b1ed91f3SChris Lattner   // all of the global values that may be referenced are available in our
1190b1ed91f3SChris Lattner   // ValueMap.
1191b1ed91f3SChris Lattner   for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I)
1192b1ed91f3SChris Lattner     if (linkFunctionProto(I))
1193b1ed91f3SChris Lattner       return true;
1194b1ed91f3SChris Lattner 
1195b1ed91f3SChris Lattner   // If there were any aliases, link them now.
1196b1ed91f3SChris Lattner   for (Module::alias_iterator I = SrcM->alias_begin(),
1197b1ed91f3SChris Lattner        E = SrcM->alias_end(); I != E; ++I)
1198b1ed91f3SChris Lattner     if (linkAliasProto(I))
1199b1ed91f3SChris Lattner       return true;
1200b1ed91f3SChris Lattner 
1201b1ed91f3SChris Lattner   for (unsigned i = 0, e = AppendingVars.size(); i != e; ++i)
1202b1ed91f3SChris Lattner     linkAppendingVarInit(AppendingVars[i]);
1203b1ed91f3SChris Lattner 
1204b1ed91f3SChris Lattner   // Update the initializers in the DstM module now that all globals that may
1205b1ed91f3SChris Lattner   // be referenced are in DstM.
1206b1ed91f3SChris Lattner   linkGlobalInits();
1207b1ed91f3SChris Lattner 
1208b1ed91f3SChris Lattner   // Link in the function bodies that are defined in the source module into
1209b1ed91f3SChris Lattner   // DstM.
1210b1ed91f3SChris Lattner   for (Module::iterator SF = SrcM->begin(), E = SrcM->end(); SF != E; ++SF) {
1211ea166d44STanya Lattner     // Skip if not linking from source.
1212ea166d44STanya Lattner     if (DoNotLinkFromSource.count(SF)) continue;
1213ea166d44STanya Lattner 
1214ea166d44STanya Lattner     // Skip if no body (function is external) or materialize.
1215ea166d44STanya Lattner     if (SF->isDeclaration()) {
1216ea166d44STanya Lattner       if (!SF->isMaterializable())
1217ea166d44STanya Lattner         continue;
1218ea166d44STanya Lattner       if (SF->Materialize(&ErrorMsg))
1219ea166d44STanya Lattner         return true;
1220ea166d44STanya Lattner     }
1221b1ed91f3SChris Lattner 
1222b1ed91f3SChris Lattner     linkFunctionBody(cast<Function>(ValueMap[SF]), SF);
1223b1ed91f3SChris Lattner   }
1224b1ed91f3SChris Lattner 
1225b1ed91f3SChris Lattner   // Resolve all uses of aliases with aliasees.
1226b1ed91f3SChris Lattner   linkAliasBodies();
1227b1ed91f3SChris Lattner 
122866f02413SBill Wendling   // Remap all of the named MDNodes in Src into the DstM module. We do this
12296ddbb2e2SDevang Patel   // after linking GlobalValues so that MDNodes that reference GlobalValues
12306ddbb2e2SDevang Patel   // are properly remapped.
12316ddbb2e2SDevang Patel   linkNamedMDNodes();
12326ddbb2e2SDevang Patel 
123366f02413SBill Wendling   // Merge the module flags into the DstM module.
123466f02413SBill Wendling   if (linkModuleFlagsMetadata())
123566f02413SBill Wendling     return true;
123666f02413SBill Wendling 
12370a48b877STanya Lattner   // Process vector of lazily linked in functions.
12380a48b877STanya Lattner   bool LinkedInAnyFunctions;
12390a48b877STanya Lattner   do {
12400a48b877STanya Lattner     LinkedInAnyFunctions = false;
12410a48b877STanya Lattner 
12420a48b877STanya Lattner     for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(),
12430a48b877STanya Lattner         E = LazilyLinkFunctions.end(); I != E; ++I) {
12440a48b877STanya Lattner       if (!*I)
12450a48b877STanya Lattner         continue;
12460a48b877STanya Lattner 
12470a48b877STanya Lattner       Function *SF = *I;
12480a48b877STanya Lattner       Function *DF = cast<Function>(ValueMap[SF]);
12490a48b877STanya Lattner 
12500a48b877STanya Lattner       if (!DF->use_empty()) {
12510a48b877STanya Lattner 
12520a48b877STanya Lattner         // Materialize if necessary.
12530a48b877STanya Lattner         if (SF->isDeclaration()) {
12540a48b877STanya Lattner           if (!SF->isMaterializable())
12550a48b877STanya Lattner             continue;
12560a48b877STanya Lattner           if (SF->Materialize(&ErrorMsg))
12570a48b877STanya Lattner             return true;
12580a48b877STanya Lattner         }
12590a48b877STanya Lattner 
12600a48b877STanya Lattner         // Link in function body.
12610a48b877STanya Lattner         linkFunctionBody(DF, SF);
12620a48b877STanya Lattner 
12630a48b877STanya Lattner         // "Remove" from vector by setting the element to 0.
12640a48b877STanya Lattner         *I = 0;
12650a48b877STanya Lattner 
12660a48b877STanya Lattner         // Set flag to indicate we may have more functions to lazily link in
12670a48b877STanya Lattner         // since we linked in a function.
12680a48b877STanya Lattner         LinkedInAnyFunctions = true;
12690a48b877STanya Lattner       }
12700a48b877STanya Lattner     }
12710a48b877STanya Lattner   } while (LinkedInAnyFunctions);
12720a48b877STanya Lattner 
12730a48b877STanya Lattner   // Remove any prototypes of functions that were not actually linked in.
12740a48b877STanya Lattner   for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(),
12750a48b877STanya Lattner       E = LazilyLinkFunctions.end(); I != E; ++I) {
12760a48b877STanya Lattner     if (!*I)
12770a48b877STanya Lattner       continue;
12780a48b877STanya Lattner 
12790a48b877STanya Lattner     Function *SF = *I;
12800a48b877STanya Lattner     Function *DF = cast<Function>(ValueMap[SF]);
12810a48b877STanya Lattner     if (DF->use_empty())
12820a48b877STanya Lattner       DF->eraseFromParent();
12830a48b877STanya Lattner   }
12840a48b877STanya Lattner 
1285b1ed91f3SChris Lattner   // Now that all of the types from the source are used, resolve any structs
1286b1ed91f3SChris Lattner   // copied over to the dest that didn't exist there.
1287b1ed91f3SChris Lattner   TypeMap.linkDefinedTypeBodies();
12882609888fSAnton Korobeynikov 
12892609888fSAnton Korobeynikov   return false;
12902609888fSAnton Korobeynikov }
1291361e513dSReid Spencer 
1292b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
1293b1ed91f3SChris Lattner // LinkModules entrypoint.
1294b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
1295b1ed91f3SChris Lattner 
1296361e513dSReid Spencer // LinkModules - This function links two modules together, with the resulting
1297361e513dSReid Spencer // left module modified to be the composite of the two input modules.  If an
1298361e513dSReid Spencer // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
1299361e513dSReid Spencer // the problem.  Upon failure, the Dest module could be in a modified state, and
1300361e513dSReid Spencer // shouldn't be relied on to be consistent.
1301cbb91408STanya Lattner bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Mode,
1302cbb91408STanya Lattner                          std::string *ErrorMsg) {
1303cbb91408STanya Lattner   ModuleLinker TheLinker(Dest, Src, Mode);
1304b1ed91f3SChris Lattner   if (TheLinker.run()) {
1305b1ed91f3SChris Lattner     if (ErrorMsg) *ErrorMsg = TheLinker.ErrorMsg;
1306d3ba7d9bSReid Spencer     return true;
1307361e513dSReid Spencer   }
1308361e513dSReid Spencer 
1309361e513dSReid Spencer   return false;
1310361e513dSReid Spencer }
1311