/*
- Copyright (C) 2009 Paul Davis
- From an idea by Carl Hetherington.
-
- 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., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2009-2018 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
+ *
+ * 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 "libpbd-config.h"
#include <map>
#include <set>
#include <vector>
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
#include <boost/shared_ptr.hpp>
#include "pbd/stacktrace.h"
+#include "pbd/boost_debug.h"
class Backtrace {
public:
- Backtrace (int op, int use_count, void const* pn);
- std::ostream& print (std::ostream& str) const;
- int use_count() const { return _use_count; }
- void const* pn() const { return _pn; }
- int op() const { return _op; }
+ Backtrace ();
+ std::ostream& print (std::ostream& str) const;
private:
- int _op;
- void const* _pn;
- void* trace[200];
- size_t size;
- int _use_count;
+ void* trace[200];
+ size_t size;
};
std::ostream& operator<< (std::ostream& str, const Backtrace& bt) { return bt.print (str); }
-
-Backtrace::Backtrace(int op, int uc, void const* pn) {
- _op = op;
- _pn = pn;
- _use_count = uc;
+Backtrace::Backtrace()
+{
#ifdef HAVE_EXECINFO
size = ::backtrace (trace, 200);
#endif
size_t i;
if (size) {
- str << "BT generated with use count = " << _use_count << std::endl;
-
#ifdef HAVE_EXECINFO
strings = ::backtrace_symbols (trace, size);
-#endif
+#endif
if (strings) {
- for (i = 5; i < 5+12; i++) {
+ for (i = 3; i < 5+18 && i < size; i++) {
str << strings[i] << std::endl;
}
free (strings);
return str;
}
-struct BTPair {
+struct BTPair {
- Backtrace* ref;
- Backtrace* rel;
- long use_count;
-
- BTPair (Backtrace* bt, long uc) : ref (bt), rel (0), use_count (uc) {}
- ~BTPair () { }
+ Backtrace* ref;
+ Backtrace* rel;
+ BTPair (Backtrace* bt) : ref (bt), rel (0) {}
+ ~BTPair () { }
};
std::ostream& operator<<(std::ostream& str, const BTPair& btp) {
str << "*********************************************\n";
- str << "@ " << btp.use_count << " Ref:\n";
if (btp.ref) str << *btp.ref << std::endl;
str << "Rel:\n";
if (btp.rel) str << *btp.rel << std::endl;
return str;
}
-struct SPDebug {
- Backtrace* constructor;
- Backtrace* destructor;
- std::vector<BTPair> others;
+struct SPDebug {
+ Backtrace* constructor;
+ Backtrace* destructor;
- SPDebug (Backtrace* c) : constructor (c), destructor (0) {}
- ~SPDebug () {
- delete constructor;
- delete destructor;
- }
+ SPDebug (Backtrace* c) : constructor (c), destructor (0) {}
+ ~SPDebug () {
+ delete constructor;
+ delete destructor;
+ }
};
std::ostream& operator<< (std::ostream& str, const SPDebug& spd)
{
- str << "Concerructor :" << std::endl;
+ str << "Constructor :" << std::endl;
if (spd.constructor) {
str << *spd.constructor << std::endl;
}
- str << "\nDestructor :" << std::endl;
- if (spd.destructor) {
- str << *spd.destructor << std::endl;
- }
-
- for (std::vector<BTPair>::const_iterator x = spd.others.begin(); x != spd.others.end(); ++x) {
- str << *x << std::endl;
- }
return str;
}
-typedef std::multimap<void const*,SPDebug*> TraceMap;
-typedef std::map<void const*,const char*> PointerMap;
-typedef std::map<void const*,void const*> PointerSet;
-
-static TraceMap traces;
-static PointerMap interesting_pointers;
-static PointerSet interesting_counters;
-static Glib::StaticMutex the_lock;
+typedef std::multimap<volatile void const*,SPDebug*> PointerMap;
+typedef std::map<volatile void const*,const char*> IPointerMap;
using namespace std;
-static void
-trace_it (int op, void const* pn, void const* object, int use_count)
+static PointerMap* _sptrs;
+PointerMap& sptrs()
{
- Glib::Mutex::Lock guard (the_lock);
- Backtrace* bt = new Backtrace (op, use_count, pn);
- TraceMap::iterator i = traces.find (const_cast<void*>(object));
-
- if (i == traces.end()) {
- pair<void const *,SPDebug*> newpair;
- newpair.first = object;
-
- if (op != 0) {
- cerr << "SPDEBUG: non-constructor op without entry in trace map\n";
- return;
- }
- newpair.second = new SPDebug (bt);
- traces.insert (newpair);
+ if (_sptrs == 0) {
+ _sptrs = new PointerMap;
+ }
+ return *_sptrs;
+}
- } else {
- if (op == 0) {
- cerr << "SPDEBUG: claimed constructor, but have range for this object\n";
- return;
- } else if (op == 2) {
- i->second->destructor = bt;
- } else {
- SPDebug* spd = i->second;
-
- if (spd->others.empty() || op == 1) {
- spd->others.push_back (BTPair (bt, use_count));
- } else {
- if (op == -1) {
- if (spd->others.back().use_count == use_count-1) {
- spd->others.back().rel = bt;
- } else {
- cerr << "********** FLoating REL\n";
- spd->others.push_back (BTPair (0, use_count));
- spd->others.back().rel = bt;
- }
- } else {
- cerr << "SPDEBUG: illegal op number " << op << endl;
- abort ();
- }
- }
- }
+static IPointerMap* _interesting_pointers;
+IPointerMap& interesting_pointers()
+{
+ if (_interesting_pointers == 0) {
+ _interesting_pointers = new IPointerMap;
+ }
+ return *_interesting_pointers;
+}
+
+static Glib::Threads::Mutex* _the_lock;
+static Glib::Threads::Mutex& the_lock()
+{
+ if (_the_lock == 0) {
+ _the_lock = new Glib::Threads::Mutex;
}
+ return *_the_lock;
}
+
static bool
-is_interesting_object (void const* ptr)
+is_interesting_object (volatile void const* ptr)
{
if (ptr == 0) {
return false;
}
-
- return interesting_pointers.find (ptr) != interesting_pointers.end();
+
+ return interesting_pointers().find (ptr) != interesting_pointers().end();
}
/* ------------------------------- */
+static bool debug_out = false;
+
+void
+boost_debug_shared_ptr_show_live_debugging (bool yn)
+{
+ debug_out = yn;
+}
+
void
boost_debug_shared_ptr_mark_interesting (void* ptr, const char* type)
{
- Glib::Mutex::Lock guard (the_lock);
- pair<void*,const char*> newpair (ptr, type);
- interesting_pointers.insert (newpair);
- cerr << "New interesting pointer: " << ptr << " type = " << type << endl;
- for (PointerMap::iterator i = interesting_pointers.begin(); i != interesting_pointers.end(); ++i) {
- cerr << "IP : " << i->first << " type = " << i->second << endl;
- }
- cerr << "is interesting ? " << is_interesting_object (ptr) << endl;
+ Glib::Threads::Mutex::Lock guard (the_lock());
+ pair<void*,const char*> newpair (ptr, type);
+ interesting_pointers().insert (newpair);
+ if (debug_out) {
+ cerr << "Interesting object @ " << ptr << " of type " << type << endl;
+ }
}
void
-boost_debug_shared_ptr_show (ostream& str, void* ptr)
+boost_debug_shared_ptr_operator_equals (void const *sp, void const *old_obj, int old_use_count, void const *obj, int new_use_count)
{
- Glib::Mutex::Lock guard (the_lock);
- pair<TraceMap::iterator,TraceMap::iterator> range;
+ if (old_obj == 0 && obj == 0) {
+ return;
+ }
- range = traces.equal_range (ptr);
+ Glib::Threads::Mutex::Lock guard (the_lock());
- if (range.first == traces.end()) {
- str << "No shared_ptr debugging information found for " << ptr << endl;
- return;
+ if (is_interesting_object (old_obj) || is_interesting_object (obj)) {
+ if (debug_out) {
+ cerr << "ASSIGN SWAPS " << old_obj << " & " << obj << endl;
+ }
}
- str << "\n\n--------------------------------------------------------\ninfo for " << ptr << endl;
+ if (is_interesting_object (old_obj)) {
+ if (debug_out) {
+ cerr << "\tlost old sp @ " << sp << " for " << old_obj << " UC = " << old_use_count << " now for " << obj << " UC = " << new_use_count
+ << " (total sp's = " << sptrs().size() << ')' << endl;
+ }
+ PointerMap::iterator x = sptrs().find (sp);
- for (TraceMap::iterator i = range.first; i != range.second; ++i) {
- str << *i->second << endl;
+ if (x != sptrs().end()) {
+ sptrs().erase (x);
+ if (debug_out) {
+ cerr << "\tRemoved (by assignment) sp for " << old_obj << " @ " << sp << " UC = " << old_use_count << " (total sp's = " << sptrs().size() << ')' << endl;
+ }
+ }
}
-}
-namespace boost {
+ if (is_interesting_object (obj)) {
-void sp_scalar_constructor_hook( void * object, std::size_t size, void * pn )
-{
- if (is_interesting_object (object)) {
- cerr << "Interesting counter @ " << pn << endl;
- pair<void const*,void const*> newpair (pn, object);
- interesting_counters.insert (newpair);
- trace_it (0, pn, object, ((boost::detail::sp_counted_base*)pn)->use_count());
-
+ pair<void const*, SPDebug*> newpair;
+
+ newpair.first = sp;
+ newpair.second = new SPDebug (new Backtrace());
+
+ sptrs().insert (newpair);
+
+ if (debug_out) {
+ cerr << "assignment created sp for " << obj << " @ " << sp << " used to point to " << old_obj << " UC = " << old_use_count
+ << " UC = " << new_use_count
+ << " (total sp's = " << sptrs().size() << ')' << endl;
+ cerr << *newpair.second << endl;
+ }
}
}
-void sp_scalar_destructor_hook( void * object, std::size_t size, void * pn )
+void
+boost_debug_shared_ptr_reset (void const *sp, void const *old_obj, int old_use_count, void const *obj, int new_use_count)
{
- pair<TraceMap::iterator,TraceMap::iterator> range;
- long use_count = ((boost::detail::sp_counted_base*)pn)->use_count();
+ if (old_obj == 0 && obj == 0) {
+ return;
+ }
+
+ Glib::Threads::Mutex::Lock guard (the_lock());
+
+ if (is_interesting_object (old_obj) || is_interesting_object (obj)) {
+ if (debug_out) {
+ cerr << "RESET SWAPS " << old_obj << " & " << obj << endl;
+ }
+ }
+
+ if (is_interesting_object (old_obj)) {
+ if (debug_out) {
+ cerr << "\tlost old sp @ " << sp << " for " << old_obj << " UC = " << old_use_count << " now for " << obj << " UC = " << new_use_count
+ << " (total sp's = " << sptrs().size() << ')' << endl;
+ }
+ PointerMap::iterator x = sptrs().find (sp);
- if (is_interesting_object (object)) {
- trace_it (-1, pn, object, use_count);
+ if (x != sptrs().end()) {
+ sptrs().erase (x);
+ if (debug_out) {
+ cerr << "\tRemoved (by reset) sp for " << old_obj << " @ " << sp << " UC = " << old_use_count << " (total sp's = " << sptrs().size() << ')' << endl;
+ }
+ }
}
- if (use_count == 1) {
- // PointerMap::iterator p = interesting_pointers.find (object);
-
- //if (p != interesting_pointers.end()) {
- // interesting_pointers.erase (p);
- //}
+ if (is_interesting_object (obj)) {
+
+ pair<void const*, SPDebug*> newpair;
+
+ newpair.first = sp;
+ newpair.second = new SPDebug (new Backtrace());
+
+ sptrs().insert (newpair);
+
+ if (debug_out) {
+ cerr << "reset created sp for " << obj << " @ " << sp << " used to point to " << old_obj << " UC = " << old_use_count
+ << " UC = " << new_use_count
+ << " (total sp's = " << sptrs().size() << ')' << endl;
+ cerr << *newpair.second << endl;
+ }
}
}
-void sp_counter_ref_hook (void* pn, long use_count)
+void
+boost_debug_shared_ptr_destructor (void const *sp, volatile void const *obj, int use_count)
{
- PointerSet::iterator i = interesting_counters.find (pn);
- if (i != interesting_counters.end()) {
- // cerr << "UC for " << pn << " inc from " << use_count << endl;
- trace_it (1, pn, i->second, use_count);
+ Glib::Threads::Mutex::Lock guard (the_lock());
+ PointerMap::iterator x = sptrs().find (sp);
+
+ if (x != sptrs().end()) {
+ sptrs().erase (x);
+ if (debug_out) {
+ cerr << "Removed sp for " << obj << " @ " << sp << " UC = " << use_count << " (total sp's = " << sptrs().size() << ')' << endl;
+ }
}
}
-void sp_counter_release_hook (void* pn, long use_count)
+
+void
+boost_debug_shared_ptr_constructor (void const *sp, volatile void const *obj, int use_count)
{
- PointerSet::iterator i = interesting_counters.find (pn);
- if (i != interesting_counters.end()) {
- // cerr << "UC for " << pn << " dec from " << use_count << endl;
- if (use_count == 1) {
- trace_it (2, pn, i->second, use_count);
- } else {
- trace_it (-1, pn, i->second, use_count);
+ if (is_interesting_object (obj)) {
+ Glib::Threads::Mutex::Lock guard (the_lock());
+ pair<void const*, SPDebug*> newpair;
+
+ newpair.first = sp;
+ newpair.second = new SPDebug (new Backtrace());
+
+ sptrs().insert (newpair);
+ if (debug_out) {
+ cerr << "Stored constructor for " << obj << " @ " << sp << " UC = " << use_count << " (total sp's = " << sptrs().size() << ')' << endl;
+ cerr << *newpair.second << endl;
}
}
}
-void sp_array_constructor_hook(void * p)
+void
+boost_debug_count_ptrs ()
+{
+ Glib::Threads::Mutex::Lock guard (the_lock());
+ // cerr << "Tracking " << interesting_pointers().size() << " interesting objects with " << sptrs().size () << " shared ptrs\n";
+}
+
+void
+boost_debug_list_ptrs ()
+{
+ Glib::Threads::Mutex::Lock guard (the_lock());
+
+ if (sptrs().empty()) {
+ cerr << "There are no dangling shared ptrs\n";
+ } else {
+ for (PointerMap::iterator x = sptrs().begin(); x != sptrs().end(); ++x) {
+ cerr << "Shared ptr @ " << x->first << " history: "
+ << *x->second
+ << endl;
+ }
+ }
+}
+
+namespace boost {
+
+void sp_scalar_constructor_hook( void *, std::size_t, void *)
+{
+}
+
+void sp_scalar_destructor_hook( void *, std::size_t, void *)
+{
+}
+
+void sp_counter_ref_hook (void* /*pn*/, long /* use count */)
+{
+}
+
+void sp_counter_release_hook (void* /*pn*/, long /*use_count*/)
+{
+}
+
+void sp_array_constructor_hook(void *)
{
}
-void sp_array_destructor_hook(void * p)
+void sp_array_destructor_hook(void *)
{
}
-void sp_scalar_constructor_hook(void * p)
+void sp_scalar_constructor_hook(void *)
{
}
-void sp_scalar_destructor_hook(void * p)
+void sp_scalar_destructor_hook(void *)
{
}
projects / ardour.git / blobdiff