ClickHouse/dbms/src/Common/StackTrace.cpp

#if !defined(__APPLE__) && !defined(__FreeBSD__)
#include <malloc.h>
#endif
#include <execinfo.h>
#include <string.h>

#include <sstream>

#include <Common/StackTrace.h>
#include <Common/SimpleCache.h>

#include <common/demangle.h>


/// Arcadia compatibility DEVTOOLS-3976
#if defined(BACKTRACE_INCLUDE)
#include BACKTRACE_INCLUDE
#endif
#if !defined(BACKTRACE_FUNC)
    #define BACKTRACE_FUNC backtrace
#endif

StackTrace::StackTrace()
{
    frames_size = BACKTRACE_FUNC(frames.data(), STACK_TRACE_MAX_DEPTH);

    for (size_t i = frames_size; i < STACK_TRACE_MAX_DEPTH; ++i)
        frames[i] = nullptr;
}


std::string StackTrace::toStringImpl(const Frames & frames, size_t frames_size)
{
    char ** symbols = backtrace_symbols(frames.data(), frames_size);
    if (!symbols)
        return "Cannot get symbols for stack trace.\n";

    std::stringstream res;
    try
    {
        for (size_t i = 0, size = frames_size; i < size; ++i)
        {
            /// We do "demangling" of names. The name is in parenthesis, before the '+' character.

            char * name_start = nullptr;
            char * name_end = nullptr;
            std::string demangled_name;
            int status = 0;

            if (nullptr != (name_start = strchr(symbols[i], '('))
                && nullptr != (name_end = strchr(name_start, '+')))
            {
                ++name_start;
                *name_end = '\0';
                demangled_name = demangle(name_start, status);
                *name_end = '+';
            }

            res << i << ". ";

            if (0 == status && name_start && name_end)
            {
                res.write(symbols[i], name_start - symbols[i]);
                res << demangled_name << name_end;
            }
            else
                res << symbols[i];

            res << std::endl;
        }
    }
    catch (...)
    {
        free(symbols);
        throw;
    }

    free(symbols);
    return res.str();
}


std::string StackTrace::toString() const
{
    /// Calculation of stack trace text is extremely slow.
    /// We use simple cache because otherwise the server could be overloaded by trash queries.

    static SimpleCache<decltype(StackTrace::toStringImpl), &StackTrace::toStringImpl> func_cached;
    return func_cached(frames, frames_size);
}