LLVM: llvm::SwitchInstProfUpdateWrapper Class Reference

LLVM 17.0.0git

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. 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 ()

Detailed Description

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

Definition at line 3625 of file Instructions.h.

Member Typedef Documentation

◆ CaseWeightOpt

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

Definition at line 3636 of file Instructions.h.

Constructor & Destructor Documentation

◆ SwitchInstProfUpdateWrapper()

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

inline

Definition at line 3641 of file Instructions.h.

References init(), and SI.

◆ ~SwitchInstProfUpdateWrapper()

llvm::SwitchInstProfUpdateWrapper::~SwitchInstProfUpdateWrapper ( )

inline

Definition at line 3643 of file Instructions.h.

References buildProfBranchWeightsMD(), and SI.

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

References assert(), SI, and llvm::RISCVFenceField::W.

Referenced by unswitchTrivialSwitch().

◆ buildProfBranchWeightsMD()

MDNode * SwitchInstProfUpdateWrapper::buildProfBranchWeightsMD ( )

protected

Definition at line 4580 of file Instructions.cpp.

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

Referenced by ~SwitchInstProfUpdateWrapper().

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

References SI.

Referenced by unswitchTrivialSwitch().

◆ getSuccessorWeight() [1/2]

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

static

Definition at line 4680 of file Instructions.cpp.

References llvm::getBranchWeightMDNode(), and SI.

◆ getSuccessorWeight() [2/2]

SwitchInstProfUpdateWrapper::CaseWeightOpt SwitchInstProfUpdateWrapper::getSuccessorWeight ( unsigned idx )

Definition at line 4656 of file Instructions.cpp.

Referenced by unswitchTrivialSwitch().

◆ init()

void SwitchInstProfUpdateWrapper::init ( )

protected

Definition at line 4597 of file Instructions.cpp.

References llvm::extractBranchWeights(), llvm::getBranchWeightMDNode(), llvm::MDNode::getNumOperands(), llvm_unreachable, move, and SI.

Referenced by SwitchInstProfUpdateWrapper().

◆ operator SwitchInst *()

llvm::SwitchInstProfUpdateWrapper::operator SwitchInst * ( )

inline

Definition at line 3639 of file Instructions.h.

References SI.

◆ operator*()

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

inline

Definition at line 3638 of file Instructions.h.

References SI.

◆ operator->()

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

inline

Definition at line 3637 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 4614 of file Instructions.cpp.

References assert(), I, and SI.

Referenced by eliminateDeadSwitchCases(), and unswitchTrivialSwitch().

◆ setSuccessorWeight()

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

Definition at line 4662 of file Instructions.cpp.

References SI, and llvm::RISCVFenceField::W.

Referenced by unswitchTrivialSwitch().

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

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