net.openhft.affinity

Class NonForkingAffinityLock

java.lang.Object

net.openhft.affinity.AffinityLock

net.openhft.affinity.NonForkingAffinityLock

All Implemented Interfaces:

Closeable, AutoCloseable, ThreadLifecycleListener

public class NonForkingAffinityLock
extends AffinityLock
implements ThreadLifecycleListener

Field Summary

Fields inherited from class net.openhft.affinity.AffinityLock

AFFINITY_RESERVED, BASE_AFFINITY, PROCESSORS, RESERVED_AFFINITY

Method Summary

Methods

Modifier and Type	Method and Description
static AffinityLock	acquireCore() Assign any free core to this thread.
static AffinityLock	acquireCore(boolean bind) Assign a core(and all its cpus) which can be bound to the current thread or another thread.
static AffinityLock	acquireLock() Assign any free cpu to this thread.
static AffinityLock	acquireLock(boolean bind) Assign a cpu which can be bound to the current thread or another thread.
void	bind(boolean wholeCore) Bind the current thread to this reservable lock.
static CpuLayout	cpuLayout()
static void	cpuLayout(CpuLayout cpuLayout) Set the CPU layout for this machine.
static String	dumpLocks()
void	release() Release the current AffinityLock which can be discarded.
void	started(Thread t) The specified thread is about to be started.
void	startFailed(Thread t) The specified thread failed to start.
void	terminated(Thread t) The specified thread has been terminated.

Methods inherited from class net.openhft.affinity.AffinityLock

acquireLock, bind, close, cpuId, finalize, isAllocated, isBound, main, toString

Methods inherited from class java.lang.Object

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

Method Detail

acquireLock

public static AffinityLock acquireLock()

Assign any free cpu to this thread.

Returns:

A handle for the current AffinityLock.

acquireCore

public static AffinityLock acquireCore()

Assign any free core to this thread.

In reality, only one cpu is assigned, the rest of the threads for that core are reservable so they are not used.

Returns:

A handle for the current AffinityLock.

acquireLock

public static AffinityLock acquireLock(boolean bind)

Assign a cpu which can be bound to the current thread or another thread.

This can be used for defining your thread layout centrally and passing the handle via dependency injection.

Parameters:

bind - if true, bind the current thread, if false, reserve a cpu which can be bound later.

Returns:

A handle for an affinity lock.

acquireCore

public static AffinityLock acquireCore(boolean bind)

Assign a core(and all its cpus) which can be bound to the current thread or another thread.

This can be used for defining your thread layout centrally and passing the handle via dependency injection.

Parameters:

bind - if true, bind the current thread, if false, reserve a cpu which can be bound later.

Returns:

A handle for an affinity lock.

cpuLayout

public static void cpuLayout(@NotNull
             CpuLayout cpuLayout)

Set the CPU layout for this machine. CPUs which are not mentioned will be ignored.

Changing the layout will have no impact on thread which have already been assigned. It only affects subsequent assignments.

Parameters:

cpuLayout - for this application to use for this machine.

cpuLayout

@NotNull
public static CpuLayout cpuLayout()

Returns:

The current CpuLayout for the application.

dumpLocks

@NotNull
public static String dumpLocks()

Returns:

All the current locks as a String.

bind

public void bind(boolean wholeCore)

Description copied from class: AffinityLock

Bind the current thread to this reservable lock.

Overrides:

bind in class AffinityLock

Parameters:

wholeCore - if true, also reserve the whole core.

release

public void release()

Description copied from class: AffinityLock

Release the current AffinityLock which can be discarded.

Overrides:

release in class AffinityLock

started

public void started(Thread t)

Description copied from interface: ThreadLifecycleListener

The specified thread is about to be started.

Specified by:

started in interface ThreadLifecycleListener

Parameters:

t - the thread which is being started

startFailed

public void startFailed(Thread t)

Description copied from interface: ThreadLifecycleListener

The specified thread failed to start.

Specified by:

startFailed in interface ThreadLifecycleListener

Parameters:

t - the thread that had a failed start

terminated

public void terminated(Thread t)

Description copied from interface: ThreadLifecycleListener

The specified thread has been terminated.

Specified by:

terminated in interface ThreadLifecycleListener

Parameters:

t - the thread that has been terminated