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 = std::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.
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.
Instruction::InstListType::iterator	eraseFromParent ()
	Delegate the call to the underlying SwitchInst::eraseFromParent() and mark this object to not touch the underlying SwitchInst in destructor.
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 ()

Detailed Description

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

Definition at line 3492 of file Instructions.h.

Member Typedef Documentation

CaseWeightOpt

using llvm::SwitchInstProfUpdateWrapper::CaseWeightOpt = std::optional<uint32_t>

Definition at line 3503 of file Instructions.h.

Constructor & Destructor Documentation

SwitchInstProfUpdateWrapper()

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

inline

Definition at line 3508 of file Instructions.h.

References init().

~SwitchInstProfUpdateWrapper()

llvm::SwitchInstProfUpdateWrapper::~SwitchInstProfUpdateWrapper ( )

inline

Definition at line 3510 of file Instructions.h.

References buildProfBranchWeightsMD().

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 4107 of file Instructions.cpp.

References assert().

Referenced by eliminateDeadSwitchCases(), and unswitchTrivialSwitch().

buildProfBranchWeightsMD()

MDNode * SwitchInstProfUpdateWrapper::buildProfBranchWeightsMD ( )

protected

Definition at line 4059 of file Instructions.cpp.

References llvm::all_of(), assert(), and llvm::MDBuilder::createBranchWeights().

Referenced by ~SwitchInstProfUpdateWrapper().

eraseFromParent()

Instruction::InstListType::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 4126 of file Instructions.cpp.

Referenced by unswitchTrivialSwitch().

getSuccessorWeight() [1/2]

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

static

Definition at line 4159 of file Instructions.cpp.

References llvm::getBranchWeightMDNode().

getSuccessorWeight() [2/2]

SwitchInstProfUpdateWrapper::CaseWeightOpt SwitchInstProfUpdateWrapper::getSuccessorWeight

(

unsigned

idx

)

Definition at line 4135 of file Instructions.cpp.

Referenced by eliminateDeadSwitchCases(), and unswitchTrivialSwitch().

init()

void SwitchInstProfUpdateWrapper::init ( )

protected

Definition at line 4076 of file Instructions.cpp.

References llvm::extractBranchWeights(), llvm::getBranchWeightMDNode(), llvm::getNumBranchWeights(), and llvm_unreachable.

Referenced by SwitchInstProfUpdateWrapper().

operator SwitchInst *()

llvm::SwitchInstProfUpdateWrapper::operator SwitchInst * ( )

inline

Definition at line 3506 of file Instructions.h.

operator*()

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

inline

Definition at line 3505 of file Instructions.h.

operator->()

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

inline

Definition at line 3504 of file Instructions.h.

removeCase()

SwitchInst::CaseIt SwitchInstProfUpdateWrapper::removeCase

(

SwitchInst::CaseIt

I

)

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

Definition at line 4093 of file Instructions.cpp.

References assert(), and I.

Referenced by eliminateDeadSwitchCases(), and unswitchTrivialSwitch().

setSuccessorWeight()

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

Definition at line 4141 of file Instructions.cpp.

Referenced by eliminateDeadSwitchCases(), and unswitchTrivialSwitch().

---

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

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