gdb.rb 0.1.1 → 0.1.2

data/README

@@ -1,6 +1,11 @@
 gdb7 hooks for MRI
   (c) 2009 Aman Gupta (tmm1)
 
+=== Requirements
+
+  gdb.rb currently requires x86_64 linux, and a REE 1.8 binary. Support for other MRI builds and
+  platforms is in the works.
+
 === Usage
 
   $ ps aux | grep deploy.rb
@@ -221,9 +226,24 @@ gdb7 hooks for MRI
      85825 NODE_CALL
     126739 NODE_ARRAY
 
+
 === TODO
 
   `ruby where` for the current stack trace
   `ruby print` to inspect ruby variables
   `ruby breakpoint` to breakpoint on ruby methods
   `ruby irb` for a simple interactive shell
+
+
+=== Credits
+
+  Tom Tromey for his work on gdb python support (gdb-eval.patch, gdb-breakpoints.patch) and help
+  tracking down some memory leaks (gdb-leak.patch)
+
+  Joe Damato for writing parts of ruby-gdb.py and various gdb hacks to make gdb.rb possible.
+
+
+=== License
+
+  Available under the Ruby License.
+

data/bin/gdb.rb

@@ -1,17 +1,27 @@
 #!/usr/bin/env ruby
 require 'rbconfig'
 
-if ARGV.size == 1 and ARGV[0] =~ /^\d+$/
-  ARGV.unshift "#{Config::CONFIG['bindir']}/ruby"
-elsif ARGV.size == 2 and File.exist?(ARGV[0]) and ARGV[1] =~ /^\d+$/
+if ARGV.size == 1 && ARGV[0] =~ /^\d+$/
+  pid = ARGV[0]
+elsif ARGV.size == 1 && ARGV[0] == 'none'
+  pid = nil
 else
   puts "Usage:"
   puts
   puts "  gdb.rb <pid>"
-  puts "  gdb.rb <path to ruby> <pid>"
   puts
   exit(1)
 end
 
-cmd = "#{File.dirname(__FILE__)}/../ext/dst/bin/gdb -ex 'py execfile(\"#{File.dirname(__FILE__)}/../scripts/ruby-gdb.py\")' #{ARGV.join(" ")}"
-exec(cmd)
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+args = []
+args << "#{dir}/ext/dst/bin/gdb"
+args << "-ex 'py execfile(\"#{dir}/scripts/ruby-gdb.py\")'"
+if pid
+  args << "-ex 'attach #{pid}'"
+else
+  args << "#{Config::CONFIG['bindir']}/#{Config::CONFIG['ruby_install_name']}"
+end
+
+exec(args.join(' '))

data/ext/extconf.rb

@@ -19,14 +19,15 @@ if RUBY_VERSION >= "1.9"
   exit(1)
 end
 
-if `uname -a 2>&1` !~ /x86_64/
+if RUBY_PLATFORM !~ /(i686|x86_64)-linux/
   STDERR.puts "\n\n"
   STDERR.puts "***************************************************************************************"
-  STDERR.puts "********************* Only x86_64 linux is supported (for now) =( *********************"
+  STDERR.puts "*********************** Only x86 linux is supported (for now) =( **********************"
   STDERR.puts "***************************************************************************************"
   exit(1)
 end
 
+dir_config('python')
 unless have_header('python2.5/Python.h') or have_header('python2.6/Python.h') or have_header('python2.4/Python.h')
   STDERR.puts "\n\n"
   STDERR.puts "***************************************************************************************"
@@ -55,6 +56,7 @@ Dir.chdir('src') do
       gdb-eval
       gdb-breakpoints
       gdb-leak
+      gdb-strings
     ].each do |patch|
       sys("patch -p1 < ../../../../patches/#{patch}.patch")
       sys("git commit -am '#{patch}'") if ENV['DEV']
@@ -62,7 +64,7 @@ Dir.chdir('src') do
   end
 
   Dir.chdir(dir) do
-    sys("./configure --prefix=#{CWD}/dst/")
+    sys("./configure --prefix=#{CWD}/dst/ --with-python=#{with_config('python-dir') || 'yes'}")
     sys("make")
     sys("make install")
   end

data/gdb.rb.gemspec

@@ -1,7 +1,7 @@
 spec = Gem::Specification.new do |s|
   s.name = 'gdb.rb'
-  s.version = '0.1.1'
-  s.date = '2009-11-06'
+  s.version = '0.1.2'
+  s.date = '2009-12-04'
   s.rubyforge_project = 'gdb-rb'
   s.summary = 'gdb hooks for MRI'
   s.description = 'A set of gdb7 extensions for the MRI interpreter'
@@ -26,6 +26,7 @@ spec = Gem::Specification.new do |s|
     "patches/gdb-eval.patch",
     "patches/gdb-breakpoints.patch",
     "patches/gdb-leak.patch",
