ExecStreamGraph Class Reference

An ExecStreamGraph is a directed graph representing dataflow among ExecStreams. More...

#include <ExecStreamGraph.h>

Inheritance diagram for ExecStreamGraph:


Public Member Functions
virtual	~ExecStreamGraph ()
ExecStreamScheduler *	getScheduler () const
	Returns: pointer to executing scheduler, or null if there is none.
SharedDynamicParamManager	getDynamicParamManager ()
	Returns: reference to the DynamicParamManager for this graph.
virtual void	setTxn (SharedLogicalTxn pTxn)=0
	Sets the transaction within which this graph should execute.
virtual void	setErrorTarget (SharedErrorTarget pErrorTarget)=0
	Sets the ErrorTarget to which this graph's streams should send row errors.
virtual void	setScratchSegment (SharedSegment pScratchSegment)=0
	Sets the ScratchSegment from which this graph's streams should allocate memory buffers.
virtual void	setResourceGovernor (SharedExecStreamGovernor pResourceGovernor)=0
	Sets the global exec stream governor.
virtual SharedLogicalTxn	getTxn ()=0
	Returns: the transaction within which this graph is executing
virtual TxnId	getTxnId ()=0
	Returns: the transaction ID for this graph
virtual void	enableDummyTxnId (bool enabled)=0
	Controls whether it is OK to call getTxnId without first calling setTxn.
virtual SharedExecStreamGovernor	getResourceGovernor ()=0
	Returns: exec stream governor
virtual void	addStream (SharedExecStream pStream)=0
	Adds a stream to this graph.
virtual void	removeStream (ExecStreamId)=0
	Removes a stream from the graph: deletes the edges, and puts the vertex on a free list to be reallocated.
virtual void	addDataflow (ExecStreamId producerId, ExecStreamId consumerId, bool isImplicit=false)=0
	Defines a dataflow relationship between two streams in this graph.
virtual void	addOutputDataflow (ExecStreamId producerId)=0
	Defines a dataflow representing external output produced by this graph.
virtual void	addInputDataflow (ExecStreamId consumerId)=0
	Defines a dataflow representing external input consumed by this graph.
virtual void	mergeFrom (ExecStreamGraph &src)=0
	Adds all the vertices and edges from another graph.
virtual void	mergeFrom (ExecStreamGraph &src, std::vector< ExecStreamId > const &nodes)=0
	Adds a subgraph, taken (removed) from another graph.
virtual SharedExecStream	findStream (std::string name)=0
	Finds a stream by name.
virtual SharedExecStream	findLastStream (std::string name, uint iOutput)=0
	Finds last stream known for name.
virtual void	interposeStream (std::string name, uint iOutput, ExecStreamId interposedId)=0
	Interposes an adapter stream.
virtual void	prepare (ExecStreamScheduler &scheduler)=0
	Prepares this graph for execution.
virtual void	open ()=0
	Opens execution on this graph.
virtual SharedExecStream	getStream (ExecStreamId id)=0
	Translates a stream ID to a stream pointer.
virtual uint	getInputCount (ExecStreamId streamId)=0
	Determines number of explicit input flows consumed by a stream.
virtual uint	getOutputCount (ExecStreamId streamId)=0
	Determines number of explicit output flows produced by a stream.
virtual SharedExecStream	getStreamInput (ExecStreamId streamId, uint iInput)=0
	Accesses a stream's input.
virtual SharedExecStreamBufAccessor	getStreamInputAccessor (ExecStreamId streamId, uint iInput)=0
	Accesses a stream's input accessor.
virtual SharedExecStream	getStreamOutput (ExecStreamId streamId, uint iOutput)=0
	Accesses a stream's output.
virtual SharedExecStreamBufAccessor	getStreamOutputAccessor (ExecStreamId streamId, uint iOutput)=0
	Accesses a stream's output accessor.
virtual std::vector< SharedExecStream >	getSortedStreams ()=0
	Gets streams, sorted topologically.
virtual int	getStreamCount ()=0
	Returns: the number of streams in the graph; can only be called after prepare.
virtual int	getDataflowCount ()=0
	Returns: the number of dataflows (edges) in the graph; can only be called after prepare.
virtual void	renderGraphviz (std::ostream &dotStream)=0
	Renders the graph in the .dot format defined by Graphviz.
virtual bool	isAcyclic ()=0
	Returns: true if graph has no cycles
virtual void	closeProducers (ExecStreamId streamId)=0
	Closes the producers of a stream with a given id.
virtual void	declareDynamicParamWriter (ExecStreamId streamId, DynamicParamId dynamicParamId)=0
	Declares that a given stream writes a given dynamic parameter.
virtual void	declareDynamicParamReader (ExecStreamId streamId, DynamicParamId dynamicParamId)=0
	Declares that a given stream reads a given dynamic parameter.
virtual const std::vector< ExecStreamId > &	getDynamicParamWriters (DynamicParamId dynamicParamId)=0
	Returns a list of stream ids that write a given dynamic parameter.
virtual const std::vector< ExecStreamId > &	getDynamicParamReaders (DynamicParamId dynamicParamId)=0
	Returns a list of stream ids that read a given dynamic parameter.
