ExecStreamGovernor.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/ExecStreamGovernor.h#9 $
// 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_ExecStreamGovernor_Included
#define Fennel_ExecStreamGovernor_Included

#include "fennel/common/SharedTypes.h"
#include "fennel/common/TraceSource.h"
#include "fennel/common/StatsSource.h"
#include "fennel/exec/ExecStreamDefs.h"
#include "fennel/synch/SynchObj.h"

#include <boost/utility.hpp>
#include <map>

FENNEL_BEGIN_NAMESPACE

enum ExecStreamResourceKnobType {
    EXEC_KNOB_EXPECTED_CONCURRENT_STATEMENTS,
    EXEC_KNOB_CACHE_RESERVE_PERCENTAGE
};

struct FENNEL_EXEC_EXPORT ExecStreamResourceKnobs
{
    uint expectedConcurrentStatements;

    uint cacheReservePercentage;
};

enum ExecStreamResourceType {
    EXEC_RESOURCE_THREADS,
    EXEC_RESOURCE_CACHE_PAGES
};

struct FENNEL_EXEC_EXPORT ExecStreamResourceRequirements
{
    uint minReqt;
    uint optReqt;
    ExecStreamResourceSettingType optType;
};

class FENNEL_EXEC_EXPORT ExecStreamGovernor
    : public boost::noncopyable, public virtual TraceSource,
    public StatsSource
{
protected:
    typedef std::map<ExecStreamGraph *, SharedExecStreamResourceQuantity>
        ExecStreamGraphResourceMap;

    ExecStreamResourceKnobs knobSettings;

    ExecStreamResourceQuantity resourcesAvailable;

    ExecStreamResourceQuantity resourcesAssigned;

    ExecStreamGraphResourceMap resourceMap;

    StrictMutex mutex;

    explicit ExecStreamGovernor(
        ExecStreamResourceKnobs const &knobSettings,
        ExecStreamResourceQuantity const &resourcesAvailable,
        SharedTraceTarget pTraceTarget,
        std::string name);

    void traceCachePageRequest(
        uint assigned, ExecStreamResourceRequirements const &reqt,
        std::string const &name);

public:
    virtual ~ExecStreamGovernor();

    virtual bool setResourceKnob(
        ExecStreamResourceKnobs const &knob,
        ExecStreamResourceKnobType knobType) = 0;

    virtual bool setResourceAvailability(
        ExecStreamResourceQuantity const &available,
        ExecStreamResourceType resourceType) = 0;

    virtual void requestResources(ExecStreamGraph &graph) = 0;

    virtual void returnResources(ExecStreamGraph &graph) = 0;

    // implement StatsSource
    void writeStats(StatsTarget &target);
};

FENNEL_END_NAMESPACE

#endif

// End ExecStreamGovernor.h

---