edu.rice.hj.runtime.phasers

Class PhaserManagerImpl

java.lang.Object

edu.rice.hj.runtime.phasers.PhaserManagerImpl

All Implemented Interfaces:

ActivityListeners.ActivityListener, PhaserManager

public final class PhaserManagerImpl
extends Object
implements PhaserManager

PhaserManagerImpl class.

Author:

Shams Imam (shams@rice.edu)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhaserManagerImpl.PhaserEventType

Constructor Summary

Constructors

Constructor and Description
PhaserManagerImpl(PropertyChangeListener changeListener) No-args constructor.

Method Summary

Modifier and Type	Method and Description
void	checkPhaserUse(InternalPhaser ph, HjPhaserMode prm) Validates the use of a phaser in the current context.
protected void	deregisterPhasers(HabaneroActivity activity) deregisterPhasers.
void	doNext(HabaneroActivity activity) Performs a next operation with the given activity.
protected int	doNextSinglePhase1(HabaneroActivity activity, String loc) doNextSinglePhase1.
protected void	doNextSinglePhase2(HabaneroActivity activity) doNextSinglePhase2.
void	doSignal(HabaneroActivity activity, boolean earlySignal) Performs a phaser signal operation with the given activity.
void	doSignal(HabaneroActivity activity, InternalPhaser phaser, boolean earlySignal, boolean fromDrop) Performs a signal operation with the given activity.
void	doWait(HabaneroActivity activity) Performs a phaser wait operation with the given activity.
void	doWait(HabaneroActivity activity, InternalPhaser phaser) Performs a wait operation with the given activity.
boolean	doWaitForNextSinglePhase1(HabaneroActivity activity, InternalPhaser phaser, String loc) Performs the first stage wait operation with the given activity in next-with-signal mode.
void	doWaitForNextSinglePhase2(HabaneroActivity activity, InternalPhaser phaser) Performs the second stage wait operation with the given activity in next-with-signal mode.
boolean	dropPhaser(HabaneroActivity activity, InternalPhaser phaser, boolean activityEndSignal) Drops the phaser registered with an activity.
int	getSigPhase(HabaneroActivity activity, InternalPhaser phaser) getSigPhase.
int	getWaitPhase(HabaneroActivity activity, InternalPhaser phaser) getWaitPhase.
void	inheritPhasers(HabaneroActivity parentActivity, HabaneroActivity childActivity) Registers a phaser to the specified activity.
<T> void	onActivityDependenciesReady(HabaneroActivity activity, List<HjFuture<T>> dependencies) Callback for the event when all the activities dependencies are ready.
void	onActivityEnd(HabaneroActivity activity, FinishState finishState, Throwable throwable) Callback for when the event ends execution.
void	onActivityResume(HabaneroActivity activity) Callback for when the event execution is resumed.
void	onActivitySpawn(HabaneroActivity parentActivity, HabaneroActivity childActivity) Callback for when the event ends execution.
void	onActivityStart(HabaneroActivity activity) Callback for when the event starts execution.
void	onActivitySuspend(HabaneroActivity activity) Callback for when the event execution is suspended.
void	onFinishScopeStart(HabaneroActivity activity, FinishState finishState)
void	onPhaserReady(HabaneroActivity activity, List<HjPhaserPair> phaserPairList) Callback for the event when phasers are created
void	onPostFinishScopeEnd(HabaneroActivity activity, FinishState finishState)
void	onPreFinishScopeEnd(HabaneroActivity activity, FinishState finishState)
HjPhaserMode	phaserMode(HabaneroActivity activity, InternalPhaser phaser) phaserMode.
void	register(HabaneroActivity parentActivity, HabaneroActivity childActivity, InternalPhaser phaser, HjPhaserMode phaserMode) register.
boolean	registered(HabaneroActivity activity, InternalPhaser phaser) registered.
void	registerPhaserToIEF(HabaneroActivity activity, InternalPhaser phaser) Registers a phaser to the immediately enclosing finish defined by the activity.
protected void	resume(HabaneroActivity activity, InternalPhaser phaser, boolean newValue) resume.
boolean	resumed(HabaneroActivity activity, InternalPhaser phaser) resumed.
protected static void	throwPhaserException(String message) Drops all phasers registered with the current finish state. throws PhaserException with the specified message
String	toString()
void	updateActivityFromCompanion(HabaneroActivity activity, CompanionMetrics companionMetrics)
void	updateCompanionFromActivity(HabaneroActivity activity, CompanionMetrics companionMetrics)

Methods inherited from class java.lang.Object

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

Constructor Detail

