ExternalSortExecStreamImpl.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/sorter/ExternalSortExecStreamImpl.h#2 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2009-2009 SQLstream, Inc.
// Copyright (C) 2004-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_ExternalSortExecStreamImpl_Included
#define Fennel_ExternalSortExecStreamImpl_Included

#include "fennel/sorter/ExternalSortExecStream.h"
#include "fennel/synch/SynchObj.h"
#include "fennel/synch/ThreadPool.h"

#include <boost/scoped_ptr.hpp>

#include "fennel/sorter/ExternalSortInfo.h"
#include "fennel/sorter/ExternalSortRunLoader.h"
#include "fennel/sorter/ExternalSortRunAccessor.h"
#include "fennel/sorter/ExternalSortMerger.h"
#include "fennel/sorter/ExternalSortOutput.h"
#include "fennel/sorter/ExternalSortTask.h"

FENNEL_BEGIN_NAMESPACE

class ExternalSortRunLoader;
typedef boost::shared_ptr<ExternalSortRunLoader>
SharedExternalSortRunLoader;

class FENNEL_SORTER_EXPORT ExternalSortExecStreamImpl
    : public ExternalSortExecStream
{
    friend class ExternalSortTask;

    SharedSegment pTempSegment;

    ExternalSortInfo sortInfo;

    uint nParallel;

    boost::scoped_array<SharedExternalSortRunLoader> runLoaders;

    ThreadPool<ExternalSortTask> threadPool;

    LocalCondition runLoaderAvailable;

    StrictMutex runLoaderMutex;

    boost::scoped_ptr<ExternalSortRunAccessor> pFinalRunAccessor;

    boost::scoped_ptr<ExternalSortMerger> pMerger;

    boost::scoped_ptr<ExternalSortOutput> pOutputWriter;

    StrictMutex storedRunMutex;

    std::vector<SharedSegStreamAllocation> storedRuns;

    bool resultsReady;

    bool storeFinalRun;

    int estimatedNumRows;

    bool earlyClose;

// ----------------------------------------------------------------------
// private methods
// ----------------------------------------------------------------------

    // TODO jvs 10-Nov-2004:  rework comments
    void computeFirstResult();

    void computeFirstResultParallel();

    void sortRun(ExternalSortRunLoader &runLoader);

    void storeRun(ExternalSortSubStream &subStream);

    void mergeFirstResult();

    void optimizeRunOrder();

    void deleteStoredRunInfo(uint iFirstRun, uint nRuns);

    ExternalSortRunLoader &reserveRunLoader();

    void unreserveRunLoader(ExternalSortRunLoader &runLoader);

    void releaseResources();

    // implement ExecStream
    virtual void closeImpl();

public:
    explicit ExternalSortExecStreamImpl();

    // implement ExecStream
    virtual void prepare(ExternalSortExecStreamParams const &params);
    virtual void open(bool restart);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity,
        ExecStreamResourceSettingType &optType);
    virtual void setResourceAllocation(
        ExecStreamResourceQuantity &quantity);
};

FENNEL_END_NAMESPACE

#endif

// End ExternalSortExecStreamImpl.h

---