bool	isClosed () const
	Returns: whether the object has been closed
void	close ()
	Closes this object, releasing any unallocated resources.
Static Public Member Functions
static SharedExecStreamGraph	newExecStreamGraph ()
	Constructs a new ExecStreamGraph.
Protected Member Functions
	ExecStreamGraph ()
virtual void	closeImpl ()=0
	Must be implemented by derived class to release any resources.
Protected Attributes
ExecStreamScheduler *	pScheduler
	A Scheduler responsible for executing streams in this graph.
SharedDynamicParamManager	pDynamicParamManager
	Manager that handles dynamic parameters for this graph.
bool	needsClose
Friends
class	ExecStreamScheduler

Detailed Description

An ExecStreamGraph is a directed graph representing dataflow among ExecStreams.

For more information, see ExecStreamDesign.

A stream is always a node is a stream graph, but over its lifetime it may be moved from one graph to another. Specifically, it may be prepared in one graph (see ExecStreamGraphEmbro), executed in another, and finally closed & deleted in a third graph.

A stream has a permanent, unique name. These names are used later to find the streams. When a stream is added to a graph it is assigned an ExecStreamId. This identifier is later used to work with the stream. If the stream is moved to another graph, it obtains a new ExecStreamId.

Definition at line 59 of file ExecStreamGraph.h.

Constructor & Destructor Documentation

ExecStreamGraph::ExecStreamGraph ( ) [explicit, protected]

Definition at line 50 of file ExecStreamGraph.cpp.

00051     : pScheduler(NULL),
00052       pDynamicParamManager(new DynamicParamManager())
00053 {
00054 }

ExecStreamGraph::~ExecStreamGraph ( ) [virtual]

Definition at line 56 of file ExecStreamGraph.cpp.

00057 {
00058 }

Member Function Documentation

SharedExecStreamGraph ExecStreamGraph::newExecStreamGraph ( ) [static]

Constructs a new ExecStreamGraph.

Returns:: new graph

Definition at line 43 of file ExecStreamGraph.cpp.

Referenced by ExecStreamTestBase::newStreamGraph(), and CmdInterpreter::visit().

00044 {
00045     return SharedExecStreamGraph(
00046         new ExecStreamGraphImpl(),
00047         ClosableObjectDestructor());
00048 }

ExecStreamScheduler * ExecStreamGraph::getScheduler ( ) const [inline]

Returns:: pointer to executing scheduler, or null if there is none.

Definition at line 444 of file ExecStreamGraph.h.

References pScheduler.

Referenced by ExecStream::checkAbort(), JavaSinkExecStream::execute(), CorrelationJoinExecStream::execute(), Java_net_sf_farrago_fennel_FennelStorage_tupleStreamFetch(), MergeExecStream::open(), CorrelationJoinExecStream::open(), and JavaSinkExecStream::stuffByteBuffer().

00445 {
00446     return pScheduler;
00447 }

SharedDynamicParamManager ExecStreamGraph::getDynamicParamManager ( ) [inline]

Returns:: reference to the DynamicParamManager for this graph.

Definition at line 449 of file ExecStreamGraph.h.

References pDynamicParamManager.

Referenced by ExecStream::prepare().

00450 {
00451     return pDynamicParamManager;
00452 }

virtual void ExecStreamGraph::setTxn ( SharedLogicalTxn pTxn ) [pure virtual]

Sets the transaction within which this graph should execute.

The transaction is reset whenever the graph is closed.

Parameters:

pTxn

transaction

virtual void ExecStreamGraph::addDataflow	(	ExecStreamId	producerId,
		ExecStreamId	consumerId,
		bool	isImplicit = `false`
	)			`[pure virtual]`

	producerId	ID of producer stream in this graph
	consumerId	ID of consumer stream in this graph
	isImplicit	false (the default) if the edge represents direct dataflow; true if the edge represents an implicit dataflow dependency

virtual void ExecStreamGraph::mergeFrom	(	ExecStreamGraph &	src,
		std::vector< ExecStreamId > const &	nodes
	)			`[pure virtual]`

virtual SharedExecStream ExecStreamGraph::findLastStream	(	std::string	name,
		uint	iOutput
	)			`[pure virtual]`

virtual void ExecStreamGraph::interposeStream	(	std::string	name,
		uint	iOutput,
		ExecStreamId	interposedId
	)			`[pure virtual]`

	name	name of stream to adapt
	iOutput	ordinal of output of stream
	interposedId	ID of adapter stream within this graph

virtual SharedExecStream ExecStreamGraph::getStreamInput	(	ExecStreamId	streamId,
		uint	iInput
	)			`[pure virtual]`

	streamId	ID of stream
	iInput	0-based input explicit flow ordinal

virtual SharedExecStreamBufAccessor ExecStreamGraph::getStreamInputAccessor	(	ExecStreamId	streamId,
		uint	iInput
	)			`[pure virtual]`

virtual void ExecStreamGraph::declareDynamicParamWriter	(	ExecStreamId	streamId,
		DynamicParamId	dynamicParamId
	)			`[pure virtual]`

	src	the source graph
	nodes	identifies source nodes.

ExecStreamGraph Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation