BTreePrefetchSearchExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/ftrs/BTreePrefetchSearchExecStream.h#6 $
// 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_BTreePrefetchSearchExecStream_Included
#define Fennel_BTreePrefetchSearchExecStream_Included

#include "fennel/ftrs/BTreeSearchExecStream.h"
#include "fennel/btree/BTreeNode.h"
#include "fennel/segment/SegPageEntryIter.h"
#include "fennel/segment/SegPageEntryIterSource.h"
#include "fennel/common/SearchEndpoint.h"

FENNEL_BEGIN_NAMESPACE

struct FENNEL_FTRS_EXPORT BTreePrefetchSearchKey
{
    SearchEndpoint lowerBoundDirective;

    SearchEndpoint upperBoundDirective;

    PBuffer lowerKeyBuffer;

    PBuffer upperKeyBuffer;

    bool newSearch;
};

struct FENNEL_FTRS_EXPORT BTreePrefetchSearchExecStreamParams
    : public BTreeSearchExecStreamParams
{
};

class FENNEL_FTRS_EXPORT BTreePrefetchSearchExecStream
    : public BTreeSearchExecStream,
        public SegPageEntryIterSource<BTreePrefetchSearchKey>
{
protected:
    SegPageEntryIter<BTreePrefetchSearchKey> leafPageQueue;

    SharedBTreeLeafReader pLeafReader;

    SharedBTreeNonLeafReader pNonLeafReader;

    TupleAccessor savedLowerBoundAccessor;

    TupleAccessor savedUpperBoundAccessor;

    SearchEndpoint pfLowerBoundDirective;

    SearchEndpoint pfUpperBoundDirective;

    TupleData pfLowerBoundData;

    TupleData pfUpperBoundData;

    bool endOnNextKey;

    BTreePageLock scratchLock;

    uint scratchPageSize;

    uint nMiscCachePages;

    uint nPrefetchScratchPages;

    uint keyValuesSize;

    uint nEntriesPerScratchPage;

    bool bigMaxKey;

    std::vector<PBuffer> scratchPages;

    uint currPage;

    uint currPageEntry;

    bool initialPrefetchDone;

    bool processingDone;

    bool prevLeafSearchRc;

    bool rootOnly;

    bool returnedRoot;

    virtual SharedBTreeReader newReader();

    void allocateScratchPages();

    bool innerSearchLoop();

    void getPrefetchSearchKey();

    void setUpSearchKey(BTreePrefetchSearchKey const &searchKey);

    void setSearchKeyData(bool newSearch, BTreePrefetchSearchKey &searchKey);

    bool testNonLeafInterval();

    virtual void setAdditionalKeys();

    virtual void setLowerBoundKey(PConstBuffer buf);

public:
    explicit BTreePrefetchSearchExecStream();
    virtual void prepare(BTreePrefetchSearchExecStreamParams const &params);
    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity,
        ExecStreamResourceSettingType &optType);
    virtual void setResourceAllocation(ExecStreamResourceQuantity &quantity);
    virtual void open(bool restart);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    virtual void initPrefetchEntry(BTreePrefetchSearchKey &searchKey);
    virtual PageId getNextPageForPrefetch(
        BTreePrefetchSearchKey &searchKey,
        bool &found);
    virtual void closeImpl();
};

FENNEL_END_NAMESPACE

#endif

// End BTreePrefetchSearchExecStream.h

---