RememberedSet

All Known Implementing Classes:

CardTableBasedRememberedSet, NoRememberedSet
```
public interface RememberedSet
```
A remembered set keeps track of references between generations (from the old generation to the young generation, or from the image heap to the runtime heap). During collections, the remembered set is used to avoid scanning the entire image heap and old generation.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clearRememberedSet(AlignedHeapChunk.AlignedHeader chunk)` Clears the remembered set of an aligned chunk.
`void`	`clearRememberedSet(UnalignedHeapChunk.UnalignedHeader chunk)` Clears the remembered set of an unaligned chunk.
`org.graalvm.compiler.nodes.gc.BarrierSet`	`createBarrierSet(jdk.vm.ci.meta.MetaAccessProvider metaAccess)` Creates the barrier set that the compiler should use for emitting read/write barriers.
`void`	`dirtyCardForAlignedObject(Object object, boolean verifyOnly)` Marks an object as dirty.
`void`	`dirtyCardForUnalignedObject(Object object, boolean verifyOnly)` Marks an object as dirty.
`void`	`dirtyCardIfNecessary(Object holderObject, Object object)` Marks the `holderObject` as dirty if needed according to the location of `object`.
`void`	`enableRememberedSetForAlignedChunk(HostedByteBufferPointer chunk, int chunkPosition, List<ImageHeapObject> objects)` Enables remembered set tracking for an aligned chunk and its objects.
`void`	`enableRememberedSetForChunk(AlignedHeapChunk.AlignedHeader chunk)` Enables remembered set tracking for an aligned chunk and its objects.
`void`	`enableRememberedSetForChunk(UnalignedHeapChunk.UnalignedHeader chunk)` Enables remembered set tracking for an unaligned chunk and its objects.
`void`	`enableRememberedSetForObject(AlignedHeapChunk.AlignedHeader chunk, Object obj)` Enables remembered set tracking for a single object in an aligned chunk.
`void`	`enableRememberedSetForUnalignedChunk(HostedByteBufferPointer chunk)` Enables remembered set tracking for an unaligned chunk and its objects.
`static RememberedSet`	`get()`
`org.graalvm.word.UnsignedWord`	`getHeaderSizeOfAlignedChunk()` Returns the header size of aligned chunks.
`org.graalvm.word.UnsignedWord`	`getHeaderSizeOfUnalignedChunk()` Returns the header size of unaligned chunks.
`boolean`	`hasRememberedSet(org.graalvm.word.UnsignedWord header)` Checks if remembered set tracking is enabled for an object.
`boolean`	`verify(AlignedHeapChunk.AlignedHeader firstAlignedHeapChunk)` Verify the remembered set for an aligned chunk.
`boolean`	`verify(UnalignedHeapChunk.UnalignedHeader firstUnalignedHeapChunk)` Verify the remembered set for an unaligned chunk.
`void`	`walkDirtyObjects(AlignedHeapChunk.AlignedHeader chunk, GreyToBlackObjectVisitor visitor, boolean clean)` Walks all dirty objects in an aligned chunk.
`void`	`walkDirtyObjects(Space space, GreyToBlackObjectVisitor visitor, boolean clean)` Walks all dirty objects in a `Space`.
`void`	`walkDirtyObjects(UnalignedHeapChunk.UnalignedHeader chunk, GreyToBlackObjectVisitor visitor, boolean clean)` Walks all dirty objects in an unaligned chunk.

- Method Detail
  - get
```
static RememberedSet get()
```
  - createBarrierSet
```
org.graalvm.compiler.nodes.gc.BarrierSet createBarrierSet(jdk.vm.ci.meta.MetaAccessProvider metaAccess)
```
    Creates the barrier set that the compiler should use for emitting read/write barriers.
  - getHeaderSizeOfAlignedChunk
```
org.graalvm.word.UnsignedWord getHeaderSizeOfAlignedChunk()
```
    Returns the header size of aligned chunks.
  - getHeaderSizeOfUnalignedChunk
```
org.graalvm.word.UnsignedWord getHeaderSizeOfUnalignedChunk()
```
    Returns the header size of unaligned chunks.
  - enableRememberedSetForAlignedChunk
```
void enableRememberedSetForAlignedChunk(HostedByteBufferPointer chunk,
                                        int chunkPosition,
                                        List<ImageHeapObject> objects)