PhaserManagerImpl

public PhaserManagerImpl(PropertyChangeListener changeListener)

No-args constructor.

Parameters:

changeListener - a PropertyChangeListener object.

Method Detail

checkPhaserUse

public void checkPhaserUse(InternalPhaser ph,
                           HjPhaserMode prm)

Description copied from interface: PhaserManager

Validates the use of a phaser in the current context.

Specified by:

checkPhaserUse in interface PhaserManager

Parameters:

ph - The phaser

prm - The phaser mode

throwPhaserException

protected static void throwPhaserException(String message)

Drops all phasers registered with the current finish state. throws PhaserException with the specified message

Parameters:

message - The Exception message

Throws:

PhaserException - with the specified message

inheritPhasers

public void inheritPhasers(HabaneroActivity parentActivity,
                           HabaneroActivity childActivity)

Registers a phaser to the specified activity.

Specified by:

inheritPhasers in interface PhaserManager

Parameters:

parentActivity - The activity to inherit phasers from.

childActivity - The new child activity.

register

public void register(HabaneroActivity parentActivity,
                     HabaneroActivity childActivity,
                     InternalPhaser phaser,
                     HjPhaserMode phaserMode)

register.

Specified by:

register in interface PhaserManager

Parameters:

parentActivity - The activity to inherit phasers from.

childActivity - The new child activity.

phaser - The new phaser to inherit

phaserMode - The phaser registration mode

registerPhaserToIEF

public void registerPhaserToIEF(HabaneroActivity activity,
                                InternalPhaser phaser)

Registers a phaser to the immediately enclosing finish defined by the activity.

Specified by:

registerPhaserToIEF in interface PhaserManager

Parameters:

activity - The activity which determines the IEF.

phaser - The phaser to register to the IEF.

dropPhaser

public boolean dropPhaser(HabaneroActivity activity,
                          InternalPhaser phaser,
                          boolean activityEndSignal)

Drops the phaser registered with an activity.

Specified by:

dropPhaser in interface PhaserManager

Parameters:

activity - The activity from which to drop the phaser.

phaser - The phaser to drop.

activityEndSignal - Whether the phaser is dropped in an activity end event

Returns:

a boolean.

registered

public boolean registered(HabaneroActivity activity,
                          InternalPhaser phaser)

registered.

Specified by:

registered in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

whether the phaser is registered with the activity.

resumed

public boolean resumed(HabaneroActivity activity,
                       InternalPhaser phaser)

resumed.

Specified by:

resumed in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

whether the phaser has been resumed.

phaserMode

public HjPhaserMode phaserMode(HabaneroActivity activity,
                               InternalPhaser phaser)

phaserMode.

Specified by:

phaserMode in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

the mode in which the phaser was registered with this activity.

getSigPhase

public int getSigPhase(HabaneroActivity activity,
                       InternalPhaser phaser)

getSigPhase.

Specified by:

getSigPhase in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

The signal phase of the phaser in the specified activity.

getWaitPhase

public int getWaitPhase(HabaneroActivity activity,
                        InternalPhaser phaser)

getWaitPhase.

Specified by:

getWaitPhase in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

The wait phase of the phaser in the specified activity.

doNext

public void doNext(HabaneroActivity activity)
            throws SuspendableException

Performs a next operation with the given activity.

Specified by:

doNext in interface PhaserManager

Parameters:

activity - The activity.

Throws:

SuspendableException

doSignal

public void doSignal(HabaneroActivity activity,
                     boolean earlySignal)

Performs a phaser signal operation with the given activity.

Specified by:

doSignal in interface PhaserManager

Parameters:

activity - The activity.

earlySignal - Flag determining whether this is an eager signal

doSignal

public void doSignal(HabaneroActivity activity,
                     InternalPhaser phaser,
                     boolean earlySignal,
                     boolean fromDrop)

Performs a signal operation with the given activity.

Specified by:

doSignal in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

earlySignal - Flag determining whether this is an eager signal

fromDrop - Flag determining whether this signal came from a drop call (to prevent double signal logging)

doWait

public void doWait(HabaneroActivity activity)
            throws SuspendableException

Performs a phaser wait operation with the given activity.

Specified by:

doWait in interface PhaserManager

Parameters:

activity - The activity.

Throws:

SuspendableException

doWait

public void doWait(HabaneroActivity activity,
                   InternalPhaser phaser)
            throws SuspendableException

Performs a wait operation with the given activity.

Specified by:

doWait in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Throws:

SuspendableException

doWaitForNextSinglePhase1

