[llvm-mca][docs] Add notes about cycle and resource callbacks. NFC.

llvm-svn: 337225

1 files changed, 8 insertions, 0 deletions

diff --git a/llvm/docs/CommandGuide/llvm-mca.rst b/llvm/docs/CommandGuide/llvm-mca.rst
index 65cf86da4ef..41c450240c9 100644
--- a/llvm/docs/CommandGuide/llvm-mca.rst
+++ b/llvm/docs/CommandGuide/llvm-mca.rst
@@ -273,6 +273,14 @@ describes the state of an instruction (e.g., Ready, Dispatched, Executed,
 etc.).  The latter describes a stall hazard (e.g., load stall, store stall,
 scheduler stall, etc.).
 
+In addition to the instruction and stall events.  A listener can also
+subscribe to cycle events (``onCycleStart``, ``onCycleEnd``).  These events
+occur before and after a simulated clock cycle is executed, respectively.
+
+Listeners can also be notified of various resource states within the stages
+of a pipeline, such as resource availability, reservation, and reclaim:
+(``onResourceAvailability``, ``onReservedBuffers``, ``onReleasedBuffers``).
+
 Creating a Custom View
 """"""""""""""""""""""
 To create a  custom view, the user must first inherit from the ``View`` class