Add profiler requested runtime suspension note

dotnet · Jul 8, 2024 · 69ddad7 · 69ddad7
1 parent f142e20
commit 69ddad7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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.