From 5cc754aa04d3c5b9e461d6052157f457618b1019 Mon Sep 17 00:00:00 2001
From: mdh1418 <mitchhwang1418@gmail.com>
Date: Mon, 8 Jul 2024 14:15:43 -0400
Subject: [PATCH] Add profiler requested runtime suspension note

---
 src/coreclr/inc/corprof.idl | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/coreclr/inc/corprof.idl b/src/coreclr/inc/corprof.idl
index 61df2d7d325b9b..960f90e25f1014 100644
--- a/src/coreclr/inc/corprof.idl
+++ b/src/coreclr/inc/corprof.idl
@@ -4324,6 +4324,10 @@ interface ICorProfilerInfo15 : ICorProfilerInfo14
      * EnumerateGCHeapObjects is a method that iterates over each object in the GC heap.
      * For each object, it invokes the provided callback function which should return a bool
      * indicating whether or not enumeration should continue.
+     * The runtime must be suspended in order to enumerate objects on the GC heap.
+     * If the profiler requested runtime suspension through SuspendRuntime and proceeds to
+     * invoke EnumerateGCHeapObjects, it is the responsibility of the profiler to not
+     * resume the runtime before EnumerateGCHeapObjects completes.
      *
      * Parameters:
      * - callback: A function pointer to the callback function that will be invoked for each object in the GC heap.