org.apache.flink.runtime.executiongraph

Class ExecutionGraph

java.lang.Object

org.apache.flink.runtime.executiongraph.ExecutionGraph

All Implemented Interfaces:

ExecutionListener

public class ExecutionGraph
extends Object
implements ExecutionListener

In Nephele an execution graph is the main data structure for scheduling, executing and observing a job. An execution graph is created from an job graph. In contrast to a job graph it can contain communication edges of specific types, sub groups of vertices and information on when and where (on which instance) to run particular tasks.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
ExecutionGraph(JobGraph job, int defaultParallelism) Creates a new execution graph from a job graph.

Method Summary

Methods

Modifier and Type	Method and Description
void	executeCommand(Runnable command) Performs an asynchronous update operation to this execution graph.
void	executionStateChanged(JobID jobID, ExecutionVertexID vertexID, ExecutionState newExecutionState, String optionalMessage) Called when the execution state of the associated task has changed.
ChannelType	getChannelType(ExecutionVertex sourceVertex, ExecutionVertex targetVertex)
ExecutionStage	getCurrentExecutionStage() Returns the stage which is currently executed.
ExecutionEdge	getEdgeByID(ChannelID id) Finds an ExecutionEdge by its ID and returns it.
int	getIndexOfCurrentExecutionStage() Returns the index of the current execution stage.
ExecutionVertex	getInputVertex(int index) Returns the input vertex with the specified index.
ExecutionVertex	getInputVertex(int stage, int index) Returns the input vertex with the specified index for the given stage
Configuration	getJobConfiguration() Returns the job configuration that was originally attached to the job graph.
JobID	getJobID() Returns the job ID of the job configuration this execution graph was originally constructed from.
String	getJobName() Returns the name of the original job graph.
InternalJobStatus	getJobStatus() Returns the current status of the job represented by this execution graph.
int	getNumberOfInputVertices() Returns the number of input vertices registered with this execution graph.
int	getNumberOfInputVertices(int stage) Returns the number of input vertices for the given stage.
int	getNumberOfOutputVertices() Returns the number of output vertices registered with this execution graph.
int	getNumberOfOutputVertices(int stage) Returns the number of output vertices for the given stage.
int	getNumberOfStages() Returns the number of execution stages in the execution graph.
ExecutionVertex	getOutputVertex(int index) Returns the output vertex with the specified index.
ExecutionVertex	getOutputVertex(int stage, int index) Returns the output vertex with the specified index for the given stage.
int	getPriority() Returns the priority of the execution listener object.
int	getRequiredSlots() Retrieves the number of required slots to run this execution graph
ExecutionStage	getStage(int num) Returns the execution stage with number num.
ExecutionVertex	getVertexByChannelID(ChannelID id) Identifies an execution by the specified channel ID and returns it.
ExecutionVertex	getVertexByID(ExecutionVertexID id) Returns the execution vertex with the given vertex ID.
boolean	isExecutionFinished() Checks if the execution of execution graph is finished.
Iterator<ExecutionStage>	iterator() Returns an iterator over all execution stages contained in this graph.
void	registerExecutionStageListener(ExecutionStageListener executionStageListener) Registers a new ExecutionStageListener object with this execution graph.
void	registerJobStatusListener(JobStatusListener jobStatusListener) Registers a new JobStatusListener object with this execution graph.
void	repairInstanceAssignment()
void	repairInstanceSharing()
void	repairStages()
void	unregisterExecutionStageListener(ExecutionStageListener executionStageListener) Unregisters the given ExecutionStageListener object.
void	unregisterJobStatusListener(JobStatusListener jobStatusListener) Unregisters the given JobStatusListener object.
void	updateJobStatus(InternalJobStatus newJobStatus, String optionalMessage) Updates the job status to given status and triggers the execution of the JobStatusListener objects.
void	userThreadFinished(JobID jobID, ExecutionVertexID vertexID, Thread userThread) Called when a thread spawn by a user task has finished.
void	userThreadStarted(JobID jobID, ExecutionVertexID vertexID, Thread userThread) Called when the user task has started a new thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionGraph

public ExecutionGraph(JobGraph job,
              int defaultParallelism)
               throws GraphConversionException

Creates a new execution graph from a job graph.

Parameters:

job - the user's job graph

