org.graalvm.compiler.debug

Interface MemUseTrackerKey

All Superinterfaces:

MetricKey

public interface MemUseTrackerKey
extends MetricKey

Tracks memory usage within a scope using com.sun.management.ThreadMXBean. This facility should be employed using the try-with-resources pattern:

 try (DebugCloseable a = memUseTracker.start()) {
     // the code to measure
 }
 

Field Summary

Fields inherited from interface org.graalvm.compiler.debug.MetricKey

NAME_COMPARATOR

Method Summary

Modifier and Type	Method and Description
MemUseTrackerKey	doc(String string) Sets the documentation for this key.
static long	getCurrentThreadAllocatedBytes()
long	getCurrentValue(DebugContext debug) Gets the current value of this tracker.
DebugCloseable	start(DebugContext debug) Creates a point from which memory usage will be recorded if memory use tracking is enabled.

Methods inherited from interface org.graalvm.compiler.debug.MetricKey

getDoc, getDocName, getName, toCSVFormat, toHumanReadableFormat

Method Detail

start

DebugCloseable start(DebugContext debug)

Creates a point from which memory usage will be recorded if memory use tracking is enabled.

Returns:

an object that must be closed once the activity has completed to add the memory used since this call to the total for this tracker

getCurrentValue

long getCurrentValue(DebugContext debug)

Gets the current value of this tracker.

doc

MemUseTrackerKey doc(String string)

Description copied from interface: MetricKey

Sets the documentation for this key.

Specified by:

doc in interface MetricKey

getCurrentThreadAllocatedBytes

static long getCurrentThreadAllocatedBytes()