org.nd4j.linalg.api.memory.abstracts

Class Nd4jWorkspace

java.lang.Object

org.nd4j.linalg.api.memory.abstracts.Nd4jWorkspace

All Implemented Interfaces:

AutoCloseable, Deallocatable, MemoryWorkspace

public abstract class Nd4jWorkspace
extends Object
implements MemoryWorkspace

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

MemoryWorkspace.Type

Field Summary

Fields

Modifier and Type	Field and Description
static int	alignmentBase
protected MemoryWorkspace	borrowingWorkspace
protected AtomicLong	currentSize
protected AtomicLong	cycleAllocations
protected AtomicLong	cyclesCount
protected int	deviceId
protected AtomicLong	deviceOffset
protected AtomicLong	disabledCounter
protected List<PointersPair>	externalAllocations
protected AtomicInteger	externalCount
protected AtomicLong	generationId
protected String	guid
protected AtomicLong	hostOffset
protected String	id
protected AtomicLong	initialBlockSize
protected AtomicBoolean	isBorrowed
protected AtomicBoolean	isDebug
protected AtomicBoolean	isInit
protected AtomicBoolean	isLearning
protected AtomicBoolean	isOpen
protected AtomicBoolean	isOver
protected AtomicBoolean	isUsed
protected AtomicLong	lastCycleAllocations
protected AtomicLong	maxCycle
protected MemoryManager	memoryManager
protected Queue<PointersPair>	pinnedAllocations
protected AtomicLong	pinnedAllocationsSize
protected AtomicInteger	pinnedCount
protected MemoryWorkspace	previousWorkspace
protected AtomicBoolean	resetPlanned
protected static long	SAFETY_OFFSET
protected AtomicLong	spilledAllocationsSize
protected AtomicLong	stepsCount
protected int	stepsNumber
protected AtomicInteger	tagScope
protected File	tempFile
protected Long	threadId
protected AtomicBoolean	trimmedMode
protected AtomicLong	trimmedStep
protected PointersPair	workspace
protected WorkspaceConfiguration	workspaceConfiguration
protected MemoryWorkspace.Type	workspaceType

Fields inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

DEFAULT_ID

Constructor Summary

Constructors

Constructor and Description
Nd4jWorkspace(@NonNull WorkspaceConfiguration configuration)
Nd4jWorkspace(@NonNull WorkspaceConfiguration configuration, @NonNull String workspaceId)

Method Summary

Modifier and Type	Method and Description
PagedPointer	alloc(long requiredMemory, DataType type, boolean initialize) This method does allocation from a given Workspace
PagedPointer	alloc(long requiredMemory, MemoryKind kind, DataType type, boolean initialize) This method does allocation from a given Workspace
protected abstract void	clearExternalAllocations()
protected abstract void	clearPinnedAllocations(boolean extended)
void	close() This method is for compatibility with "try-with-resources" java blocks.
void	destroyWorkspace() This method causes Workspace destruction: all memory allocations are released after this call.
void	destroyWorkspace(boolean extended) This method basically deallocates workspace memory
void	enableDebug(boolean reallyEnable) This method enabled debugging mode for this workspace
static void	fillFile(File file, long length)
void	free(org.bytedeco.javacpp.Pointer pointer)
long	getCurrentOffset() This mehtod returns current offset within buffer
long	getCurrentSize() This method returns current amount of memory allocated for workspace.
long	getCyclesCount()
long	getDeviceOffset() This method returns current device memory offset within workspace
long	getGenerationId() This method returns current generation Id
long	getHostOffset() This method returns current host memory offset within workspace
long	getInitialBlockSize() This method returns number of bytes for first block of circular workspace.
long	getLastCycleAllocations() This method returns number of bytes allocated during last full cycle
long	getMaxCycleAllocations() This method returns number of bytes of biggest cycle
int	getNumberOfExternalAllocations() This method returns number of spilled allocations, that can be purged at the end of block
int	getNumberOfPinnedAllocations() This method returns number of pinned allocations, they can be purged after 2 steps.
MemoryWorkspace	getParentWorkspace() This method returns parent Workspace, if any.
long	getPinnedSize() This method returns number of bytes in pinned allocations.
long	getSpilledSize() This method returns number of bytes in spilled allocations.
long	getStepNumber() This method returns step number.
long	getThisCycleAllocations() This method returns number of bytes allocated during THIS cycle
MemoryWorkspace.Type	getWorkspaceType() This method returns Type of this workspace
protected void	init()
void	initializeWorkspace() This method causes Workspace initialization PLEASE NOTE: This call will have no effect on previously initialized Workspace
boolean	isScopeActive() This method returns True if scope was opened, and not closed yet.
MemoryWorkspace	notifyScopeBorrowed() This method TEMPORARY enters this workspace, without reset applied
MemoryWorkspace	notifyScopeEntered() This method notifies given Workspace that new use cycle is starting now
MemoryWorkspace	notifyScopeLeft() This method is shortcut to close() method
void	reset() This method reset host/device offsets within workspace PLEASE NOTE: Never call this method unless you realize all consequences
protected abstract void	resetWorkspace()
MemoryWorkspace	tagOutOfScopeUse() This method temporary disables this workspace
void	toggleWorkspaceUse(boolean isEnabled) This method allows to temporary disable this workspace, and issue allocations directly.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

getDeviceId, getId, getPrimaryOffset, getThreadId, getWorkspaceConfiguration, setPreviousWorkspace

Methods inherited from interface org.nd4j.linalg.api.memory.Deallocatable

deallocator, getUniqueId, targetDevice

Field Detail

deviceId

protected int deviceId

threadId

protected Long threadId

workspaceType

protected MemoryWorkspace.Type workspaceType

SAFETY_OFFSET

protected static final long SAFETY_OFFSET

See Also:

Constant Field Values

id

protected String id

currentSize

protected AtomicLong currentSize

hostOffset

protected AtomicLong hostOffset

deviceOffset

protected AtomicLong deviceOffset

workspace

protected PointersPair workspace

memoryManager

protected MemoryManager memoryManager

isLearning

protected AtomicBoolean isLearning

isUsed

protected AtomicBoolean isUsed

disabledCounter

protected AtomicLong disabledCounter

cyclesCount

protected AtomicLong cyclesCount

stepsCount

protected AtomicLong stepsCount

stepsNumber

protected int stepsNumber

lastCycleAllocations

protected AtomicLong lastCycleAllocations

cycleAllocations

protected AtomicLong cycleAllocations

spilledAllocationsSize

protected AtomicLong spilledAllocationsSize

pinnedAllocationsSize

protected AtomicLong pinnedAllocationsSize

maxCycle

protected AtomicLong maxCycle

resetPlanned

protected AtomicBoolean resetPlanned

isOpen

protected AtomicBoolean isOpen

isInit

protected AtomicBoolean isInit

isOver

protected AtomicBoolean isOver

isBorrowed

protected AtomicBoolean isBorrowed

tagScope

protected AtomicInteger tagScope

isDebug

protected AtomicBoolean isDebug

externalCount

protected AtomicInteger externalCount

pinnedCount

protected AtomicInteger pinnedCount

trimmedMode

protected AtomicBoolean trimmedMode

trimmedStep

protected AtomicLong trimmedStep

workspaceConfiguration

protected final WorkspaceConfiguration workspaceConfiguration

externalAllocations

protected List<PointersPair> externalAllocations

pinnedAllocations

protected Queue<PointersPair> pinnedAllocations

previousWorkspace

protected MemoryWorkspace previousWorkspace

borrowingWorkspace

protected MemoryWorkspace borrowingWorkspace

initialBlockSize

protected AtomicLong initialBlockSize

guid

protected String guid

tempFile

protected File tempFile

generationId

protected AtomicLong generationId

alignmentBase

public static final int alignmentBase

See Also:

Constant Field Values

Constructor Detail

Nd4jWorkspace

public Nd4jWorkspace(@NonNull
                     @NonNull WorkspaceConfiguration configuration)

Nd4jWorkspace

public Nd4jWorkspace(@NonNull
                     @NonNull WorkspaceConfiguration configuration,
                     @NonNull
                     @NonNull String workspaceId)

Method Detail

getWorkspaceType

public MemoryWorkspace.Type getWorkspaceType()

Description copied from interface: MemoryWorkspace

This method returns Type of this workspace

Specified by:

getWorkspaceType in interface MemoryWorkspace

Returns:

fillFile

public static void fillFile(File file,
                            long length)
                     throws Exception

Throws:

Exception

getGenerationId

public long getGenerationId()

Description copied from interface: MemoryWorkspace

This method returns current generation Id

Specified by:

getGenerationId in interface MemoryWorkspace

Returns:

getStepNumber

public long getStepNumber()

This method returns step number. Viable only in circular mode.

Returns:

getSpilledSize

public long getSpilledSize()

This method returns number of bytes in spilled allocations.

Returns:

getPinnedSize

public long getPinnedSize()

This method returns number of bytes in pinned allocations.

Returns:

getInitialBlockSize

public long getInitialBlockSize()

This method returns number of bytes for first block of circular workspace.

Returns:

getParentWorkspace

public MemoryWorkspace getParentWorkspace()

This method returns parent Workspace, if any. Null if there's none.

Specified by:

getParentWorkspace in interface MemoryWorkspace

Returns:

getDeviceOffset

public long getDeviceOffset()

This method returns current device memory offset within workspace

Returns:

getHostOffset

public long getHostOffset()

This method returns current host memory offset within workspace

Returns:

getCurrentSize

public long getCurrentSize()

This method returns current amount of memory allocated for workspace. PLEASE NOTE: It shows only amount of HOST memory. If current backend assumes DEVICE/HOST memory pair, DEVICE memory will probably have the same size, but won't be accounted in this value.

Specified by:

getCurrentSize in interface MemoryWorkspace

Returns:

getCurrentOffset

public long getCurrentOffset()

Description copied from interface: MemoryWorkspace

This mehtod returns current offset within buffer

Specified by:

getCurrentOffset in interface MemoryWorkspace

Returns:

init

protected void init()

alloc

public PagedPointer alloc(long requiredMemory,
                          DataType type,
                          boolean initialize)

Description copied from interface: MemoryWorkspace

This method does allocation from a given Workspace

Specified by:

alloc in interface MemoryWorkspace

Parameters:

requiredMemory - allocation size, in bytes

type - dataType that is going to be used

Returns:

enableDebug

public void enableDebug(boolean reallyEnable)

This method enabled debugging mode for this workspace

Specified by:

enableDebug in interface MemoryWorkspace

Parameters:

reallyEnable -

alloc

public PagedPointer alloc(long requiredMemory,
                          MemoryKind kind,
                          DataType type,
                          boolean initialize)

Description copied from interface: MemoryWorkspace

This method does allocation from a given Workspace

Specified by:

alloc in interface MemoryWorkspace

Parameters:

requiredMemory - allocation size, in bytes

kind - MemoryKind for allocation

type - dataType that is going to be used

Returns:

free

public void free(org.bytedeco.javacpp.Pointer pointer)

initializeWorkspace

public void initializeWorkspace()

Description copied from interface: MemoryWorkspace

This method causes Workspace initialization PLEASE NOTE: This call will have no effect on previously initialized Workspace

Specified by:

initializeWorkspace in interface MemoryWorkspace

getNumberOfExternalAllocations

public int getNumberOfExternalAllocations()

This method returns number of spilled allocations, that can be purged at the end of block

Returns:

getNumberOfPinnedAllocations

public int getNumberOfPinnedAllocations()

This method returns number of pinned allocations, they can be purged after 2 steps. PLEASE NOTE: This method can return non-zero calues only for circular workspace mode

Returns:

destroyWorkspace

public void destroyWorkspace()

Description copied from interface: MemoryWorkspace

This method causes Workspace destruction: all memory allocations are released after this call.

Specified by:

destroyWorkspace in interface MemoryWorkspace

destroyWorkspace

public void destroyWorkspace(boolean extended)

This method basically deallocates workspace memory

Specified by:

destroyWorkspace in interface MemoryWorkspace

Parameters:

extended -

notifyScopeBorrowed

public MemoryWorkspace notifyScopeBorrowed()

This method TEMPORARY enters this workspace, without reset applied

Specified by:

notifyScopeBorrowed in interface MemoryWorkspace

Returns:

getCyclesCount

public long getCyclesCount()

close

public void close()

Description copied from interface: MemoryWorkspace

This method is for compatibility with "try-with-resources" java blocks. Internally it should be equal to notifyScopeLeft() method

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MemoryWorkspace

clearPinnedAllocations

protected abstract void clearPinnedAllocations(boolean extended)

clearExternalAllocations

protected abstract void clearExternalAllocations()

notifyScopeEntered

public MemoryWorkspace notifyScopeEntered()

Description copied from interface: MemoryWorkspace

This method notifies given Workspace that new use cycle is starting now

Specified by:

notifyScopeEntered in interface MemoryWorkspace

Returns:

reset

public void reset()

This method reset host/device offsets within workspace PLEASE NOTE: Never call this method unless you realize all consequences

resetWorkspace

protected abstract void resetWorkspace()

notifyScopeLeft

public MemoryWorkspace notifyScopeLeft()

This method is shortcut to close() method

Specified by:

notifyScopeLeft in interface MemoryWorkspace

Returns:

toggleWorkspaceUse

public void toggleWorkspaceUse(boolean isEnabled)

This method allows to temporary disable this workspace, and issue allocations directly.

Specified by:

toggleWorkspaceUse in interface MemoryWorkspace

Parameters:

isEnabled -

getLastCycleAllocations

public long getLastCycleAllocations()

This method returns number of bytes allocated during last full cycle

Specified by:

getLastCycleAllocations in interface MemoryWorkspace

Returns:

getThisCycleAllocations

public long getThisCycleAllocations()

This method returns number of bytes allocated during THIS cycle

Specified by:

getThisCycleAllocations in interface MemoryWorkspace

Returns:

getMaxCycleAllocations

public long getMaxCycleAllocations()

This method returns number of bytes of biggest cycle

Specified by:

getMaxCycleAllocations in interface MemoryWorkspace

Returns:

isScopeActive

public boolean isScopeActive()

This method returns True if scope was opened, and not closed yet.

Specified by:

isScopeActive in interface MemoryWorkspace

Returns:

tagOutOfScopeUse

public MemoryWorkspace tagOutOfScopeUse()

Description copied from interface: MemoryWorkspace

This method temporary disables this workspace

Specified by:

tagOutOfScopeUse in interface MemoryWorkspace

Returns:

toString

public String toString()

Overrides:

toString in class Object