stk-code_catmod/src/utils/leak_check.cpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2011-2015 Marianne Gagnon, Joerg Henrichs
//
// 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.
//
// 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.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

#include "utils/leak_check.hpp"

#include "utils/crash_reporting.hpp"
#include "utils/log.hpp"
#include "utils/ptr_vector.hpp"
#include "utils/string_utils.hpp"
#include "utils/synchronised.hpp"

#ifdef DEBUG

/** Define this to get the backtrace of the leaks (slows down execution a little) */
#undef GET_STACK_TRACE

Synchronised<int> m_lock_stacktrace;


#ifdef GET_STACK_TRACE
#  ifdef __APPLE__
#    include <Availability.h>
#    include <execinfo.h>
#  endif
#endif

#include <iostream>
#include <set>
#include <stdio.h>

namespace MemoryLeaks
{
    /** A set with all currently allocated objects. */
    Synchronised< std::set<AllocatedObject*> > g_all_objects;

    // ------------------------------------------------------------------------
    AllocatedObject::AllocatedObject()
    {
#ifdef GET_STACK_TRACE
#  if defined(__APPLE__)
        const int max_size = 32;
        void* callstack[max_size];
        m_stack_size = backtrace(callstack, max_size);

        m_stack = backtrace_symbols(callstack, m_stack_size);
#  elif defined(WIN32) || ENABLE_LIBBFD
        m_lock_stacktrace.lock();
        CrashReporting::getCallStack(m_stack);
        m_lock_stacktrace.unlock();
#  endif
#endif
        addObject(this);
    }   // AllocatedObject

    // ------------------------------------------------------------------------
    AllocatedObject::~AllocatedObject()
    {
        removeObject(this);
    }   // ~AllocatedObject
    // ------------------------------------------------------------------------
    /** Print the data associated with the objects.
     */
    void AllocatedObject::print() const
    {
#ifdef GET_STACK_TRACE
#  if defined ENABLE_LIBBFD
        std::vector<std::string> calls = StringUtils::split(m_stack, '\n');
        // Ignore the first 3 entries
        for (unsigned int i = 3; i < calls.size(); ++i)
        {
            Log::error("LeakCheck", "    %s", calls[i].c_str());
        }
#  elif defined(__APPLE__)
        for (int i = 0; i < m_stack_size; ++i)
        {
            Log::error("LeakCheck", "    %s\n", m_stack[i]);
        }
#  elif defined(WIN32)
        std::vector<std::string> calls = StringUtils::split(m_stack, '\n');
        // Ignore the first 4 entries, which are: empty, getCallStack(),
        // AllocatedObject(),LeakCheck()
        for (unsigned int i = 4; i < calls.size(); ++i)
        {
            Log::error("LeakCheck", "    %s", calls[i].c_str());
        }
#  endif
#else
        printf("    (No stack information available)\n");
#endif

    }   // print

    // ========================================================================
    /** Adds an object to the sets of all allocated objects. */
    void addObject(AllocatedObject* obj)
    {
        g_all_objects.lock();
        g_all_objects.getData().insert(obj);
        g_all_objects.unlock();
    }   // addObject

    // ------------------------------------------------------------------------
    /** Removes an object from the set of all allocated objects. */
    void removeObject(AllocatedObject* obj)
    {
        g_all_objects.lock();
        g_all_objects.getData().erase(obj);
        g_all_objects.unlock();
        //delete obj;
    }   // removeObject

    // ------------------------------------------------------------------------
    /** Checks if any objects are still allocated, and if so print information
     *  about those objects. */
    void checkForLeaks()
    {
        Log::debug("LeackCheck", "checking for leaks... ");
        g_all_objects.lock();
        if (g_all_objects.getData().size()>0)
        {
            Log::error("LeackCheck", "leaks detected!!");
            Log::error("LeackCheck", "\n\n* * * * WARNING * * * * WARNING * * * * "
                       "MEMORY LEAK! * * * *");
            Log::error("LeackCheck", "%d watched objects leaking.",
                       g_all_objects.getData().size());

        }
        else
        {
            Log::debug("LeackCheck", "ok (no watched class left leaking)");
        }

        std::set<AllocatedObject*>::iterator it;
        for (it  = g_all_objects.getData().begin();
             it != g_all_objects.getData().end();   ++it)
        {
            (*it)->print();
        }
        g_all_objects.unlock();
    }   // checkForLeaks

}   // namespace MemoryLeaks

#endif