+    "patches/gdb-strings.patch",
     "scripts/ruby-gdb.py",
     "gdb.rb.gemspec"
   ]

data/patches/gdb-strings.patch

@@ -0,0 +1,14 @@
+diff --git a/python/py-utils.c b/python/py-utils.c
+index 49c0437..9cca10b 100644
+--- a/python/py-utils.c
++++ b/python/py-utils.c
+@@ -189,6 +189,9 @@ python_string_to_host_string (PyObject *obj)
+   PyObject *str;
+   char *result;
+ 
++  if (PyString_Check (obj))
++    return xstrdup (PyString_AsString (obj));
++
+   str = python_string_to_unicode (obj);
+   if (str == NULL)
+     return NULL;

data/scripts/ruby-gdb.py

@@ -1,11 +1,17 @@
 import re
 import gdb
+import time
 
 class ZeroDict(dict):
   def __getitem__(self, i):
     if i not in self: self[i] = 0
     return dict.__getitem__(self, i)
 
+class ListDict(dict):
+  def __getitem__(self, i):
+    if i not in self: self[i] = []
+    return dict.__getitem__(self, i)
+
 class Ruby (gdb.Command):
   def __init__ (self):
     super (Ruby, self).__init__ ("ruby", gdb.COMMAND_NONE, gdb.COMPLETE_COMMAND, True)
@@ -24,10 +30,11 @@ class RubyThreads (gdb.Command):
         return ['list']
 
   def invoke (self, arg, from_tty):
+    self.dont_repeat()
     if re.match('trace', arg):
       self.trace()
     else:
-      self.type = arg if arg == 'list' else None
+      self.type = arg == 'list' and arg or None
       self.show()
 
   def trace (self):
@@ -54,12 +61,12 @@ class RubyThreads (gdb.Command):
       None
 
     gdb.execute('delete %d' % num)
-    gdb.execute('set unwindonsignal %s' % ('on' if self.unwind else 'off'))
+    gdb.execute('set unwindonsignal %s' % (self.unwind and 'on' or 'off'))
 
   def show (self):
     self.main = gdb.eval('rb_main_thread')
     self.curr = gdb.eval('rb_curr_thread')
-    self.now = gdb.eval('timeofday()')
+    self.now = time.time()
 
     try:
       gdb.eval('rb_thread_start_2')
@@ -82,8 +89,8 @@ class RubyThreads (gdb.Command):
   def print_thread (self, th):
     if self.type != 'list': print
     print th,
-    print 'main' if th == self.main else '    ',
-    print 'curr' if th == self.curr else '    ',
+    print th == self.main and 'main' or '    ',
+    print th == self.curr and 'curr' or '    ',
     print "thread", " %s" % str(th['status']).ljust(16), "%s" % self.wait_state(th), "   ",
     if th != self.curr:
       print "% 8d bytes" % th['stk_len']
@@ -132,7 +139,10 @@ class RubyThreads (gdb.Command):
       type = gdb.eval('(enum node_type) nd_type(%s)' % node)
 
       if frame['last_func']:
-        method = gdb.eval('rb_id2name(%s)' % frame['last_func']).string()
+        try:
+          method = gdb.eval('rb_id2name(%s)' % frame['last_func']).string()
+        except:
+          method = '(unknown)'
       else:
         method = '(unknown)'
 
@@ -179,11 +189,11 @@ class RubyTrace (gdb.Command):
     for c in commands:
       gdb.execute(c)
 
-    gdb.execute('set unwindonsignal %s' % ('on' if self.unwind else 'off'))
+    gdb.execute('set unwindonsignal %s' % (self.unwind and 'on' or 'off'))
 
   def invoke (self, arg, from_tty):
     self.dont_repeat()
-    num = int(arg) if arg else 100
+    num = arg and int(arg) or 100
     self.setup()
 
     try:
@@ -199,7 +209,7 @@ class RubyTrace (gdb.Command):
         file = node['nd_file'].string()
         line = gdb.eval('nd_line(%s)' % node)
         method = gdb.eval('rb_id2name($rcx)')
-        method = method.string() if method > 0 else '(unknown)'
+        method = method > 0 and method.string() or '(unknown)'
 
         print "%s in %s:%d" % (method,file,line)
 
@@ -216,25 +226,34 @@ class RubyObjects (gdb.Command):
     super (RubyObjects, self).__init__ ("ruby objects", gdb.COMMAND_NONE)
 
   def invoke (self, arg, from_tty):
+    self.dont_repeat()
     if arg == 'classes':
       self.print_classes()
     elif arg == 'nodes':
       self.print_nodes()
     elif arg == 'strings':
       self.print_strings()
+    elif arg == 'hashes':
+      self.print_hashes()
+    elif arg == 'arrays':
+      self.print_arrays()
     else:
       self.print_stats()
 
   def complete (self, text, word):
     if text == word:
       if word == '':
