LLVM  14.0.0git
Public Member Functions | List of all members
llvm::ValueMapper Class Reference

Context for (re-)mapping values (and metadata). More...

#include "llvm/Transforms/Utils/ValueMapper.h"

Public Member Functions

 ValueMapper (ValueToValueMapTy &VM, RemapFlags Flags=RF_None, ValueMapTypeRemapper *TypeMapper=nullptr, ValueMaterializer *Materializer=nullptr)
 ValueMapper (ValueMapper &&)=delete
 ValueMapper (const ValueMapper &)=delete
ValueMapperoperator= (ValueMapper &&)=delete
ValueMapperoperator= (const ValueMapper &)=delete
 ~ValueMapper ()
unsigned registerAlternateMappingContext (ValueToValueMapTy &VM, ValueMaterializer *Materializer=nullptr)
 Register an alternate mapping context. More...
void addFlags (RemapFlags Flags)
 Add to the current RemapFlags. More...
MetadatamapMetadata (const Metadata &MD)
MDNodemapMDNode (const MDNode &N)
ValuemapValue (const Value &V)
ConstantmapConstant (const Constant &C)
void remapInstruction (Instruction &I)
void remapFunction (Function &F)
void scheduleMapGlobalInitializer (GlobalVariable &GV, Constant &Init, unsigned MappingContextID=0)
void scheduleMapAppendingVariable (GlobalVariable &GV, Constant *InitPrefix, bool IsOldCtorDtor, ArrayRef< Constant * > NewMembers, unsigned MappingContextID=0)
void scheduleMapGlobalAlias (GlobalAlias &GA, Constant &Aliasee, unsigned MappingContextID=0)
void scheduleMapGlobalIFunc (GlobalIFunc &GI, Constant &Resolver, unsigned MappingContextID=0)
void scheduleRemapFunction (Function &F, unsigned MappingContextID=0)

Detailed Description

Context for (re-)mapping values (and metadata).

A shared context used for mapping and remapping of Value and Metadata instances using ValueToValueMapTy, RemapFlags, ValueMapTypeRemapper, and ValueMaterializer.

There are a number of top-level entry points:

The ValueMaterializer can be used as a callback, but cannot invoke any of these top-level functions recursively. Instead, callbacks should use one of the following to schedule work lazily in the ValueMapper instance:

Sometimes a callback needs a different mapping context. Such a context can be registered using registerAlternateMappingContext(), which takes an alternate ValueToValueMapTy and ValueMaterializer and returns a ID to pass into the schedule*() functions.

TODO: lib/Linker really doesn't need the ValueHandle in the ValueToValueMapTy. We should template ValueMapper (and its implementation classes), and explicitly instantiate on two concrete instances of ValueMap (one as ValueToValueMap, and one with raw Value pointers). It may be viable to do away with TrackingMDRef in the Metadata side map for the lib/Linker case as well, in which case we'll need a new template parameter on ValueMap.

TODO: Update callers of RemapInstruction() and MapValue() (etc.) to use ValueMapper directly.

Definition at line 143 of file ValueMapper.h.

Constructor & Destructor Documentation

◆ ValueMapper() [1/3]

ValueMapper::ValueMapper ( ValueToValueMapTy VM,
RemapFlags  Flags = RF_None,
ValueMapTypeRemapper TypeMapper = nullptr,
ValueMaterializer Materializer = nullptr 

Definition at line 1132 of file ValueMapper.cpp.

◆ ValueMapper() [2/3]

llvm::ValueMapper::ValueMapper ( ValueMapper &&  )

◆ ValueMapper() [3/3]

llvm::ValueMapper::ValueMapper ( const ValueMapper )

◆ ~ValueMapper()

ValueMapper::~ValueMapper ( )

Definition at line 1137 of file ValueMapper.cpp.

References getAsMapper().

Member Function Documentation

◆ addFlags()

void ValueMapper::addFlags ( RemapFlags  Flags)

Add to the current RemapFlags.

Like the top-level mapping functions, addFlags() must be called at the top level, not during a callback in a ValueMaterializer.

Definition at line 1145 of file ValueMapper.cpp.

◆ mapConstant()

Constant * ValueMapper::mapConstant ( const Constant C)

Definition at line 1153 of file ValueMapper.cpp.

References mapValue().

Referenced by llvm::MapValue().

◆ mapMDNode()

MDNode * ValueMapper::mapMDNode ( const MDNode N)

Definition at line 1161 of file ValueMapper.cpp.

References mapMetadata(), and N.

Referenced by llvm::MapMetadata().

◆ mapMetadata()

Metadata * ValueMapper::mapMetadata ( const Metadata MD)

Definition at line 1157 of file ValueMapper.cpp.

Referenced by mapMDNode(), and llvm::MapMetadata().

◆ mapValue()

Value * ValueMapper::mapValue ( const Value V)

Definition at line 1149 of file ValueMapper.cpp.

Referenced by mapConstant(), and llvm::MapValue().

◆ operator=() [1/2]

ValueMapper& llvm::ValueMapper::operator= ( const ValueMapper )

◆ operator=() [2/2]

ValueMapper& llvm::ValueMapper::operator= ( ValueMapper &&  )

◆ registerAlternateMappingContext()

unsigned ValueMapper::registerAlternateMappingContext ( ValueToValueMapTy VM,
ValueMaterializer Materializer = nullptr 

Register an alternate mapping context.

Returns a MappingContextID that can be used with the various schedule*() API to switch in a different value map on-the-fly.

Definition at line 1140 of file ValueMapper.cpp.

References getAsMapper().

◆ remapFunction()

void ValueMapper::remapFunction ( Function F)

Definition at line 1169 of file ValueMapper.cpp.

References F.

Referenced by llvm::RemapFunction().

◆ remapInstruction()

void ValueMapper::remapInstruction ( Instruction I)

Definition at line 1165 of file ValueMapper.cpp.

References I.

Referenced by llvm::RemapInstruction().

◆ scheduleMapAppendingVariable()

void ValueMapper::scheduleMapAppendingVariable ( GlobalVariable GV,
Constant InitPrefix,
bool  IsOldCtorDtor,
ArrayRef< Constant * >  NewMembers,
unsigned  MappingContextID = 0 

Definition at line 1179 of file ValueMapper.cpp.

References getAsMapper().

◆ scheduleMapGlobalAlias()

void ValueMapper::scheduleMapGlobalAlias ( GlobalAlias GA,
Constant Aliasee,
unsigned  MappingContextID = 0 

Definition at line 1188 of file ValueMapper.cpp.

References getAsMapper().

◆ scheduleMapGlobalIFunc()

void ValueMapper::scheduleMapGlobalIFunc ( GlobalIFunc GI,
Constant Resolver,
unsigned  MappingContextID = 0 

Definition at line 1193 of file ValueMapper.cpp.

References getAsMapper().

◆ scheduleMapGlobalInitializer()

void ValueMapper::scheduleMapGlobalInitializer ( GlobalVariable GV,
Constant Init,
unsigned  MappingContextID = 0 

Definition at line 1173 of file ValueMapper.cpp.

References getAsMapper().

◆ scheduleRemapFunction()

void ValueMapper::scheduleRemapFunction ( Function F,
unsigned  MappingContextID = 0 

Definition at line 1198 of file ValueMapper.cpp.

References F, and getAsMapper().

The documentation for this class was generated from the following files: