org.apache.arrow.memory

Class RootAllocator

java.lang.Object

org.apache.arrow.memory.BaseAllocator

org.apache.arrow.memory.RootAllocator

All Implemented Interfaces:

AutoCloseable, BufferAllocator

public class RootAllocator
extends BaseAllocator

A root allocator for using direct memory for Arrow Vectors/Arrays. Supports creating a tree of descendant child allocators to facilitate better instrumentation of memory allocations.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.arrow.memory.BaseAllocator

BaseAllocator.Reservation, BaseAllocator.Verbosity

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.arrow.memory.Accountant	parent The parent allocator.
protected long	reservation The amount of memory reserved for this allocator.

Fields inherited from class org.apache.arrow.memory.BaseAllocator

DEBUG, DEBUG_ALLOCATOR, DEBUG_LOG_LENGTH, DEFAULT_CONFIG

Constructor Summary

Constructors

Constructor and Description
RootAllocator()
RootAllocator(AllocationListener listener, long limit)
RootAllocator(AllocationListener listener, long limit, RoundingPolicy roundingPolicy) Constructor.
RootAllocator(org.apache.arrow.memory.BaseAllocator.Config config)
RootAllocator(long limit)

Method Summary

Modifier and Type	Method and Description
long	getAllocatedMemory() Return the current amount of allocated memory that this Accountant is managing accounting for.
long	getHeadroom()
long	getInitReservation() Return the initial reservation.
long	getLimit() Return the current limit of this Accountant.
long	getPeakMemoryAllocation() The peak memory allocated by this Accountant.
boolean	isOverLimit()
void	releaseBytes(long size)
void	setLimit(long newLimit) Set the maximum amount of memory that can be allocated in the this Accountant before failing an allocation.
void	verify() Verify the accounting state of the allocation system.

Methods inherited from class org.apache.arrow.memory.BaseAllocator

assertOpen, buffer, buffer, close, configBuilder, defaultConfig, getAsByteBufAllocator, getChildAllocators, getEmpty, getName, getParentAllocator, indent, isDebug, newChildAllocator, newChildAllocator, newReservation, nextPowerOfTwo, nextPowerOfTwo, toString, toVerboseString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.arrow.memory.BufferAllocator

getAllocatedMemory, getHeadroom, getInitReservation, getLimit, getPeakMemoryAllocation, isOverLimit, setLimit

Field Detail

parent

protected final org.apache.arrow.memory.Accountant parent

The parent allocator.

reservation

protected final long reservation

The amount of memory reserved for this allocator. Releases below this amount of memory will not be returned to the parent Accountant until this Accountant is closed.

Constructor Detail

RootAllocator

public RootAllocator()

RootAllocator

public RootAllocator(long limit)

RootAllocator

public RootAllocator(AllocationListener listener,
                     long limit)

RootAllocator

public RootAllocator(AllocationListener listener,
                     long limit,
                     RoundingPolicy roundingPolicy)

Constructor.

Parameters:

listener - the allocation listener

limit - max allocation size in bytes

roundingPolicy - the policy for rounding the buffer size

RootAllocator

public RootAllocator(org.apache.arrow.memory.BaseAllocator.Config config)

Method Detail

verify

public void verify()

Verify the accounting state of the allocation system.

releaseBytes

public void releaseBytes(long size)

isOverLimit

public boolean isOverLimit()

getLimit

public long getLimit()

Return the current limit of this Accountant.

Returns:

Limit in bytes.

getInitReservation

public long getInitReservation()

Return the initial reservation.

Returns:

reservation in bytes.

setLimit

public void setLimit(long newLimit)

Set the maximum amount of memory that can be allocated in the this Accountant before failing an allocation.

Parameters:

newLimit - The limit in bytes.

getAllocatedMemory

public long getAllocatedMemory()

Return the current amount of allocated memory that this Accountant is managing accounting for. Note this does not include reservation memory that hasn't been allocated.

Returns:

Currently allocate memory in bytes.

getPeakMemoryAllocation

public long getPeakMemoryAllocation()

The peak memory allocated by this Accountant.

Returns:

The peak allocated memory in bytes.

getHeadroom

public long getHeadroom()