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 TempMDTuple cloneMDTuple(const MDTuple *Node) {
 184   SmallVector<Metadata *, 4> Elts;
 185   Elts.append(Node->op_begin(), Node->op_end());
 186   return MDTuple::getTemporary(Node->getContext(), Elts);
 187 }
 188
 189 static TempMDLocation cloneMDLocation(const MDLocation *Node) {
 190   return MDLocation::getTemporary(Node->getContext(), Node->getLine(),
 191                                   Node->getColumn(), Node->getScope(),
 192                                   Node->getInlinedAt());
 193 }
 194
 195 static TempUniquableMDNode cloneMDNode(const UniquableMDNode *Node) {
 196   switch (Node->getMetadataID()) {
 197   default:
 198     llvm_unreachable("Invalid UniquableMDNode subclass");
 199 #define HANDLE_UNIQUABLE_LEAF(CLASS)                                           \
 200   case Metadata::CLASS##Kind:                                                  \
 201     return clone##CLASS(cast<CLASS>(Node));
 202 #include "llvm/IR/Metadata.def"
 203   }
 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   MDNode *NewMD = MDNode::replaceWithDistinct(cloneMDNode(Node));
 217   mapToMetadata(VM, Node, NewMD);
 218
 219   // Fix the operands.
 220   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I)
 221     NewMD->replaceOperandWith(I, mapMetadataOp(Node->getOperand(I), VM, Flags,
 222                                                TypeMapper, Materializer));
 223
 224   return NewMD;
 225 }
 226
 227 /// \brief Map a uniqued MDNode.
 228 ///
 229 /// Uniqued nodes may not need to be recreated (they may map to themselves).
 230 static Metadata *mapUniquedNode(const UniquableMDNode *Node,
 231                                 ValueToValueMapTy &VM, RemapFlags Flags,
 232                                 ValueMapTypeRemapper *TypeMapper,
 233                                 ValueMaterializer *Materializer) {
 234   assert(Node->isUniqued() && "Expected uniqued node");
 235
 236   // Create a temporary node upfront in case we have a metadata cycle.
 237   auto ClonedMD = cloneMDNode(Node);
 238   mapToMetadata(VM, Node, ClonedMD.get());
 239
 240   // Remap the operands, keeping track of whether any changed.
 241   bool AnyChanged = false;
 242   for (unsigned I = 0, E = Node->getNumOperands(); I != E; ++I) {
 243     Metadata *Old = Node->getOperand(I);
 244     Metadata *New = mapMetadataOp(Old, VM, Flags, TypeMapper, Materializer);
 245     if (Old != New) {
 246       ClonedMD->replaceOperandWith(I, New);
 247       AnyChanged = true;
 248     }
 249   }
 250
 251   if (!AnyChanged)
 252     // Use an identity mapping.
 253     return mapToSelf(VM, Node);
 254
 255   // At least one operand has changed, so uniquify the cloned node.
 256   return mapToMetadata(VM, Node,
 257                        MDNode::replaceWithUniqued(std::move(ClonedMD)));
 258 }
 259
 260 static Metadata *MapMetadataImpl(const Metadata *MD, ValueToValueMapTy &VM,
 261                                  RemapFlags Flags,
 262                                  ValueMapTypeRemapper *TypeMapper,
 263                                  ValueMaterializer *Materializer) {
 264   // If the value already exists in the map, use it.
 265   if (Metadata *NewMD = VM.MD().lookup(MD).get())
 266     return NewMD;
 267
 268   if (isa<MDString>(MD))
 269     return mapToSelf(VM, MD);
 270
 271   if (isa<ConstantAsMetadata>(MD))
 272     if ((Flags & RF_NoModuleLevelChanges))
 273       return mapToSelf(VM, MD);
 274
 275   if (const auto *VMD = dyn_cast<ValueAsMetadata>(MD)) {
 276     Value *MappedV =
 277         MapValue(VMD->getValue(), VM, Flags, TypeMapper, Materializer);
 278     if (VMD->getValue() == MappedV ||
 279         (!MappedV && (Flags & RF_IgnoreMissingEntries)))
 280       return mapToSelf(VM, MD);
 281
 282     // FIXME: This assert crashes during bootstrap, but I think it should be
 283     // correct.  For now, just match behaviour from before the metadata/value
 284     // split.
 285     //
 286     //    assert(MappedV && "Referenced metadata not in value map!");
 287     if (MappedV)
 288       return mapToMetadata(VM, MD, ValueAsMetadata::get(MappedV));
 289     return nullptr;
 290   }
 291
 292   const UniquableMDNode *Node = cast<UniquableMDNode>(MD);
 293   assert(Node->isResolved() && "Unexpected unresolved node");
 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   if (Node->isDistinct())
 301     return mapDistinctNode(Node, VM, Flags, TypeMapper, Materializer);
 302
 303   return mapUniquedNode(Node, VM, Flags, TypeMapper, Materializer);
 304 }
 305
 306 Metadata *llvm::MapMetadata(const Metadata *MD, ValueToValueMapTy &VM,
 307                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 308                             ValueMaterializer *Materializer) {
 309   Metadata *NewMD = MapMetadataImpl(MD, VM, Flags, TypeMapper, Materializer);
 310   if (NewMD && NewMD != MD)
 311     if (auto *N = dyn_cast<UniquableMDNode>(NewMD))
 312       N->resolveCycles();
 313   return NewMD;
 314 }
 315
 316 MDNode *llvm::MapMetadata(const MDNode *MD, ValueToValueMapTy &VM,
 317                           RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 318                           ValueMaterializer *Materializer) {
 319   return cast<MDNode>(MapMetadata(static_cast<const Metadata *>(MD), VM, Flags,
 320                                   TypeMapper, Materializer));
 321 }
 322
 323 /// RemapInstruction - Convert the instruction operands from referencing the
 324 /// current values into those specified by VMap.
 325 ///
 326 void llvm::RemapInstruction(Instruction *I, ValueToValueMapTy &VMap,
 327                             RemapFlags Flags, ValueMapTypeRemapper *TypeMapper,
 328                             ValueMaterializer *Materializer){
 329   // Remap operands.
 330   for (User::op_iterator op = I->op_begin(), E = I->op_end(); op != E; ++op) {
 331     Value *V = MapValue(*op, VMap, Flags, TypeMapper, Materializer);
 332     // If we aren't ignoring missing entries, assert that something happened.
 333     if (V)
 334       *op = V;
 335     else
 336       assert((Flags & RF_IgnoreMissingEntries) &&
 337              "Referenced value not in value map!");
 338   }
 339
 340   // Remap phi nodes' incoming blocks.
 341   if (PHINode *PN = dyn_cast<PHINode>(I)) {
 342     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 343       Value *V = MapValue(PN->getIncomingBlock(i), VMap, Flags);
 344       // If we aren't ignoring missing entries, assert that something happened.
 345       if (V)
 346         PN->setIncomingBlock(i, cast<BasicBlock>(V));
 347       else
 348         assert((Flags & RF_IgnoreMissingEntries) &&
 349                "Referenced block not in value map!");
 350     }
 351   }
 352
 353   // Remap attached metadata.
 354   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 355   I->getAllMetadata(MDs);
 356   for (SmallVectorImpl<std::pair<unsigned, MDNode *>>::iterator
 357            MI = MDs.begin(),
 358            ME = MDs.end();
 359        MI != ME; ++MI) {
 360     MDNode *Old = MI->second;
 361     MDNode *New = MapMetadata(Old, VMap, Flags, TypeMapper, Materializer);
 362     if (New != Old)
 363       I->setMetadata(MI->first, New);
 364   }
 365
 366   // If the instruction's type is being remapped, do so now.
 367   if (TypeMapper)
 368     I->mutateType(TypeMapper->remapType(I->getType()));
 369 }