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

The instrumentation opportunity for functions. More...

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

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

Classes

struct  ConfigTy

Public Types

enum  ConfigKind {
  PassAddress = 0 , PassName , PassNumArguments , PassArguments ,
  ReplaceArguments , PassIsMain , PassId , NumConfig
}
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

 FunctionIO (InstrumentationLocation::KindTy Kind)
StringRef getName () const override
 Get the name of the instrumentation opportunity.
void init (InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB, ConfigTy *UserConfig=nullptr)
 FunctionIO {.
Value * getNumArguments (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
Value * getArguments (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
Value * setArguments (Value &V, Value &NewV, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
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.
virtual ArrayRef< unsigned > getAllOpcodes () const
 Get all opcodes for this instrumentation opportunity.
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 Value * getFunctionAddress (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static Value * getFunctionName (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static Value * isMainFunction (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static void populate (InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
Static Public Member Functions inherited from llvm::instrumentor::InstrumentationOpportunity
static 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 Value * replaceValue (Value &V, Value &NewV, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static Value * getIdPre (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
 Get the opportunity identifier for the pre and post positions.
static Value * getIdPost (Value &V, Type &Ty, InstrumentationConfig &IConf, InstrumentorIRBuilderTy &IIRB)
static int32_t getIdFromEpoch (uint32_t CurrentEpoch)
 }

Public Attributes

llvm::instrumentor::FunctionIO::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

Detailed Description

The instrumentation opportunity for functions.

Definition at line 621 of file Instrumentor.h.

Member Enumeration Documentation

◆ ConfigKind

enum llvm::instrumentor::FunctionIO::ConfigKind
Enumerator
PassAddress 
PassName 
PassNumArguments 
PassArguments 
ReplaceArguments 
PassIsMain 
PassId 
NumConfig 

Definition at line 625 of file Instrumentor.h.

Constructor & Destructor Documentation

◆ FunctionIO()

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

Definition at line 622 of file Instrumentor.h.

References llvm::instrumentor::InstrumentationOpportunity::InstrumentationOpportunity().

Referenced by populate().

Member Function Documentation

◆ getArguments()

Value * FunctionIO::getArguments ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )

Definition at line 967 of file Instrumentor.cpp.

References llvm::Function::args(), llvm::cast(), Config, createValuePack(), and llvm::make_filter_range().

Referenced by init().

◆ getFunctionAddress()

Value * FunctionIO::getFunctionAddress ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 941 of file Instrumentor.cpp.

References llvm::cast(), llvm::Constant::getNullValue(), and llvm::Function::isIntrinsic().

Referenced by init().

◆ getFunctionName()

Value * FunctionIO::getFunctionName ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 949 of file Instrumentor.cpp.

References llvm::cast(), llvm::demangle(), llvm::instrumentor::InstrumentationConfig::DemangleFunctionNames, llvm::instrumentor::InstrumentationConfig::getGlobalString(), and llvm::Value::getName().

Referenced by init().

◆ getName()

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

Get the name of the instrumentation opportunity.

Implements llvm::instrumentor::InstrumentationOpportunity.

Definition at line 642 of file Instrumentor.h.

◆ getNumArguments()

Value * FunctionIO::getNumArguments ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )

Definition at line 958 of file Instrumentor.cpp.

References llvm::Function::arg_size(), llvm::Function::args(), llvm::cast(), Config, and llvm::make_filter_range().

Referenced by init().

◆ init()

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

FunctionIO {.

Definition at line 907 of file Instrumentor.cpp.

References llvm::instrumentor::InstrumentationConfig::addChoice(), llvm::instrumentor::InstrumentationOpportunity::addCommonArgs(), Config, llvm::instrumentor::InstrumentorIRBuilderTy::Ctx, llvm::instrumentor::InstrumentationLocation::FUNCTION_PRE, getArguments(), getFunctionAddress(), getFunctionName(), llvm::instrumentor::InstrumentationOpportunity::getLocationKind(), getNumArguments(), llvm::instrumentor::InstrumentorIRBuilderTy::Int32Ty, llvm::instrumentor::InstrumentorIRBuilderTy::Int8Ty, llvm::instrumentor::InstrumentationOpportunity::IRTArgs, isMainFunction(), llvm::instrumentor::IRTArg::NONE, PassAddress, PassArguments, PassId, PassIsMain, PassName, PassNumArguments, llvm::instrumentor::InstrumentorIRBuilderTy::PtrTy, llvm::instrumentor::IRTArg::REPLACABLE_CUSTOM, ReplaceArguments, setArguments(), llvm::instrumentor::IRTArg::STRING, and llvm::instrumentor::IRTArg::VALUE_PACK.

◆ isMainFunction()

Value * FunctionIO::isMainFunction ( Value & V,
Type & Ty,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )
static

Definition at line 996 of file Instrumentor.cpp.

References llvm::cast(), and llvm::Value::getName().

Referenced by init().

◆ populate()

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

Definition at line 662 of file Instrumentor.h.

References llvm::instrumentor::InstrumentationConfig::allocate(), llvm::instrumentor::InstrumentationLocation::FUNCTION_POST, llvm::instrumentor::InstrumentationLocation::FUNCTION_PRE, and FunctionIO().

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

◆ setArguments()

Value * FunctionIO::setArguments ( Value & V,
Value & NewV,
InstrumentationConfig & IConf,
InstrumentorIRBuilderTy & IIRB )

Definition at line 976 of file Instrumentor.cpp.

References llvm::Function::arg_begin(), llvm::Function::args(), llvm::cast(), llvm::instrumentor::InstrumentationOpportunity::CB, Config, llvm::instrumentor::InstrumentorIRBuilderTy::Epoch, llvm::Function::getArg(), llvm::make_filter_range(), llvm::instrumentor::InstrumentorIRBuilderTy::NewInsts, readValuePack(), and llvm::Value::replaceUsesWithIf().

Referenced by init().

Member Data Documentation

◆ Config

llvm::instrumentor::FunctionIO::ConfigTy llvm::instrumentor::FunctionIO::Config

Referenced by getArguments(), getNumArguments(), init(), and setArguments().

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