LbmSplicerExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/bitmap/LbmSplicerExecStream.h#16 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2006-2009 LucidEra, Inc.
// Copyright (C) 2006-2009 The Eigenbase Project
//
// 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_LbmSplicerExecStream_Included
#define Fennel_LbmSplicerExecStream_Included

#include "fennel/btree/BTreeWriter.h"
#include "fennel/ftrs/BTreeExecStream.h"
#include "fennel/exec/DiffluenceExecStream.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/tuple/TupleAccessor.h"
#include "fennel/tuple/TupleData.h"
#include "fennel/tuple/TupleDataWithBuffer.h"
#include "fennel/segment/SnapshotRandomAllocationSegment.h"
#include "fennel/lucidera/bitmap/LbmEntry.h"
#include "fennel/lucidera/bitmap/LbmRidReader.h"
#include <boost/scoped_array.hpp>

FENNEL_BEGIN_NAMESPACE

struct LbmSplicerExecStreamParams : public DiffluenceExecStreamParams
{
    std::vector<BTreeParams> bTreeParams;

    DynamicParamId insertRowCountParamId;

    DynamicParamId writeRowCountParamId;

    bool createNewIndex;
};

class FENNEL_LBM_EXPORT LbmSplicerExecStream
    : public DiffluenceExecStream
{
    SegmentAccessor scratchAccessor;

    BTreeDescriptor writeBTreeDesc;

    BTreeDescriptor deletionBTreeDesc;

    DynamicParamId insertRowCountParamId;

    bool createNewIndex;

    bool newIndexCreated;

    DynamicParamId writeRowCountParamId;

    uint maxEntrySize;

    boost::scoped_array<FixedBuffer> bitmapBuffer;

    boost::scoped_array<FixedBuffer> mergeBuffer;

    SharedLbmEntry pCurrentEntry;

    bool currEntry;

    bool currExistingEntry;

    LcsRid currBTreeStartRid;

    bool emptyTableUnknown;

    bool emptyTable;

    SharedBTreeWriter bTreeWriter;

    bool bTreeWriterMoved;

    bool isDone;

    TupleData inputTuple;

    TupleData singletonTuple;

    TupleData outputTuple;

    RecordNum numRowsLoaded;

    TupleData bTreeTupleData;
    TupleData tempBTreeTupleData;

    TupleDescriptor bitmapTupleDesc;

    uint nIdxKeys;

    bool computeRowCount;

    bool uniqueKey;

    bool currValidation;

    bool firstValidation;

    TupleDataWithBuffer currUniqueKey;

    uint nKeyRows;

    LbmDeletionIndexReader deletionReader;

    TupleData deletionTuple;

    LbmTupleRidReader inputRidReader;

    bool nullUpsertRid;

    LcsRid upsertRid;

    SharedExecStreamBufAccessor violationAccessor;

    TupleData violationTuple;

    std::string errorMsg;

    TupleDescriptor errorDesc;

    TupleData errorTuple;

    SnapshotRandomAllocationSegment *pSnapshotSegment;

    PageId origRootPageId;

    bool isEmpty();

    bool existingEntry(TupleData const &bitmapEntry);

    bool findMatchingBTreeEntry(
        TupleData const &bitmapEntry,
        TupleData &bTreeTupleData,
        bool leastUpper);

    bool findBTreeEntry(
        TupleData const &bitmapEntry,
        TupleData &bTreeTupleData);

    bool ridOverlaps(LcsRid rid, TupleData &bitmapTupleData, bool firstByte);

    void findBetterEntry(TupleData const &bitmapEntry);

    void spliceEntry(TupleData &bitmapEntry);

    void insertBitmapEntry();

    void createNewBitmapEntry(TupleData const &bitmapEntry);

    void upsertSingleton(TupleData const &bitmapEntry);

    ExecStreamResult getValidatedTuple();

    bool uniqueRequired(const TupleData &tuple);

    uint countKeyRows(const TupleData &tuple);

    inline void setUpsertRid(LcsRid rid);

    inline const LcsRid *getUpsertRidPtr() const;

    void postViolation(const TupleData &input, const TupleData &violation);

public:
    virtual void prepare(LbmSplicerExecStreamParams const &params);
    virtual void open(bool restart);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity);
    virtual void closeImpl();
};

/**************************************************************
  Definitions of inline methods for class LbmSplicerExecStream
***************************************************************/

inline void LbmSplicerExecStream::setUpsertRid(LcsRid rid)
{
    nullUpsertRid = false;
    upsertRid = rid;
}

inline const LcsRid *LbmSplicerExecStream::getUpsertRidPtr() const
{
    return (nullUpsertRid ? NULL : &upsertRid);
}

FENNEL_END_NAMESPACE

#endif

// End LbmSplicerExecStream.h

---