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                               bool IsDistinct) {
 188   // Distinct MDTuples have their own code path.
 189   assert(!IsDistinct && "Unexpected distinct tuple");
 190   (void)IsDistinct;
 191
 192   SmallVector<Metadata *, 4> Elts;
 193   Elts.reserve(Node->getNumOperands());
 194   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I)
 195     Elts.push_back(mapMetadataOp(Node->getOperand(I), VM, Flags, TypeMapper,
 196                                  Materializer));
 197
 198   return MDTuple::get(Node->getContext(), Elts);
 199 }
 200
 201 static Metadata *cloneMDLocation(const MDLocation *Node, ValueToValueMapTy &VM,
 202                                  RemapFlags Flags,
 203                                  ValueMapTypeRemapper *TypeMapper,
 204                                  ValueMaterializer *Materializer,
 205                                  bool IsDistinct) {
 206   return (IsDistinct ? MDLocation::getDistinct : MDLocation::get)(
 207       Node->getContext(), Node->getLine(), Node->getColumn(),
 208       mapMetadataOp(Node->getScope(), VM, Flags, TypeMapper, Materializer),
 209       mapMetadataOp(Node->getInlinedAt(), VM, Flags, TypeMapper, Materializer));
 210 }
 211
 212 static Metadata *cloneMDNode(const UniquableMDNode *Node, ValueToValueMapTy &VM,
 213                              RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 214                              ValueMaterializer *Materializer, bool IsDistinct) {
 215   switch (Node->getMetadataID()) {
 216   default:
 217     llvm_unreachable("Invalid UniquableMDNode subclass");
 218 #define HANDLE_UNIQUABLE_LEAF(CLASS)                                           \
 219   case Metadata::CLASS##Kind:                                                  \
 220     return clone##CLASS(cast<CLASS>(Node), VM, Flags, TypeMapper,              \
 221                         Materializer, IsDistinct);                             \
 222 #include "llvm/IR/Metadata.def"
 223   }
 224 }
 225
 226 /// \brief Map a distinct MDNode.
 227 ///
 228 /// Distinct nodes are not uniqued, so they must always recreated.
 229 static Metadata *mapDistinctNode(const UniquableMDNode *Node,
 230                                  ValueToValueMapTy &VM, RemapFlags Flags,
 231                                  ValueMapTypeRemapper *TypeMapper,
 232                                  ValueMaterializer *Materializer) {
 233   assert(Node->isDistinct() && "Expected distinct node");
 234
 235   // Optimization for MDTuples.
 236   if (isa<MDTuple>(Node)) {
 237     // Create the node first so it's available for cyclical references.
 238     SmallVector<Metadata *, 4> EmptyOps(Node->getNumOperands());
 239     MDTuple *NewMD = MDTuple::getDistinct(Node->getContext(), EmptyOps);
 240     mapToMetadata(VM, Node, NewMD);
 241
 242     // Fix the operands.
 243     for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I)
 244       NewMD->replaceOperandWith(I, mapMetadataOp(Node->getOperand(I), VM, Flags,
 245                                                  TypeMapper, Materializer));
 246
 247     return NewMD;
 248   }
 249
 250   // In general we need a dummy node, since whether the operands are null can
 251   // affect the size of the node.
 252   std::unique_ptr<MDNodeFwdDecl> Dummy(
 253       MDNode::getTemporary(Node->getContext(), None));
 254   mapToMetadata(VM, Node, Dummy.get());
 255   Metadata *NewMD = cloneMDNode(Node, VM, Flags, TypeMapper, Materializer,
 256                                 /* IsDistinct */ true);
 257   Dummy->replaceAllUsesWith(NewMD);
 258   return mapToMetadata(VM, Node, NewMD);
 259 }
 260
 261 /// \brief Check whether a uniqued node needs to be remapped.
 262 ///
 263 /// Check whether a uniqued node needs to be remapped (due to any operands
 264 /// changing).
 265 static bool shouldRemapUniquedNode(const UniquableMDNode *Node,
 266                                    ValueToValueMapTy &VM, RemapFlags Flags,
 267                                    ValueMapTypeRemapper *TypeMapper,
 268                                    ValueMaterializer *Materializer) {
 269   // Check all operands to see if any need to be remapped.
 270   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I) {
 271     Metadata *Op = Node->getOperand(I);
 272     if (Op != mapMetadataOp(Op, VM, Flags, TypeMapper, Materializer))
 273       return true;
 274   }
 275   return false;
 276 }
 277
 278 /// \brief Map a uniqued MDNode.
 279 ///
 280 /// Uniqued nodes may not need to be recreated (they may map to themselves).
 281 static Metadata *mapUniquedNode(const UniquableMDNode *Node,
 282                                  ValueToValueMapTy &VM, RemapFlags Flags,
 283                                  ValueMapTypeRemapper *TypeMapper,
 284                                  ValueMaterializer *Materializer) {
 285   assert(!Node->isDistinct() && "Expected uniqued node");
 286
 287   // Create a dummy node in case we have a metadata cycle.
 288   MDNodeFwdDecl *Dummy = MDNode::getTemporary(Node->getContext(), None);
 289   mapToMetadata(VM, Node, Dummy);
 290
 291   // Check all operands to see if any need to be remapped.
 292   if (!shouldRemapUniquedNode(Node, VM, Flags, TypeMapper, Materializer)) {
 293     // Use an identity mapping.
 294     mapToSelf(VM, Node);
 295     MDNode::deleteTemporary(Dummy);
 296     return const_cast<Metadata *>(static_cast<const Metadata *>(Node));
 297   }
 298
 299   // At least one operand needs remapping.
 300   Metadata *NewMD = cloneMDNode(Node, VM, Flags, TypeMapper, Materializer,
 301                                 /* IsDistinct */ false);
 302   Dummy->replaceAllUsesWith(NewMD);
 303   MDNode::deleteTemporary(Dummy);
 304   return mapToMetadata(VM, Node, NewMD);
 305 }
 306
 307 static Metadata *MapMetadataImpl(const Metadata *MD, ValueToValueMapTy &VM,
 308                                  RemapFlags Flags,
 309                                  ValueMapTypeRemapper *TypeMapper,
 310                                  ValueMaterializer *Materializer) {
 311   // If the value already exists in the map, use it.
 312   if (Metadata *NewMD = VM.MD().lookup(MD).get())
 313     return NewMD;
 314
 315   if (isa<MDString>(MD))
 316     return mapToSelf(VM, MD);
 317
 318   if (isa<ConstantAsMetadata>(MD))
 319     if ((Flags & RF_NoModuleLevelChanges))
 320       return mapToSelf(VM, MD);
 321
 322   if (const auto *VMD = dyn_cast<ValueAsMetadata>(MD)) {
 323     Value *MappedV =
 324         MapValue(VMD->getValue(), VM, Flags, TypeMapper, Materializer);
 325     if (VMD->getValue() == MappedV ||
 326         (!MappedV && (Flags & RF_IgnoreMissingEntries)))
 327       return mapToSelf(VM, MD);
 328
 329     // FIXME: This assert crashes during bootstrap, but I think it should be
 330     // correct.  For now, just match behaviour from before the metadata/value
 331     // split.
 332     //
 333     //    assert(MappedV && "Referenced metadata not in value map!");
 334     if (MappedV)
 335       return mapToMetadata(VM, MD, ValueAsMetadata::get(MappedV));
 336     return nullptr;
 337   }
 338
 339   const UniquableMDNode *Node = cast<UniquableMDNode>(MD);
 340   assert(Node->isResolved() && "Unexpected unresolved node");
 341
 342   // If this is a module-level metadata and we know that nothing at the
 343   // module level is changing, then use an identity mapping.
 344   if (Flags & RF_NoModuleLevelChanges)
 345     return mapToSelf(VM, MD);
 346
 347   if (Node->isDistinct())
 348     return mapDistinctNode(Node, VM, Flags, TypeMapper, Materializer);
 349
 350   return mapUniquedNode(Node, VM, Flags, TypeMapper, Materializer);
 351 }
 352
 353 Metadata *llvm::MapMetadata(const Metadata *MD, ValueToValueMapTy &VM,
 354                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 355                             ValueMaterializer *Materializer) {
 356   Metadata *NewMD = MapMetadataImpl(MD, VM, Flags, TypeMapper, Materializer);
 357   if (NewMD && NewMD != MD)
 358     if (auto *N = dyn_cast<UniquableMDNode>(NewMD))
 359       N->resolveCycles();
 360   return NewMD;
 361 }
 362
 363 MDNode *llvm::MapMetadata(const MDNode *MD, ValueToValueMapTy &VM,
 364                           RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 365                           ValueMaterializer *Materializer) {
 366   return cast<MDNode>(MapMetadata(static_cast<const Metadata *>(MD), VM, Flags,
 367                                   TypeMapper, Materializer));
 368 }
 369
 370 /// RemapInstruction - Convert the instruction operands from referencing the
 371 /// current values into those specified by VMap.
 372 ///
 373 void llvm::RemapInstruction(Instruction *I, ValueToValueMapTy &VMap,
 374                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 375                             ValueMaterializer *Materializer){
 376   // Remap operands.
 377   for (User::op_iterator op = I->op_begin(), E = I->op_end(); op != E; ++op) {
 378     Value *V = MapValue(*op, VMap, Flags, TypeMapper, Materializer);
 379     // If we aren't ignoring missing entries, assert that something happened.
 380     if (V)
 381       *op = V;
 382     else
 383       assert((Flags & RF_IgnoreMissingEntries) &&
 384              "Referenced value not in value map!");
 385   }
 386
 387   // Remap phi nodes' incoming blocks.
 388   if (PHINode *PN = dyn_cast<PHINode>(I)) {
 389     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 390       Value *V = MapValue(PN->getIncomingBlock(i), VMap, Flags);
 391       // If we aren't ignoring missing entries, assert that something happened.
 392       if (V)
 393         PN->setIncomingBlock(i, cast<BasicBlock>(V));
 394       else
 395         assert((Flags & RF_IgnoreMissingEntries) &&
 396                "Referenced block not in value map!");
 397     }
 398   }
 399
 400   // Remap attached metadata.
 401   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 402   I->getAllMetadata(MDs);
 403   for (SmallVectorImpl<std::pair<unsigned, MDNode *>>::iterator
 404            MI = MDs.begin(),
 405            ME = MDs.end();
 406        MI != ME; ++MI) {
 407     MDNode *Old = MI->second;
 408     MDNode *New = MapMetadata(Old, VMap, Flags, TypeMapper, Materializer);
 409     if (New != Old)
 410       I->setMetadata(MI->first, New);
 411   }
 412
 413   // If the instruction's type is being remapped, do so now.
 414   if (TypeMapper)
 415     I->mutateType(TypeMapper->remapType(I->getType()));
 416 }