libphobos-4.9-dev 4.9.3-13ubuntu2 / usr / include / d / 4.9 / gcc / backtrace.di

/* GDC -- D front-end for GCC
   Copyright (C) 2013 Free Software Foundation, Inc.

   GCC 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 3, or (at your option) any later
   version.

   GCC 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 GCC; see the file COPYING3.  If not see
   <http://www.gnu.org/licenses/>.
*/

/* This module provides a backtrace implementation for gdc */
module gcc.backtrace;

import gcc.libbacktrace;


version( Posix )
{
    // NOTE: The first 5 frames with the current implementation are
    //       inside core.runtime and the object code, so eliminate
    //       these for readability.  The alternative would be to
    //       exclude the first N frames that are in a list of
    //       mangled function names.
    static enum FIRSTFRAME = 5;
}
else
{
    // NOTE: On Windows, the number of frames to exclude is based on
    //       whether the exception is user or system-generated, so
    //       it may be necessary to exclude a list of function names
    //       instead.
    static enum FIRSTFRAME = 0;
}

static if(BACKTRACE_SUPPORTED && !BACKTRACE_USES_MALLOC)
{
    import core.stdc.stdint, core.stdc.string, core.stdc.stdio;
    enum MAXFRAMES = 128;

    extern(C) int simpleCallback(void* data, uintptr_t pc)
    {
        auto context = cast(LibBacktrace)data;

        if(context.numPCs == MAXFRAMES)
            return 1;

        context.pcs[context.numPCs++] = pc;
        return 0;
    }

    /*
     * Used for backtrace_create_state and backtrace_simple
     */
    extern(C) void simpleErrorCallback(void* data, const(char)* msg, int errnum)
    {
        if(data) //context is not available in backtrace_create_state
        {
            auto context = cast(LibBacktrace)data;
            strncpy(context.errorBuf.ptr, msg, context.errorBuf.length - 1);
            context.error = errnum;
        }
    }

    /*
     * Used for backtrace_pcinfo
     */
    extern(C) int pcinfoCallback(void* data, uintptr_t pc, const(char)* filename,
        int lineno, const(char)* func)
    {
        auto context = cast(SymbolCallbackInfo*)data;

        //Try to get the function name via backtrace_syminfo
        if(func is null)
        {
            SymbolCallbackInfo2 info;
            info.base = context;
            info.filename = filename;
            info.lineno = lineno;
            if(backtrace_syminfo(context.state, pc, &syminfoCallback2, null, &info) != 0)
            {
                return context.retval;
            }
        }

        auto sym = SymbolOrError(0, SymbolInfo(func, filename, lineno, cast(void*)pc));
        context.retval = context.applyCB(context.num, sym);
        context.num++;

        return context.retval;
    }

    /*
     * Used for backtrace_pcinfo and backtrace_syminfo
     */
    extern(C) void pcinfoErrorCallback(void* data, const(char)* msg, int errnum)
    {
        auto context = cast(SymbolCallbackInfo*)data;

        if(errnum == -1)
        {
            context.noInfo = true;
            return;
        }

        SymbolOrError symError;
        symError.errnum = errnum;
        symError.msg = msg;

        size_t i = 0;
        context.retval = context.applyCB(i, symError);
    }

    /*
     * Used for backtrace_syminfo (in opApply)
     */
    extern(C) void syminfoCallback(void* data, uintptr_t pc,
        const(char)* symname, uintptr_t symval)
    {
        auto context = cast(SymbolCallbackInfo*)data;

        auto sym = SymbolOrError(0, SymbolInfo(symname, null, 0, cast(void*)pc));
        context.retval = context.applyCB(context.num, sym);

        context.num++;
    }

    /*
     * This callback is used if backtrace_syminfo is called from the pcinfoCallback
     * callback. It merges it's information with the information from pcinfoCallback.
     */
    extern(C) void syminfoCallback2(void* data, uintptr_t pc,
        const(char)* symname, uintptr_t symval)
    {
        auto context = cast(SymbolCallbackInfo2*)data;

        auto sym = SymbolOrError(0, SymbolInfo(symname, context.filename, context.lineno,
            cast(void*)pc));
        context.base.retval = context.base.applyCB(context.base.num, sym);

        context.base.num++;
    }

    /*
     * The callback type used with the opApply overload which returns a SymbolOrError
     */
    private alias scope int delegate(ref size_t, ref SymbolOrError) ApplyCallback;

    /*
     * Passed to syminfoCallback, pcinfoCallback and pcinfoErrorCallback
     */
    struct SymbolCallbackInfo
    {
        bool noInfo = false;       //True if debug info / symbol table is not available
        size_t num = 0;            //Counter for opApply
        int retval;                //Value returned by applyCB
        backtrace_state* state;

        //info.fileName / funcName / errmsg may become invalid after this delegate returned
        ApplyCallback applyCB;

        void reset()
        {
            noInfo = false;
            num = 0;
        }
    }

    /*
     * Passed to the syminfoCallback2 callback. That function merges it's
     * funcName with this information and updates base as all other callbacks do.
     */
    struct SymbolCallbackInfo2
    {
        SymbolCallbackInfo* base;
        const(char)* filename;
        int lineno;
    }

    /*
     * Contains a valid symbol or an error message if errnum is != 0.
     */
    struct SymbolOrError
    {
        int errnum; // == 0: No error
        union
        {
            SymbolInfo symbol;
            const(char)* msg;
        }
    }

    //FIXME: state is never freed as libbacktrace doesn't provide a free function...
    public class LibBacktrace : Throwable.TraceInfo
    {
        enum MaxAlignment = (void*).alignof;

        static void initLibBacktrace()
        {
            if(!initialized)
            {
                state = backtrace_create_state(null, false, &simpleErrorCallback, null);
                initialized = true;
            }
        }

        this(int firstFrame = FIRSTFRAME)
        {
            _firstFrame = firstFrame;

            initLibBacktrace();

            if(state)
            {
                backtrace_simple(state, _firstFrame, &simpleCallback,
                    &simpleErrorCallback, cast(void*)this);
            }
        }

        override int opApply( scope int delegate(ref const(char[])) dg ) const
        {
            return opApply( (ref size_t, ref const(char[]) buf)
                            {
                                return dg( buf );
                            } );
        }

        override int opApply( scope int delegate(ref size_t, ref const(char[])) dg ) const
        {
            return opApply( (ref size_t i, ref SymbolOrError sym)
                {
                    char[512] buffer = '\0';
                    char[] msg;
                    if(sym.errnum != 0)
                    {
                        auto retval = snprintf(buffer.ptr, buffer.length,
                            "libbacktrace error: '%s' errno: %d", sym.msg, sym.errnum);

                        if(retval >= buffer.length)
                            msg = buffer[0 .. $-1]; //Ignore zero terminator
                        else if(retval > 0)
                            msg = buffer[0 .. retval];
                    }
                    else
                    {
                        msg = formatLine(sym.symbol, buffer);
                    }

                    return dg(i, msg);
                } );
        }

        int opApply(ApplyCallback dg) const
        {
            //If backtrace_simple produced an error report it and exit
            if(!state || error != 0)
            {
                size_t pos = 0;
                SymbolOrError symError;
                symError.errnum = error;
                symError.msg = errorBuf.ptr;

                return dg(pos, symError);
            }

            SymbolCallbackInfo cinfo;
            cinfo.applyCB = dg;
            cinfo.state = cast(backtrace_state*)state;

            //Try using debug info first
            foreach(i, pc; pcs[0 .. numPCs])
            {
                //FIXME: We may violate const guarantees here...
                if(backtrace_pcinfo(cast(backtrace_state*)state, pc, &pcinfoCallback,
                    &pcinfoErrorCallback, &cinfo) != 0)
                {
                    break; //User delegate requested abort or no debug info at all
                }
            }

            //If no error or other error which has already been reported via callback
            if(!cinfo.noInfo)
                return cinfo.retval;

            //Try using symbol table
            cinfo.reset();
            foreach(pc; pcs[0 .. numPCs])
            {
                if(backtrace_syminfo(cast(backtrace_state*)state, pc, &syminfoCallback,
                    &pcinfoErrorCallback, &cinfo) == 0)
                {
                    break;
                }
            }

            if(!cinfo.noInfo)
                return cinfo.retval;

            //No symbol table
            foreach(i, pc; pcs[0 .. numPCs])
            {
                auto sym = SymbolOrError(0, SymbolInfo(null, null, 0, cast(void*)pc));
                if(auto ret = dg(i, sym) != 0)
                    return ret;
            }

            return 0;
        }

        override string toString() const
        {
            string buf;
            foreach(i, const(char[]) line; this )
                buf ~= i ? "\n" ~ line : line;
            return buf;
        }

    private:
        static backtrace_state* state = null;
        static bool initialized       = false;
        size_t                  numPCs = 0;
        uintptr_t[MAXFRAMES]    pcs;

        int                   error = 0;
        int                   _firstFrame = 0;
        char[128]             errorBuf;
    }
}
else
{
    /*
     * Our fallback backtrace implementation using libgcc's unwind
     * and backtrace support. In theory libbacktrace should be available
     * everywhere where this code works. We keep it anyway till libbacktrace
     * is well-tested.
     */
    public class GDCBacktrace : Throwable.TraceInfo
    {
        this(int firstFrame = FIRSTFRAME)
        {
            _firstFrame = firstFrame;
            _callstack = gdcBacktrace();
            _framelist = gdcBacktraceSymbols(_callstack);
        }

        override int opApply( scope int delegate(ref const(char[])) dg ) const
        {
            return opApply( (ref size_t, ref const(char[]) buf)
                            {
                                return dg( buf );
                            } );
        }

        override int opApply( scope int delegate(ref size_t, ref const(char[])) dg ) const
        {
            int ret = 0;
            char[512] fixbuf = '\0';

            for( int i = _firstFrame; i < _framelist.entries; ++i )
            {
                auto pos = cast(size_t)(i - _firstFrame);
                auto buf = formatLine(_framelist.symbols[i], fixbuf);
                ret = dg( pos, buf );
                if( ret )
                    break;
            }
            return ret;
        }

        override string toString() const
        {
            string buf;
            foreach( i, line; this )
                buf ~= i ? "\n" ~ line : line;
            return buf;
        }

    private:
        BTSymbolData     _framelist;
        GDCBacktraceData _callstack;
        int              _firstFrame = 0;
    }

    // Implementation details
    private:
        import gcc.unwind;

        static enum MAXFRAMES = 128;

        struct GDCBacktraceData
        {
            void*[MAXFRAMES] callstack;
            int numframes = 0;
        }

        struct BTSymbolData
        {
            size_t entries;
            SymbolInfo[MAXFRAMES] symbols;
        }

        static extern (C) _Unwind_Reason_Code unwindCB(_Unwind_Context *ctx, void *d)
        {
            GDCBacktraceData* bt = cast(GDCBacktraceData*)d;
            if(bt.numframes >= MAXFRAMES)
                return _URC_NO_REASON;

            bt.callstack[bt.numframes] = cast(void*)_Unwind_GetIP(ctx);
            bt.numframes++;
            return _URC_NO_REASON;
        }

        GDCBacktraceData gdcBacktrace()
        {
            GDCBacktraceData stackframe;
            _Unwind_Backtrace(&unwindCB, &stackframe);
            return stackframe;
        }

        BTSymbolData gdcBacktraceSymbols(GDCBacktraceData data)
        {
            BTSymbolData symData;

            for(auto i = 0; i < data.numframes; i++)
            {
                static if(HAVE_DLADDR)
                {
                    Dl_info funcInfo;

                    if(data.callstack[i] !is null && dladdr(data.callstack[i], &funcInfo) != 0)
                    {
                        symData.symbols[symData.entries].funcName = funcInfo.dli_sname;

                        symData.symbols[symData.entries].address = data.callstack[i];
                        symData.entries++;
                    }
                    else
                    {
                        symData.symbols[symData.entries].address = data.callstack[i];
                        symData.entries++;
                    }
                }
                else
                {
                    symData.symbols[symData.entries].address = data.callstack[i];
                    symData.entries++;
                }
            }

            return symData;
        }
}

