Backtrace.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/common/Backtrace.h#12 $
// 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_Backtrace_Included
#define Fennel_Backtrace_Included

#include <ostream>
#include <stdlib.h>

#ifndef __MSVC__
#include <signal.h>
#include <execinfo.h>
#include <link.h>
#endif


FENNEL_BEGIN_NAMESPACE

class FENNEL_COMMON_EXPORT Backtrace
{
    size_t depth;                       // actual depth
    const bool ownbuf;                  // the object allocated the addrbuf
    const size_t bufsize;
    void** addrbuf;                     // [bufsize]

#ifndef __MSVC__
    struct LibraryInfo
    {
        ElfW(Addr) baseAddress;
        char const *pImageName;
    };

    static int lookupLibraryBase(struct dl_phdr_info *, size_t, void *);
#endif

public:
    Backtrace(size_t maxdepth = 32);

    Backtrace(size_t bufsize, void** buffer);

    ~Backtrace();

    std::ostream& print(std::ostream&) const;

    void print(int fd) const;

    static void writeDemangled(
        std::ostream &out, char const *pMangled);
};

inline std::ostream& operator << (std::ostream& os, const Backtrace& bt)
{
    return bt.print(os);
}

class FENNEL_COMMON_EXPORT AutoBacktrace
{
    static std::ostream* pstream;
    static SharedTraceTarget ptrace;
    static void signal_handler(int signum);
#ifndef __MSVC__
#define BACKTRACE_SIG_MAX 32
    static struct sigaction nextAction[BACKTRACE_SIG_MAX];
#endif

    // hide constructor
    AutoBacktrace()
    {
    }

    static void installSignal(int signum);
public:
    static void install(bool includeSegFault = true);

    static void setOutputStream(std::ostream &outStream);

    static void setOutputStream();

    static void setTraceTarget(
        SharedTraceTarget pTraceTarget = SharedTraceTarget());
};

FENNEL_END_NAMESPACE

#endif

// End Backtrace.h

---