edu.rice.hj

Class Module2

java.lang.Object

edu.rice.hj.Module0

edu.rice.hj.Module1

edu.rice.hj.Module2

Direct Known Subclasses:

ModuleE, ModuleEventLogging

public class Module2
extends Module1

A facade to all the Habanero-Java operations like isolated, actors, etc. The calls delegate to the actual HjRuntime instance.

Author:

Shams Imam (shams@rice.edu)

Field Summary

Fields inherited from class edu.rice.hj.Module0

runtimeInitialized

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Module2() Private constructor to disallow instance creation.

Method Summary

Modifier and Type	Method and Description
static void	isolated(HjRunnable runnable) Isolated statement identifies a critical section.
static void	isolated(Object[] participants, HjRunnable runnable) Refer to isolated(Object, edu.rice.hj.api.HjRunnable)
static void	isolated(Object participant1, HjRunnable runnable) Mutual exclusion is only guaranteed for instances of isolated statements that have a non-empty intersection in their object lists.
static void	isolated(Object participant1, Object participant2, HjRunnable runnable) Refer to isolated(Object, edu.rice.hj.api.HjRunnable)
static void	isolated(Object participant1, Object participant2, Object participant3, HjRunnable runnable) Refer to isolated(Object, edu.rice.hj.api.HjRunnable)
static <V> V	isolatedWithReturn(HjCallable<V> callable) variant for isolated when the critical section needs to return a value.
static <V> V	isolatedWithReturn(Object[] participants, HjCallable<V> callable) variant for isolated when the critical section needs to return a value.
static <V> V	isolatedWithReturn(Object participant1, HjCallable<V> callable) variant for isolated when the critical section needs to return a value.
static <V> V	isolatedWithReturn(Object participant1, Object participant2, HjCallable<V> callable) variant for isolated when the critical section needs to return a value.
static <V> V	isolatedWithReturn(Object participant1, Object participant2, Object participant3, HjCallable<V> callable) variant for isolated when the critical section needs to return a value.
static <MsgType> HjActor<MsgType>	newActor(HjProcedure<Pair<HjActor<MsgType>,MsgType>> processor) Factory method to create a new Actor instance with the specified message processing body.
static Object	readMode(Object wrappee) Obtain a representation for the wrappee in read mode for use in isolated statements.
static Object	writeMode(Object wrappee) Obtain a representation for the wrappee in write mode for use in isolated statements.

Methods inherited from class edu.rice.hj.Module1

async, asyncAwait, asyncAwait, asyncAwait, asyncAwait, forall, forall, forall, forall, forall, forall, forallChunked, forallChunked, forallChunked, forallChunked, forallChunked, forallChunked, forasync, forasync, forasync, forasync, forasync, forasync, forasyncChunked, forasyncChunked, forasyncChunked, forasyncChunked, forasyncChunked, forseq, forseq, forseq, forseq, forseq, forseq, future, futureAwait, futureAwait, futureAwait, futureAwait

Methods inherited from class edu.rice.hj.Module0

abstractMetrics, asyncNb, asyncNbAt, asyncNbAwait, asyncNbAwait, asyncNbAwait, asyncNbAwait, asyncNbSeq, asyncNbSeq, asyncPhased, asyncPhased, asyncPhased, computeDefaultChunkSize, doWait, doWork, dumpEventLog, emergencyShutdown, finalizeHabanero, finish, finish, finish, finish, finish, forallNb, forallNb, forallNb, forallNb, forallNb, forallNb, forallNbChunked, forallNbChunked, forallNbChunked, forallNbChunked, forallNbChunked, forallNbChunked, forallPhased, forallPhased, forasync, forasyncChunked, forasyncNb, forasyncNb, forasyncNb, forasyncNb, forasyncNb, forasyncNbChunked, forasyncNbChunked, forasyncNbChunked, forasyncNbChunked, forasyncPhased, forasyncPhased, forasyncPhased, forseqNb, forseqNb, forseqNb, forseqNb, forseqNb, forseqNb, futureNb, futureNbAwait, futureNbAwait, futureNbAwait, futureNbAwait, futureNbSeq, futureNbSeq, group, group, here, initializeHabanero, launchHabaneroApp, launchHabaneroApp, myGroup, myGroup, newDataDrivenFuture, newDataDrivenFuture, newDDF, newDDF, newFinishAccumulator, newPhaser, newPhaser, newPoint, newRectangularRegion1D, newRectangularRegion2D, newRectangularRegion3D, next, numPlaces, numWorkerThreads, place, printBuildInfo, signal, waitAll, waitAny

Methods inherited from class java.lang.Object

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

Constructor Detail

Module2

protected Module2()

Private constructor to disallow instance creation.

Method Detail

isolated

public static void isolated(HjRunnable runnable)

Isolated statement identifies a critical section. Two tasks executing isolated statements must perform them in mutual exclusion. Isolated statements may be nested. An inner isolated statement is redundant. Parallel constructs should be avoided inside isolated statements. Isolated statements can never cause a deadlock.

isolatedWithReturn(edu.rice.hj.api.HjCallable) variant available when the critical section needs to return a value.

Parameters:

runnable - The body of the code to run using weak isolation.

See Also:

HjRuntime.isolated(edu.rice.hj.api.HjRunnable)

isolated

public static void isolated(Object participant1,
                            HjRunnable runnable)