public boolean doWaitForNextSinglePhase1(HabaneroActivity activity,
                                         InternalPhaser phaser,
                                         String loc)
                                  throws SuspendableException

Performs the first stage wait operation with the given activity in next-with-signal mode.

Specified by:

doWaitForNextSinglePhase1 in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

loc - The location of the next operation

Returns:

a boolean.

Throws:

SuspendableException

doWaitForNextSinglePhase2

public void doWaitForNextSinglePhase2(HabaneroActivity activity,
                                      InternalPhaser phaser)
                               throws SuspendableException

Performs the second stage wait operation with the given activity in next-with-signal mode.

Specified by:

doWaitForNextSinglePhase2 in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Throws:

SuspendableException

onActivityStart

public void onActivityStart(HabaneroActivity activity)

Callback for when the event starts execution.

Specified by:

onActivityStart in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity being started.

onActivitySuspend

public void onActivitySuspend(HabaneroActivity activity)

Callback for when the event execution is suspended.

Specified by:

onActivitySuspend in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity being suspended.

onActivityResume

public void onActivityResume(HabaneroActivity activity)

Callback for when the event execution is resumed.

Specified by:

onActivityResume in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity being resumed.

onActivityEnd

public void onActivityEnd(HabaneroActivity activity,
                          FinishState finishState,
                          Throwable throwable)

Callback for when the event ends execution.

Specified by:

onActivityEnd in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that is ending.

finishState - The root finish state associated with the activity

onActivityDependenciesReady

public <T> void onActivityDependenciesReady(HabaneroActivity activity,
                                            List<HjFuture<T>> dependencies)

Callback for the event when all the activities dependencies are ready.

Specified by:

onActivityDependenciesReady in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that is ready to execute.

dependencies - The dependencies of the activity

onPhaserReady

public void onPhaserReady(HabaneroActivity activity,
                          List<HjPhaserPair> phaserPairList)

Description copied from interface: ActivityListeners.ActivityListener

Callback for the event when phasers are created

Specified by:

onPhaserReady in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that is ready to execute.

phaserPairList - The a list of phasers of HjPhaserPair type

onActivitySpawn

public void onActivitySpawn(HabaneroActivity parentActivity,
                            HabaneroActivity childActivity)

Callback for when the event ends execution.

Specified by:

onActivitySpawn in interface ActivityListeners.ActivityListener

Parameters:

parentActivity - The parent activity.

childActivity - The child activity that was spawned.

onFinishScopeStart

public void onFinishScopeStart(HabaneroActivity activity,
                               FinishState finishState)

Specified by:

onFinishScopeStart in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity running the finish scope

finishState - The finish state associated with the activity

onPreFinishScopeEnd

public void onPreFinishScopeEnd(HabaneroActivity activity,
                                FinishState finishState)

Specified by:

onPreFinishScopeEnd in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that ran the finish scope

finishState - The finish state associated with the activity

onPostFinishScopeEnd

public void onPostFinishScopeEnd(HabaneroActivity activity,
                                 FinishState finishState)

Specified by:

onPostFinishScopeEnd in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that ran the finish scope

finishState - The finish state associated with the activity

updateCompanionFromActivity

public void updateCompanionFromActivity(HabaneroActivity activity,
                                        CompanionMetrics companionMetrics)

Specified by:

updateCompanionFromActivity in interface ActivityListeners.ActivityListener

updateActivityFromCompanion

public void updateActivityFromCompanion(HabaneroActivity activity,
                                        CompanionMetrics companionMetrics)

Specified by:

updateActivityFromCompanion in interface ActivityListeners.ActivityListener

deregisterPhasers

protected void deregisterPhasers(HabaneroActivity activity)

deregisterPhasers.

Parameters:

activity - a HabaneroActivity object.

resume

protected void resume(HabaneroActivity activity,
                      InternalPhaser phaser,
                      boolean newValue)

resume.

Parameters:

activity - a HabaneroActivity object.

phaser - a InternalPhaser object.

newValue - a boolean.

doNextSinglePhase1

protected int doNextSinglePhase1(HabaneroActivity activity,
                                 String loc)
                          throws SuspendableException

doNextSinglePhase1.

Parameters:

activity - a HabaneroActivity object.

loc - a String object.

Returns:

a int.

Throws:

SuspendableException

doNextSinglePhase2

protected void doNextSinglePhase2(HabaneroActivity activity)
                           throws SuspendableException

doNextSinglePhase2.

Parameters:

activity - a HabaneroActivity object.

Throws:

SuspendableException

toString

public String toString()

Overrides:

toString in class Object