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<TrackingMDNodeRef> &Cycles,
 160                                  ValueToValueMapTy &VM, RemapFlags Flags,
 161                                  ValueMapTypeRemapper *TypeMapper,
 162                                  ValueMaterializer *Materializer);
 163
 164 static Metadata *mapMetadataOp(Metadata *Op,
 165                                SmallVectorImpl<TrackingMDNodeRef> &Cycles,
 166                                ValueToValueMapTy &VM, RemapFlags Flags,
 167                                ValueMapTypeRemapper *TypeMapper,
 168                                ValueMaterializer *Materializer) {
 169   if (!Op)
 170     return nullptr;
 171   if (Metadata *MappedOp =
 172           MapMetadataImpl(Op, Cycles, VM, Flags, 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 /// \brief Remap nodes.
 187 ///
 188 /// Insert \c NewNode in the value map, and then remap \c OldNode's operands.
 189 /// Assumes that \c NewNode is already a clone of \c OldNode.
 190 ///
 191 /// \pre \c NewNode is a clone of \c OldNode.
 192 static bool remap(const MDNode *OldNode, MDNode *NewNode,
 193                   SmallVectorImpl<TrackingMDNodeRef> &Cycles,
 194                   ValueToValueMapTy &VM, RemapFlags Flags,
 195                   ValueMapTypeRemapper *TypeMapper,
 196                   ValueMaterializer *Materializer) {
 197   assert(OldNode->getNumOperands() == NewNode->getNumOperands() &&
 198          "Expected nodes to match");
 199   assert(OldNode->isResolved() && "Expected resolved node");
 200   assert(!NewNode->isUniqued() && "Expected non-uniqued node");
 201
 202   // Map the node upfront so it's available for cyclic references.
 203   mapToMetadata(VM, OldNode, NewNode);
 204   bool AnyChanged = false;
 205   for (unsigned I = 0, E = OldNode->getNumOperands(); I != E; ++I) {
 206     Metadata *Old = OldNode->getOperand(I);
 207     assert(NewNode->getOperand(I) == Old &&
 208            "Expected old operands to already be in place");
 209
 210     Metadata *New =
 211         mapMetadataOp(Old, Cycles, VM, Flags, TypeMapper, Materializer);
 212     if (Old != New) {
 213       AnyChanged = true;
 214       NewNode->replaceOperandWith(I, New);
 215     }
 216   }
 217
 218   return AnyChanged;
 219 }
 220
 221 /// Map a distinct MDNode.
 222 ///
 223 /// Whether distinct nodes change is independent of their operands.  If \a
 224 /// RF_MoveDistinctMDs, then they are reused, and their operands remapped in
 225 /// place; effectively, they're moved from one graph to another.  Otherwise,
 226 /// they're cloned/duplicated, and the new copy's operands are remapped.
 227 static Metadata *mapDistinctNode(const MDNode *Node,
 228                                  SmallVectorImpl<TrackingMDNodeRef> &Cycles,
 229                                  ValueToValueMapTy &VM, RemapFlags Flags,
 230                                  ValueMapTypeRemapper *TypeMapper,
 231                                  ValueMaterializer *Materializer) {
 232   assert(Node->isDistinct() && "Expected distinct node");
 233
 234   MDNode *NewMD;
 235   if (Flags & RF_MoveDistinctMDs)
 236     NewMD = const_cast<MDNode *>(Node);
 237   else
 238     NewMD = MDNode::replaceWithDistinct(Node->clone());
 239
 240   // Remap the operands.  If any change, track those that could be involved in
 241   // uniquing cycles.
 242   if (remap(Node, NewMD, Cycles, VM, Flags, TypeMapper, Materializer))
 243     for (Metadata *Op : NewMD->operands())
 244       if (auto *Node = dyn_cast_or_null<MDNode>(Op))
 245         if (!Node->isResolved())
 246           Cycles.emplace_back(Node);
 247
 248   return NewMD;
 249 }
 250
 251 /// \brief Map a uniqued MDNode.
 252 ///
 253 /// Uniqued nodes may not need to be recreated (they may map to themselves).
 254 static Metadata *mapUniquedNode(const MDNode *Node,
 255                                 SmallVectorImpl<TrackingMDNodeRef> &Cycles,
 256                                 ValueToValueMapTy &VM, RemapFlags Flags,
 257                                 ValueMapTypeRemapper *TypeMapper,
 258                                 ValueMaterializer *Materializer) {
 259   assert(Node->isUniqued() && "Expected uniqued node");
 260
 261   // Create a temporary node upfront in case we have a metadata cycle.
 262   auto ClonedMD = Node->clone();
 263   if (!remap(Node, ClonedMD.get(), Cycles, VM, Flags, TypeMapper, Materializer)) {
 264     // No operands changed, so use the identity mapping.
 265     ClonedMD->replaceAllUsesWith(const_cast<MDNode *>(Node));
 266     return mapToSelf(VM, Node);
 267   }
 268
 269   // At least one operand has changed, so uniquify the cloned node.
 270   return mapToMetadata(VM, Node,
 271                        MDNode::replaceWithUniqued(std::move(ClonedMD)));
 272 }
 273
 274 static Metadata *MapMetadataImpl(const Metadata *MD,
 275                                  SmallVectorImpl<TrackingMDNodeRef> &Cycles,
 276                                  ValueToValueMapTy &VM, RemapFlags Flags,
 277                                  ValueMapTypeRemapper *TypeMapper,
 278                                  ValueMaterializer *Materializer) {
 279   // If the value already exists in the map, use it.
 280   if (Metadata *NewMD = VM.MD().lookup(MD).get())
 281     return NewMD;
 282
 283   if (isa<MDString>(MD))
 284     return mapToSelf(VM, MD);
 285
 286   if (isa<ConstantAsMetadata>(MD))
 287     if ((Flags & RF_NoModuleLevelChanges))
 288       return mapToSelf(VM, MD);
 289
 290   if (const auto *VMD = dyn_cast<ValueAsMetadata>(MD)) {
 291     Value *MappedV =
 292         MapValue(VMD->getValue(), VM, Flags, TypeMapper, Materializer);
 293     if (VMD->getValue() == MappedV ||
 294         (!MappedV && (Flags & RF_IgnoreMissingEntries)))
 295       return mapToSelf(VM, MD);
 296
 297     // FIXME: This assert crashes during bootstrap, but I think it should be
 298     // correct.  For now, just match behaviour from before the metadata/value
 299     // split.
 300     //
 301     //    assert(MappedV && "Referenced metadata not in value map!");
 302     if (MappedV)
 303       return mapToMetadata(VM, MD, ValueAsMetadata::get(MappedV));
 304     return nullptr;
 305   }
 306
 307   // Note: this cast precedes the Flags check so we always get its associated
 308   // assertion.
 309   const MDNode *Node = cast<MDNode>(MD);
 310
 311   // If this is a module-level metadata and we know that nothing at the
 312   // module level is changing, then use an identity mapping.
 313   if (Flags & RF_NoModuleLevelChanges)
 314     return mapToSelf(VM, MD);
 315
 316   // Require resolved nodes whenever metadata might be remapped.
 317   assert(Node->isResolved() && "Unexpected unresolved node");
 318
 319   if (Node->isDistinct())
 320     return mapDistinctNode(Node, Cycles, VM, Flags, TypeMapper, Materializer);
 321
 322   return mapUniquedNode(Node, Cycles, VM, Flags, TypeMapper, Materializer);
 323 }
 324
 325 Metadata *llvm::MapMetadata(const Metadata *MD, ValueToValueMapTy &VM,
 326                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 327                             ValueMaterializer *Materializer) {
 328   SmallVector<TrackingMDNodeRef, 8> Cycles;
 329   Metadata *NewMD =
 330       MapMetadataImpl(MD, Cycles, VM, Flags, TypeMapper, Materializer);
 331
 332   if ((Flags & RF_NoModuleLevelChanges) ||
 333       (MD == NewMD && !(Flags & RF_MoveDistinctMDs))) {
 334     assert(Cycles.empty() && "Unresolved cycles without remapping anything?");
 335     return NewMD;
 336   }
 337
 338   if (auto *N = dyn_cast<MDNode>(NewMD))
 339     if (!N->isResolved())
 340       N->resolveCycles();
 341
 342   // Resolve cycles underneath MD.
 343   for (MDNode *N : Cycles)
 344     if (!N->isResolved())
 345       N->resolveCycles();
 346
 347   return NewMD;
 348 }
 349
 350 MDNode *llvm::MapMetadata(const MDNode *MD, ValueToValueMapTy &VM,
 351                           RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 352                           ValueMaterializer *Materializer) {
 353   return cast<MDNode>(MapMetadata(static_cast<const Metadata *>(MD), VM, Flags,
 354                                   TypeMapper, Materializer));
 355 }
 356
 357 /// RemapInstruction - Convert the instruction operands from referencing the
 358 /// current values into those specified by VMap.
 359 ///
 360 void llvm::RemapInstruction(Instruction *I, ValueToValueMapTy &VMap,
 361                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 362                             ValueMaterializer *Materializer){
 363   // Remap operands.
 364   for (User::op_iterator op = I->op_begin(), E = I->op_end(); op != E; ++op) {
 365     Value *V = MapValue(*op, VMap, Flags, TypeMapper, Materializer);
 366     // If we aren't ignoring missing entries, assert that something happened.
 367     if (V)
 368       *op = V;
 369     else
 370       assert((Flags & RF_IgnoreMissingEntries) &&
 371              "Referenced value not in value map!");
 372   }
 373
 374   // Remap phi nodes' incoming blocks.
 375   if (PHINode *PN = dyn_cast<PHINode>(I)) {
 376     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 377       Value *V = MapValue(PN->getIncomingBlock(i), VMap, Flags);
 378       // If we aren't ignoring missing entries, assert that something happened.
 379       if (V)
 380         PN->setIncomingBlock(i, cast<BasicBlock>(V));
 381       else
 382         assert((Flags & RF_IgnoreMissingEntries) &&
 383                "Referenced block not in value map!");
 384     }
 385   }
 386
 387   // Remap attached metadata.
 388   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 389   I->getAllMetadata(MDs);
 390   for (const auto &MI : MDs) {
 391     MDNode *Old = MI.second;
 392     MDNode *New = MapMetadata(Old, VMap, Flags, TypeMapper, Materializer);
 393     if (New != Old)
 394       I->setMetadata(MI.first, New);
 395   }
 396
 397   if (!TypeMapper)
 398     return;
 399
 400   // If the instruction's type is being remapped, do so now.
 401   if (auto CS = CallSite(I)) {
 402     SmallVector<Type *, 3> Tys;
 403     FunctionType *FTy = CS.getFunctionType();
 404     Tys.reserve(FTy->getNumParams());
 405     for (Type *Ty : FTy->params())
 406       Tys.push_back(TypeMapper->remapType(Ty));
 407     CS.mutateFunctionType(FunctionType::get(
 408         TypeMapper->remapType(I->getType()), Tys, FTy->isVarArg()));
 409     return;
 410   }
 411   if (auto *AI = dyn_cast<AllocaInst>(I))
 412     AI->setAllocatedType(TypeMapper->remapType(AI->getAllocatedType()));
 413   if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
 414     GEP->setSourceElementType(
 415         TypeMapper->remapType(GEP->getSourceElementType()));
 416     GEP->setResultElementType(
 417         TypeMapper->remapType(GEP->getResultElementType()));
 418   }
 419   I->mutateType(TypeMapper->remapType(I->getType()));
 420 }