[llvm] 1768c45 - [MCA] Document behaviour of ResourceRef

[Andrea Di Biagio via llvm-commits]

Author: Christoph Stiller
Date: 2023-07-18T14:09:21+01:00
New Revision: 1768c4597e70477af2d69f576f33400181a5f945

URL: https://github.com/llvm/llvm-project/commit/1768c4597e70477af2d69f576f33400181a5f945
DIFF: https://github.com/llvm/llvm-project/commit/1768c4597e70477af2d69f576f33400181a5f945.diff

LOG: [MCA] Document behaviour of ResourceRef

Differential Revision: https://reviews.llvm.org/D155347

Added: 
    

Modified: 
    llvm/include/llvm/MCA/HWEventListener.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/MCA/HWEventListener.h b/llvm/include/llvm/MCA/HWEventListener.h
index 4a7d0df6b18a93..a24b90654e2f19 100644
--- a/llvm/include/llvm/MCA/HWEventListener.h
+++ b/llvm/include/llvm/MCA/HWEventListener.h
@@ -59,7 +59,10 @@ class HWInstructionEvent {
   const InstRef &IR;
 };
 
+// ResourceRef::first is the index of the associated Resource.
+// ResourceRef::second is a bitmask of the referenced sub-unit of the resource.
 using ResourceRef = std::pair<uint64_t, uint64_t>;
+
 using ResourceUse = std::pair<ResourceRef, ResourceCycles>;
 
 class HWInstructionIssuedEvent : public HWInstructionEvent {