Mutual exclusion is only guaranteed for instances of isolated statements that have a non-empty intersection in their object lists. Standard isolated is equivalent to “isolated(*)” by default i.e., isolation across all objects. Isolated statements may be nested only when the nested isolated refers to a subset of object lists from the parent isolated block.

Programmer may also specify list of objects as well as their read-write modes for which isolation is required. Not specifying a mode is the same as specifying a write mode. Distinguish between read/write accesses for further fine-grained mutual exclusion during parallelism.

Parameters:

participant1 - a Object object.

runnable - a HjRunnable object.

See Also:

HjRuntime.isolated(Object[], edu.rice.hj.api.HjRunnable)

isolated

public static void isolated(Object participant1,
                            Object participant2,
                            HjRunnable runnable)

Refer to isolated(Object, edu.rice.hj.api.HjRunnable)

Parameters:

participant1 - a Object object.

participant2 - a Object object.

runnable - a HjRunnable object.

See Also:

HjRuntime.isolated(Object[], edu.rice.hj.api.HjRunnable)

isolated

public static void isolated(Object[] participants,
                            HjRunnable runnable)

Refer to isolated(Object, edu.rice.hj.api.HjRunnable)

Parameters:

participants - an array of Object objects.

runnable - a HjRunnable object.

See Also:

HjRuntime.isolated(Object[], edu.rice.hj.api.HjRunnable)

isolated

public static void isolated(Object participant1,
                            Object participant2,
                            Object participant3,
                            HjRunnable runnable)

Refer to isolated(Object, edu.rice.hj.api.HjRunnable)

Parameters:

participant1 - a Object object.

participant2 - a Object object.

participant3 - a Object object.

runnable - a HjRunnable object.

See Also:

HjRuntime.isolated(Object[], edu.rice.hj.api.HjRunnable)

isolatedWithReturn

public static <V> V isolatedWithReturn(HjCallable<V> callable)

variant for isolated when the critical section needs to return a value. Refer to isolated(edu.rice.hj.api.HjRunnable)

Type Parameters:

V - a V object.

Parameters:

callable - a HjCallable object.

Returns:

a V object.

See Also:

HjRuntime.isolatedWithReturn(edu.rice.hj.api.HjCallable)

isolatedWithReturn

public static <V> V isolatedWithReturn(Object participant1,
                                       HjCallable<V> callable)

variant for isolated when the critical section needs to return a value. Refer to isolated(Object, edu.rice.hj.api.HjRunnable)

Type Parameters:

V - a V object.

Parameters:

participant1 - a Object object.

callable - a HjCallable object.

Returns:

a V object.

See Also:

HjRuntime.isolatedWithReturn(Object[], edu.rice.hj.api.HjCallable)

isolatedWithReturn

public static <V> V isolatedWithReturn(Object participant1,
                                       Object participant2,
                                       HjCallable<V> callable)

variant for isolated when the critical section needs to return a value. Refer to isolated(Object, Object, edu.rice.hj.api.HjRunnable)

Type Parameters:

V - a V object.

Parameters:

participant1 - a Object object.

participant2 - a Object object.

callable - a HjCallable object.

Returns:

a V object.

See Also:

HjRuntime.isolatedWithReturn(Object[], edu.rice.hj.api.HjCallable)

isolatedWithReturn

public static <V> V isolatedWithReturn(Object[] participants,
                                       HjCallable<V> callable)

variant for isolated when the critical section needs to return a value. Refer to isolated(Object[], edu.rice.hj.api.HjRunnable)

Type Parameters:

V - a V object.

Parameters:

participants - an array of Object objects.

callable - a HjCallable object.

Returns:

a V object.

See Also:

HjRuntime.isolatedWithReturn(Object[], edu.rice.hj.api.HjCallable)

isolatedWithReturn

public static <V> V isolatedWithReturn(Object participant1,
                                       Object participant2,
                                       Object participant3,
                                       HjCallable<V> callable)

variant for isolated when the critical section needs to return a value. Refer to isolated(Object, Object, Object, edu.rice.hj.api.HjRunnable)

Type Parameters:

V - a V object.

Parameters:

participant1 - a Object object.

participant2 - a Object object.

participant3 - a Object object.

callable - a HjCallable object.

Returns:

a V object.

See Also:

HjRuntime.isolatedWithReturn(Object[], edu.rice.hj.api.HjCallable)

readMode

public static Object readMode(Object wrappee)

Obtain a representation for the wrappee in read mode for use in isolated statements.

Parameters:

wrappee - a Object object.

Returns:

a Object object.

See Also:

HjRuntime.readMode(Object)

writeMode

public static Object writeMode(Object wrappee)

Obtain a representation for the wrappee in write mode for use in isolated statements.

Parameters:

wrappee - a Object object.

Returns:

a Object object.

See Also:

HjRuntime.writeMode(Object)

newActor

public static <MsgType> HjActor<MsgType> newActor(HjProcedure<Pair<HjActor<MsgType>,MsgType>> processor)

Factory method to create a new Actor instance with the specified message processing body.

Type Parameters:

MsgType - The type of message being processed by the Actor.

Parameters:

processor - The logic that determines how a message is processed by the actor. The processor accepts a Pair where the left element represents the Actor while the right element is the message being currently processed.

Returns:

a new Actor instance with the specified message processing body.