LLVM 20.0.0git
|
This pass implements the reg bank selector pass used in the GlobalISel pipeline. More...
#include "llvm/CodeGen/GlobalISel/RegBankSelect.h"
Classes | |
class | EdgeInsertPoint |
Insertion point on an edge. More... | |
class | InsertPoint |
Abstract class used to represent an insertion point in a CFG. More... | |
class | InstrInsertPoint |
Insertion point before or after an instruction. More... | |
class | MappingCost |
Helper class used to represent the cost for mapping an instruction. More... | |
class | MBBInsertPoint |
Insertion point at the beginning or end of a basic block. More... | |
class | RepairingPlacement |
Struct used to represent the placement of a repairing point for a given operand. More... | |
Public Types | |
enum | Mode { Fast , Greedy } |
List of the modes supported by the RegBankSelect pass. More... | |
Public Member Functions | |
RegBankSelect (char &PassID=ID, Mode RunningMode=Fast) | |
Create a RegBankSelect pass with the specified RunningMode . | |
StringRef | getPassName () const override |
getPassName - Return a nice clean name for a pass. | |
void | getAnalysisUsage (AnalysisUsage &AU) const override |
getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. | |
MachineFunctionProperties | getRequiredProperties () const override |
MachineFunctionProperties | getSetProperties () const override |
MachineFunctionProperties | getClearedProperties () const override |
bool | checkFunctionIsLegal (MachineFunction &MF) const |
Check that our input is fully legal: we require the function to have the Legalized property, so it should be. | |
bool | assignRegisterBanks (MachineFunction &MF) |
Walk through MF and assign a register bank to every virtual register that are still mapped to nothing. | |
bool | runOnMachineFunction (MachineFunction &MF) override |
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis. | |
Public Member Functions inherited from llvm::MachineFunctionPass | |
bool | doInitialization (Module &) override |
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. | |
Public Member Functions inherited from llvm::FunctionPass | |
FunctionPass (char &pid) | |
Pass * | createPrinterPass (raw_ostream &OS, const std::string &Banner) const override |
createPrinterPass - Get a function printer pass. | |
virtual bool | runOnFunction (Function &F)=0 |
runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass. | |
void | assignPassManager (PMStack &PMS, PassManagerType T) override |
Find appropriate Function Pass Manager or Call Graph Pass Manager in the PM Stack and add self into that manager. | |
PassManagerType | getPotentialPassManagerType () const override |
Return what kind of Pass Manager can manage this pass. | |
Public Member Functions inherited from llvm::Pass | |
Pass (PassKind K, char &pid) | |
Pass (const Pass &)=delete | |
Pass & | operator= (const Pass &)=delete |
virtual | ~Pass () |
PassKind | getPassKind () const |
virtual StringRef | getPassName () const |
getPassName - Return a nice clean name for a pass. | |
AnalysisID | getPassID () const |
getPassID - Return the PassID number that corresponds to this pass. | |
virtual bool | doInitialization (Module &) |
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. | |
virtual bool | doFinalization (Module &) |
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. | |
virtual void | print (raw_ostream &OS, const Module *M) const |
print - Print out the internal state of the pass. | |
void | dump () const |
virtual Pass * | createPrinterPass (raw_ostream &OS, const std::string &Banner) const =0 |
createPrinterPass - Get a Pass appropriate to print the IR this pass operates on (Module, Function or MachineFunction). | |
virtual void | assignPassManager (PMStack &, PassManagerType) |
Each pass is responsible for assigning a pass manager to itself. | |
virtual void | preparePassManager (PMStack &) |
Check if available pass managers are suitable for this pass or not. | |
virtual PassManagerType | getPotentialPassManagerType () const |
Return what kind of Pass Manager can manage this pass. | |
void | setResolver (AnalysisResolver *AR) |
AnalysisResolver * | getResolver () const |
virtual void | getAnalysisUsage (AnalysisUsage &) const |
getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. | |
virtual void | releaseMemory () |
releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed. | |
virtual void * | getAdjustedAnalysisPointer (AnalysisID ID) |
getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance. | |
virtual ImmutablePass * | getAsImmutablePass () |
virtual PMDataManager * | getAsPMDataManager () |
virtual void | verifyAnalysis () const |
verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. | |
virtual void | dumpPassStructure (unsigned Offset=0) |
template<typename AnalysisType > | |
AnalysisType * | getAnalysisIfAvailable () const |
getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it. | |
bool | mustPreserveAnalysisID (char &AID) const |
mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. | |
template<typename AnalysisType > | |
AnalysisType & | getAnalysis () const |
getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. | |
template<typename AnalysisType > | |
AnalysisType & | getAnalysis (Function &F, bool *Changed=nullptr) |
getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. | |
template<typename AnalysisType > | |
AnalysisType & | getAnalysisID (AnalysisID PI) const |
template<typename AnalysisType > | |
AnalysisType & | getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr) |
Static Public Attributes | |
static char | ID = 0 |
Protected Member Functions | |
bool | assignInstr (MachineInstr &MI) |
Assign the register bank of each operand of MI . | |
void | init (MachineFunction &MF) |
Initialize the field members using MF . | |
bool | assignmentMatch (Register Reg, const RegisterBankInfo::ValueMapping &ValMapping, bool &OnlyAssign) const |
Check if Reg is already assigned what is described by ValMapping . | |
bool | repairReg (MachineOperand &MO, const RegisterBankInfo::ValueMapping &ValMapping, RegBankSelect::RepairingPlacement &RepairPt, const iterator_range< SmallVectorImpl< Register >::const_iterator > &NewVRegs) |
Insert repairing code for Reg as specified by ValMapping . | |
uint64_t | getRepairCost (const MachineOperand &MO, const RegisterBankInfo::ValueMapping &ValMapping) const |
Return the cost of the instruction needed to map MO to ValMapping . | |
const RegisterBankInfo::InstructionMapping & | findBestMapping (MachineInstr &MI, RegisterBankInfo::InstructionMappings &PossibleMappings, SmallVectorImpl< RepairingPlacement > &RepairPts) |
Find the best mapping for MI from PossibleMappings . | |
MappingCost | computeMapping (MachineInstr &MI, const RegisterBankInfo::InstructionMapping &InstrMapping, SmallVectorImpl< RepairingPlacement > &RepairPts, const MappingCost *BestCost=nullptr) |
Compute the cost of mapping MI with InstrMapping and compute the repairing placement for such mapping in RepairPts . | |
void | tryAvoidingSplit (RegBankSelect::RepairingPlacement &RepairPt, const MachineOperand &MO, const RegisterBankInfo::ValueMapping &ValMapping) const |
When RepairPt involves splitting to repair MO for the given ValMapping , try to change the way we repair such that the splitting is not required anymore. | |
bool | applyMapping (MachineInstr &MI, const RegisterBankInfo::InstructionMapping &InstrMapping, SmallVectorImpl< RepairingPlacement > &RepairPts) |
Apply Mapping to MI . | |
Protected Member Functions inherited from llvm::MachineFunctionPass | |
MachineFunctionPass (char &ID) | |
virtual bool | runOnMachineFunction (MachineFunction &MF)=0 |
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis. | |
void | getAnalysisUsage (AnalysisUsage &AU) const override |
getAnalysisUsage - Subclasses that override getAnalysisUsage must call this. | |
virtual MachineFunctionProperties | getRequiredProperties () const |
virtual MachineFunctionProperties | getSetProperties () const |
virtual MachineFunctionProperties | getClearedProperties () const |
Protected Member Functions inherited from llvm::FunctionPass | |
bool | skipFunction (const Function &F) const |
Optional passes call this function to check whether the pass should be skipped. | |
Protected Attributes | |
const RegisterBankInfo * | RBI = nullptr |
Interface to the target lowering info related to register banks. | |
MachineRegisterInfo * | MRI = nullptr |
MRI contains all the register class/bank information that this pass uses and updates. | |
const TargetRegisterInfo * | TRI = nullptr |
Information on the register classes for the current function. | |
MachineBlockFrequencyInfo * | MBFI = nullptr |
Get the frequency of blocks. | |
MachineBranchProbabilityInfo * | MBPI = nullptr |
Get the frequency of the edges. | |
std::unique_ptr< MachineOptimizationRemarkEmitter > | MORE |
Current optimization remark emitter. Used to report failures. | |
MachineIRBuilder | MIRBuilder |
Helper class used for every code morphing. | |
Mode | OptMode |
Optimization mode of the pass. | |
const TargetPassConfig * | TPC |
Current target configuration. Controls how the pass handles errors. | |
Additional Inherited Members | |
Static Public Member Functions inherited from llvm::Pass | |
static const PassInfo * | lookupPassInfo (const void *TI) |
static const PassInfo * | lookupPassInfo (StringRef Arg) |
static Pass * | createPass (AnalysisID ID) |
This pass implements the reg bank selector pass used in the GlobalISel pipeline.
At the end of this pass, all register operands have been assigned
Definition at line 91 of file RegBankSelect.h.
List of the modes supported by the RegBankSelect pass.
Definition at line 96 of file RegBankSelect.h.
Create a RegBankSelect pass with the specified RunningMode
.
|
protected |
Apply Mapping
to MI
.
RepairPts
represents the different mapping action that need to happen for the mapping to be applied.
Definition at line 588 of file RegBankSelect.cpp.
References llvm::RegisterBankInfo::applyMapping(), assert(), llvm::RegisterBankInfo::ValueMapping::BreakDown, llvm::RegisterBankInfo::OperandsMapper::createVRegs(), llvm::dbgs(), llvm::MachineOperand::getReg(), llvm::RegisterBankInfo::OperandsMapper::getVRegs(), llvm::RegBankSelect::RepairingPlacement::Impossible, llvm::RegBankSelect::RepairingPlacement::Insert, LLVM_DEBUG, llvm_unreachable, MI, MIRBuilder, MRI, llvm::RegBankSelect::RepairingPlacement::None, llvm::RegisterBankInfo::ValueMapping::NumBreakDowns, RBI, llvm::RegBankSelect::RepairingPlacement::Reassign, llvm::RegisterBankInfo::PartialMapping::RegBank, repairReg(), and llvm::MachineRegisterInfo::setRegBank().
Referenced by assignInstr().
|
protected |
Assign the register bank of each operand of MI
.
Definition at line 633 of file RegBankSelect.cpp.
References applyMapping(), assert(), computeMapping(), llvm::dbgs(), llvm::SmallVectorBase< Size_T >::empty(), Fast, findBestMapping(), llvm::RegisterBankInfo::getInstrMapping(), llvm::RegisterBankInfo::getInstrPossibleMappings(), llvm::RegisterBankInfo::getRegBank(), llvm::RegBankSelect::MappingCost::ImpossibleCost(), llvm::isPreISelGenericOptimizationHint(), LLVM_DEBUG, MI, MRI, OptMode, RBI, llvm::MachineRegisterInfo::setRegBank(), TRI, and llvm::RegisterBankInfo::InstructionMapping::verify().
Referenced by assignRegisterBanks().
|
protected |
Check if Reg
is already assigned what is described by ValMapping
.
OnlyAssign
== true means that Reg
just needs to be assigned a register bank. I.e., no repairing is necessary to have the assignment match.
Definition at line 110 of file RegBankSelect.cpp.
References assert(), llvm::RegisterBankInfo::ValueMapping::BreakDown, llvm::dbgs(), llvm::RegisterBankInfo::getRegBank(), LLVM_DEBUG, MRI, llvm::RegisterBankInfo::ValueMapping::NumBreakDowns, RBI, llvm::RegisterBankInfo::PartialMapping::RegBank, and TRI.
Referenced by computeMapping().
bool RegBankSelect::assignRegisterBanks | ( | MachineFunction & | MF | ) |
Walk through MF
and assign a register bank to every virtual register that are still mapped to nothing.
The target needs to provide a RegisterBankInfo and in particular override RegisterBankInfo::getInstrMapping.
Simplified algo:
Definition at line 681 of file RegBankSelect.cpp.
References assignInstr(), llvm::SmallVectorBase< Size_T >::empty(), llvm::MachineBasicBlock::instrs(), llvm::isTargetSpecificOpcode(), llvm::make_pointer_range(), MBB, MI, MIRBuilder, MORE, llvm::SmallVectorImpl< T >::pop_back_val(), llvm::reportGISelFailure(), llvm::reverse(), llvm::MachineIRBuilder::setMBB(), and TPC.
Referenced by runOnMachineFunction().
bool RegBankSelect::checkFunctionIsLegal | ( | MachineFunction & | MF | ) | const |
Check that our input is fully legal: we require the function to have the Legalized property, so it should be.
FIXME: This should be in the MachineVerifier.
Definition at line 721 of file RegBankSelect.cpp.
References llvm::DisableGISelLegalityCheck, llvm::machineFunctionIsIllegal(), MI, MORE, llvm::reportGISelFailure(), and TPC.
Referenced by runOnMachineFunction().
|
protected |
Compute the cost of mapping MI
with InstrMapping
and compute the repairing placement for such mapping in RepairPts
.
BestCost
is used to specify when the cost becomes too high and thus it is not worth computing the RepairPts. Moreover if BestCost
== nullptr, the mapping cost is actually not computed.
Definition at line 443 of file RegBankSelect.cpp.
References assert(), assignmentMatch(), llvm::SmallVectorTemplateCommon< T, typename >::back(), llvm::RegBankSelect::RepairingPlacement::canMaterialize(), llvm::SmallVectorImpl< T >::clear(), llvm::dbgs(), llvm::SmallVectorImpl< T >::emplace_back(), llvm::MachineBlockFrequencyInfo::getBlockFreq(), llvm::RegisterBankInfo::InstructionMapping::getCost(), llvm::RegisterBankInfo::InstructionMapping::getNumOperands(), llvm::MachineOperand::getReg(), getRepairCost(), llvm::MachineRegisterInfo::getType(), llvm::RegBankSelect::RepairingPlacement::hasSplit(), llvm::RegBankSelect::MappingCost::ImpossibleCost(), llvm::RegBankSelect::RepairingPlacement::Insert, llvm::MachineOperand::isReg(), llvm::RegisterBankInfo::InstructionMapping::isValid(), llvm::LLT::isValid(), LLVM_DEBUG, MBFI, MBPI, MI, MRI, llvm::RegBankSelect::RepairingPlacement::Reassign, TRI, and tryAvoidingSplit().
Referenced by assignInstr(), and findBestMapping().
|
protected |
Find the best mapping for MI
from PossibleMappings
.
PossibleMappings
. Definition at line 289 of file RegBankSelect.cpp.
References assert(), llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::SmallVectorImpl< T >::clear(), computeMapping(), llvm::dbgs(), llvm::SmallVectorImpl< T >::emplace_back(), llvm::SmallVectorBase< Size_T >::empty(), llvm::RegBankSelect::RepairingPlacement::Impossible, llvm::RegBankSelect::MappingCost::ImpossibleCost(), llvm::TargetPassConfig::isGlobalISelAbortEnabled(), LLVM_DEBUG, MI, TPC, and TRI.
Referenced by assignInstr().
|
overridevirtual |
getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.
If a pass specifies that it uses a particular analysis result to this function, it can then use the getAnalysis<AnalysisType>() function, below.
Reimplemented from llvm::Pass.
Reimplemented in llvm::AMDGPURegBankSelect.
Definition at line 98 of file RegBankSelect.cpp.
References llvm::AnalysisUsage::addRequired(), Fast, llvm::MachineFunctionPass::getAnalysisUsage(), llvm::getSelectionDAGFallbackAnalysisUsage(), and OptMode.
Referenced by llvm::AMDGPURegBankSelect::getAnalysisUsage().
|
inlineoverridevirtual |
Reimplemented from llvm::MachineFunctionPass.
Definition at line 637 of file RegBankSelect.h.
References llvm::MachineFunctionProperties::NoPHIs, and llvm::MachineFunctionProperties::set().
|
inlineoverridevirtual |
getPassName - Return a nice clean name for a pass.
This usually implemented in terms of the name that is registered by one of the Registration templates, but can be overloaded directly.
Reimplemented from llvm::Pass.
Reimplemented in llvm::AMDGPURegBankSelect.
Definition at line 622 of file RegBankSelect.h.
|
protected |
Return the cost of the instruction needed to map MO
to ValMapping
.
The cost is free of basic block frequencies.
Definition at line 237 of file RegBankSelect.cpp.
References assert(), llvm::RegisterBankInfo::ValueMapping::BreakDown, llvm::RegisterBankInfo::copyCost(), llvm::RegisterBankInfo::getBreakDownCost(), llvm::MachineOperand::getReg(), llvm::RegisterBankInfo::getRegBank(), llvm::RegisterBankInfo::getSizeInBits(), llvm::MachineOperand::isDef(), llvm::MachineOperand::isReg(), MRI, llvm::RegisterBankInfo::ValueMapping::NumBreakDowns, RBI, llvm::RegisterBankInfo::PartialMapping::RegBank, std::swap(), and TRI.
Referenced by computeMapping().
|
inlineoverridevirtual |
Reimplemented from llvm::MachineFunctionPass.
Definition at line 626 of file RegBankSelect.h.
References llvm::MachineFunctionProperties::IsSSA, llvm::MachineFunctionProperties::Legalized, and llvm::MachineFunctionProperties::set().
|
inlineoverridevirtual |
Reimplemented from llvm::MachineFunctionPass.
Definition at line 632 of file RegBankSelect.h.
References llvm::MachineFunctionProperties::RegBankSelected, and llvm::MachineFunctionProperties::set().
|
protected |
Initialize the field members using MF
.
Definition at line 81 of file RegBankSelect.cpp.
References assert(), Fast, llvm::TargetSubtargetInfo::getRegBankInfo(), llvm::MachineFunction::getRegInfo(), llvm::TargetSubtargetInfo::getRegisterInfo(), llvm::MachineFunction::getSubtarget(), MBFI, MBPI, MIRBuilder, MORE, MRI, OptMode, RBI, llvm::MachineIRBuilder::setMF(), TPC, and TRI.
Referenced by runOnMachineFunction().
|
protected |
Insert repairing code for Reg
as specified by ValMapping
.
The repairing placement is specified by RepairPt
. NewVRegs
contains all the registers required to remap Reg
. In other words, the number of registers in NewVRegs must be equal to ValMapping.BreakDown.size().
The transformation could be sketched as:
Becomes
and
Becomes
Definition at line 133 of file RegBankSelect.cpp.
References llvm::MachineInstrBuilder::addDef(), llvm::MachineInstrBuilder::addUse(), assert(), llvm::RegisterBankInfo::ValueMapping::BreakDown, llvm::MachineIRBuilder::buildInstrNoInsert(), llvm::MachineFunction::CloneMachineInstr(), llvm::dbgs(), llvm::MachineIRBuilder::getMF(), llvm::LLT::getNumElements(), llvm::RegBankSelect::RepairingPlacement::getNumInsertPoints(), llvm::MachineOperand::getReg(), llvm::LLT::getScalarSizeInBits(), llvm::LLT::getSizeInBits(), llvm::MachineRegisterInfo::getType(), Idx, llvm::MachineInstr::insert(), llvm::MachineOperand::isDef(), llvm::LLT::isVector(), llvm::RegisterBankInfo::PartialMapping::Length, LLVM_DEBUG, MI, MIRBuilder, MRI, llvm::RegisterBankInfo::ValueMapping::NumBreakDowns, llvm::RegisterBankInfo::ValueMapping::partsAllUniform(), llvm::printReg(), llvm::printRegClassOrBank(), llvm::report_fatal_error(), llvm::size(), std::swap(), and TRI.
Referenced by applyMapping().
|
overridevirtual |
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.
Implements llvm::MachineFunctionPass.
Reimplemented in llvm::AMDGPURegBankSelect.
Definition at line 734 of file RegBankSelect.cpp.
References assignRegisterBanks(), checkFunctionIsLegal(), llvm::dbgs(), F, llvm::MachineFunctionProperties::FailedISel, Fast, llvm::MachineFunction::getFunction(), llvm::MachineFunction::getName(), llvm::MachineFunction::getProperties(), llvm::MachineFunctionProperties::hasProperty(), init(), LLVM_DEBUG, and OptMode.
|
protected |
When RepairPt
involves splitting to repair MO
for the given ValMapping
, try to change the way we repair such that the splitting is not required anymore.
RepairPt.hasSplit()
MO
== MO.getParent()->getOperand(RepairPt.getOpIdx()
) ValMapping
is the mapping of MO
for MO.getParent() that implied RepairPt
. Definition at line 323 of file RegBankSelect.cpp.
References assert(), llvm::RegBankSelect::RepairingPlacement::getOpIdx(), llvm::MachineOperand::getParent(), llvm::MachineOperand::getReg(), llvm::RegBankSelect::RepairingPlacement::hasSplit(), llvm::RegBankSelect::RepairingPlacement::Impossible, llvm::MachineOperand::isDef(), llvm::MachineInstr::isUnconditionalBranch(), MI, llvm::RegisterBankInfo::ValueMapping::NumBreakDowns, llvm::MachineInstr::readsRegister(), llvm::RegBankSelect::RepairingPlacement::Reassign, and llvm::RegBankSelect::RepairingPlacement::switchTo().
Referenced by computeMapping().
|
static |
Definition at line 93 of file RegBankSelect.h.
|
protected |
Get the frequency of blocks.
This is required for non-fast mode.
Definition at line 498 of file RegBankSelect.h.
Referenced by computeMapping(), llvm::RegBankSelect::EdgeInsertPoint::frequency(), and init().
|
protected |
Get the frequency of the edges.
This is required for non-fast mode.
Definition at line 502 of file RegBankSelect.h.
Referenced by computeMapping(), llvm::RegBankSelect::EdgeInsertPoint::frequency(), and init().
|
protected |
Helper class used for every code morphing.
Definition at line 508 of file RegBankSelect.h.
Referenced by applyMapping(), assignRegisterBanks(), init(), and repairReg().
|
protected |
Current optimization remark emitter. Used to report failures.
Definition at line 505 of file RegBankSelect.h.
Referenced by assignRegisterBanks(), checkFunctionIsLegal(), and init().
|
protected |
MRI contains all the register class/bank information that this pass uses and updates.
Definition at line 491 of file RegBankSelect.h.
Referenced by applyMapping(), assignInstr(), assignmentMatch(), computeMapping(), getRepairCost(), init(), and repairReg().
|
protected |
Optimization mode of the pass.
Definition at line 511 of file RegBankSelect.h.
Referenced by assignInstr(), getAnalysisUsage(), init(), and runOnMachineFunction().
|
protected |
Interface to the target lowering info related to register banks.
Definition at line 487 of file RegBankSelect.h.
Referenced by applyMapping(), assignInstr(), assignmentMatch(), getRepairCost(), and init().
|
protected |
Current target configuration. Controls how the pass handles errors.
Definition at line 514 of file RegBankSelect.h.
Referenced by assignRegisterBanks(), checkFunctionIsLegal(), findBestMapping(), and init().
|
protected |
Information on the register classes for the current function.
Definition at line 494 of file RegBankSelect.h.
Referenced by assignInstr(), assignmentMatch(), computeMapping(), findBestMapping(), getRepairCost(), init(), llvm::RegBankSelect::RepairingPlacement::RepairingPlacement(), and repairReg().