HeapImpl

java.lang.Object
- com.oracle.svm.core.heap.Heap
- - com.oracle.svm.core.genscavenge.HeapImpl

```
public class HeapImpl
extends Heap
```
An implementation of a card remembered set generational heap.

Constructor Summary

Constructors
Constructor and Description

HeapImpl(org.graalvm.nativeimage.Feature.FeatureAccess access)
Constructor for subclasses.

Constructors
Constructor and Description
`HeapImpl(org.graalvm.nativeimage.Feature.FeatureAccess access)` Constructor for subclasses.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`assertHub(DynamicHub hub)` For assertions: Verify that the hub is a reference to where DynamicHubs live in the heap.
`boolean`	`assertHubOfObject(Object obj)` For assertions: Verify the hub of the object.
`PinnedAllocator`	`createPinnedAllocator()` Create a PinnedAllocator.
`void`	`disableAllocation(org.graalvm.nativeimage.IsolateThread vmThread)`
`org.graalvm.word.UnsignedWord`	`freeMemory()`
`List<Class<?>>`	`getClassList()` Return a list of all the classes in the heap.
`HeapChunk.Header<?>`	`getEnclosingHeapChunk(Object obj)`
`GC`	`getGC()`
`GCImpl`	`getGCImpl()`
`static HeapImpl`	`getHeapImpl()`
`HeapPolicy`	`getHeapPolicy()`
`HeapVerifierImpl`	`getHeapVerifierImpl()`
`MemoryMXBean`	`getMemoryMXBean()` An accessor for the MemoryMXBean.
`ObjectHeader`	`getObjectHeader()` Get the ObjectHeader implementation that this Heap uses.
`ObjectHeaderImpl`	`getObjectHeaderImpl()`
`OldGeneration`	`getOldGeneration()`
`UninterruptibleUtils.AtomicReference<PinnedObjectImpl>`	`getPinHead()`
`org.graalvm.word.UnsignedWord`	`getUsedObjectBytes()` Return the size, in bytes, of the actual used memory, not the committed memory.
`YoungGeneration`	`getYoungGeneration()`
`boolean`	`isAllocationDisallowed()` Allocation is disallowed if ...
`boolean`	`isImageHeapObject(Object obj)`
`boolean`	`isPinned(Object instance)`
`boolean`	`isValidSpace(Space space)` For assertions: Verify that a Space is a valid Space.
`boolean`	`isYoungGeneration(Space space)`
`org.graalvm.word.UnsignedWord`	`maxMemory()`
`Object`	`promoteObject(Object original)`
`protected void`	`report(Log log)`
`Log`	`report(Log log, boolean traceHeapChunks)`
`void`	`resumeAllocation()`
`void`	`suspendAllocation()`
`void`	`tearDown()` Tear down the heap, return all allocated virtual memory chunks to VirtualMemoryProvider.
`org.graalvm.word.UnsignedWord`	`totalMemory()`
`boolean`	`walkHeap(MemoryWalker.Visitor visitor)` Walk the regions of the heap with a MemoryWalker.
`void`	`walkObjects(ObjectVisitor visitor)` Walk all the Objects in the Heap, passing each to the visitor.

Methods inherited from class com.oracle.svm.core.heap.Heap
getHeap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HeapImpl
```
public HeapImpl(org.graalvm.nativeimage.Feature.FeatureAccess access)
```
    Constructor for subclasses.
- Method Detail
  - getHeapImpl
```
public static HeapImpl getHeapImpl()
```
  - suspendAllocation
```
public void suspendAllocation()
```
    Specified by:
    
    suspendAllocation in class Heap
  - resumeAllocation
```
public void resumeAllocation()
```
    Specified by:
    
    resumeAllocation in class Heap
  - disableAllocation
```
public void disableAllocation(org.graalvm.nativeimage.IsolateThread vmThread)
```
    Specified by:
    
    disableAllocation in class Heap
  - createPinnedAllocator
```
public PinnedAllocator createPinnedAllocator()
```
    Description copied from class: Heap
    
    Create a PinnedAllocator.
    
    Specified by:
    
    createPinnedAllocator in class Heap
  - walkObjects
```
public void walkObjects(ObjectVisitor visitor)
```
    Description copied from class: Heap
    
    Walk all the Objects in the Heap, passing each to the visitor.
    
    Specified by:
    
    walkObjects in class Heap
  - walkHeap
```
public boolean walkHeap(MemoryWalker.Visitor visitor)
```
    Walk the regions of the heap with a MemoryWalker.
  - tearDown
