BTreeInsertExecStream.cpp

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/ftrs/BTreeInsertExecStream.cpp#9 $
// 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
*/

#include "fennel/common/CommonPreamble.h"
#include "fennel/ftrs/BTreeInsertExecStream.h"
#include "fennel/btree/BTreeBuilder.h"
#include "fennel/btree/BTreeWriter.h"
#include "fennel/tuple/TupleDescriptor.h"
#include "fennel/exec/ExecStreamBufAccessor.h"

FENNEL_BEGIN_CPPFILE("$Id: //open/dev/fennel/ftrs/BTreeInsertExecStream.cpp#9 $");

void BTreeInsertExecStream::prepare(BTreeInsertExecStreamParams const &params)
{
    BTreeExecStream::prepare(params);
    ConduitExecStream::prepare(params);
    distinctness = params.distinctness;
    monotonic = params.monotonic;

    dynamicBTree = (rootPageIdParamId > DynamicParamId(0));
    truncateOnRestart = false;
    assert(treeDescriptor.tupleDescriptor == pInAccessor->getTupleDesc());
}

void BTreeInsertExecStream::getResourceRequirements(
    ExecStreamResourceQuantity &minQuantity,
    ExecStreamResourceQuantity &optQuantity)
{
    BTreeExecStream::getResourceRequirements(minQuantity,optQuantity);

    // max number of pages locked during tree update (REVIEW),
    // including BTreeWriter's private scratch page
    minQuantity.nCachePages += 5;

    // TODO:  use opt to govern prefetch and come up with a good formula
    optQuantity = minQuantity;
}

void BTreeInsertExecStream::open(bool restart)
{
    BTreeExecStream::open(restart);
    ConduitExecStream::open(restart);

    if (dynamicBTree) {
        buildTree(restart);
    }

    if (restart) {
        return;
    }

    if (rootPageIdParamId > DynamicParamId(0)) {
        StandardTypeDescriptorFactory stdTypeFactory;
        TupleAttributeDescriptor attrDesc =
            TupleAttributeDescriptor(
                stdTypeFactory.newDataType(STANDARD_TYPE_UINT_64));
        pDynamicParamManager->createParam(rootPageIdParamId, attrDesc);
        TupleDatum rootPageIdDatum;
        rootPageIdDatum.pData = (PConstBuffer) &(treeDescriptor.rootPageId);
        rootPageIdDatum.cbData = sizeof(PageId);
        pDynamicParamManager->writeParam(rootPageIdParamId, rootPageIdDatum);
    }

    // NOTE: do this last so that rootPageId is available
    pWriter = newWriter(monotonic);
}

void BTreeInsertExecStream::buildTree(bool restart)
{
    if (restart) {
        if (truncateOnRestart) {
            truncateTree(false);
        }
    } else {
        BTreeBuilder builder(
            treeDescriptor,
            treeDescriptor.segmentAccessor.pSegment);
        builder.createEmptyRoot();
        treeDescriptor.rootPageId = builder.getRootPageId();
    }
}

void BTreeInsertExecStream::truncateTree(bool rootless)
{
    if (treeDescriptor.rootPageId == NULL_PAGE_ID) {
        // nothing to do
        assert(rootless);
        return;
    }
    BTreeBuilder builder(
        treeDescriptor,
        treeDescriptor.segmentAccessor.pSegment);
    builder.truncate(rootless);
    if (rootless) {
        treeDescriptor.rootPageId = NULL_PAGE_ID;
    }
}

ExecStreamResult BTreeInsertExecStream::execute(
    ExecStreamQuantum const &quantum)
{
    ExecStreamResult rc = precheckConduitBuffers();
    if (rc != EXECRC_YIELD) {
        if (rc == EXECRC_EOS) {
            // Terminate search so other streams can read from the btree
            pWriter->endSearch();
            pOutAccessor->markEOS();
        }
        return rc;
    }

    uint nTuples = 0;

    for (;;) {
        PConstBuffer pTupleBuf = pInAccessor->getConsumptionStart();
        uint cb = pWriter->insertTupleFromBuffer(pTupleBuf,distinctness);
        pInAccessor->consumeData(pTupleBuf + cb);
        ++nTuples;
        if (nTuples > quantum.nTuplesMax) {
            return EXECRC_QUANTUM_EXPIRED;
        }
        if (!pInAccessor->demandData()) {
            return EXECRC_BUF_UNDERFLOW;
        }
    }
}

void BTreeInsertExecStream::closeImpl()
{
    BTreeExecStream::closeImpl();
    pWriter.reset();
    pBTreeAccessBase.reset();
    ConduitExecStream::closeImpl();
    if (dynamicBTree) {
        truncateTree(true);
    }
}

FENNEL_END_CPPFILE("$Id: //open/dev/fennel/ftrs/BTreeInsertExecStream.cpp#9 $");

// End BTreeInsertExecStream.cpp

---