LLVM 23.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
llvm::instrumentor::CastIO Struct Referencefinal

The instrumentation opportunity for type cast instructions. More...

#include "llvm/Transforms/IPO/Instrumentor.h"

Inheritance diagram for llvm::instrumentor::CastIO:
[legend]

Public Types

enum  ConfigKind {
  PassInput , PassInputTypeId , PassInputSubTypeId , PassInputSize ,
  PassResult , ReplaceResult , PassResultTypeId , PassResultSubTypeId ,
  PassResultSize , PassOpcode , PassId , NumConfig
}
using ConfigTy = BaseConfigTy<ConfigKind>
Public Types inherited from llvm::instrumentor::InstrumentationOpportunity
using CallbackTy = std::function<bool(Value &)>
 An optional callback that takes the value that is about to be instrumented and can return false if it should be skipped.

Public Member Functions

 CastIO (InstrumentationLocation::KindTy Kind)
StringRef getName () const override
 Get the name of the instruction.
LLVM_ABI void init (InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB, ConfigTy *UserConfig=nullptr)
 CastIO {.
Public Member Functions inherited from llvm::instrumentor::InstructionIO< Instruction::PtrToInt, Instruction::IntToPtr, Instruction::Trunc, Instruction::ZExt, Instruction::SExt, Instruction::FPToUI, Instruction::FPToSI, Instruction::UIToFP, Instruction::SIToFP, Instruction::FPTrunc, Instruction::FPExt, Instruction::AddrSpaceCast, Instruction::BitCast >
virtual ~InstructionIO ()
 InstructionIO (InstrumentationLocation::KindTy Kind)
 Construct an instruction opportunity.
ArrayRef< unsigned > getAllOpcodes () const override
 Get all opcodes for this instrumentation opportunity (override).
Public Member Functions inherited from llvm::instrumentor::BaseInstructionIO
virtual ~BaseInstructionIO ()
 BaseInstructionIO (InstrumentationLocation::KindTy Kind)
Public Member Functions inherited from llvm::instrumentor::InstrumentationOpportunity
virtual ~InstrumentationOpportunity ()
 InstrumentationOpportunity (const InstrumentationLocation IP)
 Construct an opportunity with location IP.
virtual Value * instrument (Value *&V, bool &Changed, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB, InstrumentationCaches &ICaches)
 }
virtual Type * getRetTy (LLVMContext &Ctx) const
 Get the return type for the instrumentation runtime function.
InstrumentationLocation::KindTy getLocationKind () const
 Get the location kind of the instrumentation opportunity.
void addCommonArgs (InstrumentationConfig &IConf, LLVMContext &Ctx, bool PassId)
 }

Static Public Member Functions

