LbmGeneratorExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/bitmap/LbmGeneratorExecStream.h#15 $
// 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_LbmGeneratorExecStream_Included
#define Fennel_LbmGeneratorExecStream_Included

#include "fennel/tuple/TupleDataWithBuffer.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/lucidera/colstore/LcsRowScanBaseExecStream.h"
#include "fennel/lucidera/bitmap/LbmEntry.h"

FENNEL_BEGIN_NAMESPACE

enum LbmPendingProduceType {
    LBM_TABLEFLUSH_PENDING,
    LBM_ENTRYFLUSH_PENDING,
    LBM_NOFLUSH_PENDING
};

struct LbmEntryInfo
{
    SharedLbmEntry pBitmap;

    PBuffer bufferPtr;

    bool inuse;
};

struct LbmGeneratorExecStreamParams :
    public BTreeExecStreamParams, public LcsRowScanBaseExecStreamParams
{
    DynamicParamId insertRowCountParamId;

    bool createIndex;
};

class FENNEL_LBM_EXPORT LbmGeneratorExecStream
    : public BTreeExecStream, LcsRowScanBaseExecStream
{
    uint numMiscScratchPages;

    uint maxNumScratchPages;

    DynamicParamId insertRowCountParamId;

    bool createIndex;

    std::vector<DynamicParamId> parameterIds;

    uint scratchPageSize;

    uint entrySize;

    uint maxBitmapSize;

    uint minBitmapSize;

    ClusterPageLock scratchLock;

    TupleData inputTuple;

    RecordNum numRowsToLoad;

    RecordNum rowCount;

    LcsRid startRid;

    LcsRid currRid;

    TupleDataWithBuffer bitmapTuple;

    TupleDescriptor bitmapTupleDesc;

    TupleData outputTuple;

    uint nIdxKeys;

    bool batchRead;

    uint currBatch;

    std::vector<uint16_t> keyCodes;

    std::vector<LbmEntryInfo> bitmapTable;

    uint nBitmapEntries;

    uint flushIdx;

    uint nBitmapBuffers;

    uint nScratchPagesAllocated;

    std::vector<PBuffer> scratchPages;

    LbmPendingProduceType producePending;

    uint flushStart;

    bool skipRead;

    bool doneReading;

    bool revertToSingletons;

    ExecStreamResult generateSingleKeyBitmaps(ExecStreamQuantum const &quantum);

    ExecStreamResult generateMultiKeyBitmaps(ExecStreamQuantum const &quantum);

    void createSingletonBitmapEntry();

    bool generateBitmaps();

    bool generateSingletons();

    bool advanceReader(SharedLcsClusterReader &pScan);

    bool initBitmapTable(uint nEntries);

    void initRidAndBitmap(TupleData &bitmapTuple, LcsRid* pCurrRid);

    bool addRidToBitmap(uint keycode, TupleData &keyvalue, LcsRid rid);

    PBuffer flushBuffer(LcsRid addRid);

    bool flushTable(uint start);

    bool flushEntry(uint keycode);

public:
    virtual void prepare(LbmGeneratorExecStreamParams 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);
    virtual void closeImpl();
};

FENNEL_END_NAMESPACE

#endif

// End LbmGeneratorExecStream.h

---