-        return ['classes', 'strings', 'nodes']
+        return ['classes', 'strings', 'nodes', 'hashes', 'arrays']
       elif word[0] == 'c':
         return ['classes']
       elif word[0] == 'n':
         return ['nodes']
       elif word[0] == 's':
         return ['strings']
+      elif word[0] == 'h':
+        return ['hashes']
+      elif word[0] == 'a':
+        return ['arrays']
 
   def print_nodes (self):
     nodes = ZeroDict()
@@ -276,6 +295,53 @@ class RubyObjects (gdb.Command):
     print "% 9d" % bytes, "bytes"
     print
 
+  def print_hashes (self):
+    sample = ListDict()
+    hash_sizes = ZeroDict()
+    num_elems = 0
+
+    for (obj, type) in self.live_objects():
+      if type == 0xb:
+        h = obj['as']['hash']
+        tbl = h['tbl']
+        l = int(tbl['num_entries'])
+
+        num_elems += l
+        hash_sizes[l] += 1
+        if len(sample[l]) < 5: sample[l].append(h.address)
+
+    print " elements instances"
+    for (l, num) in sorted(hash_sizes.items()):
+      print "%9d" % l, num, "(", ', '.join([ str(i) for i in sample[l] ]), ")"
+
+    print
+    print "% 9d" % sum(hash_sizes.values()), "hashes"
+    print "% 9d" % num_elems, "member elements"
+    print
+
+  def print_arrays (self):
+    sample = ListDict()
+    array_sizes = ZeroDict()
+    num_elems = 0
+
+    for (obj, type) in self.live_objects():
+      if type == 0x9:
+        a = obj['as']['array']
+        l = int(a['len'])
+
+        num_elems += l
+        array_sizes[l] += 1
+        if len(sample[l]) < 5: sample[l].append(a.address)
+
+    print " elements instances"
+    for (l, num) in sorted(array_sizes.items()):
+      print "%9d" % l, num, "(", ', '.join([ str(i) for i in sample[l] ]), ")"
+
+    print
+    print "% 9d" % sum(array_sizes.values()), "arrays"
+    print "% 9d" % num_elems, "member elements"
+    print
+
   def print_stats (self):
     total = live = free = 0
     types = ZeroDict()
@@ -320,10 +386,61 @@ class RubyObjects (gdb.Command):
   def obj_type (self, type):
     return RubyObjects.TYPES.get(type, 'unknown')
 
+class RubyMethodCache (gdb.Command):
+  def __init__ (self):
+    super (RubyMethodCache, self).__init__ ("ruby methodcache", gdb.COMMAND_NONE)
+
+  def invoke (self, arg, from_tty):
+    self.dont_repeat()
+    cache = gdb.eval('cache')
+    size = 0x800
+    empty = 0
+
+    for i in xrange(size):
+      entry = cache[i]
+      if entry['mid'] != 0:
+        klass = gdb.eval('rb_class2name(%d)' % entry['klass'])
+        method = gdb.eval('rb_id2name(%d)' % entry['mid'])
+        print " %s#%s" % (klass and klass.string() or '(unknown)',  method and method.string() or '(unknown)')
+      else:
+        empty += 1
+
+    print
+    print "%d empty slots (%.2f%%)" % (empty, empty*100.0/size)
+    print
+
+class RubyPrint (gdb.Command):
+  def __init__ (self):
+    super (RubyPrint, self).__init__ ("ruby print", gdb.COMMAND_NONE)
+
+  def invoke (self, arg, from_tty):
+    self.dont_repeat()
+
+    type = int(gdb.eval("((struct RBasic *)(%d))->flags & 0x3f" % int(arg,0)))
+    rtype = RubyObjects.TYPES.get(type, 'unknown')
+
+    if rtype == 'array':
+      print rtype
+    elif rtype == 'hash':
+      print rtype
+    else:
+      print 'unknown'
+
+class RubyEval (gdb.Command):
+  def __init__ (self):
+    super (RubyEval, self).__init__ ("ruby eval", gdb.COMMAND_NONE)
+
+  def invoke (self, arg, from_tty):
+    self.dont_repeat()
+    print gdb.eval("((struct RString*)rb_eval_string_protect(\"begin; (%s).inspect; rescue Exception => e; e.inspect; end\", 0))->ptr" % arg).string()
+
 Ruby()
 RubyThreads()
 RubyTrace()
 RubyObjects()
+RubyMethodCache()
+RubyPrint()
+RubyEval()
 
 macros = """
   macro define R_CAST(st)   (struct st*)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gdb.rb
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Aman Gupta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 -08:00
+date: 2009-12-04 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ files:
 - patches/gdb-eval.patch
 - patches/gdb-breakpoints.patch
 - patches/gdb-leak.patch
+- patches/gdb-strings.patch
 - scripts/ruby-gdb.py
 - gdb.rb.gemspec
 has_rdoc: true
@@ -56,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gdb-rb
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: gdb hooks for MRI