llvm::SwitchInstProfUpdateWrapper Class Reference

A wrapper class to simplify modification of SwitchInst cases along with their prof branch_weights metadata. More...

#include "llvm/IR/Instructions.h"

Public Types
using	CaseWeightOpt = Optional< uint32_t >

Public Member Functions
SwitchInst *	operator-> ()
SwitchInst &	operator* ()
	operator SwitchInst * ()
	SwitchInstProfUpdateWrapper (SwitchInst &SI)
	~SwitchInstProfUpdateWrapper ()
SwitchInst::CaseIt	removeCase (SwitchInst::CaseIt I)
	Delegate the call to the underlying SwitchInst::removeCase() and remove correspondent branch weight. More...
void	addCase (ConstantInt *OnVal, BasicBlock *Dest, CaseWeightOpt W)
	Delegate the call to the underlying SwitchInst::addCase() and set the specified branch weight for the added case. More...
SymbolTableList< Instruction >::iterator	eraseFromParent ()
	Delegate the call to the underlying SwitchInst::eraseFromParent() and mark this object to not touch the underlying SwitchInst in destructor. More...
void	setSuccessorWeight (unsigned idx, CaseWeightOpt W)
CaseWeightOpt	getSuccessorWeight (unsigned idx)

Static Public Member Functions
static CaseWeightOpt	getSuccessorWeight (const SwitchInst &SI, unsigned idx)

Protected Member Functions
MDNode *	buildProfBranchWeightsMD ()
void	init ()

Static Protected Member Functions
static MDNode *	getProfBranchWeightsMD (const SwitchInst &SI)

Detailed Description

A wrapper class to simplify modification of SwitchInst cases along with their prof branch_weights metadata.

Definition at line 3459 of file Instructions.h.

Member Typedef Documentation

CaseWeightOpt

using llvm::SwitchInstProfUpdateWrapper::CaseWeightOpt = Optional<uint32_t>

Definition at line 3481 of file Instructions.h.

Constructor & Destructor Documentation

SwitchInstProfUpdateWrapper()

llvm::SwitchInstProfUpdateWrapper::SwitchInstProfUpdateWrapper ( SwitchInst &  SI )

inline

Definition at line 3486 of file Instructions.h.

References llvm::cl::init().

~SwitchInstProfUpdateWrapper()

llvm::SwitchInstProfUpdateWrapper::~SwitchInstProfUpdateWrapper ( )

inline

Definition at line 3488 of file Instructions.h.

References llvm::Instruction::eraseFromParent(), llvm::Instruction::setMetadata(), and llvm::RISCVFenceField::W.

Member Function Documentation

addCase()

void SwitchInstProfUpdateWrapper::addCase	(	ConstantInt *	OnVal,
		BasicBlock *	Dest,
		SwitchInstProfUpdateWrapper::CaseWeightOpt	W
	)

Delegate the call to the underlying SwitchInst::addCase() and set the specified branch weight for the added case.

Definition at line 3946 of file Instructions.cpp.

References llvm::SwitchInst::addCase(), assert(), llvm::SwitchInst::getNumSuccessors(), and llvm::RISCVFenceField::W.

Referenced by SimplifyIndirectBrOnSelect().

buildProfBranchWeightsMD()

MDNode * SwitchInstProfUpdateWrapper::buildProfBranchWeightsMD ( )

protected

Definition at line 3888 of file Instructions.cpp.

References llvm::all_of(), assert(), llvm::BasicBlock::getContext(), llvm::SwitchInst::getNumSuccessors(), llvm::Instruction::getParent(), and llvm::RISCVFenceField::W.

eraseFromParent()

SymbolTableList< Instruction >::iterator SwitchInstProfUpdateWrapper::eraseFromParent

(

)

Delegate the call to the underlying SwitchInst::eraseFromParent() and mark this object to not touch the underlying SwitchInst in destructor.

Definition at line 3968 of file Instructions.cpp.

References llvm::Instruction::eraseFromParent().

Referenced by unswitchTrivialSwitch().

getProfBranchWeightsMD()

MDNode * SwitchInstProfUpdateWrapper::getProfBranchWeightsMD ( const SwitchInst &  SI )

staticprotected

Definition at line 3880 of file Instructions.cpp.

References llvm::Instruction::getMetadata().

getSuccessorWeight() [1/2]

SwitchInstProfUpdateWrapper::CaseWeightOpt SwitchInstProfUpdateWrapper::getSuccessorWeight

(

unsigned

idx

)

Definition at line 3979 of file Instructions.cpp.

References llvm::None.

Referenced by SimplifyIndirectBrOnSelect(), and unswitchTrivialSwitch().

getSuccessorWeight() [2/2]

SwitchInstProfUpdateWrapper::CaseWeightOpt SwitchInstProfUpdateWrapper::getSuccessorWeight ( const SwitchInst &  SI, unsigned  idx  )

static

Definition at line 4003 of file Instructions.cpp.

References llvm::Address, llvm::User::allocHungoffUses(), assert(), E, llvm::Value::getContext(), llvm::User::getNumOperands(), llvm::SwitchInst::getNumSuccessors(), llvm::User::getOperandList(), llvm::Value::getType(), llvm::Type::getVoidTy(), llvm::User::growHungoffUses(), llvm::cl::init(), llvm::Instruction::Instruction(), llvm::Type::isPointerTy(), llvm::None, llvm::User::setNumHungOffUseOperands(), and llvm::Value::SubclassOptionalData.

init()

void SwitchInstProfUpdateWrapper::init ( )

protected

Definition at line 3906 of file Instructions.cpp.

References llvm::MDNode::getNumOperands(), llvm::SwitchInst::getNumSuccessors(), llvm::MDNode::getOperand(), llvm::ConstantInt::getValue(), llvm::APInt::getZExtValue(), llvm_unreachable, llvm::SmallVectorTemplateBase< T, bool >::push_back(), and SwitchInstProfUpdateWrapperStrict.

operator SwitchInst *()

llvm::SwitchInstProfUpdateWrapper::operator SwitchInst * ( )

inline

Definition at line 3484 of file Instructions.h.

References SI.

operator*()

SwitchInst& llvm::SwitchInstProfUpdateWrapper::operator* ( )

inline

Definition at line 3483 of file Instructions.h.

References SI.

operator->()

SwitchInst* llvm::SwitchInstProfUpdateWrapper::operator-> ( )

inline

Definition at line 3482 of file Instructions.h.

References SI.

removeCase()

SwitchInst::CaseIt SwitchInstProfUpdateWrapper::removeCase

(

SwitchInst::CaseIt

I

)

Delegate the call to the underlying SwitchInst::removeCase() and remove correspondent branch weight.

Definition at line 3932 of file Instructions.cpp.

References assert(), llvm::SwitchInst::getNumSuccessors(), and llvm::SwitchInst::removeCase().

Referenced by setBranchWeights(), and unswitchTrivialSwitch().

setSuccessorWeight()

void SwitchInstProfUpdateWrapper::setSuccessorWeight	(	unsigned	idx,
		SwitchInstProfUpdateWrapper::CaseWeightOpt	W
	)

Definition at line 3985 of file Instructions.cpp.

References llvm::SwitchInst::getNumSuccessors(), and llvm::RISCVFenceField::W.

Referenced by SimplifyIndirectBrOnSelect(), and unswitchTrivialSwitch().

---

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

• include/llvm/IR/Instructions.h
• lib/IR/Instructions.cpp