rb-threadframe 0.39 → 0.40

data/NEWS

@@ -1,3 +1,9 @@
+Nov 25, 2012 (0.40) 
+ - Redone for Ruby 1.9.3 p327
+ - RubyVM::ThreadFrame is now RubyVM::Frame. RubyVM::ThreadFrame is still 
+   there for compatibility
+-  Some small administrative and bug fixes
+
 Oct 27, 2011 (0.39)
 - Revise patch for 1.9.2 revision 33354
 - save return value in one more C_RETURN hook 

data/README.md

@@ -1,10 +1,13 @@
 # rb-threadframe
 
-rb-threadframe is a set of patches to Ruby 1.9.2 and a C extension
-that gives introspection access for method call frames.
+rb-threadframe is a set of patches to Ruby MRI 1.9.2 and 1.9.3 that
+adds introspection of call frames and adds other run-time support for debuggers and run-time introspection. 
+
+For MRI 1.9.2, there are additional routines are in a C extension. For MRI 1.9.3, everthing is in a patched Ruby. Necessary patches and some simple patch code are found in this repository though. 
 
 ## Requirements
 
-A patched version of YARV Ruby 1.9.2 (and not any other version Ruby) of is needed.
+Source for Ruby MRI version 1.9.2 or 1.9.3 p327. Patches are provided
+for these two versions only.
 
 See the [wiki](http://github.com/rocky/rb-threadframe/wiki) for more information.

data/Rakefile

@@ -14,7 +14,7 @@ def gemspec
   @gemspec ||= eval(File.read(Gemspec_filename), binding, Gemspec_filename)
 end
 
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
@@ -32,11 +32,11 @@ task :install => :gem do
   end
 end
 
-desc 'Create the core thread-frame shared library extension'
+desc 'Create the thread-frame shared library extension'
 task :ext do
   Dir.chdir('ext') do
     system("#{Gem.ruby} extconf.rb && make")
-  end
+  end if '1.9.2' == RUBY_VERSION
 end
 
 desc 'Remove built files'
@@ -110,7 +110,7 @@ task :gemspec do
 end
 
 # ---------  RDoc Documentation ------
-require 'rake/rdoctask'
+require 'rdoc/task'
 desc "Generate rdoc documentation"
 Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'

data/ext/1.9.3/thread_frame.c

@@ -0,0 +1,22 @@
+/* Ruby 1.9.3 doesn't need a C extension while 1.9.2 does. I can't figure
+   out a way build a gem so that it loads the C extension conditionally.
+   So instead we have a simple stupid stub extension. 
+
+   This as it is not elegant. 
+*/
+   
+#include <ruby.h>
+#include <ruby/version.h>
+#include <string.h>
+void
+Init_thread_frame(void)
+{
+    if (0 == strncmp("1.9.2", ruby_version, sizeof("1.9.2")))
+    {
+	rb_raise(rb_eLoadError, 
+		 "Gem installed under Ruby 1.9.3 but this Ruby 1.9.2. Please reinstall 'rb-threadframe' gem under 1.9.2.");
+    } else if (0 == strncmp("1.9.3", ruby_version, sizeof("1.9.3"))) {
+	rb_raise(rb_eLoadError, 
+		 "Under Ruby 1.9.3 there is no reason to load this thread_frame C extension.");
+    }
+}

data/ext/extconf.rb

@@ -1,4 +1,4 @@
-require "mkmf"
+require 'mkmf'
 
 fail "You need to install a threadframe-patched Ruby.
 See http://github.com/rocky/rb-threadframe/wiki/How-to-Install" unless 
@@ -11,4 +11,4 @@ See http://github.com/rocky/rb-threadframe/wiki/How-to-Install" unless
 config_file = File.join(File.dirname(__FILE__), 'config_options.rb')
 load config_file if File.exist?(config_file)
 
-create_makefile("thread_frame")
+create_makefile("thread_frame", RUBY_VERSION)

data/ext/version.h

@@ -0,0 +1 @@
+#define THREADFRAME_VERSION "0.40"

data/lib/iseq_extra.rb

@@ -1,5 +1,5 @@
 require 'digest/sha1'
-require_relative '../ext/thread_frame'
+require_relative '../ext/thread_frame' if '1.9.2' == RUBY_VERSION
 # Some additions to RubyVM::InstructionSequence
 class RubyVM::InstructionSequence
 
@@ -141,8 +141,9 @@ end
 
 if __FILE__ == $0
   # Demo it.
-  iseq = RubyVM::ThreadFrame.current.iseq
-  puts iseq.format_args
+  iseq = RubyVM::Frame.current.iseq
+  ## FIXME
+  ## puts iseq.format_args
   puts iseq.disassemble
   puts iseq.lineoffsets
   puts iseq.sha1
@@ -150,7 +151,7 @@ if __FILE__ == $0
   p iseq.line2offsets(__LINE__+100)
 
   def show_type # :nodoc:
-    tf = RubyVM::ThreadFrame.current
+    tf = RubyVM::Frame.current
     while tf do
       is = tf.iseq
       if is
@@ -166,12 +167,12 @@ if __FILE__ == $0
   
   line = __LINE__
   def find_line(line) # :nodoc
-    tf = RubyVM::ThreadFrame.current
+    tf = RubyVM::Frame.current
     puts "find_line has lines: #{tf.iseq.lines}"
     p tf.iseq.find_iseq_with_line(line)
   end
 
-  tf = RubyVM::ThreadFrame.current
+  tf = RubyVM::Frame.current
   puts tf.iseq.disassemble
   puts("offset %d above should be at line %d" % 
        [tf.iseq.locate_line(line), line])

data/lib/thread_frame.rb

@@ -1,3 +1,11 @@
 # Boilerplate to pull shared object and helper routines.
-require_relative '../ext/thread_frame'
+if RUBY_VERSION == '1.9.2'
+  require_relative '../ext/thread_frame'
+end
 require_relative 'iseq_extra'
+
+RubyVM::ThreadFrame = RubyVM::Frame
+class Thread
+  # For compatibility with old stuff
+  alias tracing tracing? 
+end

data/test/unit/cfunc-use.rb

@@ -2,7 +2,7 @@ def cfunc_loc
   ftype, file = [nil, nil]
   1.times do
     1.times do
-      f = RubyVM::ThreadFrame::current.prev
+      f = RubyVM::Frame::current.prev
       ftype = f.type 
       file  = f.source_container[1]
     end

data/test/unit/test-argc.rb

@@ -1,5 +1,6 @@
 require 'test/unit'
-require_relative '../../ext/thread_frame'
+
+require_relative '../../ext/thread_frame' if '1.9.2' == RUBY_VERSION
 
 class TestARGC < Test::Unit::TestCase
 
@@ -23,7 +24,7 @@ class TestARGC < Test::Unit::TestCase
     all_events = []
     eval <<-EOF.gsub(/^.*?: /, "")
      1: set_trace_func(Proc.new { |event, file, lineno, mid, binding, klass|
-     2:   tf = RubyVM::ThreadFrame.prev
+     2:   tf = RubyVM::Frame.prev
      3:   all_events << [tf.argc, tf.arity, tf.type, mid]
      4:   if :basename == mid 
      5:     events << [tf.argc, tf.arity, tf.type, mid]

data/test/unit/test-binding.rb

@@ -1,8 +1,8 @@
 require 'test/unit'
-require_relative '../../ext/thread_frame'
+require_relative '../../ext/thread_frame' if '1.9.2' == RUBY_VERSION
 
 def outside(a)
-    return eval('a', RubyVM::ThreadFrame.new(Thread::current).binding)
+    return eval('a', RubyVM::Frame.new(Thread::current).binding)
 end
 
 $a = 10
@@ -12,13 +12,13 @@ class TestBinding < Test::Unit::TestCase
     a = 1
     c = 0
     assert_equal(5, outside(5))
-    tf = RubyVM::ThreadFrame.new(Thread::current)
+    tf = RubyVM::Frame.new(Thread::current)
     b  = tf.binding
     assert_equal(1, eval('a', b))
     assert_equal(10, eval('$a', b))
     assert_equal(self, tf.self)
     1.times do |i;a| 
-      tf2 = Thread::current.threadframe()
+      tf2 = Thread::current.frame()
       b2  = tf2.binding
       a = 2
       assert_equal(2, eval('a', b2))
@@ -29,7 +29,7 @@ class TestBinding < Test::Unit::TestCase
       assert_equal(1, eval('a', tf2.prev(2).binding))
     end
     def inner(a)
-      tf3 = Thread::current.threadframe()
+      tf3 = Thread::current.frame()
       b3  = tf3.binding
       if a == 4
         assert_equal(4, eval('a', b3))

data/test/unit/{test-thread.rb → test-frame.rb}

@@ -1,17 +1,17 @@
 require 'test/unit'
-require_relative '../../ext/thread_frame'
+require_relative '../../ext/thread_frame' if '1.9.2' == RUBY_VERSION
 
 class TestThread < Test::Unit::TestCase
   def test_basic
-    assert_equal(RubyVM::ThreadFrame.new(Thread::current).thread, 
-                 RubyVM::ThreadFrame::current.thread)
-    assert_equal(RubyVM::ThreadFrame.new(Thread::current).thread, 
+    assert_equal(RubyVM::Frame.new(Thread::current).thread, 
+                 RubyVM::Frame::current.thread)
+    assert_equal(RubyVM::Frame.new(Thread::current).thread, 
                  Thread::current)
-    assert_equal(Thread::current.threadframe.thread, Thread::current)
+    assert_equal(Thread::current.frame.thread, Thread::current)
   end
 
   def test_pc_offset
-    tf = RubyVM::ThreadFrame::current
+    tf = RubyVM::Frame::current
     offset_1 = tf.pc_offset
     assert_equal(true, offset_1 > 0,
                  "Expecting a positive integer pc offset, got %s" % offset_1)
@@ -24,11 +24,10 @@ class TestThread < Test::Unit::TestCase
   end
 
   def test_sp
-    tf = RubyVM::ThreadFrame::current.prev
+    tf = RubyVM::Frame.prev
     assert tf.sp(1)
     tf.sp_set(1, 5)
-    assert_equal(5, tf.sp(1),
-                 'chcking value of recently-set sp(1)')
+    assert_equal(5, tf.sp(1), 'checking value of recently-set sp(1)')
   end
 
   def test_source_container
@@ -38,7 +37,7 @@ class TestThread < Test::Unit::TestCase
     assert_equal(['CFUNC',  cfunc_filebase], [type, File.basename(loc, '.rb')],
                  'CFUNCs should get their file location from frame.prev*')
     cont = 'file'
-    eval '1.times{cont = RubyVM::ThreadFrame.current.source_container[0]}'
+    eval '1.times{cont = RubyVM::Frame.current.source_container[0]}'
     assert_equal('string',  cont, 
                  'source container[0] of an eval(...) should be "string"')
   end
@@ -51,8 +50,9 @@ class TestThread < Test::Unit::TestCase
     # because the location is reported on a traceback
     # and that probably can't happen at PC 0.
     def bug_when_zero_pc
+      skip "pc_offset= not implemented on 1.9.3" if '1.9.3' == RUBY_VERSION
       @not_first = true
-      tf = RubyVM::ThreadFrame::current.prev
+      tf = RubyVM::Frame::current.prev
       pc_save = tf.pc_offset
       tf.pc_offset = 0
       loc = tf.source_location
@@ -65,23 +65,23 @@ class TestThread < Test::Unit::TestCase
     
 
   def test_thread_tracing
-    assert_equal(false, Thread.current.tracing)
+    assert_equal(false, Thread.current.tracing?)
     Thread.current.tracing = true
-    assert_equal(true, Thread.current.tracing)
+    assert_equal(true, Thread.current.tracing?)
     Thread.current.tracing = false
-    assert_equal(false, Thread.current.tracing)
+    assert_equal(false, Thread.current.tracing?)
   end    
     
   def test_thread_exec_event_tracing
-    assert_equal(false, Thread.current.exec_event_tracing)
+    assert_equal(false, Thread.current.exec_event_tracing?)
     Thread.current.exec_event_tracing = true
-    assert_equal(true, Thread.current.exec_event_tracing)
+    assert_equal(true, Thread.current.exec_event_tracing?)
     Thread.current.exec_event_tracing = false
-    assert_equal(false, Thread.current.exec_event_tracing)
+    assert_equal(false, Thread.current.exec_event_tracing?)
   end    
     
   def test_fields(notused=nil)
-    tf = RubyVM::ThreadFrame::current
+    tf = RubyVM::Frame::current
     pc1 = tf.pc_offset
     assert(pc1 > 0, 'Should be able to get a valid PC offset')
     # pc_offset is dynamic - it changes constantly
@@ -91,12 +91,13 @@ class TestThread < Test::Unit::TestCase
     assert_equal(self, tf.self)
     assert_equal(0, tf.arity)
     assert_equal(0, tf.argc)
-    assert tf.dfp(0)
-    assert tf.lfp(0)
+    ## FIXME: Should we allow this?
+    ## assert tf.dfp(0)
+    ## assert tf.lfp(0)
 
-    assert_raises IndexError do
-      x = tf.lfp(tf.iseq.local_size+1)
-    end
+    # assert_raises IndexError do
+    #   x = tf.lfp(tf.iseq.local_size+1)
+    # end
 
 
     tf_prev = tf.prev
@@ -107,10 +108,10 @@ class TestThread < Test::Unit::TestCase
 
     # 1.times creates a C frame.
     1.times do 
-      tf = RubyVM::ThreadFrame::current
+      tf = RubyVM::Frame::current
       tup = tf.source_container
       tup[1] = File.basename(tup[1])
-      assert_equal(['file', 'test-thread.rb'], tup)
+      assert_equal(['file', 'test-frame.rb'], tup)
       assert_equal('block in test_fields', tf.method)
       assert_equal('CFUNC', tf.prev.type)
       assert_equal('times', tf.prev.method) 
@@ -124,24 +125,26 @@ class TestThread < Test::Unit::TestCase
 
     # 1.upto also creates a C frame.
     1.upto(1) do 
-      tf = RubyVM::ThreadFrame::current.prev
+      # We could use ".prev" below instead of '.current.prev", but we
+      # may as well test current.prev.
+      tf = RubyVM::Frame::current.prev  
       assert_equal('CFUNC', tf.type)
       assert_equal(1, tf.arity, 'C arity should work nowadays' )
       assert_equal(1, tf.argc)
     end
 
     x  = lambda do |x,y| 
-      frame = RubyVM::ThreadFrame::current
+      frame = RubyVM::Frame::current
       assert_equal('block in test_fields', frame.method)
       assert_equal('LAMBDA', frame.type)
       assert_equal(x, tf.self)
-    assert_equal(2, frame.arity)
-    assert_equal(2, frame.argc)
+      assert_equal(2, frame.arity)
+      assert_equal(2, frame.argc)
     end
     x.call(x,2)
 
     x  = Proc.new do |x, y|
-      frame = RubyVM::ThreadFrame::current
+      frame = RubyVM::Frame::current
       assert_equal('block in test_fields', frame.method)
       assert_equal(x, tf.self)
     assert_equal('BLOCK', frame.type)
@@ -150,9 +153,9 @@ class TestThread < Test::Unit::TestCase
 
   end
 
-  def test_threadframe_equal
-    tf = RubyVM::ThreadFrame.current
-    tf2 = RubyVM::ThreadFrame.current
+  def test_frame_equal
+    tf = RubyVM::Frame.current
+    tf2 = RubyVM::Frame.current
     assert_equal(true,  tf.equal?(tf))
     assert_equal(true,  tf.equal?(tf2))
     tf2 = tf2.prev 

data/test/unit/test-invalid.rb

@@ -1,17 +1,18 @@
 require 'test/unit'
-require_relative '../../ext/thread_frame'
 
-class TestProc < Test::Unit::TestCase
+require_relative '../../ext/thread_frame' if '1.9.2' == RUBY_VERSION
+
+class TestInvalid < Test::Unit::TestCase
   def test_basic
-    @tf = RubyVM::ThreadFrame::current
+    @tf = RubyVM::Frame::current
     assert_equal(false, @tf.invalid?, 
-                 'Frame should be valid right after ThreadFrame::current')
+                 'Frame should be valid right after RubyVM::Frame::current')
     def notgood(test_tf=nil)
       # FIXME
       # if test_tf
       #   assert_equal(test_tf != @tf, test_tf.invalid?)
       # end
-      return RubyVM::ThreadFrame::current
+      return RubyVM::Frame::current
     end
 
     def inner_fn(tf)

data/test/unit/test-iseq-brkpt.rb

@@ -1,10 +1,10 @@
 require 'test/unit'
-require_relative '../../ext/thread_frame'
+require_relative '../../ext/thread_frame' if '1.9.2' == RUBY_VERSION
 
 class TestISeqBrkpt < Test::Unit::TestCase
 
   def test_iseq_brkpt
-    iseq = RubyVM::ThreadFrame.current.iseq
+    iseq = RubyVM::Frame.current.iseq
     assert iseq
     assert_equal(nil, iseq.brkpts)
     assert_equal(true, iseq.brkpt_alloc)
@@ -41,14 +41,14 @@ class TestISeqBrkpt < Test::Unit::TestCase
   end
 
   def test_iseq_brkpt_set
-    add_trace_func(Proc.new { |event, file, lineno, mid, binding, klass|
+    set_trace_func(Proc.new { |event, file, lineno, mid, binding, klass|
                      if 'brkpt' == event
                        $saw_brkpt = true
                      end
                     })
 
     $saw_brkpt = false
-    tf = RubyVM::ThreadFrame.current
+    tf = RubyVM::Frame.current
     tf.iseq.offsetlines.keys.each do |offset|
       tf.iseq.brkpt_set(offset)
     end

data/test/unit/test-iseq-save.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require_relative '../../ext/thread_frame'
+require_relative '../../ext/thread_frame' if '1.9.2' == RUBY_VERSION
 
 class TestISeqSave < Test::Unit::TestCase