/*
 * Struct representing a symbol (function) in the backtrace
 */
struct SymbolInfo
{
    const(char)* funcName, fileName;
    size_t line;
    const(void)* address;
}

/*
 * Format one output line for symbol sym.
 * Returns a slice of fixbuf.
 */
char[] formatLine(const SymbolInfo sym, ref char[512] fixbuf)
{
    import core.demangle, core.stdc.config;
    import core.stdc.stdio : snprintf, printf;
    import core.stdc.string : strlen;

    int ret;

    ret = snprintf(fixbuf.ptr, fixbuf.sizeof, "0x%lx ", cast(c_ulong)sym.address);
    if(ret >= fixbuf.sizeof)
        return fixbuf[0 .. $-1]; //Ignore zero terminator

    if(sym.funcName is null)
    {
        if(!(fixbuf.sizeof - ret > 3))
            return fixbuf[0 .. ret];

        fixbuf[ret] = fixbuf[ret+1] = fixbuf[ret+2] = '?';
        ret += 3;
    }
    else
    {
        auto demangled = demangle(sym.funcName[0 .. strlen(sym.funcName)],
            fixbuf[ret .. $-1]);

        ret += demangled.length;
        if(ret + 1 >= fixbuf.sizeof)
            return fixbuf[0 .. $-1]; //Ignore zero terminator
    }

    ret += snprintf(fixbuf.ptr + ret, fixbuf.sizeof - ret, "\n\t%s:%d",
        sym.fileName is null ? "???" : sym.fileName,
        sym.line);

    if(ret >= fixbuf.sizeof)
        return fixbuf[0 .. $-1]; //Ignore zero terminator
    else
        return fixbuf[0 .. ret];
}


unittest
{
    char[512] sbuf = '\0';
    char[] result;
    string longString;
    for(size_t i = 0; i < 60; i++)
        longString ~= "abcdefghij";
    longString ~= '\0';

    auto symbol = SymbolInfo(null, null, 0, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo(longString.ptr, null, 0, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo("func", "test.d", 0, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo("func", longString.ptr, 0, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo(longString.ptr, "test.d", 0, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo(longString.ptr, longString.ptr, 0, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo("func", "test.d", 1000, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo(null, (longString[0..500] ~ '\0').ptr, 100000000, null);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo("func", "test.d", 0, cast(void*)0x100000);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo("func", null, 0, cast(void*)0x100000);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo(null, "test.d", 0, cast(void*)0x100000);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');

    symbol = SymbolInfo(longString.ptr, "test.d", 0, cast(void*)0x100000);
    result = formatLine(symbol, sbuf);
    assert(result.length < 512 && result.ptr[result.length] == '\0' && sbuf[$-1] == '\0');
}