ExternalSortRunLoader.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/sorter/ExternalSortRunLoader.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_ExternalSortRunLoader_Included
#define Fennel_ExternalSortRunLoader_Included

#include "fennel/tuple/TupleAccessor.h"
#include "fennel/tuple/TupleProjectionAccessor.h"
#include "fennel/tuple/TupleData.h"
#include "fennel/segment/SegPageLock.h"
#include "fennel/sorter/ExternalSortSubStream.h"

#include <vector>

FENNEL_BEGIN_NAMESPACE

class ExternalSortInfo;

class FENNEL_SORTER_EXPORT ExternalSortRunLoader
    : public ExternalSortSubStream
{
    ExternalSortInfo &sortInfo;

    SegPageLock bufferLock;

    uint nMemPagesMax;

    std::vector<PBuffer> freeBuffers;

    std::vector<PBuffer> indexBuffers;

    std::vector<PBuffer> dataBuffers;

    uint indexToPageShift;

    uint indexPageMask;

    PBuffer pDataBuffer;

    PBuffer pDataBufferEnd;

    PBuffer pIndexBuffer;

    PBuffer pIndexBufferEnd;

    uint nTuplesLoaded;

    uint nTuplesFetched;

    ExternalSortFetchArray fetchArray;

    // TODO:  comment or replace
    TupleAccessor tupleAccessor;
    TupleAccessor tupleAccessor2;
    TupleProjectionAccessor keyAccessor;
    TupleProjectionAccessor keyAccessor2;
    TupleData keyData;
    TupleData keyData2;

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

    PBuffer allocateBuffer();

    bool allocateDataBuffer();

    bool allocateIndexBuffer();

    inline PBuffer &getPointerArrayEntry(uint iTuple);

    inline void quickSortSwap(uint l,uint r);
    uint quickSortPartition(uint i,uint j,PBuffer pivot);
    PBuffer quickSortFindPivot(uint l,uint r);
    void quickSort(uint l,uint r);

public:
    bool runningParallelTask;

    explicit ExternalSortRunLoader(ExternalSortInfo &info);
    virtual ~ExternalSortRunLoader();

    void startRun();

    bool isStarted();

    ExternalSortRC loadRun(ExecStreamBufAccessor &bufAccessor);

    void sort();

    uint getLoadedTupleCount();

    void releaseResources();

    // implement ExternalSortSubStream
    virtual ExternalSortFetchArray &bindFetchArray();
    virtual ExternalSortRC fetch(uint nTuplesRequested);
};

FENNEL_END_NAMESPACE

#endif

// End ExternalSortRunLoader.h

---