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