LLVM 20.0.0git
Public Member Functions | Public Attributes | List of all members
llvm::InstrItineraryData Class Reference

Itinerary data supplied by a subtarget to be used by a target. More...

#include "llvm/MC/MCInstrItineraries.h"

Public Member Functions

 InstrItineraryData ()=default
 
 InstrItineraryData (const MCSchedModel &SM, const InstrStage *S, const unsigned *OS, const unsigned *F)
 
bool isEmpty () const
 Returns true if there are no itineraries.
 
bool isEndMarker (unsigned ItinClassIndx) const
 Returns true if the index is for the end marker itinerary.
 
const InstrStagebeginStage (unsigned ItinClassIndx) const
 Return the first stage of the itinerary.
 
const InstrStageendStage (unsigned ItinClassIndx) const
 Return the last+1 stage of the itinerary.
 
unsigned getStageLatency (unsigned ItinClassIndx) const
 Return the total stage latency of the given class.
 
std::optional< unsignedgetOperandCycle (unsigned ItinClassIndx, unsigned OperandIdx) const
 Return the cycle for the given class and operand.
 
bool hasPipelineForwarding (unsigned DefClass, unsigned DefIdx, unsigned UseClass, unsigned UseIdx) const
 Return true if there is a pipeline forwarding between instructions of itinerary classes DefClass and UseClasses so that value produced by an instruction of itinerary class DefClass, operand index DefIdx can be bypassed when it's read by an instruction of itinerary class UseClass, operand index UseIdx.
 
std::optional< unsignedgetOperandLatency (unsigned DefClass, unsigned DefIdx, unsigned UseClass, unsigned UseIdx) const
 Compute and return the use operand latency of a given itinerary class and operand index if the value is produced by an instruction of the specified itinerary class and def operand index.
 
int getNumMicroOps (unsigned ItinClassIndx) const
 Return the number of micro-ops that the given class decodes to.
 

Public Attributes

MCSchedModel SchedModel
 Basic machine properties.
 
const InstrStageStages = nullptr
 Array of stages selected.
 
const unsignedOperandCycles = nullptr
 Array of operand cycles selected.
 
const unsignedForwardings = nullptr
 Array of pipeline forwarding paths.
 
const InstrItineraryItineraries
 Array of itineraries selected.
 

Detailed Description

Itinerary data supplied by a subtarget to be used by a target.

Definition at line 110 of file MCInstrItineraries.h.

Constructor & Destructor Documentation

◆ InstrItineraryData() [1/2]

llvm::InstrItineraryData::InstrItineraryData ( )
default

◆ InstrItineraryData() [2/2]

llvm::InstrItineraryData::InstrItineraryData ( const MCSchedModel SM,
const InstrStage S,
const unsigned OS,
const unsigned F 
)
inline

Definition at line 121 of file MCInstrItineraries.h.

Member Function Documentation

◆ beginStage()

const InstrStage * llvm::InstrItineraryData::beginStage ( unsigned  ItinClassIndx) const
inline

◆ endStage()

const InstrStage * llvm::InstrItineraryData::endStage ( unsigned  ItinClassIndx) const
inline

◆ getNumMicroOps()

int llvm::InstrItineraryData::getNumMicroOps ( unsigned  ItinClassIndx) const
inline

Return the number of micro-ops that the given class decodes to.

Return -1 for classes that require dynamic lookup via TargetInstrInfo.

Definition at line 232 of file MCInstrItineraries.h.

References isEmpty(), Itineraries, and llvm::InstrItinerary::NumMicroOps.

Referenced by llvm::ARMBaseInstrInfo::getNumMicroOps(), llvm::TargetSchedModel::getNumMicroOps(), and getNumMicroOpsSwiftLdSt().

◆ getOperandCycle()

std::optional< unsigned > llvm::InstrItineraryData::getOperandCycle ( unsigned  ItinClassIndx,
unsigned  OperandIdx 
) const
inline

◆ getOperandLatency()

std::optional< unsigned > llvm::InstrItineraryData::getOperandLatency ( unsigned  DefClass,
unsigned  DefIdx,
unsigned  UseClass,
unsigned  UseIdx 
) const
inline

Compute and return the use operand latency of a given itinerary class and operand index if the value is produced by an instruction of the specified itinerary class and def operand index.

Return std::nullopt if the information is not available for the operand.

Definition at line 208 of file MCInstrItineraries.h.

References getOperandCycle(), hasPipelineForwarding(), and isEmpty().

Referenced by llvm::TargetInstrInfo::getOperandLatency().

◆ getStageLatency()

unsigned llvm::InstrItineraryData::getStageLatency ( unsigned  ItinClassIndx) const
inline

Return the total stage latency of the given class.

The latency is the maximum completion time for any stage in the itinerary. If no stages exist, it defaults to one cycle.

Definition at line 150 of file MCInstrItineraries.h.

References beginStage(), E, endStage(), isEmpty(), and llvm::Latency.

Referenced by llvm::TargetInstrInfo::getInstrLatency(), and llvm::HexagonInstrInfo::getInstrTimingClassLatency().

◆ hasPipelineForwarding()

bool llvm::InstrItineraryData::hasPipelineForwarding ( unsigned  DefClass,
unsigned  DefIdx,
unsigned  UseClass,
unsigned  UseIdx 
) const
inline

Return true if there is a pipeline forwarding between instructions of itinerary classes DefClass and UseClasses so that value produced by an instruction of itinerary class DefClass, operand index DefIdx can be bypassed when it's read by an instruction of itinerary class UseClass, operand index UseIdx.

Definition at line 186 of file MCInstrItineraries.h.

References llvm::InstrItinerary::FirstOperandCycle, Forwardings, Itineraries, and llvm::InstrItinerary::LastOperandCycle.

Referenced by getOperandLatency().

◆ isEmpty()

bool llvm::InstrItineraryData::isEmpty ( ) const
inline

◆ isEndMarker()

bool llvm::InstrItineraryData::isEndMarker ( unsigned  ItinClassIndx) const
inline

Returns true if the index is for the end marker itinerary.

Definition at line 130 of file MCInstrItineraries.h.

References Itineraries.

Referenced by llvm::ScoreboardHazardRecognizer::ScoreboardHazardRecognizer().

Member Data Documentation

◆ Forwardings

const unsigned* llvm::InstrItineraryData::Forwardings = nullptr

Array of pipeline forwarding paths.

Definition at line 116 of file MCInstrItineraries.h.

Referenced by hasPipelineForwarding().

◆ Itineraries

const InstrItinerary* llvm::InstrItineraryData::Itineraries

◆ OperandCycles

const unsigned* llvm::InstrItineraryData::OperandCycles = nullptr

Array of operand cycles selected.

Definition at line 115 of file MCInstrItineraries.h.

Referenced by getOperandCycle().

◆ SchedModel

MCSchedModel llvm::InstrItineraryData::SchedModel
Initial value:
=
static const MCSchedModel Default
Returns the default initialized model.
Definition: MCSchedule.h:393

Basic machine properties.

Definition at line 112 of file MCInstrItineraries.h.

Referenced by llvm::ResourcePriorityQueue::reserveResources(), and llvm::ScoreboardHazardRecognizer::ScoreboardHazardRecognizer().

◆ Stages

const InstrStage* llvm::InstrItineraryData::Stages = nullptr

Array of stages selected.

Definition at line 114 of file MCInstrItineraries.h.

Referenced by beginStage(), and endStage().


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