2e2795ce7767f42394c42c5e0a72a71bcdac0245
[oota-llvm.git] / lib / Transforms / Utils / ValueMapper.cpp
1 //===- ValueMapper.cpp - Interface shared by lib/Transforms/Utils ---------===//
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 defines the MapValue function, which is shared by various parts of
11 // the lib/Transforms/Utils library.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Transforms/Utils/ValueMapper.h"
16 #include "llvm/IR/Constants.h"
17 #include "llvm/IR/Function.h"
18 #include "llvm/IR/InlineAsm.h"
19 #include "llvm/IR/Instructions.h"
20 #include "llvm/IR/Metadata.h"
21 using namespace llvm;
22
23 // Out of line method to get vtable etc for class.
24 void ValueMapTypeRemapper::anchor() {}
25 void ValueMaterializer::anchor() {}
26
27 Value *llvm::MapValue(const Value *V, ValueToValueMapTy &VM, RemapFlags Flags,
28                       ValueMapTypeRemapper *TypeMapper,
29                       ValueMaterializer *Materializer) {
30   ValueToValueMapTy::iterator I = VM.find(V);
31   
32   // If the value already exists in the map, use it.
33   if (I != VM.end() && I->second) return I->second;
34   
35   // If we have a materializer and it can materialize a value, use that.
36   if (Materializer) {
37     if (Value *NewV = Materializer->materializeValueFor(const_cast<Value*>(V)))
38       return VM[V] = NewV;
39   }
40
41   // Global values do not need to be seeded into the VM if they
42   // are using the identity mapping.
43   if (isa<GlobalValue>(V))
44     return VM[V] = const_cast<Value*>(V);
45   
46   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
47     // Inline asm may need *type* remapping.
48     FunctionType *NewTy = IA->getFunctionType();
49     if (TypeMapper) {
50       NewTy = cast<FunctionType>(TypeMapper->remapType(NewTy));
51
52       if (NewTy != IA->getFunctionType())
53         V = InlineAsm::get(NewTy, IA->getAsmString(), IA->getConstraintString(),
54                            IA->hasSideEffects(), IA->isAlignStack());
55     }
56     
57     return VM[V] = const_cast<Value*>(V);
58   }
59
60   if (const auto *MDV = dyn_cast<MetadataAsValue>(V)) {
61     const Metadata *MD = MDV->getMetadata();
62     // If this is a module-level metadata and we know that nothing at the module
63     // level is changing, then use an identity mapping.
64     if (!isa<LocalAsMetadata>(MD) && (Flags & RF_NoModuleLevelChanges))
65       return VM[V] = const_cast<Value *>(V);
66
67     auto *MappedMD = MapMetadata(MD, VM, Flags, TypeMapper, Materializer);
68     if (MD == MappedMD || (!MappedMD && (Flags & RF_IgnoreMissingEntries)))
69       return VM[V] = const_cast<Value *>(V);
70
71     // FIXME: This assert crashes during bootstrap, but I think it should be
72     // correct.  For now, just match behaviour from before the metadata/value
73     // split.
74     //
75     //    assert(MappedMD && "Referenced metadata value not in value map");
76     return VM[V] = MetadataAsValue::get(V->getContext(), MappedMD);
77   }
78
79   // Okay, this either must be a constant (which may or may not be mappable) or
80   // is something that is not in the mapping table.
81   Constant *C = const_cast<Constant*>(dyn_cast<Constant>(V));
82   if (!C)
83     return nullptr;
84   
85   if (BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
86     Function *F = 
87       cast<Function>(MapValue(BA->getFunction(), VM, Flags, TypeMapper, Materializer));
88     BasicBlock *BB = cast_or_null<BasicBlock>(MapValue(BA->getBasicBlock(), VM,
89                                                        Flags, TypeMapper, Materializer));
90     return VM[V] = BlockAddress::get(F, BB ? BB : BA->getBasicBlock());
91   }
92   
93   // Otherwise, we have some other constant to remap.  Start by checking to see
94   // if all operands have an identity remapping.
95   unsigned OpNo = 0, NumOperands = C->getNumOperands();
96   Value *Mapped = nullptr;
97   for (; OpNo != NumOperands; ++OpNo) {
98     Value *Op = C->getOperand(OpNo);
99     Mapped = MapValue(Op, VM, Flags, TypeMapper, Materializer);
100     if (Mapped != C) break;
101   }
102   
103   // See if the type mapper wants to remap the type as well.
104   Type *NewTy = C->getType();
105   if (TypeMapper)
106     NewTy = TypeMapper->remapType(NewTy);
107
108   // If the result type and all operands match up, then just insert an identity
109   // mapping.
110   if (OpNo == NumOperands && NewTy == C->getType())
111     return VM[V] = C;
112   
113   // Okay, we need to create a new constant.  We've already processed some or
114   // all of the operands, set them all up now.
115   SmallVector<Constant*, 8> Ops;
116   Ops.reserve(NumOperands);
117   for (unsigned j = 0; j != OpNo; ++j)
118     Ops.push_back(cast<Constant>(C->getOperand(j)));
119   
120   // If one of the operands mismatch, push it and the other mapped operands.
121   if (OpNo != NumOperands) {
122     Ops.push_back(cast<Constant>(Mapped));
123   
124     // Map the rest of the operands that aren't processed yet.
125     for (++OpNo; OpNo != NumOperands; ++OpNo)
126       Ops.push_back(MapValue(cast<Constant>(C->getOperand(OpNo)), VM,
127                              Flags, TypeMapper, Materializer));
128   }
129   
130   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
131     return VM[V] = CE->getWithOperands(Ops, NewTy);
132   if (isa<ConstantArray>(C))
133     return VM[V] = ConstantArray::get(cast<ArrayType>(NewTy), Ops);
134   if (isa<ConstantStruct>(C))
135     return VM[V] = ConstantStruct::get(cast<StructType>(NewTy), Ops);
136   if (isa<ConstantVector>(C))
137     return VM[V] = ConstantVector::get(Ops);
138   // If this is a no-operand constant, it must be because the type was remapped.
139   if (isa<UndefValue>(C))
140     return VM[V] = UndefValue::get(NewTy);
141   if (isa<ConstantAggregateZero>(C))
142     return VM[V] = ConstantAggregateZero::get(NewTy);
143   assert(isa<ConstantPointerNull>(C));
144   return VM[V] = ConstantPointerNull::get(cast<PointerType>(NewTy));
145 }
146
147 static Metadata *mapToMetadata(ValueToValueMapTy &VM, const Metadata *Key,
148                      Metadata *Val) {
149   VM.MD()[Key].reset(Val);
150   return Val;
151 }
152
153 static Metadata *mapToSelf(ValueToValueMapTy &VM, const Metadata *MD) {
154   return mapToMetadata(VM, MD, const_cast<Metadata *>(MD));
155 }
156
157 static Metadata *MapMetadataImpl(const Metadata *MD, ValueToValueMapTy &VM,
158                                  RemapFlags Flags,
159                                  ValueMapTypeRemapper *TypeMapper,
160                                  ValueMaterializer *Materializer);
161
162 static Metadata *mapMetadataOp(Metadata *Op, ValueToValueMapTy &VM,
163                                  RemapFlags Flags,
164                                  ValueMapTypeRemapper *TypeMapper,
165                                  ValueMaterializer *Materializer) {
166   if (!Op)
167     return nullptr;
168   if (Metadata *MappedOp =
169           MapMetadataImpl(Op, VM, Flags, TypeMapper, Materializer))
170     return MappedOp;
171   // Use identity map if MappedOp is null and we can ignore missing entries.
172   if (Flags & RF_IgnoreMissingEntries)
173     return Op;
174
175   // FIXME: This assert crashes during bootstrap, but I think it should be
176   // correct.  For now, just match behaviour from before the metadata/value
177   // split.
178   //
179   //    llvm_unreachable("Referenced metadata not in value map!");
180   return nullptr;
181 }
182
183 static Metadata *cloneMDTuple(const MDTuple *Node, ValueToValueMapTy &VM,
184                               RemapFlags Flags,
185                               ValueMapTypeRemapper *TypeMapper,
186                               ValueMaterializer *Materializer) {
187   SmallVector<Metadata *, 4> Elts;
188   Elts.reserve(Node->getNumOperands());
189   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I)
190     Elts.push_back(mapMetadataOp(Node->getOperand(I), VM, Flags, TypeMapper,
191                                  Materializer));
192
193   return MDTuple::get(Node->getContext(), Elts);
194 }
195
196 static Metadata *cloneMDLocation(const MDLocation *Node, ValueToValueMapTy &VM,
197                                  RemapFlags Flags,
198                                  ValueMapTypeRemapper *TypeMapper,
199                                  ValueMaterializer *Materializer) {
200   return MDLocation::get(
201       Node->getContext(), Node->getLine(), Node->getColumn(),
202       mapMetadataOp(Node->getScope(), VM, Flags, TypeMapper, Materializer),
203       mapMetadataOp(Node->getInlinedAt(), VM, Flags, TypeMapper, Materializer));
204 }
205
206 /// \brief Map a distinct MDNode.
207 ///
208 /// Distinct nodes are not uniqued, so they must always recreated.
209 static Metadata *mapDistinctNode(const UniquableMDNode *Node,
210                                  ValueToValueMapTy &VM, RemapFlags Flags,
211                                  ValueMapTypeRemapper *TypeMapper,
212                                  ValueMaterializer *Materializer) {
213   assert(Node->isDistinct() && "Expected distinct node");
214
215   // Create the node first so it's available for cyclical references.
216   SmallVector<Metadata *, 4> EmptyOps(Node->getNumOperands());
217   MDTuple *NewMD = MDTuple::getDistinct(Node->getContext(), EmptyOps);
218   mapToMetadata(VM, Node, NewMD);
219
220   // Fix the operands.
221   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I)
222     NewMD->replaceOperandWith(I, mapMetadataOp(Node->getOperand(I), VM, Flags,
223                                                TypeMapper, Materializer));
224
225   return NewMD;
226 }
227
228 /// \brief Check whether a uniqued node needs to be remapped.
229 ///
230 /// Check whether a uniqued node needs to be remapped (due to any operands
231 /// changing).
232 static bool shouldRemapUniquedNode(const UniquableMDNode *Node,
233                                    ValueToValueMapTy &VM, RemapFlags Flags,
234                                    ValueMapTypeRemapper *TypeMapper,
235                                    ValueMaterializer *Materializer) {
236   // Check all operands to see if any need to be remapped.
237   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I) {
238     Metadata *Op = Node->getOperand(I);
239     if (Op != mapMetadataOp(Op, VM, Flags, TypeMapper, Materializer))
240       return true;
241   }
242   return false;
243 }
244
245 /// \brief Map a uniqued MDNode.
246 ///
247 /// Uniqued nodes may not need to be recreated (they may map to themselves).
248 static Metadata *mapUniquedNode(const UniquableMDNode *Node,
249                                  ValueToValueMapTy &VM, RemapFlags Flags,
250                                  ValueMapTypeRemapper *TypeMapper,
251                                  ValueMaterializer *Materializer) {
252   assert(!Node->isDistinct() && "Expected uniqued node");
253
254   // Create a dummy node in case we have a metadata cycle.
255   MDNodeFwdDecl *Dummy = MDNode::getTemporary(Node->getContext(), None);
256   mapToMetadata(VM, Node, Dummy);
257
258   // Check all operands to see if any need to be remapped.
259   if (!shouldRemapUniquedNode(Node, VM, Flags, TypeMapper, Materializer)) {
260     // Use an identity mapping.
261     mapToSelf(VM, Node);
262     MDNode::deleteTemporary(Dummy);
263     return const_cast<Metadata *>(static_cast<const Metadata *>(Node));
264   }
265
266   // At least one operand needs remapping.
267   Metadata *NewMD;
268   switch (Node->getMetadataID()) {
269   default:
270     llvm_unreachable("Invalid UniquableMDNode subclass");
271 #define HANDLE_UNIQUABLE_LEAF(CLASS)                                           \
272   case Metadata::CLASS##Kind:                                                  \
273     NewMD =                                                                    \
274         clone##CLASS(cast<CLASS>(Node), VM, Flags, TypeMapper, Materializer);  \
275     break;
276 #include "llvm/IR/Metadata.def"
277   }
278   Dummy->replaceAllUsesWith(NewMD);
279   MDNode::deleteTemporary(Dummy);
280   return mapToMetadata(VM, Node, NewMD);
281 }
282
283 static Metadata *MapMetadataImpl(const Metadata *MD, ValueToValueMapTy &VM,
284                                  RemapFlags Flags,
285                                  ValueMapTypeRemapper *TypeMapper,
286                                  ValueMaterializer *Materializer) {
287   // If the value already exists in the map, use it.
288   if (Metadata *NewMD = VM.MD().lookup(MD).get())
289     return NewMD;
290
291   if (isa<MDString>(MD))
292     return mapToSelf(VM, MD);
293
294   if (isa<ConstantAsMetadata>(MD))
295     if ((Flags & RF_NoModuleLevelChanges))
296       return mapToSelf(VM, MD);
297
298   if (const auto *VMD = dyn_cast<ValueAsMetadata>(MD)) {
299     Value *MappedV =
300         MapValue(VMD->getValue(), VM, Flags, TypeMapper, Materializer);
301     if (VMD->getValue() == MappedV ||
302         (!MappedV && (Flags & RF_IgnoreMissingEntries)))
303       return mapToSelf(VM, MD);
304
305     // FIXME: This assert crashes during bootstrap, but I think it should be
306     // correct.  For now, just match behaviour from before the metadata/value
307     // split.
308     //
309     //    assert(MappedV && "Referenced metadata not in value map!");
310     if (MappedV)
311       return mapToMetadata(VM, MD, ValueAsMetadata::get(MappedV));
312     return nullptr;
313   }
314
315   const UniquableMDNode *Node = cast<UniquableMDNode>(MD);
316   assert(Node->isResolved() && "Unexpected unresolved node");
317
318   // If this is a module-level metadata and we know that nothing at the
319   // module level is changing, then use an identity mapping.
320   if (Flags & RF_NoModuleLevelChanges)
321     return mapToSelf(VM, MD);
322
323   if (Node->isDistinct())
324     return mapDistinctNode(Node, VM, Flags, TypeMapper, Materializer);
325
326   return mapUniquedNode(Node, VM, Flags, TypeMapper, Materializer);
327 }
328
329 Metadata *llvm::MapMetadata(const Metadata *MD, ValueToValueMapTy &VM,
330                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
331                             ValueMaterializer *Materializer) {
332   Metadata *NewMD = MapMetadataImpl(MD, VM, Flags, TypeMapper, Materializer);
333   if (NewMD && NewMD != MD)
334     if (auto *N = dyn_cast<UniquableMDNode>(NewMD))
335       N->resolveCycles();
336   return NewMD;
337 }
338
339 MDNode *llvm::MapMetadata(const MDNode *MD, ValueToValueMapTy &VM,
340                           RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
341                           ValueMaterializer *Materializer) {
342   return cast<MDNode>(MapMetadata(static_cast<const Metadata *>(MD), VM, Flags,
343                                   TypeMapper, Materializer));
344 }
345
346 /// RemapInstruction - Convert the instruction operands from referencing the
347 /// current values into those specified by VMap.
348 ///
349 void llvm::RemapInstruction(Instruction *I, ValueToValueMapTy &VMap,
350                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
351                             ValueMaterializer *Materializer){
352   // Remap operands.
353   for (User::op_iterator op = I->op_begin(), E = I->op_end(); op != E; ++op) {
354     Value *V = MapValue(*op, VMap, Flags, TypeMapper, Materializer);
355     // If we aren't ignoring missing entries, assert that something happened.
356     if (V)
357       *op = V;
358     else
359       assert((Flags & RF_IgnoreMissingEntries) &&
360              "Referenced value not in value map!");
361   }
362
363   // Remap phi nodes' incoming blocks.
364   if (PHINode *PN = dyn_cast<PHINode>(I)) {
365     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
366       Value *V = MapValue(PN->getIncomingBlock(i), VMap, Flags);
367       // If we aren't ignoring missing entries, assert that something happened.
368       if (V)
369         PN->setIncomingBlock(i, cast<BasicBlock>(V));
370       else
371         assert((Flags & RF_IgnoreMissingEntries) &&
372                "Referenced block not in value map!");
373     }
374   }
375
376   // Remap attached metadata.
377   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
378   I->getAllMetadata(MDs);
379   for (SmallVectorImpl<std::pair<unsigned, MDNode *>>::iterator
380            MI = MDs.begin(),
381            ME = MDs.end();
382        MI != ME; ++MI) {
383     MDNode *Old = MI->second;
384     MDNode *New = MapMetadata(Old, VMap, Flags, TypeMapper, Materializer);
385     if (New != Old)
386       I->setMetadata(MI->first, New);
387   }
388   
389   // If the instruction's type is being remapped, do so now.
390   if (TypeMapper)
391     I->mutateType(TypeMapper->remapType(I->getType()));
392 }