memscale

Class OffHeapHelper

java.lang.Object

memscale.OffHeapHelper

public class OffHeapHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
OffHeapHelper()

Method Summary

Modifier and Type	Method and Description
static void	closeAllOffHeapRegions() Closes all off-heap regions in the cache and waits for off-heap memory to be empty (closing a region asynchronously releases the off-heap memory it held, so we want to wait for that to finish).
static void	closeAllRegions() Closes all offheap regions in the cache and waits for off-heap memory to be empty (closing a region asynchronously releases the off-heap memory it held, so we want to wait for that to finish).
static void	dumpOffHeapOrphans() use internal product calls to determine who the orphans are and log them
static Set<com.gemstone.gemfire.cache.Region<?,?>>	getAllRegions() Return a Set of all regions defined in this member.
static com.gemstone.gemfire.internal.offheap.OffHeapMemoryStats	getOffHeapMemoryStats() Return the off-heap memory stats object for this member
static boolean	isOffHeapMemoryConfigured() Determines if this member has off-heap memory currently allocated.
static void	verifyOffHeapMemoryConsistency(boolean checkRefCounts) Do consistency checks on off-heap memory.
static void	verifyOffHeapMemoryConsistencyOnce()
static void	verifyRegionsEnabledWithOffHeap(List<String> regionNames) Verify that the given list of full region path names have off-heap memory enabled
static void	waitForGlobalOffHeapSilence() Wait for 30 seconds of off-heap silence throughout the system.
static void	waitForGlobalOffHeapSilence(int secondsOfSilence) Wait for off-heap memory to be stable and silent across the system for the given number of seconds.
static void	waitForOffHeapSilence() Wait for 30 seconds of off-heap silence in this member.
static void	waitForOffHeapSilence(int secondsOfSilence) Wait for off-heap memory to be stable and silent for the given number of seconds.
static void	waitForWanQueuesToDrain() Wait for all async event queues (including wan queues) in this member to drain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OffHeapHelper

public OffHeapHelper()

Method Detail

verifyOffHeapMemoryConsistency

public static void verifyOffHeapMemoryConsistency(boolean checkRefCounts)

Do consistency checks on off-heap memory. This is non-intrusive of the cache, meaning it is written to not rattle anything while the validation occurs, for example it won't cause eviction. This must be called when the system is quiet. * If there are persistent regions you cannot call this while asynchronous recovery of values is running. To make the test run with synchronous recovery of values, set the property gemfire.disk.recoverValuesSync=true. * Redundancy recovery for PartitionedRegions must not be running. This method iterates all keys and values of all regions. If no regions are defined, this still provides consistency checks on off-heap memory as it verifies that there are no objects in off-heap as compared to off-heap stats; this check could indicate a leak if objects are found off-heap when no regions are defined. Note that this validation trusts the enableOffHeapMemory region attribute in that it will verify that off-heap enabled regions have all entries off-heap and that region with off-heap disabled will have all entries in heap. To be completely thorough, the test can verify that each region's off-heap enabled attribute is correct before calling this method. See OffHeapHelper.verifyRegionsEnabledWithOffHeap(...) to verify this attribute on regions. If no off-heap memory was configured for this member (ie no off-heap memory was specified with GemFirePrms.offHeapMemorySize), then this method takes an early return.

Parameters:

checkRefCounts - If true, then check that all refCounts are exactly 1. If false skip the refCount check. During validation, if any remote member is doing gets on data that lives in this member, the refCounts will be changing.

waitForGlobalOffHeapSilence

public static void waitForGlobalOffHeapSilence()

Wait for 30 seconds of off-heap silence throughout the system.

waitForGlobalOffHeapSilence

public static void waitForGlobalOffHeapSilence(int secondsOfSilence)

Wait for off-heap memory to be stable and silent across the system for the given number of seconds. Do not return until then.

Parameters:

secondsOfSilence - The number of seconds off-heap memory must be stable for before returning.

waitForOffHeapSilence

public static void waitForOffHeapSilence()

Wait for 30 seconds of off-heap silence in this member.

waitForOffHeapSilence

public static void waitForOffHeapSilence(int secondsOfSilence)

Wait for off-heap memory to be stable and silent for the given number of seconds. Do not return until then.

Parameters:

secondsOfSilence - The number of seconds off-heap memory must be stable for before returning.

dumpOffHeapOrphans

public static void dumpOffHeapOrphans()

use internal product calls to determine who the orphans are and log them

closeAllRegions

public static void closeAllRegions()

Closes all offheap regions in the cache and waits for off-heap memory to be empty (closing a region asynchronously releases the off-heap memory it held, so we want to wait for that to finish). This is used to look for off-heap memory leaks. After all the regions are closed calling verifyOffHeapMemoryConsistency will detect any objects still in off-heap which indicates a leak.

closeAllOffHeapRegions

public static void closeAllOffHeapRegions()

Closes all off-heap regions in the cache and waits for off-heap memory to be empty (closing a region asynchronously releases the off-heap memory it held, so we want to wait for that to finish). This is used to look for off-heap memory leaks. After all the regions are closed calling verifyOffHeapMemoryConsistency will detect any objects still in off-heap which indicates a leak.

getAllRegions

public static Set<com.gemstone.gemfire.cache.Region<?,?>> getAllRegions()

Return a Set of all regions defined in this member.

Returns:

A Set of all regions defined in this member.

verifyRegionsEnabledWithOffHeap

public static void verifyRegionsEnabledWithOffHeap(List<String> regionNames)

Verify that the given list of full region path names have off-heap memory enabled

Parameters:

regionNames - A List of full region path names, or null of all regions are expected to have off-heap enabled.

isOffHeapMemoryConfigured

public static boolean isOffHeapMemoryConfigured()

Determines if this member has off-heap memory currently allocated. This returns true if off-heap memory is present even if the cache is closed.

Returns:

True if this member has off-heap memory currently allocated, false otherwise.

verifyOffHeapMemoryConsistencyOnce

public static void verifyOffHeapMemoryConsistencyOnce()

getOffHeapMemoryStats

public static com.gemstone.gemfire.internal.offheap.OffHeapMemoryStats getOffHeapMemoryStats()

Return the off-heap memory stats object for this member

Returns:

The off-heap memory stats for this member.

waitForWanQueuesToDrain

public static void waitForWanQueuesToDrain()

Wait for all async event queues (including wan queues) in this member to drain. Does not return until all wan queues are empty.