LbmUnionExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/bitmap/LbmUnionExecStream.h#11 $
// 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_LbmUnionExecStream_Included
#define Fennel_LbmUnionExecStream_Included

#include "fennel/tuple/TupleData.h"
#include "fennel/exec/ConfluenceExecStream.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/lucidera/bitmap/LbmSeqSegmentReader.h"
#include "fennel/lucidera/bitmap/LbmSegmentWriter.h"
#include "fennel/lucidera/bitmap/LbmUnionWorkspace.h"

FENNEL_BEGIN_NAMESPACE

struct LbmUnionExecStreamParams : public ConfluenceExecStreamParams
{
    LcsRid maxRid;

    DynamicParamId ridLimitParamId;

    DynamicParamId startRidParamId;

    DynamicParamId segmentLimitParamId;
};

class FENNEL_LBM_EXPORT LbmUnionExecStream
    : public ConfluenceExecStream
{
    // see LbmUnionExecStreamParams
    LcsRid maxRid;
    DynamicParamId ridLimitParamId;
    DynamicParamId startRidParamId;
    DynamicParamId segmentLimitParamId;

    TupleDatum ridLimitDatum;

    RecordNum ridLimit;

    uint pageSize;

    uint nWorkspacePages;

    LbmSeqSegmentReader segmentReader;

    LbmUnionWorkspace workspace;

    LbmSegmentWriter segmentWriter;

    SegmentAccessor scratchAccessor;

    SegPageLock workspacePageLock;

    SegPageLock writerPageLock;

    TupleData inputTuple;

    LbmByteSegment inputSegment;

    PBuffer reverseArea;

    uint reverseAreaSize;

    TupleData outputTuple;

    bool writePending;

    bool producePending;

    bool isDone;

    LcsRid requestedSrid;

    uint segmentsRemaining;

    uint computeOptWorkspacePages(LcsRid maxRid);

    uint computeRidLimit(uint nWorkspacePages);

    bool isConsumerSridSet();

    bool isSegmentLimitSet();

    ExecStreamResult readSegment();

    bool writeSegment();

    void transferLast();

    bool transfer();

    bool produceTuple();

public:
    virtual void prepare(LbmUnionExecStreamParams 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 LbmUnionExecStream.h

---