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

Instrumentation opportunity for numeric operations. More...

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

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

Public Types

enum  ConfigKind {
  PassTypeId , PassSubTypeId , PassSize , PassOpcode ,
  PassResult , ReplaceResult , PassLeft , PassRight ,
  PassFlags , 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

 NumericIO (InstrumentationLocation::KindTy Kind)
StringRef getName () const override
 Get the name of the instruction.
LLVM_ABI void init (InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB, ConfigTy *UserConfig=nullptr)
LLVM_ABI void addFlagNames ()
Public Member Functions inherited from llvm::instrumentor::InstructionIO< Instruction::Add, Instruction::FAdd, Instruction::Sub, Instruction::FSub, Instruction::Mul, Instruction::FMul, Instruction::UDiv, Instruction::FDiv, Instruction::SDiv, Instruction::URem, Instruction::SRem, Instruction::FRem, Instruction::Shl, Instruction::LShr, Instruction::AShr, Instruction::And, Instruction::Or, Instruction::Xor, Instruction::FNeg >
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 * getFlags (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::Add, Instruction::FAdd, Instruction::Sub, Instruction::FSub, Instruction::Mul, Instruction::FMul, Instruction::UDiv, Instruction::FDiv, Instruction::SDiv, Instruction::URem, Instruction::SRem, Instruction::FRem, Instruction::Shl, Instruction::LShr, Instruction::AShr, Instruction::And, Instruction::Or, Instruction::Xor, Instruction::FNeg >
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.
StringMap< int32_t > FlagNames
 Flag names and their integer bitmask values.
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::Add, Instruction::FAdd, Instruction::Sub, Instruction::FSub, Instruction::Mul, Instruction::FMul, Instruction::UDiv, Instruction::FDiv, Instruction::SDiv, Instruction::URem, Instruction::SRem, Instruction::FRem, Instruction::Shl, Instruction::LShr, Instruction::AShr, Instruction::And, Instruction::Or, Instruction::Xor, Instruction::FNeg >
static constexpr std::array< unsigned, sizeof...(Opcodes)> OpcodesArray

Detailed Description

Instrumentation opportunity for numeric operations.

This includes Add, FAdd, Sub, FSub, Mul, FMul, UDiv, FDiv, SDiv, URem, SRem, FRem, Shl, LShr, AShr, And, Or, Xor, and FNeg.

Definition at line 1194 of file Instrumentor.h.

Member Typedef Documentation

◆ ConfigTy

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

Definition at line 1219 of file Instrumentor.h.

Member Enumeration Documentation

◆ ConfigKind

enum llvm::instrumentor::NumericIO::ConfigKind
Enumerator
PassTypeId 
PassSubTypeId 
PassSize 
PassOpcode 
PassResult 
ReplaceResult 
PassLeft 
PassRight 
PassFlags 
PassId 
NumConfig 

Definition at line 1205 of file Instrumentor.h.

Constructor & Destructor Documentation

◆ NumericIO()

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

Definition at line 1203 of file Instrumentor.h.

References llvm::instrumentor::InstructionIO< Instruction::Add, Instruction::FAdd, Instruction::Sub, Instruction::FSub, Instruction::Mul, Instruction::FMul, Instruction::UDiv, Instruction::FDiv, Instruction::SDiv, Instruction::URem, Instruction::SRem, Instruction::FRem, Instruction::Shl, Instruction::LShr, Instruction::AShr, Instruction::And, Instruction::Or, Instruction::Xor, Instruction::FNeg >::InstructionIO().

Referenced by populate().

Member Function Documentation

◆ addFlagNames()

void NumericIO::addFlagNames ( )

Definition at line 1904 of file Instrumentor.cpp.

References llvm::instrumentor::InstrumentationOpportunity::FlagNames, NUMERIC_FLAG_HAS_NO_INFS, NUMERIC_FLAG_HAS_NO_NANS, NUMERIC_FLAG_HAS_NO_SIGNED_ZEROS, NUMERIC_FLAG_IS_EXACT, NUMERIC_FLAG_NO_SIGNED_WRAP, and NUMERIC_FLAG_NO_UNSIGNED_WRAP.

Referenced by init().

◆ getFlags()

Value * NumericIO::getFlags ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

}

Definition at line 1861 of file Instrumentor.cpp.

References llvm::cast(), llvm::dyn_cast(), I, NUMERIC_FLAG_HAS_NO_INFS, NUMERIC_FLAG_HAS_NO_NANS, NUMERIC_FLAG_HAS_NO_SIGNED_ZEROS, NUMERIC_FLAG_IS_DISJOINT, NUMERIC_FLAG_IS_EXACT, NUMERIC_FLAG_NO_SIGNED_WRAP, NUMERIC_FLAG_NO_UNSIGNED_WRAP, and NUMERIC_FLAG_NONE.

Referenced by init().

◆ getName()

StringRef llvm::instrumentor::NumericIO::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::Add, Instruction::FAdd, Instruction::Sub, Instruction::FSub, Instruction::Mul, Instruction::FMul, Instruction::UDiv, Instruction::FDiv, Instruction::SDiv, Instruction::URem, Instruction::SRem, Instruction::FRem, Instruction::Shl, Instruction::LShr, Instruction::AShr, Instruction::And, Instruction::Or, Instruction::Xor, Instruction::FNeg >.

Definition at line 1222 of file Instrumentor.h.

◆ init()

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

Definition at line 1913 of file Instrumentor.cpp.

References llvm::instrumentor::InstrumentationConfig::addChoice(), llvm::instrumentor::InstrumentationOpportunity::addCommonArgs(), addFlagNames(), Config, llvm::instrumentor::InstrumentorIRBuilderTy::Ctx, getFlags(), llvm::instrumentor::BaseInstructionIO::getLeftOperand(), llvm::instrumentor::InstrumentationOpportunity::getLocationKind(), llvm::instrumentor::BaseInstructionIO::getOpcode(), llvm::instrumentor::BaseInstructionIO::getRightOperand(), llvm::instrumentor::BaseInstructionIO::getSubTypeId(), llvm::instrumentor::BaseInstructionIO::getTypeId(), llvm::instrumentor::BaseInstructionIO::getTypeSize(), 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, PassFlags, PassId, PassLeft, PassOpcode, PassResult, PassRight, PassSize, PassSubTypeId, PassTypeId, llvm::instrumentor::IRTArg::POTENTIALLY_INDIRECT, llvm::instrumentor::IRTArg::REPLACABLE, ReplaceResult, llvm::instrumentor::InstrumentationOpportunity::replaceValue(), and llvm::instrumentor::IRTArg::TYPEID.

◆ populate()

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

Definition at line 1233 of file Instrumentor.h.

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

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

Member Data Documentation

◆ Config

ConfigTy llvm::instrumentor::NumericIO::Config

Definition at line 1220 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