ExecStreamDefs.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/ExecStreamDefs.h#14 $
// 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
*/

#ifndef Fennel_ExecStreamDefs_Included
#define Fennel_ExecStreamDefs_Included

#include "fennel/tuple/TupleDescriptor.h"
#include "fennel/segment/SegmentAccessor.h"

FENNEL_BEGIN_NAMESPACE

typedef uint ExecStreamId;

enum ExecStreamBufState
{
    EXECBUF_EMPTY,
    EXECBUF_NONEMPTY,
    EXECBUF_UNDERFLOW,
    EXECBUF_OVERFLOW,
    EXECBUF_EOS
};

static std::string ExecStreamBufState_names[] = {
    "EXECBUF_EMPTY",
    "EXECBUF_NONEMPTY",
    "EXECBUF_UNDERFLOW",
    "EXECBUF_OVERFLOW",
    "EXECBUF_EOS"
};

static std::string ExecStreamBufState_names_short[] = {
    "EMP",
    "NEM",
    "UND",
    "OVR",
    "EOS"
};

inline std::ostream & operator<< (std::ostream &os, ExecStreamBufState e)
{
    return os << ExecStreamBufState_names[e];
}

enum ExecStreamBufProvision
{
    BUFPROV_NONE,
    BUFPROV_CONSUMER,
    BUFPROV_PRODUCER,
};

enum ExecStreamResult
{
    EXECRC_BUF_UNDERFLOW,
    EXECRC_BUF_OVERFLOW,
    EXECRC_EOS,
    EXECRC_QUANTUM_EXPIRED,
    EXECRC_YIELD
};

static std::string ExecStreamResult_names[] = {
    "EXECRC_BUF_UNDERFLOW",
    "EXECRC_BUF_OVERFLOW",
    "EXECRC_EOS",
    "EXECRC_QUANTUM_EXPIRED",
    "EXECRC_YIELD"
};

static std::string ExecStreamResult_names_short[] = {
    "UND",
    "OVR",
    "EOS",
    "QNT",
    "YLD"
};

inline std::ostream & operator<< (std::ostream &os, ExecStreamResult e)
{
    return os << ExecStreamResult_names[e];
}

struct FENNEL_EXEC_EXPORT ExecStreamQuantum
{
    uint nTuplesMax;

    explicit ExecStreamQuantum()
    {
        nTuplesMax = MAXU;
    }
};

enum ExecStreamResourceSettingType {
    EXEC_RESOURCE_ACCURATE,
    EXEC_RESOURCE_ESTIMATE,
    EXEC_RESOURCE_UNBOUNDED
};

struct FENNEL_EXEC_EXPORT ExecStreamResourceQuantity
{
    uint nThreads;

    uint nCachePages;

    explicit ExecStreamResourceQuantity()
    {
        nThreads = 0;
        nCachePages = 0;
    }
};

struct FENNEL_EXEC_EXPORT ExecStreamParams
{
    SharedCacheAccessor pCacheAccessor;

    SegmentAccessor scratchAccessor;

    explicit ExecStreamParams();

    virtual ~ExecStreamParams();
};

FENNEL_END_NAMESPACE

#endif

// End ExecStreamDefs.h

---