static LLVM_ABI Value * getInput (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getInputTypeId (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getInputSubTypeId (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getInputSize (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getResultTypeId (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getResultSubTypeId (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getResultSize (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static void populate (InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
Static Public Member Functions inherited from llvm::instrumentor::InstructionIO< Instruction::PtrToInt, Instruction::IntToPtr, Instruction::Trunc, Instruction::ZExt, Instruction::SExt, Instruction::FPToUI, Instruction::FPToSI, Instruction::UIToFP, Instruction::SIToFP, Instruction::FPTrunc, Instruction::FPExt, Instruction::AddrSpaceCast, Instruction::BitCast >
static constexpr size_t getNumOpcodes ()
 Get the number of opcodes.
Static Public Member Functions inherited from llvm::instrumentor::BaseInstructionIO
static LLVM_ABI Value * getOpcode (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getTypeSize (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getLeftOperand (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getRightOperand (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getTypeId (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getSubTypeId (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
Static Public Member Functions inherited from llvm::instrumentor::InstrumentationOpportunity
static LLVM_ABI Value * forceCast (Value &V, Type &Ty, InstrumentorIRBuilderTy &IIRB)
 Helpers to cast values, pass them to the runtime, and replace them.
static Value * getValue (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * replaceValue (Value &V, Value &NewV, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static LLVM_ABI Value * getIdPre (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
 Get the opportunity identifier for the pre and post positions.
static LLVM_ABI Value * getIdPost (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static int32_t getIdFromEpoch (uint32_t CurrentEpoch)
 }

Public Attributes

ConfigTy Config
Public Attributes inherited from llvm::instrumentor::InstrumentationOpportunity
InstrumentationLocation IP
 The instrumentation location of the opportunity.
SmallVector< IRTArg > IRTArgs
 The list of possible arguments for the instrumentation runtime function.
bool Enabled = true
 Whether the opportunity is enabled.
StringRef Filter
 A filter expression to be matched against runtime property values.
CallbackTy CB = nullptr

Additional Inherited Members

Static Public Attributes inherited from llvm::instrumentor::InstructionIO< Instruction::PtrToInt, Instruction::IntToPtr, Instruction::Trunc, Instruction::ZExt, Instruction::SExt, Instruction::FPToUI, Instruction::FPToSI, Instruction::UIToFP, Instruction::SIToFP, Instruction::FPTrunc, Instruction::FPExt, Instruction::AddrSpaceCast, Instruction::BitCast >
static constexpr std::array< unsigned, sizeof...(Opcodes)> OpcodesArray

Detailed Description

The instrumentation opportunity for type cast instructions.

This includes PtrToInt, IntToPtr, Trunc, ZExt, SExt, FPToUI, FPToSI, UIToFP, SIToFP, FPTrunc, FPExt, AddrSpaceCast, and BitCast.

Definition at line 1116 of file Instrumentor.h.

Member Typedef Documentation

◆ ConfigTy

using llvm::instrumentor::CastIO::ConfigTy = BaseConfigTy<ConfigKind>

Definition at line 1140 of file Instrumentor.h.

Member Enumeration Documentation

◆ ConfigKind

enum llvm::instrumentor::CastIO::ConfigKind
Enumerator
PassInput 
PassInputTypeId 
PassInputSubTypeId 
PassInputSize 
PassResult 
ReplaceResult 
PassResultTypeId 
PassResultSubTypeId 
PassResultSize 
PassOpcode 
PassId 
NumConfig 

Definition at line 1125 of file Instrumentor.h.

Constructor & Destructor Documentation

◆ CastIO()

llvm::instrumentor::CastIO::CastIO ( InstrumentationLocation::KindTy Kind)
inline

Definition at line 1123 of file Instrumentor.h.

References llvm::instrumentor::InstructionIO< Instruction::PtrToInt, Instruction::IntToPtr, Instruction::Trunc, Instruction::ZExt, Instruction::SExt, Instruction::FPToUI, Instruction::FPToSI, Instruction::UIToFP, Instruction::SIToFP, Instruction::FPTrunc, Instruction::FPExt, Instruction::AddrSpaceCast, Instruction::BitCast >::InstructionIO().

Referenced by populate().

Member Function Documentation

◆ getInput()

Value * CastIO::getInput ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1743 of file Instrumentor.cpp.

References llvm::cast().

Referenced by init().

◆ getInputSize()

Value * CastIO::getInputSize ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1762 of file Instrumentor.cpp.

References llvm::cast(), and DL.

Referenced by init().

◆ getInputSubTypeId()

Value * CastIO::getInputSubTypeId ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1755 of file Instrumentor.cpp.

References llvm::cast().

Referenced by init().

◆ getInputTypeId()

Value * CastIO::getInputTypeId ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1749 of file Instrumentor.cpp.

References llvm::cast().

Referenced by init().

◆ getName()

StringRef llvm::instrumentor::CastIO::getName ( ) const
inlineoverridevirtual

Get the name of the instruction.

For single-opcode IOs, this defaults to the opcode name. For multi-opcode IOs, getName() MUST be overridden to provide an explicit name identifying the whole group of opcodes.

Reimplemented from llvm::instrumentor::InstructionIO< Instruction::PtrToInt, Instruction::IntToPtr, Instruction::Trunc, Instruction::ZExt, Instruction::SExt, Instruction::FPToUI, Instruction::FPToSI, Instruction::UIToFP, Instruction::SIToFP, Instruction::FPTrunc, Instruction::FPExt, Instruction::AddrSpaceCast, Instruction::BitCast >.

Definition at line 1143 of file Instrumentor.h.

◆ getResultSize()

Value * CastIO::getResultSize ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1782 of file Instrumentor.cpp.

References llvm::cast(), and DL.

Referenced by init().

◆ getResultSubTypeId()

Value * CastIO::getResultSubTypeId ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1775 of file Instrumentor.cpp.

References llvm::cast().

Referenced by init().

◆ getResultTypeId()

Value * CastIO::getResultTypeId ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 1769 of file Instrumentor.cpp.

References llvm::cast().

Referenced by init().

◆ init()

void CastIO::init ( InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB,
ConfigTy * UserConfig = nullptr )

CastIO {.

Definition at line 1689 of file Instrumentor.cpp.

References llvm::instrumentor::InstrumentationConfig::addChoice(), llvm::instrumentor::InstrumentationOpportunity::addCommonArgs(), Config, llvm::instrumentor::InstrumentorIRBuilderTy::Ctx, getInput(), getInputSize(), getInputSubTypeId(), getInputTypeId(), llvm::instrumentor::InstrumentationOpportunity::getLocationKind(), llvm::instrumentor::BaseInstructionIO::getOpcode(), getResultSize(), getResultSubTypeId(), getResultTypeId(), llvm::instrumentor::InstrumentationOpportunity::getValue(), llvm::instrumentor::IRTArg::INDIRECT_HAS_SIZE, llvm::instrumentor::InstrumentationLocation::INSTRUCTION_PRE, llvm::instrumentor::InstrumentorIRBuilderTy::Int32Ty, llvm::instrumentor::InstrumentorIRBuilderTy::Int64Ty, llvm::instrumentor::InstrumentationOpportunity::IRTArgs, llvm::instrumentor::IRTArg::NONE, PassId, PassInput, PassInputSize, PassInputSubTypeId, PassInputTypeId, PassOpcode, PassResult, PassResultSize, PassResultSubTypeId, PassResultTypeId, llvm::instrumentor::IRTArg::POTENTIALLY_INDIRECT, llvm::instrumentor::IRTArg::REPLACABLE, ReplaceResult, llvm::instrumentor::InstrumentationOpportunity::replaceValue(), and llvm::instrumentor::IRTArg::TYPEID.

◆ populate()

void llvm::instrumentor::CastIO::populate ( InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
inlinestatic

Definition at line 1171 of file Instrumentor.h.

References llvm::instrumentor::InstrumentationConfig::allocate(), CastIO(), llvm::instrumentor::InstrumentationLocation::INSTRUCTION_POST, and llvm::instrumentor::InstrumentationLocation::INSTRUCTION_PRE.

Referenced by llvm::instrumentor::InstrumentationConfig::populate().

Member Data Documentation

◆ Config

ConfigTy llvm::instrumentor::CastIO::Config

Definition at line 1141 of file Instrumentor.h.

Referenced by init().

The documentation for this struct was generated from the following files:
Generated on for LLVM by doxygen 1.14.0