defaultParallelism - defaultParallelism in case that nodes have no parallelism set

Throws:

GraphConversionException - thrown if the job graph is not valid and no execution graph can be constructed from it

Method Detail

getNumberOfInputVertices

public int getNumberOfInputVertices()

Returns the number of input vertices registered with this execution graph.

Returns:

the number of input vertices registered with this execution graph

getNumberOfInputVertices

public int getNumberOfInputVertices(int stage)

Returns the number of input vertices for the given stage.

Parameters:

stage - the index of the execution stage

Returns:

the number of input vertices for the given stage

getNumberOfOutputVertices

public int getNumberOfOutputVertices()

Returns the number of output vertices registered with this execution graph.

Returns:

the number of output vertices registered with this execution graph

getNumberOfOutputVertices

public int getNumberOfOutputVertices(int stage)

Returns the number of output vertices for the given stage.

Parameters:

stage - the index of the execution stage

Returns:

the number of input vertices for the given stage

getInputVertex

public ExecutionVertex getInputVertex(int index)

Returns the input vertex with the specified index.

Parameters:

index - the index of the input vertex to return

Returns:

the input vertex with the specified index or null if no input vertex with such an index exists

getOutputVertex

public ExecutionVertex getOutputVertex(int index)

Returns the output vertex with the specified index.

Parameters:

index - the index of the output vertex to return

Returns:

the output vertex with the specified index or null if no output vertex with such an index exists

getInputVertex

public ExecutionVertex getInputVertex(int stage,
                             int index)

Returns the input vertex with the specified index for the given stage

Parameters:

stage - the index of the stage

index - the index of the input vertex to return

Returns:

the input vertex with the specified index or null if no input vertex with such an index exists in that stage

getOutputVertex

public ExecutionVertex getOutputVertex(int stage,
                              int index)

Returns the output vertex with the specified index for the given stage.

Parameters:

stage - the index of the stage

index - the index of the output vertex to return

Returns:

the output vertex with the specified index or null if no output vertex with such an index exists in that stage

getStage

public ExecutionStage getStage(int num)

Returns the execution stage with number num.

Parameters:

num - the number of the execution stage to be returned

Returns:

the execution stage with number num or null if no such execution stage exists

getNumberOfStages

public int getNumberOfStages()

Returns the number of execution stages in the execution graph.

Returns:

the number of execution stages in the execution graph

getVertexByChannelID

public ExecutionVertex getVertexByChannelID(ChannelID id)

Identifies an execution by the specified channel ID and returns it.

Parameters:

id - the channel ID to identify the vertex with

Returns:

the execution vertex which has a channel with ID id or null if no such vertex exists in the execution graph

getEdgeByID

public ExecutionEdge getEdgeByID(ChannelID id)

Finds an ExecutionEdge by its ID and returns it.

Parameters:

id - the channel ID to identify the edge

Returns:

the edge whose ID matches id or null if no such edge is known

getVertexByID

public ExecutionVertex getVertexByID(ExecutionVertexID id)

Returns the execution vertex with the given vertex ID.

Parameters:

id - the vertex ID to retrieve the execution vertex

Returns:

the execution vertex matching the provided vertex ID or null if no such vertex could be found

isExecutionFinished

public boolean isExecutionFinished()

Checks if the execution of execution graph is finished.

Returns:

true if the execution of the graph is finished, false otherwise

getJobID

public JobID getJobID()

Returns the job ID of the job configuration this execution graph was originally constructed from.

Returns:

the job ID of the job configuration this execution graph was originally constructed from

getIndexOfCurrentExecutionStage

public int getIndexOfCurrentExecutionStage()

Returns the index of the current execution stage.

Returns:

the index of the current execution stage

getCurrentExecutionStage

public ExecutionStage getCurrentExecutionStage()

Returns the stage which is currently executed.

Returns:

the currently executed stage or null if the job execution is already completed

repairStages

public void repairStages()

repairInstanceSharing

public void repairInstanceSharing()

repairInstanceAssignment

public void repairInstanceAssignment()

getChannelType

public ChannelType getChannelType(ExecutionVertex sourceVertex,
                         ExecutionVertex targetVertex)

getJobConfiguration

public Configuration getJobConfiguration()

Returns the job configuration that was originally attached to the job graph.