```
public final void tearDown()
```
    Tear down the heap, return all allocated virtual memory chunks to VirtualMemoryProvider.
    
    Specified by:
    
    tearDown in class Heap
  - getObjectHeader
```
public ObjectHeader getObjectHeader()
```
    Description copied from class: Heap
    
    Get the ObjectHeader implementation that this Heap uses. TODO: This is used during native image generation to put appropriate headers on Objects in the native image heap. Is there any reason to expose the whole ObjectHeader interface, since only setBootImageOnLong(0L) is used then, to get the native image object header bits? TODO: Would an "Unsigned getBootImageObjectHeaderBits()" method be sufficient?
    
    Specified by:
    
    getObjectHeader in class Heap
  - getObjectHeaderImpl
```
public ObjectHeaderImpl getObjectHeaderImpl()
```
  - getGC
```
public GC getGC()
```
    Specified by:
    
    getGC in class Heap
  - getGCImpl
```
public GCImpl getGCImpl()
```
  - isAllocationDisallowed
```
public boolean isAllocationDisallowed()
```
    Allocation is disallowed if ...
    
    Specified by:
    
    isAllocationDisallowed in class Heap
  - getEnclosingHeapChunk
```
public HeapChunk.Header<?> getEnclosingHeapChunk(Object obj)
```
  - promoteObject
```
public Object promoteObject(Object original)
```
  - getHeapPolicy
```
public HeapPolicy getHeapPolicy()
```
  - isYoungGeneration
```
public boolean isYoungGeneration(Space space)
```
  - getYoungGeneration
```
public YoungGeneration getYoungGeneration()
```
  - getOldGeneration
```
public OldGeneration getOldGeneration()
```
  - getPinHead
```
public UninterruptibleUtils.AtomicReference<PinnedObjectImpl> getPinHead()
```
  - isPinned
```
public boolean isPinned(Object instance)
```
  - isImageHeapObject
```
public boolean isImageHeapObject(Object obj)
```
  - getUsedObjectBytes
```
public org.graalvm.word.UnsignedWord getUsedObjectBytes()
```
    Return the size, in bytes, of the actual used memory, not the committed memory.
  - report
```
protected void report(Log log)
```
  - report
```
public Log report(Log log,
                  boolean traceHeapChunks)
```
  - getMemoryMXBean
```
public MemoryMXBean getMemoryMXBean()
```
    An accessor for the MemoryMXBean.
    
    Specified by:
    
    getMemoryMXBean in class Heap
  - getClassList
```
public List<Class<?>> getClassList()
```
    Return a list of all the classes in the heap.
    
    Specified by:
    
    getClassList in class Heap
  - getHeapVerifierImpl
```
public HeapVerifierImpl getHeapVerifierImpl()
```
  - assertHub
```
public boolean assertHub(DynamicHub hub)
```
    For assertions: Verify that the hub is a reference to where DynamicHubs live in the heap.
  - assertHubOfObject
```
public boolean assertHubOfObject(Object obj)
```
    For assertions: Verify the hub of the object.
  - isValidSpace
```
public boolean isValidSpace(Space space)
```
    For assertions: Verify that a Space is a valid Space.
  - freeMemory
```
public org.graalvm.word.UnsignedWord freeMemory()
```
    Returns:
    
    an approximation to the total amount of memory currently available for future allocated objects, measured in bytes.
  - totalMemory
```
public org.graalvm.word.UnsignedWord totalMemory()
```
    Returns:
    
    the total amount of memory currently available for current and future objects, measured in bytes.
  - maxMemory
```
public org.graalvm.word.UnsignedWord maxMemory()
```
    Returns:
    
    the maximum amount of memory that the virtual machine will attempt to use, measured in bytes

Class HeapImpl

Constructor Summary

Method Summary

Methods inherited from class com.oracle.svm.core.heap.Heap

Methods inherited from class java.lang.Object

Constructor Detail

HeapImpl

Method Detail

getHeapImpl

suspendAllocation

resumeAllocation

disableAllocation

createPinnedAllocator

walkObjects

walkHeap

tearDown

getObjectHeader

getObjectHeaderImpl

getGC

getGCImpl

isAllocationDisallowed

getEnclosingHeapChunk

promoteObject

getHeapPolicy

isYoungGeneration

getYoungGeneration

getOldGeneration

getPinHead

isPinned

isImageHeapObject

getUsedObjectBytes

report

report

getMemoryMXBean

getClassList

getHeapVerifierImpl

assertHub

assertHubOfObject

isValidSpace

freeMemory

totalMemory

maxMemory