From 89b411990a88179dfb53fc450425c7f3838c7b26 Mon Sep 17 00:00:00 2001
From: Michael Davidsaver <mdavidsaver@bnl.gov>
Date: Sun, 4 Jan 2015 12:09:10 -0500
Subject: [PATCH] Reference counter debugging

---
 Makefile                       |   2 +
 devsupApp/src/Makefile         |   1 +
 devsupApp/src/devsup/disect.py | 117 +++++++++++++++++++++++++++++++++
 documentation/devsup.rst       |   5 ++
 test.cmd                       |   3 +
 5 files changed, 128 insertions(+)
 create mode 100644 devsupApp/src/devsup/disect.py

diff --git a/Makefile b/Makefile
index 7824dc6..2627e9a 100644
--- a/Makefile
+++ b/Makefile
@@ -19,3 +19,5 @@ UNINSTALL_DIRS += $(wildcard $(INSTALL_LOCATION)/python*)
 #useful targets includ: doc-html and doc-clean
 doc-%:
 	PYTHONPATH=$$PWD/python$(PY_VER)/$(EPICS_HOST_ARCH) $(MAKE) -C documentation $*
+
+doc: doc-html
diff --git a/devsupApp/src/Makefile b/devsupApp/src/Makefile
index 53af864..242646b 100644
--- a/devsupApp/src/Makefile
+++ b/devsupApp/src/Makefile
@@ -77,6 +77,7 @@ PY += devsup/db.py
 PY += devsup/hooks.py
 PY += devsup/interfaces.py
 PY += devsup/util.py
+PY += devsup/disect.py
 PY += devsup/ptable.py
 
 #===========================
diff --git a/devsupApp/src/devsup/disect.py b/devsupApp/src/devsup/disect.py
new file mode 100644
index 0000000..a106fb2
--- /dev/null
+++ b/devsupApp/src/devsup/disect.py
@@ -0,0 +1,117 @@
+"""Python reference counter statistics.
+"""
+import sys, gc, inspect, weakref, time
+from UserDict import UserDict
+from types import InstanceType
+
+# a special container which we can recognize and avoid
+# including in output sets, which might create reference loops
+class _StatsDict(weakref.WeakKeyDictionary):
+  pass
+
+class StatsDelta(object):
+  """GC statistics tracking.
+
+  Monitors the number of instances of each type/class (cf. gcstats())
+  and prints a report of any changes (ie. new types/count changes).
+  Intended to assist in detecting reference leaks.
+  """
+  def __init__(self):
+    self.reset()
+  def reset(self):
+    """Reset internal statistics counters
+    """
+    self.stats, self.ntypes = None, None
+  def collect(self, file=sys.stderr):
+    """Collect stats and print results to file
+
+    :param file: A writable file-like object
+    """
+    cur = gcstats()
+    Ncur = len(cur)
+    if self.stats is not None:
+      prev = self.stats
+      Nprev = self.ntypes # may be less than len(prev)
+
+      if Ncur!=Nprev:
+        print >>file,"# Types %d -> %d"%(Nprev,Ncur)
+
+      Scur, Sprev, first = set(cur), set(prev), True
+      for T in Scur-Sprev: # new types
+        if first:
+          print >>file,'New Types'
+          first=False
+        print >>file,' ',T,cur[T]
+
+      first = True
+      for T in Scur&Sprev:
+        if cur[T]==prev[T]:
+          continue
+        if first:
+          print >>file,'Known Types'
+          first=False
+        print >>file,' ',T,cur[T],'delta',cur[T]-prev[T]
+
+    self.stats, self.ntypes = cur, len(cur)
+    #gc.collect()
+
+def gcstats():
+  """Count the number of instances of each type/class
+
+  :returns: A WeakKeyDictionary mapping type to an integer number of references
+  """
+  all = gc.get_objects()
+  _stats = {}
+
+  for obj in all:
+    K = type(obj)
+    if K in [_StatsDict, StatsDelta]:
+      continue # avoid counting ourselves
+
+    elif K is InstanceType: # instance of an old-style class
+      K = getattr(obj, '__class__', K)
+
+    try:
+      _stats[K] += 1
+    except KeyError:
+      _stats[K] = 1
+
+  # explicitly break the reference loop between the list and this frame,
+  # which is contained in the list
+  # This would otherwise prevent the list from being free'd
+  del all
+
+  # use a weakref to allow types to be GC'd
+  return _StatsDict(_stats)
+
+class _StatsThread(object):
+  def __init__(self, period, file):
+    self.period, self.file = period, file
+    self.S = StatsDelta()
+
+  def __call__(self):
+    while True:
+      self.S.collect(file=self.file)
+      time.sleep(self.period)
+
+def periodic(period=60.0, file=sys.stderr):
+  """Start a daemon thread which will periodically print GC stats
+
+  :param period: Update period in seconds
+  :param file: A writable file-like object
+  """
+  import threading, time
+  S = _StatsThread(period=period, file=file)
+  T = threading.Thread(target=S)
+  T.daemon = True
+  T.start()
+
+if __name__=='__main__':
+  #for T,C in gcstats().iteritems():
+  #  print T,C
+  gc.set_debug(gc.DEBUG_COLLECTABLE|gc.DEBUG_INSTANCES|gc.DEBUG_OBJECTS)
+  S=StatsDelta()
+  while True:
+    print 'Iteration'
+    S.collect()
+    #gc.collect()
diff --git a/documentation/devsup.rst b/documentation/devsup.rst
index 054e792..01f6e7c 100644
--- a/documentation/devsup.rst
+++ b/documentation/devsup.rst
@@ -112,3 +112,8 @@ devsup Package
     :undoc-members:
     :show-inheritance:
 
+:mod:`disect` Module
+--------------------
+
+.. automodule:: devsup.disect
+    :members:
diff --git a/test.cmd b/test.cmd
index fee11f9..210dcdf 100644
--- a/test.cmd
+++ b/test.cmd
@@ -21,3 +21,6 @@ dbLoadRecords("db/test.db","P=md:")
 dbLoadRecords("db/test6.db","P=tst:,TNAME=tsum")
 
 iocInit()
+
+# Start Reference tracker
+py "from devsup import disect; disect.periodic(10)"