Returns:

the job configuration that was originally attached to the job graph

getJobStatus

public InternalJobStatus getJobStatus()

Returns the current status of the job represented by this execution graph.

Returns:

the current status of the job

executionStateChanged

public void executionStateChanged(JobID jobID,
                         ExecutionVertexID vertexID,
                         ExecutionState newExecutionState,
                         String optionalMessage)

Description copied from interface: ExecutionListener

Called when the execution state of the associated task has changed. It is important to point out that multiple execution listeners can be invoked as a reaction to a state change, according to their priority. As a result, the value of newExecutionState may be out-dated by the time a particular execution listener is called. To determine the most recent state of the respective task, it is recommended to store a reference on the execution that represents it and then call getExecutionState() on the vertex within this method.

Specified by:

executionStateChanged in interface ExecutionListener

Parameters:

jobID - the ID of the job the task belongs to

vertexID - the ID of the task whose state has changed

newExecutionState - the execution state the task has just switched to

optionalMessage - an optional message providing further information on the state change

updateJobStatus

public void updateJobStatus(InternalJobStatus newJobStatus,
                   String optionalMessage)

Updates the job status to given status and triggers the execution of the JobStatusListener objects.

Parameters:

newJobStatus - the new job status

optionalMessage - an optional message providing details on the reasons for the state change

registerJobStatusListener

public void registerJobStatusListener(JobStatusListener jobStatusListener)

Registers a new JobStatusListener object with this execution graph. After being registered the object will receive notifications about changes of the job status. It is not possible to register the same listener object twice.

Parameters:

jobStatusListener - the listener object to register

unregisterJobStatusListener

public void unregisterJobStatusListener(JobStatusListener jobStatusListener)

Unregisters the given JobStatusListener object. After having called this method, the object will no longer receive notifications about changes of the job status.

Parameters:

jobStatusListener - the listener object to unregister

registerExecutionStageListener

public void registerExecutionStageListener(ExecutionStageListener executionStageListener)

Registers a new ExecutionStageListener object with this execution graph. After being registered the object will receive a notification whenever the job has entered its next execution stage. Note that a notification is not sent when the job has entered its initial execution stage.

Parameters:

executionStageListener - the listener object to register

unregisterExecutionStageListener

public void unregisterExecutionStageListener(ExecutionStageListener executionStageListener)

Unregisters the given ExecutionStageListener object. After having called this method, the object will no longer receiver notifications about the execution stage progress.

Parameters:

executionStageListener - the listener object to unregister

getJobName

public String getJobName()

Returns the name of the original job graph.

Returns:

the name of the original job graph, possibly null

userThreadStarted

public void userThreadStarted(JobID jobID,
                     ExecutionVertexID vertexID,
                     Thread userThread)

Description copied from interface: ExecutionListener

Called when the user task has started a new thread.

Specified by:

userThreadStarted in interface ExecutionListener

Parameters:

jobID - the ID of the job the task belongs to

vertexID - the ID of the task that started of new thread

userThread - the user thread which has been started

userThreadFinished

public void userThreadFinished(JobID jobID,
                      ExecutionVertexID vertexID,
                      Thread userThread)

Description copied from interface: ExecutionListener

Called when a thread spawn by a user task has finished.

Specified by:

userThreadFinished in interface ExecutionListener

Parameters:

jobID - the ID of the job the task belongs to

vertexID - the ID of the task whose thread has finished

userThread - the user thread which has finished

iterator

public Iterator<ExecutionStage> iterator()

Returns an iterator over all execution stages contained in this graph.

Returns:

an iterator over all execution stages contained in this graph

getPriority

public int getPriority()

Description copied from interface: ExecutionListener

Returns the priority of the execution listener object. If multiple execution listener objects are registered for a given vertex, the priority determines in which order they will be called. Priorities are expressed as non-negative integer values. The lower the integer value, the higher the call priority.

Specified by:

getPriority in interface ExecutionListener

Returns:

the priority of this execution listener

executeCommand

public void executeCommand(Runnable command)

Performs an asynchronous update operation to this execution graph.

Parameters:

command - the update command to be asynchronously executed on this graph

getRequiredSlots

public int getRequiredSlots()

Retrieves the number of required slots to run this execution graph

Returns: