An IR builder augmented with extra information for the instrumentor pass. More...

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

Public Types
using	AllocaListTy = SmallVector<AllocaInst *>
	}

Public Member Functions
	InstrumentorIRBuilderTy (Module &M)
	Construct an IR builder for the module `M`.
	~InstrumentorIRBuilderTy ()
	Destroy the IR builder and remove all erasable instructions cached during the process of instrumenting.
AllocaInst *	getAlloca (Function Fn, Type Ty, bool MatchType=false)
	Get a temporary alloca to communicate (large) values with the runtime.
void	returnAllocas ()
	Return the temporary allocas.
void	eraseLater (Instruction *I)
	Save instruction `I` to be erased later.

Public Attributes
Module &	M
	Commonly used values for IR inspection and creation.
LLVMContext &	Ctx
const DataLayout &	DL = M.getDataLayout()
Type *	VoidTy = Type::getVoidTy(Ctx)
PointerType *	PtrTy = PointerType::get(Ctx, 0)
IntegerType *	Int8Ty = Type::getInt8Ty(Ctx)
IntegerType *	Int32Ty = Type::getInt32Ty(Ctx)
IntegerType *	Int64Ty = Type::getInt64Ty(Ctx)
DenseMap< std::pair< Function , unsigned >, AllocaListTy >	AllocaMap
	Map that holds a list of currently available allocas for a function and alloca size.
DenseMap< AllocaInst , AllocaListTy >	UsedAllocas
	Map that holds the currently used allocas and the list where they belong.
SmallPtrSet< Instruction *, 32 >	ErasableInstructions
	Instructions that should be erased later.
IRBuilder< ConstantFolder, IRBuilderCallbackInserter >	IRB
	The underlying IR builder with insertion callback.
unsigned	Epoch = 0
	The current epoch number.
DenseMap< Instruction *, unsigned >	NewInsts
	A mapping from instrumentation instructions to the epoch they have been created.

Detailed Description

An IR builder augmented with extra information for the instrumentor pass.

The underlying IR builder features an insertion callback to keep track of the new instructions.

Definition at line 34 of file InstrumentorUtils.h.

Member Typedef Documentation

◆ AllocaListTy

using llvm::instrumentor::InstrumentorIRBuilderTy::AllocaListTy = SmallVector<AllocaInst *>

}

Definition at line 102 of file InstrumentorUtils.h.

Constructor & Destructor Documentation

◆ InstrumentorIRBuilderTy()

llvm::instrumentor::InstrumentorIRBuilderTy::InstrumentorIRBuilderTy ( Module & M )

inline

Construct an IR builder for the module M.

Definition at line 36 of file InstrumentorUtils.h.

References Ctx, Epoch, I, IRB, M, and NewInsts.

◆ ~InstrumentorIRBuilderTy()

llvm::instrumentor::InstrumentorIRBuilderTy::~InstrumentorIRBuilderTy ( )

inline

Destroy the IR builder and remove all erasable instructions cached during the process of instrumenting.

Definition at line 45 of file InstrumentorUtils.h.

References ErasableInstructions, llvm::PoisonValue::get(), and I.

Member Function Documentation

◆ eraseLater()

void llvm::instrumentor::InstrumentorIRBuilderTy::eraseLater ( Instruction * I )

inline

Save instruction I to be erased later.

The instructions are erased when the IR builder is destroyed.

Definition at line 85 of file InstrumentorUtils.h.

References ErasableInstructions, and I.

◆ getAlloca()

AllocaInst * llvm::instrumentor::InstrumentorIRBuilderTy::getAlloca	(	Function *	Fn,
		Type *	Ty,
		bool	MatchType = false )

inline

Get a temporary alloca to communicate (large) values with the runtime.

Definition at line 54 of file InstrumentorUtils.h.

References AllocaMap, llvm::BasicBlock::begin(), DL, llvm::Function::getDataLayout(), llvm::Function::getEntryBlock(), and UsedAllocas.

Referenced by llvm::instrumentor::IRTCallDescription::createLLVMCall().

◆ returnAllocas()

void llvm::instrumentor::InstrumentorIRBuilderTy::returnAllocas ( )

inline

Return the temporary allocas.

Definition at line 77 of file InstrumentorUtils.h.

References llvm::List, and UsedAllocas.

Member Data Documentation

◆ AllocaMap

DenseMap<std::pair<Function *, unsigned>, AllocaListTy *> llvm::instrumentor::InstrumentorIRBuilderTy::AllocaMap

Map that holds a list of currently available allocas for a function and alloca size.

Definition at line 106 of file InstrumentorUtils.h.

Referenced by getAlloca().

◆ Ctx

LLVMContext& llvm::instrumentor::InstrumentorIRBuilderTy::Ctx

Definition at line 91 of file InstrumentorUtils.h.

Referenced by llvm::instrumentor::IRTCallDescription::createLLVMCall(), llvm::instrumentor::LoadIO::init(), llvm::instrumentor::StoreIO::init(), and InstrumentorIRBuilderTy().

◆ DL

const DataLayout& llvm::instrumentor::InstrumentorIRBuilderTy::DL = M.getDataLayout()

Definition at line 93 of file InstrumentorUtils.h.

Referenced by getAlloca(), and llvm::instrumentor::InstrumentationOpportunity::replaceValue().

◆ Epoch

unsigned llvm::instrumentor::InstrumentorIRBuilderTy::Epoch = 0

The current epoch number.

Each instrumentation, e.g., of an instruction, is happening in a dedicated epoch. The epoch allows to determine if instrumentation instructions were already around, due to prior instrumentations, or have been introduced to support the current instrumentation, e.g., compute information about the current instruction.

Definition at line 123 of file InstrumentorUtils.h.

Referenced by llvm::instrumentor::IRTCallDescription::createLLVMCall(), llvm::instrumentor::InstrumentationOpportunity::getIdPost(), llvm::instrumentor::InstrumentationOpportunity::getIdPre(), InstrumentorIRBuilderTy(), and llvm::instrumentor::InstrumentationOpportunity::replaceValue().