[llvm-mca] Simplify eventing by adding an onEvent templated method.
Summary:
This patch eliminates some redundancy in iterating across Listeners for the
Instruction and Stall HWEvents, by introducing a template onEvent routine.
This change was suggested by @courbet in https://reviews.llvm.org/D48576. I
hope that this patch addresses that suggestion appropriately. I do like this
change better than what we had previously.
Reviewers: andreadb, courbet, RKSimon
Reviewed By: andreadb, courbet
Subscribers: javed.absar, tschuett, gbedwell, llvm-commits, courbet
Differential Revision: https://reviews.llvm.org/D48672
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@336916 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/tools/llvm-mca/DispatchStage.cpp b/tools/llvm-mca/DispatchStage.cpp
index 21eef3d..99cf8e0 100644
--- a/tools/llvm-mca/DispatchStage.cpp
+++ b/tools/llvm-mca/DispatchStage.cpp
@@ -30,12 +30,7 @@
void DispatchStage::notifyInstructionDispatched(const InstRef &IR,
ArrayRef<unsigned> UsedRegs) {
LLVM_DEBUG(dbgs() << "[E] Instruction Dispatched: " << IR << '\n');
- notifyInstructionEvent(HWInstructionDispatchedEvent(IR, UsedRegs));
-}
-
-void DispatchStage::notifyStallEvent(const HWStallEvent &Event) {
- for (HWEventListener *Listener : getListeners())
- Listener->onStallEvent(Event);
+ notifyEvent<HWInstructionEvent>(HWInstructionDispatchedEvent(IR, UsedRegs));
}
bool DispatchStage::checkPRF(const InstRef &IR) {
@@ -47,7 +42,8 @@
const unsigned RegisterMask = PRF.isAvailable(RegDefs);
// A mask with all zeroes means: register files are available.
if (RegisterMask) {
- notifyStallEvent(HWStallEvent(HWStallEvent::RegisterFileStall, IR));
+ notifyEvent<HWStallEvent>(
+ HWStallEvent(HWStallEvent::RegisterFileStall, IR));
return false;
}
@@ -58,7 +54,8 @@
const unsigned NumMicroOps = IR.getInstruction()->getDesc().NumMicroOps;
if (RCU.isAvailable(NumMicroOps))
return true;
- notifyStallEvent(HWStallEvent(HWStallEvent::RetireControlUnitStall, IR));
+ notifyEvent<HWStallEvent>(
+ HWStallEvent(HWStallEvent::RetireControlUnitStall, IR));
return false;
}
@@ -66,7 +63,7 @@
HWStallEvent::GenericEventType Event;
const bool Ready = SC.canBeDispatched(IR, Event);
if (!Ready)
- notifyStallEvent(HWStallEvent(Event, IR));
+ notifyEvent<HWStallEvent>(HWStallEvent(Event, IR));
return Ready;
}
diff --git a/tools/llvm-mca/DispatchStage.h b/tools/llvm-mca/DispatchStage.h
index fff9a2b..65ac2bc 100644
--- a/tools/llvm-mca/DispatchStage.h
+++ b/tools/llvm-mca/DispatchStage.h
@@ -64,7 +64,6 @@
void dispatch(InstRef IR);
void updateRAWDependencies(ReadState &RS, const llvm::MCSubtargetInfo &STI);
- void notifyStallEvent(const HWStallEvent &Event);
void notifyInstructionDispatched(const InstRef &IR,
llvm::ArrayRef<unsigned> UsedPhysRegs);
diff --git a/tools/llvm-mca/DispatchStatistics.cpp b/tools/llvm-mca/DispatchStatistics.cpp
index da85245..4bddbef 100644
--- a/tools/llvm-mca/DispatchStatistics.cpp
+++ b/tools/llvm-mca/DispatchStatistics.cpp
@@ -20,12 +20,12 @@
namespace mca {
-void DispatchStatistics::onStallEvent(const HWStallEvent &Event) {
+void DispatchStatistics::onEvent(const HWStallEvent &Event) {
if (Event.Type < HWStallEvent::LastGenericEvent)
HWStalls[Event.Type]++;
}
-void DispatchStatistics::onInstructionEvent(const HWInstructionEvent &Event) {
+void DispatchStatistics::onEvent(const HWInstructionEvent &Event) {
if (Event.Type == HWInstructionEvent::Dispatched)
++NumDispatched;
}
diff --git a/tools/llvm-mca/DispatchStatistics.h b/tools/llvm-mca/DispatchStatistics.h
index 7b98a84..1e389d5 100644
--- a/tools/llvm-mca/DispatchStatistics.h
+++ b/tools/llvm-mca/DispatchStatistics.h
@@ -66,14 +66,14 @@
: NumDispatched(0), NumCycles(0),
HWStalls(HWStallEvent::LastGenericEvent) {}
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWStallEvent &Event) override;
+
+ void onEvent(const HWInstructionEvent &Event) override;
void onCycleBegin() override { NumCycles++; }
void onCycleEnd() override { updateHistograms(); }
- void onStallEvent(const HWStallEvent &Event) override;
-
void printView(llvm::raw_ostream &OS) const override {
printDispatchStalls(OS);
printDispatchHistogram(OS);
diff --git a/tools/llvm-mca/ExecuteStage.cpp b/tools/llvm-mca/ExecuteStage.cpp
index c446ad6..f2e458d 100644
--- a/tools/llvm-mca/ExecuteStage.cpp
+++ b/tools/llvm-mca/ExecuteStage.cpp
@@ -154,13 +154,15 @@
void ExecuteStage::notifyInstructionExecuted(const InstRef &IR) {
HWS.onInstructionExecuted(IR);
LLVM_DEBUG(dbgs() << "[E] Instruction Executed: " << IR << '\n');
- notifyInstructionEvent(HWInstructionEvent(HWInstructionEvent::Executed, IR));
+ notifyEvent<HWInstructionEvent>(
+ HWInstructionEvent(HWInstructionEvent::Executed, IR));
RCU.onInstructionExecuted(IR.getInstruction()->getRCUTokenID());
}
void ExecuteStage::notifyInstructionReady(const InstRef &IR) {
LLVM_DEBUG(dbgs() << "[E] Instruction Ready: " << IR << '\n');
- notifyInstructionEvent(HWInstructionEvent(HWInstructionEvent::Ready, IR));
+ notifyEvent<HWInstructionEvent>(
+ HWInstructionEvent(HWInstructionEvent::Ready, IR));
}
void ExecuteStage::notifyResourceAvailable(const ResourceRef &RR) {
@@ -180,7 +182,7 @@
dbgs() << " cycles: " << Resource.second << '\n';
}
});
- notifyInstructionEvent(HWInstructionIssuedEvent(IR, Used));
+ notifyEvent<HWInstructionEvent>(HWInstructionIssuedEvent(IR, Used));
}
void ExecuteStage::notifyReservedBuffers(ArrayRef<uint64_t> Buffers) {
diff --git a/tools/llvm-mca/HWEventListener.h b/tools/llvm-mca/HWEventListener.h
index c7384d5..aa3e6dc 100644
--- a/tools/llvm-mca/HWEventListener.h
+++ b/tools/llvm-mca/HWEventListener.h
@@ -120,8 +120,8 @@
virtual void onCycleBegin() {}
virtual void onCycleEnd() {}
- virtual void onInstructionEvent(const HWInstructionEvent &Event) {}
- virtual void onStallEvent(const HWStallEvent &Event) {}
+ virtual void onEvent(const HWInstructionEvent &Event) {}
+ virtual void onEvent(const HWStallEvent &Event) {}
using ResourceRef = std::pair<uint64_t, uint64_t>;
virtual void onResourceAvailable(const ResourceRef &RRef) {}
diff --git a/tools/llvm-mca/InstructionTables.cpp b/tools/llvm-mca/InstructionTables.cpp
index 652ef20..c7cce7c 100644
--- a/tools/llvm-mca/InstructionTables.cpp
+++ b/tools/llvm-mca/InstructionTables.cpp
@@ -39,9 +39,8 @@
if (!Resource.second.size())
continue;
double Cycles = static_cast<double>(Resource.second.size());
- unsigned Index =
- std::distance(Masks.begin(), std::find(Masks.begin(), Masks.end(),
- Resource.first));
+ unsigned Index = std::distance(
+ Masks.begin(), std::find(Masks.begin(), Masks.end(), Resource.first));
const MCProcResourceDesc &ProcResource = *SM.getProcResource(Index);
unsigned NumUnits = ProcResource.NumUnits;
if (!ProcResource.SubUnitsIdxBegin) {
@@ -73,7 +72,7 @@
InstRef IR(SR.first, Inst.get());
HWInstructionIssuedEvent Event(IR, UsedResources);
for (std::unique_ptr<View> &Listener : Views)
- Listener->onInstructionEvent(Event);
+ Listener->onEvent(Event);
S.updateNext();
}
}
diff --git a/tools/llvm-mca/RegisterFileStatistics.cpp b/tools/llvm-mca/RegisterFileStatistics.cpp
index 46302bf..1b07bf9 100644
--- a/tools/llvm-mca/RegisterFileStatistics.cpp
+++ b/tools/llvm-mca/RegisterFileStatistics.cpp
@@ -39,8 +39,7 @@
std::fill(RegisterFiles.begin(), RegisterFiles.end(), Empty);
}
-void RegisterFileStatistics::onInstructionEvent(
- const HWInstructionEvent &Event) {
+void RegisterFileStatistics::onEvent(const HWInstructionEvent &Event) {
switch (Event.Type) {
default:
break;
diff --git a/tools/llvm-mca/RegisterFileStatistics.h b/tools/llvm-mca/RegisterFileStatistics.h
index d36b61e..cbe816c 100644
--- a/tools/llvm-mca/RegisterFileStatistics.h
+++ b/tools/llvm-mca/RegisterFileStatistics.h
@@ -58,7 +58,7 @@
initializeRegisterFileInfo();
}
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWInstructionEvent &Event) override;
void printView(llvm::raw_ostream &OS) const override;
};
diff --git a/tools/llvm-mca/ResourcePressureView.cpp b/tools/llvm-mca/ResourcePressureView.cpp
index 37bb059..fe9d5b7 100644
--- a/tools/llvm-mca/ResourcePressureView.cpp
+++ b/tools/llvm-mca/ResourcePressureView.cpp
@@ -40,7 +40,7 @@
std::fill(ResourceUsage.begin(), ResourceUsage.end(), 0.0);
}
-void ResourcePressureView::onInstructionEvent(const HWInstructionEvent &Event) {
+void ResourcePressureView::onEvent(const HWInstructionEvent &Event) {
// We're only interested in Issue events.
if (Event.Type != HWInstructionEvent::Issued)
return;
diff --git a/tools/llvm-mca/ResourcePressureView.h b/tools/llvm-mca/ResourcePressureView.h
index c15cf18..fe1c6af 100644
--- a/tools/llvm-mca/ResourcePressureView.h
+++ b/tools/llvm-mca/ResourcePressureView.h
@@ -96,7 +96,7 @@
initialize();
}
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWInstructionEvent &Event) override;
void printView(llvm::raw_ostream &OS) const override {
unsigned Executions = Source.getNumIterations();
diff --git a/tools/llvm-mca/RetireControlUnitStatistics.cpp b/tools/llvm-mca/RetireControlUnitStatistics.cpp
index 5d3632f..edb855e 100644
--- a/tools/llvm-mca/RetireControlUnitStatistics.cpp
+++ b/tools/llvm-mca/RetireControlUnitStatistics.cpp
@@ -19,8 +19,7 @@
namespace mca {
-void RetireControlUnitStatistics::onInstructionEvent(
- const HWInstructionEvent &Event) {
+void RetireControlUnitStatistics::onEvent(const HWInstructionEvent &Event) {
if (Event.Type == HWInstructionEvent::Retired)
++NumRetired;
}
diff --git a/tools/llvm-mca/RetireControlUnitStatistics.h b/tools/llvm-mca/RetireControlUnitStatistics.h
index 5c91af5..1f03e7e 100644
--- a/tools/llvm-mca/RetireControlUnitStatistics.h
+++ b/tools/llvm-mca/RetireControlUnitStatistics.h
@@ -47,7 +47,7 @@
public:
RetireControlUnitStatistics() : NumRetired(0), NumCycles(0) {}
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWInstructionEvent &Event) override;
void onCycleBegin() override { NumCycles++; }
diff --git a/tools/llvm-mca/RetireStage.cpp b/tools/llvm-mca/RetireStage.cpp
index 0d1f4e4..b4dcc28 100644
--- a/tools/llvm-mca/RetireStage.cpp
+++ b/tools/llvm-mca/RetireStage.cpp
@@ -49,7 +49,7 @@
for (const std::unique_ptr<WriteState> &WS : IR.getInstruction()->getDefs())
PRF.removeRegisterWrite(*WS.get(), FreedRegs, !Desc.isZeroLatency());
- notifyInstructionEvent(HWInstructionRetiredEvent(IR, FreedRegs));
+ notifyEvent<HWInstructionEvent>(HWInstructionRetiredEvent(IR, FreedRegs));
}
} // namespace mca
diff --git a/tools/llvm-mca/SchedulerStatistics.cpp b/tools/llvm-mca/SchedulerStatistics.cpp
index dc38f68..5c6d22a 100644
--- a/tools/llvm-mca/SchedulerStatistics.cpp
+++ b/tools/llvm-mca/SchedulerStatistics.cpp
@@ -19,7 +19,7 @@
namespace mca {
-void SchedulerStatistics::onInstructionEvent(const HWInstructionEvent &Event) {
+void SchedulerStatistics::onEvent(const HWInstructionEvent &Event) {
if (Event.Type == HWInstructionEvent::Issued)
++NumIssued;
}
diff --git a/tools/llvm-mca/SchedulerStatistics.h b/tools/llvm-mca/SchedulerStatistics.h
index 08d8a34..7383c54 100644
--- a/tools/llvm-mca/SchedulerStatistics.h
+++ b/tools/llvm-mca/SchedulerStatistics.h
@@ -65,9 +65,9 @@
public:
SchedulerStatistics(const llvm::MCSubtargetInfo &STI)
- : SM(STI.getSchedModel()), NumIssued(0), NumCycles(0) { }
+ : SM(STI.getSchedModel()), NumIssued(0), NumCycles(0) {}
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWInstructionEvent &Event) override;
void onCycleBegin() override { NumCycles++; }
diff --git a/tools/llvm-mca/Stage.cpp b/tools/llvm-mca/Stage.cpp
index cfcb3f8..7ead940 100644
--- a/tools/llvm-mca/Stage.cpp
+++ b/tools/llvm-mca/Stage.cpp
@@ -24,9 +24,4 @@
Listeners.insert(Listener);
}
-void Stage::notifyInstructionEvent(const HWInstructionEvent &Event) {
- for (HWEventListener *Listener : Listeners)
- Listener->onInstructionEvent(Event);
-}
-
} // namespace mca
diff --git a/tools/llvm-mca/Stage.h b/tools/llvm-mca/Stage.h
index 2719376..80d4906 100644
--- a/tools/llvm-mca/Stage.h
+++ b/tools/llvm-mca/Stage.h
@@ -55,7 +55,11 @@
/// Add a listener to receive callbacks during the execution of this stage.
void addListener(HWEventListener *Listener);
- virtual void notifyInstructionEvent(const HWInstructionEvent &Event);
+ /// Notify listeners of a particular hardware event.
+ template <typename EventT> void notifyEvent(const EventT &Event) {
+ for (HWEventListener *Listener : Listeners)
+ Listener->onEvent(Event);
+ }
};
} // namespace mca
diff --git a/tools/llvm-mca/SummaryView.cpp b/tools/llvm-mca/SummaryView.cpp
index 5cb5c23..0139905 100644
--- a/tools/llvm-mca/SummaryView.cpp
+++ b/tools/llvm-mca/SummaryView.cpp
@@ -32,7 +32,7 @@
computeProcResourceMasks(SM, ProcResourceMasks);
}
-void SummaryView::onInstructionEvent(const HWInstructionEvent &Event) {
+void SummaryView::onEvent(const HWInstructionEvent &Event) {
// We are only interested in the "instruction dispatched" events generated by
// the dispatch stage for instructions that are part of iteration #0.
if (Event.Type != HWInstructionEvent::Dispatched)
diff --git a/tools/llvm-mca/SummaryView.h b/tools/llvm-mca/SummaryView.h
index 04f4a87..b799ce3 100644
--- a/tools/llvm-mca/SummaryView.h
+++ b/tools/llvm-mca/SummaryView.h
@@ -67,7 +67,7 @@
void onCycleEnd() override { ++TotalCycles; }
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWInstructionEvent &Event) override;
void printView(llvm::raw_ostream &OS) const override;
};
diff --git a/tools/llvm-mca/TimelineView.cpp b/tools/llvm-mca/TimelineView.cpp
index 8087ea9..6e75cac 100644
--- a/tools/llvm-mca/TimelineView.cpp
+++ b/tools/llvm-mca/TimelineView.cpp
@@ -34,7 +34,7 @@
std::fill(WaitTime.begin(), WaitTime.end(), NullWTEntry);
}
-void TimelineView::onInstructionEvent(const HWInstructionEvent &Event) {
+void TimelineView::onEvent(const HWInstructionEvent &Event) {
const unsigned Index = Event.IR.getSourceIndex();
if (CurrentCycle >= MaxCycle || Index >= Timeline.size())
return;
diff --git a/tools/llvm-mca/TimelineView.h b/tools/llvm-mca/TimelineView.h
index 1a85ca1..e53c23e 100644
--- a/tools/llvm-mca/TimelineView.h
+++ b/tools/llvm-mca/TimelineView.h
@@ -174,7 +174,7 @@
// Event handlers.
void onCycleEnd() override { ++CurrentCycle; }
- void onInstructionEvent(const HWInstructionEvent &Event) override;
+ void onEvent(const HWInstructionEvent &Event) override;
// print functionalities.
void printTimeline(llvm::raw_ostream &OS) const;
