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 namespace PBD {
  38         void stacktrace (std::ostream& out, int levels = 0);
  39         void trace_twb();
  40
  41 template<typename T>
  42 class thing_with_backtrace
  43 {
  44   public:
  45     thing_with_backtrace () {
  46             trace_twb();
  47 #ifdef HAVE_EXECINFO
  48             allocation_backtrace = new void*[50];
  49             allocation_backtrace_size = backtrace (allocation_backtrace, 50);
  50 #else
  51             allocation_backtrace_size = 0;
  52 #endif
  53             Glib::Threads::Mutex::Lock lm (all_mutex);
  54             all.push_back (this);
  55     }
  56
  57     thing_with_backtrace (const thing_with_backtrace<T>& other) {
  58             trace_twb();
  59 #ifdef HAVE_EXECINFO
  60             allocation_backtrace = new void*[50];
  61             allocation_backtrace_size = backtrace (allocation_backtrace, 50);
  62 #else
  63             allocation_backtrace_size = 0;
  64 #endif
  65             Glib::Threads::Mutex::Lock lm (all_mutex);
  66             all.push_back (this);
  67     }
  68
  69     ~thing_with_backtrace() {
  70             if (allocation_backtrace_size) {
  71                     delete [] allocation_backtrace;
  72             }
  73             Glib::Threads::Mutex::Lock lm (all_mutex);
  74             all.remove (this);
  75     }
  76
  77     thing_with_backtrace<T>& operator= (const thing_with_backtrace<T>& other) {
  78             /* no copyable members */
  79             return *this;
  80     }
  81
  82     static void peek_a_boo (std::ostream& stream) {
  83 #ifdef HAVE_EXECINFO
  84             typename std::list<thing_with_backtrace<T>*>::iterator x;
  85             for (x = all.begin(); x != all.end(); ++x) {
  86                     char **strings;
  87                     size_t i;
  88
  89                     strings = backtrace_symbols ((*x)->allocation_backtrace, (*x)->allocation_backtrace_size);
  90
  91                     if (strings) {
  92                             stream << "--- ALLOCATED SHARED_PTR @ " << (*x) << std::endl;
  93                             for (i = 0; i < (*x)->allocation_backtrace_size && i < 50U; i++) {
  94                                     stream << strings[i] << std::endl;
  95                             }
  96                             free (strings);
  97                     }
  98             }
  99 #else
 100             stream << "execinfo not defined for this platform" << std::endl;
 101 #endif
 102     }
 103
 104 private:
 105     void** allocation_backtrace;
 106     int allocation_backtrace_size;
 107     static std::list<thing_with_backtrace<T>* > all;
 108     static Glib::Threads::Mutex all_mutex;
 109 };
 110
 111 template<typename T> std::list<PBD::thing_with_backtrace<T> *> PBD::thing_with_backtrace<T>::all;
 112 template<typename T> Glib::Threads::Mutex PBD::thing_with_backtrace<T>::all_mutex;
 113
 114 } // namespace PBD
 115
 116
 117
 118 #endif /* __libpbd_stacktrace_h__ */