edu.rice.hj.runtime.baseruntime

Class EventLogger

java.lang.Object

edu.rice.hj.runtime.baseruntime.EventLogger

All Implemented Interfaces:

HjEventLogger, ActivityListeners.ActivityListener

public final class EventLogger
extends Object
implements HjEventLogger, ActivityListeners.ActivityListener

Utility class that tracks events occurring in the Habanero runtime. Tracked events include (but not limited to):

• Finish scope start
• Finish scope end
• Task spawn
• Task start
• Task end

Author:

Yoko Li (yoko.li@rice.edu), Peter Elmers (peter.elmers@rice.edu), Shams Imam (shams@rice.edu)

Nested Class Summary

Nested classes/interfaces inherited from interface edu.rice.hj.api.HjEventLogger

HjEventLogger.EventType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventLogger()

Method Summary

Modifier and Type	Method and Description
void	dumpEventLog(PrintStream printStream) Dumps the events tracked by the runtime.
void	dumpEventLog(URL url, File javaFile) Send the eventLog to an HJ-Viz server running at URL.
long	eventCount() Return the number of events logged.
Map<HjEventLogger.EventType,Long>	eventFrequencies() Return the frequency of each type of event logged.
<T> void	onActivityDependenciesReady(HabaneroActivity activity, List<HjFuture<T>> dependencies) Callback for the event when all the activities dependencies are ready.
void	onActivityDoWork(HabaneroActivity activity, long workUnits)
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	onActorMsgProcessed(Actor actor, HabaneroActivity activity, String message)
void	onActorMsgReceived(Actor actor, HabaneroActivity activity, String message, long parentId)
void	onActorMsgSent(Actor actor, HabaneroActivity activity, String message)
void	onDDFStore(HabaneroActivity activity, int futureId)
void	onFinishScopeStart(HabaneroActivity activity, FinishState finishState)
void	onFutureRestore(HabaneroActivity activity, int futureId)
void	onFutureStore(HabaneroActivity activity, long futureActivityId)
void	onIsolationEnd(HabaneroActivity activity, int[] lockIds, int[] lockModes)
void	onIsolationStart(HabaneroActivity activity, int[] lockIds, int[] lockModes)
void	onPhaserActivityDropped(HabaneroActivity activity, InternalPhaser phaser, int phase)
void	onPhaserFinishDropped(HabaneroActivity activity, InternalPhaser phaser, int phase)
void	onPhaserReady(HabaneroActivity activity, List<HjPhaserPair> phaserList) Callback for the event when phasers are created
void	onPhaserSignal(HabaneroActivity activity, InternalPhaser phaser)
void	onPhaserWait(HabaneroActivity activity, InternalPhaser phaser)
void	onPostFinishScopeEnd(HabaneroActivity activity, FinishState finishState)
void	onPreFinishScopeEnd(HabaneroActivity activity, FinishState finishState)
void	setActivityLabel(String label) Label an activity with some string.
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, toString, wait, wait, wait

Constructor Detail

EventLogger

protected EventLogger()

Method Detail

dumpEventLog

public void dumpEventLog(PrintStream printStream)

Dumps the events tracked by the runtime.

Specified by:

dumpEventLog in interface HjEventLogger

Parameters:

printStream - The stream to use while dumping the events.

dumpEventLog

public void dumpEventLog(URL url,
                         File javaFile)

Send the eventLog to an HJ-Viz server running at URL.

Specified by:

dumpEventLog in interface HjEventLogger

Parameters:

url - the URL to the HJ-Viz server

javaFile - File representing path to the Java source code

eventCount

public long eventCount()

Return the number of events logged.

Specified by:

eventCount in interface HjEventLogger

Returns:

the number of events logged.

eventFrequencies

public Map<HjEventLogger.EventType,Long> eventFrequencies()

Return the frequency of each type of event logged.

Specified by:

eventFrequencies in interface HjEventLogger

Returns:

the frequency of each type of event logged.

setActivityLabel

public void setActivityLabel(String label)

Label an activity with some string.

Specified by:

setActivityLabel in interface HjEventLogger

Parameters:

label - String to label an activity

onActivityStart

public void onActivityStart(HabaneroActivity activity)

Description copied from interface: ActivityListeners.ActivityListener

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)

Description copied from interface: ActivityListeners.ActivityListener

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)

Description copied from interface: ActivityListeners.ActivityListener

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)

Description copied from interface: ActivityListeners.ActivityListener

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

onActivitySpawn

public void onActivitySpawn(HabaneroActivity parentActivity,
                            HabaneroActivity childActivity)

Description copied from interface: ActivityListeners.ActivityListener

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.

onActivityDependenciesReady

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

Description copied from interface: ActivityListeners.ActivityListener

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> phaserList)

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.

phaserList - The a list of phasers of HjPhaserPair type

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

onIsolationStart

public void onIsolationStart(HabaneroActivity activity,
                             int[] lockIds,
                             int[] lockModes)

onIsolationEnd

public void onIsolationEnd(HabaneroActivity activity,
                           int[] lockIds,
                           int[] lockModes)

onFutureStore

public void onFutureStore(HabaneroActivity activity,
                          long futureActivityId)

onPhaserSignal

public void onPhaserSignal(HabaneroActivity activity,
                           InternalPhaser phaser)

onPhaserWait

public void onPhaserWait(HabaneroActivity activity,
                         InternalPhaser phaser)

onPhaserActivityDropped

public void onPhaserActivityDropped(HabaneroActivity activity,
                                    InternalPhaser phaser,
                                    int phase)

onPhaserFinishDropped

public void onPhaserFinishDropped(HabaneroActivity activity,
                                  InternalPhaser phaser,
                                  int phase)

onFutureRestore

public void onFutureRestore(HabaneroActivity activity,
                            int futureId)

onDDFStore

public void onDDFStore(HabaneroActivity activity,
                       int futureId)

onActorMsgSent

public void onActorMsgSent(Actor actor,
                           HabaneroActivity activity,
                           String message)

onActorMsgReceived

public void onActorMsgReceived(Actor actor,
                               HabaneroActivity activity,
                               String message,
                               long parentId)

onActorMsgProcessed

public void onActorMsgProcessed(Actor actor,
                                HabaneroActivity activity,
                                String message)

onActivityDoWork

public void onActivityDoWork(HabaneroActivity activity,
                             long workUnits)