Skip to content

Commit 69ddad7

Browse files
committed
Add profiler requested runtime suspension note
1 parent f142e20 commit 69ddad7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/coreclr/inc/corprof.idl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4324,6 +4324,10 @@ interface ICorProfilerInfo15 : ICorProfilerInfo14
43244324
* EnumerateGCHeapObjects is a method that iterates over each object in the GC heap.
43254325
* For each object, it invokes the provided callback function which should return a bool
43264326
* indicating whether or not enumeration should continue.
4327+
* The runtime must be suspended in order to enumerate objects on the GC heap.
4328+
* If the profiler requested runtime suspension through SuspendRuntime and proceeds to
4329+
* invoke EnumerateGCHeapObjects, it is the responsibility of the profiler to not
4330+
* resume the runtime before EnumerateGCHeapObjects completes.
43274331
*
43284332
* Parameters:
43294333
* - callback: A function pointer to the callback function that will be invoked for each object in the GC heap.

0 commit comments

Comments
 (0)