LcsClusterNode.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/lucidera/colstore/LcsClusterNode.h#9 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Copyright (C) 2005-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_LcsClusterNode_Included
#define Fennel_LcsClusterNode_Included

#include "fennel/segment/SegPageLock.h"
#include "fennel/tuple/StandardTypeDescriptor.h"

FENNEL_BEGIN_NAMESPACE

DEFINE_OPAQUE_INTEGER(LcsRid, uint64_t);

// batch compression mode values

enum LcsBatchMode { LCS_COMPRESSED, LCS_FIXED, LCS_VARIABLE };

struct LcsBatchDir
{
public:
    LcsBatchMode mode;

    uint nRow;

    uint nVal;

    uint nValHighMark;

    uint oVal;

    uint oLastValHighMark;  // value high mark before the batch

    uint recSize;
};

typedef LcsBatchDir *PLcsBatchDir;

struct LcsClusterNode : public StoredNode
{
    static const MagicNumber MAGIC_NUMBER = 0xa83767addb0d2f09LL;
public:

    LcsRid firstRID;

    uint nColumn;

    uint oBatch;

    uint nBatch;
};

inline uint getClusterSubHeaderSize(uint nColumns)
{
    return sizeof(LcsClusterNode) + (3 * sizeof(uint16_t *) * nColumns) +
        sizeof(uint) * nColumns;
}

typedef LcsClusterNode *PLcsClusterNode;
typedef const LcsClusterNode *PConstLcsClusterNode;
typedef SegNodeLock<LcsClusterNode> ClusterPageLock;

FENNEL_END_NAMESPACE

#endif

// End LcsClusterNode.h

---