ExecStreamScheduler.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/ExecStreamScheduler.h#17 $
// 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) 2004-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_ExecStreamScheduler_Included
#define Fennel_ExecStreamScheduler_Included

#include "fennel/exec/ExecStream.h"
#include "fennel/common/TraceSource.h"

#include <boost/utility.hpp>

FENNEL_BEGIN_NAMESPACE

class FENNEL_EXEC_EXPORT ExecStreamScheduler
    : public boost::noncopyable,
        public virtual TraceSource
{
protected:
    bool tracingFine;

    explicit ExecStreamScheduler(
        SharedTraceTarget pTraceTarget,
        std::string name);

    inline ExecStreamResult executeStream(
        ExecStream &stream,
        ExecStreamQuantum const &quantum);

    virtual void tracePreExecution(
        ExecStream &stream,
        ExecStreamQuantum const &quantum);

    virtual void tracePostExecution(
        ExecStream &stream,
        ExecStreamResult rc);

    virtual void traceStreamBuffers(
        ExecStream &stream,
        TraceLevel inputTupleTraceLevel,
        TraceLevel outputTupleTraceLevel);

public:
    virtual ~ExecStreamScheduler();

    virtual void traceStreamBufferContents(
        ExecStream &stream,
        ExecStreamBufAccessor &bufAccessor,
        TraceLevel traceLevel);

    virtual void addGraph(SharedExecStreamGraph pGraph);

    virtual void removeGraph(SharedExecStreamGraph pGraph);

    virtual void start() = 0;

    inline void makeRunnable(ExecStream &stream);

    virtual void setRunnable(
        ExecStream &stream,
        bool runnable) = 0;

    virtual void abort(ExecStreamGraph &graph) = 0;

    virtual void checkAbort() const;

    virtual void stop() = 0;

    virtual SharedExecStreamBufAccessor newBufAccessor();

    virtual void createBufferProvisionAdapter(
        ExecStreamEmbryo &embryo);

    virtual void createCopyProvisionAdapter(
        ExecStreamEmbryo &embryo);

    virtual ExecStreamBufAccessor &readStream(
        ExecStream &stream) = 0;

    virtual uint getDegreeOfParallelism();
};

inline ExecStreamResult ExecStreamScheduler::executeStream(
    ExecStream &stream,
    ExecStreamQuantum const &quantum)
{
    if (tracingFine) {
        tracePreExecution(stream, quantum);
        ExecStreamResult rc = stream.execute(quantum);
        tracePostExecution(stream, rc);
        return rc;
    } else {
        return stream.execute(quantum);
    }
}

inline void ExecStreamScheduler::makeRunnable(
    ExecStream &stream)
{
    setRunnable(stream, true);
}

FENNEL_END_NAMESPACE

#endif

// End ExecStreamScheduler.h

---