```
    Enables remembered set tracking for an aligned chunk and its objects. Must be called when adding a new chunk to the image heap or old generation.
  - enableRememberedSetForUnalignedChunk
```
void enableRememberedSetForUnalignedChunk(HostedByteBufferPointer chunk)
```
    Enables remembered set tracking for an unaligned chunk and its objects. Must be called when adding a new chunk to the image heap or old generation.
  - enableRememberedSetForChunk
```
void enableRememberedSetForChunk(AlignedHeapChunk.AlignedHeader chunk)
```
    Enables remembered set tracking for an aligned chunk and its objects. Must be called when adding a new chunk to the image heap or old generation.
  - enableRememberedSetForChunk
```
void enableRememberedSetForChunk(UnalignedHeapChunk.UnalignedHeader chunk)
```
    Enables remembered set tracking for an unaligned chunk and its objects. Must be called when adding a new chunk to the image heap or old generation.
  - enableRememberedSetForObject
```
void enableRememberedSetForObject(AlignedHeapChunk.AlignedHeader chunk,
                                  Object obj)
```
    Enables remembered set tracking for a single object in an aligned chunk. Must be called when an object is added to the image heap or old generation.
  - clearRememberedSet
```
void clearRememberedSet(AlignedHeapChunk.AlignedHeader chunk)
```
    Clears the remembered set of an aligned chunk.
  - clearRememberedSet
```
void clearRememberedSet(UnalignedHeapChunk.UnalignedHeader chunk)
```
    Clears the remembered set of an unaligned chunk.
  - hasRememberedSet
```
boolean hasRememberedSet(org.graalvm.word.UnsignedWord header)
```
    Checks if remembered set tracking is enabled for an object.
  - dirtyCardForAlignedObject
```
void dirtyCardForAlignedObject(Object object,
                               boolean verifyOnly)
```
    Marks an object as dirty. May only be called for objects for which remembered set tracking is enabled. This tells the GC that the object may contain a reference to another generation (from old generation to young generation, or from image heap to runtime heap).
  - dirtyCardForUnalignedObject
```
void dirtyCardForUnalignedObject(Object object,
                                 boolean verifyOnly)
```
    Marks an object as dirty. May only be called for objects for which remembered set tracking is enabled. This tells the GC that the object may contain a reference to another generation (from old generation to young generation, or from image heap to runtime heap).
  - dirtyCardIfNecessary
```
void dirtyCardIfNecessary(Object holderObject,
                          Object object)
```
    Marks the holderObject as dirty if needed according to the location of object. May only be called for holderObjects for which remembered set tracking is enabled.
  - walkDirtyObjects
```
void walkDirtyObjects(AlignedHeapChunk.AlignedHeader chunk,
                      GreyToBlackObjectVisitor visitor,
                      boolean clean)
```
    Walks all dirty objects in an aligned chunk.
  - walkDirtyObjects
```
void walkDirtyObjects(UnalignedHeapChunk.UnalignedHeader chunk,
                      GreyToBlackObjectVisitor visitor,
                      boolean clean)
```
    Walks all dirty objects in an unaligned chunk.
  - walkDirtyObjects
```
void walkDirtyObjects(Space space,
                      GreyToBlackObjectVisitor visitor,
                      boolean clean)
```
    Walks all dirty objects in a Space.
  - verify
```
boolean verify(AlignedHeapChunk.AlignedHeader firstAlignedHeapChunk)
```
    Verify the remembered set for an aligned chunk.
  - verify
```
boolean verify(UnalignedHeapChunk.UnalignedHeader firstUnalignedHeapChunk)
```
    Verify the remembered set for an unaligned chunk.

Interface RememberedSet

Method Summary

Method Detail

get

createBarrierSet

getHeaderSizeOfAlignedChunk

getHeaderSizeOfUnalignedChunk

enableRememberedSetForAlignedChunk

enableRememberedSetForUnalignedChunk

enableRememberedSetForChunk

enableRememberedSetForChunk

enableRememberedSetForObject

clearRememberedSet

clearRememberedSet

hasRememberedSet

dirtyCardForAlignedObject

dirtyCardForUnalignedObject

dirtyCardIfNecessary

walkDirtyObjects

walkDirtyObjects

walkDirtyObjects

verify

verify