From 1c1de452570b525f1a7ed9f7da919e0af16c23bd Mon Sep 17 00:00:00 2001 From: Matt Davis Date: Mon, 16 Jul 2018 23:50:53 +0000 Subject: [PATCH] [llvm-mca][docs] Add notes about cycle and resource callbacks. NFC. llvm-svn: 337225 --- llvm/docs/CommandGuide/llvm-mca.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/llvm/docs/CommandGuide/llvm-mca.rst b/llvm/docs/CommandGuide/llvm-mca.rst index 65cf86d..41c4502 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 -- 2.7.4