libs/pbd/pbd/stacktrace.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __libpbd_stacktrace_h__
  21 #define __libpbd_stacktrace_h__
  22
  23 #ifdef HAVE_WAFBUILD
  24 #include "libpbd-config.h"
  25 #endif
  26
  27 #include <iostream>
  28 #include <ostream>
  29 #include <glibmm/threads.h>
  30 #include <list>
  31
  32 #ifdef HAVE_EXECINFO
  33 #include <execinfo.h>
  34 #include <cstdlib>
  35 #endif
  36
  37 #include "pbd/libpbd_visibility.h"
  38
  39
  40 namespace PBD {
  41
  42         LIBPBD_API void stacktrace (std::ostream& out, int levels = 0);
  43         LIBPBD_API void trace_twb();
  44
  45 template<typename T>
  46 class /*LIBPBD_API*/ thing_with_backtrace
  47 {
  48   public:
  49     thing_with_backtrace () {
  50             trace_twb();
  51 #ifdef HAVE_EXECINFO
  52             allocation_backtrace = new void*[50];
  53             allocation_backtrace_size = backtrace (allocation_backtrace, 50);
  54 #else
  55             allocation_backtrace_size = 0;
  56 #endif
  57             Glib::Threads::Mutex::Lock lm (all_mutex);
  58             all.push_back (this);
  59     }
  60
  61     thing_with_backtrace (const thing_with_backtrace<T>& other) {
  62             trace_twb();
  63 #ifdef HAVE_EXECINFO
  64             allocation_backtrace = new void*[50];
  65             allocation_backtrace_size = backtrace (allocation_backtrace, 50);
  66 #else
  67             allocation_backtrace_size = 0;
  68 #endif
  69             Glib::Threads::Mutex::Lock lm (all_mutex);
  70             all.push_back (this);
  71     }
  72
  73     ~thing_with_backtrace() {
  74             if (allocation_backtrace_size) {
  75                     delete [] allocation_backtrace;
  76             }
  77             Glib::Threads::Mutex::Lock lm (all_mutex);
  78             all.remove (this);
  79     }
  80
  81     thing_with_backtrace<T>& operator= (const thing_with_backtrace<T>& other) {
  82             /* no copyable members */
  83             return *this;
  84     }
  85
  86     static void peek_a_boo (std::ostream& stream) {
  87 #ifdef HAVE_EXECINFO
  88             typename std::list<thing_with_backtrace<T>*>::iterator x;
  89             for (x = all.begin(); x != all.end(); ++x) {
  90                     char **strings;
  91                     size_t i;
  92
  93                     strings = backtrace_symbols ((*x)->allocation_backtrace, (*x)->allocation_backtrace_size);
  94
  95                     if (strings) {
  96                             stream << "--- ALLOCATED SHARED_PTR @ " << (*x) << std::endl;
  97                             for (i = 0; i < (*x)->allocation_backtrace_size && i < 50U; i++) {
  98                                     stream << strings[i] << std::endl;
  99                             }
 100                             free (strings);
 101                     }
 102             }
 103 #else
 104             stream << "execinfo not defined for this platform" << std::endl;
 105 #endif
 106     }
 107
 108 private:
 109     void** allocation_backtrace;
 110     int allocation_backtrace_size;
 111     static std::list<thing_with_backtrace<T>* > all;
 112     static Glib::Threads::Mutex all_mutex;
 113 };
 114
 115 template<typename T> /*LIBPBD_API*/ std::list<PBD::thing_with_backtrace<T> *> PBD::thing_with_backtrace<T>::all;
 116 template<typename T> /*LIBPBD_API*/ Glib::Threads::Mutex PBD::thing_with_backtrace<T>::all_mutex;
 117
 118 } // namespace PBD
 119
 120 #endif /* __libpbd_stacktrace_h__ */