1 //===- ValueMapper.cpp - Interface shared by lib/Transforms/Utils ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the MapValue function, which is shared by various parts of
11 // the lib/Transforms/Utils library.
13 //===----------------------------------------------------------------------===//
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"
23 // Out of line method to get vtable etc for class.
24 void ValueMapTypeRemapper::anchor() {}
25 void ValueMaterializer::anchor() {}
27 Value *llvm::MapValue(const Value *V, ValueToValueMapTy &VM, RemapFlags Flags,
28 ValueMapTypeRemapper *TypeMapper,
29 ValueMaterializer *Materializer) {
30 ValueToValueMapTy::iterator I = VM.find(V);
32 // If the value already exists in the map, use it.
33 if (I != VM.end() && I->second) return I->second;
35 // If we have a materializer and it can materialize a value, use that.
37 if (Value *NewV = Materializer->materializeValueFor(const_cast<Value*>(V)))
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);
46 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
47 // Inline asm may need *type* remapping.
48 FunctionType *NewTy = IA->getFunctionType();
50 NewTy = cast<FunctionType>(TypeMapper->remapType(NewTy));
52 if (NewTy != IA->getFunctionType())
53 V = InlineAsm::get(NewTy, IA->getAsmString(), IA->getConstraintString(),
54 IA->hasSideEffects(), IA->isAlignStack());
57 return VM[V] = const_cast<Value*>(V);
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);
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);
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
75 // assert(MappedMD && "Referenced metadata value not in value map");
76 return VM[V] = MetadataAsValue::get(V->getContext(), MappedMD);
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));
85 if (BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
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());
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;
103 // See if the type mapper wants to remap the type as well.
104 Type *NewTy = C->getType();
106 NewTy = TypeMapper->remapType(NewTy);
108 // If the result type and all operands match up, then just insert an identity
110 if (OpNo == NumOperands && NewTy == C->getType())
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)));
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));
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));
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));
147 static Metadata *mapToMetadata(ValueToValueMapTy &VM, const Metadata *Key,
149 VM.MD()[Key].reset(Val);
153 static Metadata *mapToSelf(ValueToValueMapTy &VM, const Metadata *MD) {
154 return mapToMetadata(VM, MD, const_cast<Metadata *>(MD));
157 static Metadata *MapMetadataImpl(const Metadata *MD, ValueToValueMapTy &VM,
159 ValueMapTypeRemapper *TypeMapper,
160 ValueMaterializer *Materializer);
162 static Metadata *mapMetadataOp(Metadata *Op, ValueToValueMapTy &VM,
164 ValueMapTypeRemapper *TypeMapper,
165 ValueMaterializer *Materializer) {
168 if (Metadata *MappedOp =
169 MapMetadataImpl(Op, VM, Flags, TypeMapper, Materializer))
171 // Use identity map if MappedOp is null and we can ignore missing entries.
172 if (Flags & RF_IgnoreMissingEntries)
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
179 // llvm_unreachable("Referenced metadata not in value map!");
183 /// \brief Remap nodes.
185 /// Insert \c NewNode in the value map, and then remap \c OldNode's operands.
186 /// Assumes that \c NewNode is already a clone of \c OldNode.
188 /// \pre \c NewNode is a clone of \c OldNode.
189 static bool remap(const MDNode *OldNode, MDNode *NewNode, ValueToValueMapTy &VM,
190 RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
191 ValueMaterializer *Materializer) {
192 assert(OldNode->getNumOperands() == NewNode->getNumOperands() &&
193 "Expected nodes to match");
194 assert(OldNode->isResolved() && "Expected resolved node");
195 assert(!NewNode->isUniqued() && "Expected non-uniqued node");
197 // Map the node upfront so it's available for cyclic references.
198 mapToMetadata(VM, OldNode, NewNode);
199 bool AnyChanged = false;
200 for (unsigned I = 0, E = OldNode->getNumOperands(); I != E; ++I) {
201 Metadata *Old = OldNode->getOperand(I);
202 assert(NewNode->getOperand(I) == Old &&
203 "Expected old operands to already be in place");
205 Metadata *New = mapMetadataOp(OldNode->getOperand(I), VM, Flags, TypeMapper,
209 NewNode->replaceOperandWith(I, New);
216 /// \brief Map a distinct MDNode.
218 /// Distinct nodes are not uniqued, so they must always recreated.
219 static Metadata *mapDistinctNode(const MDNode *Node, ValueToValueMapTy &VM,
221 ValueMapTypeRemapper *TypeMapper,
222 ValueMaterializer *Materializer) {
223 assert(Node->isDistinct() && "Expected distinct node");
225 MDNode *NewMD = MDNode::replaceWithDistinct(Node->clone());
226 remap(Node, NewMD, VM, Flags, TypeMapper, Materializer);
230 /// \brief Map a uniqued MDNode.
232 /// Uniqued nodes may not need to be recreated (they may map to themselves).
233 static Metadata *mapUniquedNode(const MDNode *Node, ValueToValueMapTy &VM,
235 ValueMapTypeRemapper *TypeMapper,
236 ValueMaterializer *Materializer) {
237 assert(Node->isUniqued() && "Expected uniqued node");
239 // Create a temporary node upfront in case we have a metadata cycle.
240 auto ClonedMD = Node->clone();
241 if (!remap(Node, ClonedMD.get(), VM, Flags, TypeMapper, Materializer))
242 // No operands changed, so use the identity mapping.
243 return mapToSelf(VM, Node);
245 // At least one operand has changed, so uniquify the cloned node.
246 return mapToMetadata(VM, Node,
247 MDNode::replaceWithUniqued(std::move(ClonedMD)));
250 static Metadata *MapMetadataImpl(const Metadata *MD, ValueToValueMapTy &VM,
252 ValueMapTypeRemapper *TypeMapper,
253 ValueMaterializer *Materializer) {
254 // If the value already exists in the map, use it.
255 if (Metadata *NewMD = VM.MD().lookup(MD).get())
258 if (isa<MDString>(MD))
259 return mapToSelf(VM, MD);
261 if (isa<ConstantAsMetadata>(MD))
262 if ((Flags & RF_NoModuleLevelChanges))
263 return mapToSelf(VM, MD);
265 if (const auto *VMD = dyn_cast<ValueAsMetadata>(MD)) {
267 MapValue(VMD->getValue(), VM, Flags, TypeMapper, Materializer);
268 if (VMD->getValue() == MappedV ||
269 (!MappedV && (Flags & RF_IgnoreMissingEntries)))
270 return mapToSelf(VM, MD);
272 // FIXME: This assert crashes during bootstrap, but I think it should be
273 // correct. For now, just match behaviour from before the metadata/value
276 // assert(MappedV && "Referenced metadata not in value map!");
278 return mapToMetadata(VM, MD, ValueAsMetadata::get(MappedV));
282 const MDNode *Node = cast<MDNode>(MD);
283 assert(Node->isResolved() && "Unexpected unresolved node");
285 // If this is a module-level metadata and we know that nothing at the
286 // module level is changing, then use an identity mapping.
287 if (Flags & RF_NoModuleLevelChanges)
288 return mapToSelf(VM, MD);
290 if (Node->isDistinct())
291 return mapDistinctNode(Node, VM, Flags, TypeMapper, Materializer);
293 return mapUniquedNode(Node, VM, Flags, TypeMapper, Materializer);
296 Metadata *llvm::MapMetadata(const Metadata *MD, ValueToValueMapTy &VM,
297 RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
298 ValueMaterializer *Materializer) {
299 Metadata *NewMD = MapMetadataImpl(MD, VM, Flags, TypeMapper, Materializer);
300 if (NewMD && NewMD != MD)
301 if (auto *N = dyn_cast<MDNode>(NewMD))
302 if (!N->isResolved())
307 MDNode *llvm::MapMetadata(const MDNode *MD, ValueToValueMapTy &VM,
308 RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
309 ValueMaterializer *Materializer) {
310 return cast<MDNode>(MapMetadata(static_cast<const Metadata *>(MD), VM, Flags,
311 TypeMapper, Materializer));
314 /// RemapInstruction - Convert the instruction operands from referencing the
315 /// current values into those specified by VMap.
317 void llvm::RemapInstruction(Instruction *I, ValueToValueMapTy &VMap,
318 RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
319 ValueMaterializer *Materializer){
321 for (User::op_iterator op = I->op_begin(), E = I->op_end(); op != E; ++op) {
322 Value *V = MapValue(*op, VMap, Flags, TypeMapper, Materializer);
323 // If we aren't ignoring missing entries, assert that something happened.
327 assert((Flags & RF_IgnoreMissingEntries) &&
328 "Referenced value not in value map!");
331 // Remap phi nodes' incoming blocks.
332 if (PHINode *PN = dyn_cast<PHINode>(I)) {
333 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
334 Value *V = MapValue(PN->getIncomingBlock(i), VMap, Flags);
335 // If we aren't ignoring missing entries, assert that something happened.
337 PN->setIncomingBlock(i, cast<BasicBlock>(V));
339 assert((Flags & RF_IgnoreMissingEntries) &&
340 "Referenced block not in value map!");
344 // Remap attached metadata.
345 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
346 I->getAllMetadata(MDs);
347 for (SmallVectorImpl<std::pair<unsigned, MDNode *>>::iterator
351 MDNode *Old = MI->second;
352 MDNode *New = MapMetadata(Old, VMap, Flags, TypeMapper, Materializer);
354 I->setMetadata(MI->first, New);
357 // If the instruction's type is being remapped, do so now.
359 I->mutateType(TypeMapper->remapType(I->getType()));