[llvm] 8e06058 - [MSSA] Add clarifying comment for isOptimized on MemoryUse [nfc]

[Philip Reames via llvm-commits]

Author: Philip Reames
Date: 2022-03-08T09:43:16-08:00
New Revision: 8e06058bfe4b97fbd54f244cb7c72e9214bab7ed

URL: https://github.com/llvm/llvm-project/commit/8e06058bfe4b97fbd54f244cb7c72e9214bab7ed
DIFF: https://github.com/llvm/llvm-project/commit/8e06058bfe4b97fbd54f244cb7c72e9214bab7ed.diff

LOG: [MSSA] Add clarifying comment for isOptimized on MemoryUse [nfc]

Added: 
    

Modified: 
    llvm/include/llvm/Analysis/MemorySSA.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/Analysis/MemorySSA.h b/llvm/include/llvm/Analysis/MemorySSA.h
index f119316129b32..fa333001156b0 100644
--- a/llvm/include/llvm/Analysis/MemorySSA.h
+++ b/llvm/include/llvm/Analysis/MemorySSA.h
@@ -346,6 +346,9 @@ class MemoryUse final : public MemoryUseOrDef {
     setOperand(0, DMA);
   }
 
+  /// The defining access of a MemoryUses are always optimized if queried from
+  /// outside MSSA construction itself.  This result is only useful inside
+  /// the MSSA implementation.
   bool isOptimized() const {
     return getDefiningAccess() && OptimizedID == getDefiningAccess()->getID();
   }