ExecStreamGraph.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/ExecStreamGraph.h#29 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2005-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_ExecStreamGraph_Included
#define Fennel_ExecStreamGraph_Included

#include "fennel/common/ClosableObject.h"
#include <vector>
#include <boost/utility.hpp>

FENNEL_BEGIN_NAMESPACE

typedef uint ExecStreamId;

class ExecStreamGraphImpl;
class ExecStreamScheduler;

class FENNEL_EXEC_EXPORT ExecStreamGraph
    : public boost::noncopyable,
        public ClosableObject
{
    friend class ExecStreamScheduler;

protected:
    ExecStreamScheduler *pScheduler;

    SharedDynamicParamManager pDynamicParamManager;

    explicit ExecStreamGraph();

public:
    static SharedExecStreamGraph newExecStreamGraph();

    virtual ~ExecStreamGraph();

    inline ExecStreamScheduler *getScheduler() const;

    inline SharedDynamicParamManager getDynamicParamManager();

    virtual void setTxn(
        SharedLogicalTxn pTxn) = 0;

    virtual void setErrorTarget(
        SharedErrorTarget pErrorTarget) = 0;

    virtual void setScratchSegment(
        SharedSegment pScratchSegment) = 0;

    virtual void setResourceGovernor(
        SharedExecStreamGovernor pResourceGovernor) = 0;

    virtual SharedLogicalTxn getTxn() = 0;

    virtual TxnId getTxnId() = 0;

    virtual void enableDummyTxnId(bool enabled) = 0;

    virtual SharedExecStreamGovernor getResourceGovernor() = 0;

    virtual void addStream(
        SharedExecStream pStream) = 0;

    virtual void removeStream(ExecStreamId) = 0;

    virtual void addDataflow(
        ExecStreamId producerId,
        ExecStreamId consumerId,
        bool isImplicit = false) = 0;

    virtual void addOutputDataflow(
        ExecStreamId producerId) = 0;

    virtual void addInputDataflow(
        ExecStreamId consumerId) = 0;

    virtual void mergeFrom(ExecStreamGraph& src) = 0;

    virtual void mergeFrom(
        ExecStreamGraph& src,
        std::vector<ExecStreamId> const& nodes) = 0;

    virtual SharedExecStream findStream(
        std::string name) = 0;

    virtual SharedExecStream findLastStream(
        std::string name,
        uint iOutput) = 0;

    virtual void interposeStream(
        std::string name,
        uint iOutput,
        ExecStreamId interposedId) = 0;

    virtual void prepare(ExecStreamScheduler &scheduler) = 0;

    virtual void open() = 0;

    virtual SharedExecStream getStream(ExecStreamId id) = 0;

    virtual uint getInputCount(
        ExecStreamId streamId) = 0;

    virtual uint getOutputCount(
        ExecStreamId streamId) = 0;

    virtual SharedExecStream getStreamInput(
        ExecStreamId streamId,
        uint iInput) = 0;

    virtual SharedExecStreamBufAccessor getStreamInputAccessor(
        ExecStreamId streamId,
        uint iInput) = 0;

    virtual SharedExecStream getStreamOutput(
        ExecStreamId streamId,
        uint iOutput) = 0;

    virtual SharedExecStreamBufAccessor getStreamOutputAccessor(
        ExecStreamId streamId,
        uint iOutput) = 0;

    virtual std::vector<SharedExecStream> getSortedStreams() = 0;

    virtual int getStreamCount() = 0;

    virtual int getDataflowCount() = 0;

    virtual void renderGraphviz(std::ostream &dotStream) = 0;

    virtual bool isAcyclic() = 0;

    virtual void closeProducers(ExecStreamId streamId) = 0;

    virtual void declareDynamicParamWriter(
        ExecStreamId streamId,
        DynamicParamId dynamicParamId) = 0;

    virtual void declareDynamicParamReader(
        ExecStreamId streamId,
        DynamicParamId dynamicParamId) = 0;

    virtual const std::vector<ExecStreamId> &getDynamicParamWriters(
        DynamicParamId dynamicParamId) = 0;


    virtual const std::vector<ExecStreamId> &getDynamicParamReaders(
        DynamicParamId dynamicParamId) = 0;

};

inline ExecStreamScheduler *ExecStreamGraph::getScheduler() const
{
    return pScheduler;
}

inline SharedDynamicParamManager ExecStreamGraph::getDynamicParamManager()
{
    return pDynamicParamManager;
}

FENNEL_END_NAMESPACE

#endif

// End ExecStreamGraph.h

---