TraceSource.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/common/TraceSource.h#20 $
// 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) 1999-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_TraceSource_Included
#define Fennel_TraceSource_Included

#include <sstream>
#include "fennel/common/TraceTarget.h"

FENNEL_BEGIN_NAMESPACE

class FENNEL_COMMON_EXPORT TraceSource
{
    SharedTraceTarget pTraceTarget;

    std::string name;

    TraceLevel minimumLevel;

protected:
    explicit TraceSource();

    explicit TraceSource(
        SharedTraceTarget pTraceTarget,
        std::string name);

public:
    virtual ~TraceSource();

    virtual void initTraceSource(
        SharedTraceTarget pTraceTarget, std::string name);

    void trace(TraceLevel level,std::string message) const;

    bool isTracing() const
    {
        return pTraceTarget.get() ? true : false;
    }

    bool isTracingLevel(TraceLevel level) const
    {
        return level >= minimumLevel;
    }

    TraceTarget &getTraceTarget() const
    {
        assert(isTracing());
        return *(pTraceTarget.get());
    }

    SharedTraceTarget getSharedTraceTarget() const
    {
        return pTraceTarget;
    }

    std::string getTraceSourceName() const
    {
        return name;
    }

    void setTraceSourceName(std::string const& n)
    {
        name = n;
    }

    TraceLevel getMinimumTraceLevel() const
    {
        return minimumLevel;
    }

    void disableTracing();
};

#define FENNEL_TRACE(level,msg) FENNEL_DELEGATE_TRACE(level,this,msg)
#define FENNEL_DELEGATE_TRACE(level,tracer,msg) \
do { \
    if ((tracer)->isTracingLevel(level)) { \
        std::ostringstream oss; \
        oss << msg; \
        (tracer)->trace(level,oss.str()); \
    } \
} while (false)

// REVIEW jvs 18-Mar-2005:  Why can't we just pass getCurrentThreadId()
// to operator <<?

// return a string id for the current thread
inline char *get_tid(char *tidstr, int cb)
{
    snprintf(tidstr, cb, "%d", getCurrentThreadId());
    return tidstr;
}

#define FENNEL_TRACE_THREAD(level, expr) \
{ \
    char tidstr[32]; \
    FENNEL_TRACE(\
        level, \
        "[thread " << fennel::get_tid(tidstr,sizeof(tidstr)) << "] " << expr); \
}

FENNEL_END_NAMESPACE

#endif

// End TraceSource.h

---