BTreeWriter.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/btree/BTreeWriter.h#20 $
// 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_BTreeWriter_Included
#define Fennel_BTreeWriter_Included

#include "fennel/btree/BTreeReader.h"
#include "fennel/txn/LogicalTxnParticipant.h"
#include "fennel/common/FemEnums.h"

#include <boost/scoped_array.hpp>

FENNEL_BEGIN_NAMESPACE

class FENNEL_BTREE_EXPORT BTreeWriter
    : public BTreeReader, public LogicalTxnParticipant
{
    static const LogicalActionType ACTION_INSERT = 1;

    static const LogicalActionType ACTION_DELETE = 2;

    SegmentAccessor scratchAccessor;

    BTreePageLock scratchPageLock;

    std::vector<PageId> pageStack;

    boost::scoped_array<FixedBuffer> splitTupleBuffer;

    boost::scoped_array<FixedBuffer> leafTupleBuffer;

    bool monotonic;

    inline void optimizeRootLockMode();

    void compactNode(BTreePageLock &targetPageLock);

    void splitCurrentNode(
        PConstBuffer pTupleBuffer,
        uint cbTuple,
        uint iNewTuple);

    void grow(
        BTreeNode const &rightNode, PageId rightPageId);

    uint lockParentPage(uint height, bool rightMostNode);

    bool attemptInsertWithoutSplit(
        BTreePageLock &targetPageLock,
        PConstBuffer pTupleBuffer,uint cbTuple,uint iNewTuple);

    void insertLogged(ByteInputStream &logStream);

    void deleteLogged(ByteInputStream &logStream);

    bool positionSearchKey(BTreeNodeAccessor &nodeAccessor);

    bool checkMonotonicity(
        BTreeNodeAccessor &nodeAccessor, PConstBuffer pTupleBuffer);

public:
    explicit BTreeWriter(
        BTreeDescriptor const &descriptor,
        SegmentAccessor const &scratchAccessor,
        bool monotonic = false);

    virtual ~BTreeWriter();

    void insertTupleData(
        TupleData const &tupleData,
        Distinctness distinctness);

    uint insertTupleFromBuffer(
        PConstBuffer pTupleBuffer,Distinctness distinctness);

    void deleteCurrent();

    bool updateCurrent(TupleData const &tupleData);

    void releaseScratchBuffers();

    // implement LogicalTxnParticipant
    virtual LogicalTxnClassId getParticipantClassId() const;
    virtual void describeParticipant(
        ByteOutputStream &logStream);
    virtual void undoLogicalAction(
        LogicalActionType actionType,
        ByteInputStream &logStream);
    virtual void redoLogicalAction(
        LogicalActionType actionType,
        ByteInputStream &logStream);
};

FENNEL_END_NAMESPACE

#endif

// End BTreeWriter.h

---