rb-threadframe 0.38 → 0.39

data/NEWS

@@ -1,3 +1,7 @@
+Oct 27, 2011 (0.39)
+- Revise patch for 1.9.2 revision 33354
+- save return value in one more C_RETURN hook 
+
 March 15, 2011 (0.38) Ron Frankel Release
  - Add RubyVM::ThreadFrame.prev (same as RubyVM::ThreadFrame.current.prev)
  - Allow access to a C method type

data/README.md

@@ -5,6 +5,6 @@ that gives introspection access for method call frames.
 
 ## Requirements
 
-A patched version of Ruby 1.9.2 is needed.
+A patched version of YARV Ruby 1.9.2 (and not any other version Ruby) of is needed.
 
 See the [wiki](http://github.com/rocky/rb-threadframe/wiki) for more information.

data/Rakefile

@@ -4,13 +4,14 @@ require 'rubygems'
 require 'fileutils'
 
 ROOT_DIR = File.dirname(__FILE__)
+Gemspec_filename='rb-threadframe.gemspec'
 
 require 'rbconfig'
 RUBY_PATH = File.join(RbConfig::CONFIG['bindir'],  
                       RbConfig::CONFIG['RUBY_INSTALL_NAME'])
 
 def gemspec
-  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+  @gemspec ||= eval(File.read(Gemspec_filename), binding, Gemspec_filename)
 end
 
 require 'rake/gempackagetask'
@@ -18,7 +19,7 @@ desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
   Dir.chdir(ROOT_DIR) do
-    sh "gem build .gemspec"
+    sh "gem build #{Gemspec_filename}"
     FileUtils.mkdir_p 'pkg'
     FileUtils.mv("#{gemspec.file_name}", "pkg/")
   end
@@ -50,19 +51,20 @@ task :clean do
   end
 end
 
-def run_standalone_ruby_file(directory)
-  puts ('*' * 10) + ' ' + directory + ' ' + ('*' * 10)
+def run_standalone_ruby_file(directory, opts={})
+  puts(('*' * 10) + ' ' + directory + ' ' + ('*' * 10))
   Dir.chdir(directory) do
     Dir.glob('*.rb').each do |ruby_file|
-      puts ('-' * 20) + ' ' + ruby_file + ' ' + ('-' * 20)
+      puts(('-' * 20) + ' ' + ruby_file + ' ' + ('-' * 20))
       system(RUBY_PATH, ruby_file)
+      break if $?.exitstatus != 0 && !opts[:continue]
     end
   end
 end
 
-desc "Create a GNU-style ChangeLog via git2cl"
+desc 'Create a GNU-style ChangeLog via git2cl'
 task :ChangeLog do
-  system("git log --pretty --numstat --summary | git2cl > ChangeLog")
+  system('git log --pretty --numstat --summary | git2cl > ChangeLog')
 end
 
 task :default => [:test]
@@ -109,8 +111,8 @@ end
 
 # ---------  RDoc Documentation ------
 require 'rake/rdoctask'
-desc 'Generate rdoc documentation'
-Rake::RDocTask.new('rdoc') do |rdoc|
+desc "Generate rdoc documentation"
+Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = 'rb-threadframe'
   # Make the readme file the start page for the generated html
@@ -128,3 +130,10 @@ end
 task :clobber_rdoc do
   FileUtils.rm_rf File.join(ROOT_DIR, 'doc')
 end
+
+task :rm_patch_residue do
+  FileUtils.rm_rf FileList['**/*.{rej,orig}'].to_a
+end
+
+desc "Remove built files"
+task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue]

data/ext/thread_frame.c

@@ -6,7 +6,7 @@
  */
 
 /* What release we got? */
-#define THREADFRAME_VERSION "0.38"
+#define THREADFRAME_VERSION "0.39"
 
 #include <string.h>
 #include "../include/vm_core_mini.h"   /* Pulls in ruby.h and node.h */
@@ -339,10 +339,8 @@ thread_frame_sp_size_internal(thread_frame_t *tf)
     if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(tf->th, prev_cfp))
 	return Qnil;
     ret_val = tf->cfp->sp - prev_cfp->sp - 1;
-    /* FIXME: Why For C Functions we tack on 3? Possibly we're doing
-       the previous frame and possibly that's where the action is that
-       we should be looking at.? */
-    if (RUBYVM_CFUNC_FRAME_P(tf->cfp)) ret_val += 3;
+    /* FIXME: Why For C Functions we tack on 2 for this RubyVM::ENV? */
+    if (RUBYVM_CFUNC_FRAME_P(tf->cfp)) ret_val += 2;
     return ret_val;
 }
 

data/test/ruby/test_brkpt.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+
+class TestISeqBrkpt < Test::Unit::TestCase
+
+  def setup
+    @original_compile_option = RubyVM::InstructionSequence.compile_option
+    RubyVM::InstructionSequence.compile_option = {
+      :trace_instruction => false,
+      :specialized_instruction => false
+    }
+  end
+
+  def teardown
+    set_trace_func(nil)
+    RubyVM::InstructionSequence.compile_option = @original_compile_option
+  end
+
+  def test_iseq_brkpt
+    iseq = RubyVM::InstructionSequence.compile('x=1; y=2')
+    assert iseq
+    assert_equal(nil, iseq.brkpts)
+    assert_equal(true, iseq.brkpt_alloc)
+    assert_equal([], iseq.brkpts)
+    assert_equal(false, iseq.brkpt_alloc)
+    
+    assert_equal(true, iseq.brkpt_set(0))
+    assert_equal(1,    iseq.brkpts.size)
+    assert_equal(true, iseq.brkpt_get(0), 'Offset 0 should be set')
+    assert_equal(true, iseq.brkpt_unset(0),'Offset 0 should be unset')
+    assert_equal(false, iseq.brkpt_get(0), 'Offset 0 should be unset now')
+    assert_equal(true, iseq.brkpt_unset(0), 
+                 'Offset 0 should be unset again')
+    assert_raises TypeError do iseq.brkpt_get(100) end
+    assert_equal(true, iseq.brkpt_dealloc)
+    assert_equal(false, iseq.brkpt_dealloc)
+    assert_equal(true, iseq.brkpt_unset(0),
+                 'Offset 0 should be unset even when deallocated')
+
+    assert_raises TypeError do iseq.brkpt_set('a') end
+
+    iseq.brkpt_set(2)    
+    iseq.brkpt_set(4)    
+    events = []
+    eval <<-EOF.gsub(/^.*?: /, "")
+     1: set_trace_func(Proc.new { |event, file, lineno, mid, binding, klass|
+     2:   events << [event, lineno, mid, klass]
+     3: })
+     4: iseq.eval
+     5: set_trace_func(nil)
+    EOF
+    # puts iseq.disassemble
+    brkpt_events = events.select{|item| item[0] == 'brkpt'}
+    assert_equal(2, brkpt_events.size, 
+                 "Expecting to see 2 brkpts in #{events}.inspect")
+    assert_equal(true, iseq.brkpt_dealloc)
+  end
+end
+
+# We want to double-check we didn't mess up any pointers somewhere.
+at_exit { GC.start  }

data/test/ruby/test_disasm.rb

@@ -0,0 +1,17 @@
+# Some simple tests of RubyVM::InstructionSequence#disasm, and
+# #disasm_nochildren
+require 'test/unit'
+
+class TestDisasmClass < Test::Unit::TestCase
+
+  def test_basic
+    assert_equal(RubyVM::InstructionSequence.compile('1+2').disassemble,
+                 RubyVM::InstructionSequence.compile('1+2').disasm)
+
+    p='def five; 5 end; five'
+    s1=RubyVM::InstructionSequence.compile(p).disasm
+    assert_equal String, s1.class, 'disasm output should be a string'
+    s2=RubyVM::InstructionSequence.compile(p).disasm_nochildren
+    assert_equal true, s1.size > s2.size
+  end
+end

data/test/ruby/test_iseq.rb

@@ -0,0 +1,50 @@
+# See that setting ISEQS__ and SCRIPT_ISEQS__ saves 
+# RubyVM::Instruction_sequenses
+require 'test/unit'
+
+class TestIseqAccess < Test::Unit::TestCase
+  def setup
+    old_verbosity = $VERBOSE
+    $VERBOSE = nil
+    Kernel.const_set(:ISEQS__, {})
+    Kernel.const_set(:SCRIPT_ISEQS__, {})
+    $VERBOSE = old_verbosity
+  end
+
+  def teardown
+    old_verbosity = $VERBOSE
+    $VERBOSE = nil
+    Kernel.const_set(:ISEQS__, nil)
+    Kernel.const_set(:SCRIPT_ISEQS__, nil)
+    $VERBOSE = old_verbosity
+  end
+
+  def test_basic
+    sizes=[]
+    [ISEQS__, SCRIPT_ISEQS__].each do |iseq_hash|
+      sizes << iseq_hash.size
+    end
+    # defining five should trigger five instruction sequence additions
+    # to ISEQS__ and SCRIPT_ISEQS__
+    # 
+    eval 'def five; 5 end'
+    assert_equal sizes[0], sizes[1]
+    [SCRIPT_ISEQS__, ISEQS__].each do |iseq_hash|
+      assert_equal true, iseq_hash.size > sizes.pop
+      assert_equal Hash, iseq_hash.class
+      a = iseq_hash.first
+      assert_equal Array, a.class
+      assert_equal RubyVM::InstructionSequence, iseq_hash.values[0][0].class
+    end
+  end
+
+  # Check RubyVM::InstructionSequence#arity
+  def test_arity
+    eval 'def five; 5 end'
+    eval 'def add(a,b); a+b end'
+    eval 'def splat(*a); 5 end'
+    [['five', 0,], ['add', 2], ['splat', -1]].each do |meth, expect|
+      assert_equal(expect, ISEQS__[meth][0].arity)
+    end
+  end
+end

data/test/ruby/test_tracefunc_adds.rb

@@ -0,0 +1,151 @@
+require 'test/unit'
+
+# tests set_trace_func with event bitmasks, clear_trace_func, 
+# Newer changes
+class TestSetTraceFuncAdds < Test::Unit::TestCase
+
+  # Some of the below setup is similar to what is in lib/trace_mod.rb of 
+  # rb-trace
+  @@NO_EVENT_MASK        = 0x0000
+  @@LINE_EVENT_MASK      = 0x0001
+  @@CLASS_EVENT_MASK     = 0x0002
+  @@END_EVENT_MASK       = 0x0004
+  @@CALL_EVENT_MASK      = 0x0008
+  @@RETURN_EVENT_MASK    = 0x0010
+  @@C_CALL_EVENT_MASK    = 0x0020
+  @@C_RETURN_EVENT_MASK  = 0x0040
+  @@RAISE_EVENT_MASK     = 0x0080
+  @@INSN_EVENT_MASK      = 0x0100
+  @@ALL_EVENTS_MASK      = (0xffff & ~@@INSN_EVENT_MASK)
+  
+  @@EVENT2MASK = {
+    'line'     => @@LINE_EVENT_MASK,
+    'call'     => @@CALL_EVENT_MASK,
+    'return'   => @@RETURN_EVENT_MASK,
+    'c-call'   => @@C_CALL_EVENT_MASK,
+    'c-return' => @@C_RETURN_EVENT_MASK,
+    'c-raise'  => @@RAISE_EVENT_MASK
+  }
+
+  # Convert +events+ into a Fixnum bitmask used internally by Ruby.
+  # Parameter +events+ should be Enumerable and each element should
+  # either be a Fixnum mask value or something that can be converted
+  # to a symbol. If the latter, the case is not important as we'll
+  # downcase the string representation.
+  def events2bitmask(event_list)
+    bitmask = @@NO_EVENT_MASK
+    event_list.each do |event|
+      bitmask |= @@EVENT2MASK[event]
+    end
+    return bitmask
+  end
+
+  def setup
+    @original_compile_option = RubyVM::InstructionSequence.compile_option
+    RubyVM::InstructionSequence.compile_option = {
+      :trace_instruction => true,
+      :specialized_instruction => false
+    }
+    @proc_template = 'Proc.new { |event, file, lineno, mid, binding, klass|
+      %s << [event, lineno, mid, klass]}'
+  end
+
+  def teardown
+    clear_trace_func
+    RubyVM::InstructionSequence.compile_option = @original_compile_option
+  end
+
+  def test_eventmask
+    returned_tuples = 
+      [['line', 5, :test_eventmask, self.class],
+       ['class', 5, nil, nil],
+       ['end', 5, nil, nil],
+       ["leave", 5, nil, nil],
+       ['line', 6, :test_eventmask, self.class],
+       ["send", 6, :test_eventmask, TestSetTraceFuncAdds],
+       ['call', 1, :five, self.class],
+       ['line', 1, :five, self.class],
+       ['return', 1, :five, self.class],
+       ["leave", 1, :five, TestSetTraceFuncAdds],
+       ["send", 6, :test_eventmask, TestSetTraceFuncAdds],
+       ['c-call', 6, :any?, Enumerable],
+       ['c-call', 6, :each, Array],
+       ['line', 6, :test_eventmask, self.class],
+       ["leave", 6, :test_eventmask, TestSetTraceFuncAdds],
+       ['c-return', 6, :each, Array],
+       ['c-return', 6, :any?, Enumerable],
+       ['line', 7, :test_eventmask, self.class],
+       ["send", 7, :test_eventmask, TestSetTraceFuncAdds],
+       ['c-call', 7, :clear_trace_func, Kernel]]
+
+    [[], nil, 
+     %w(line),
+     %w(call line),
+     %w(c-call c-return line),
+    ].each do |event_list|
+      tuples = []
+      event_mask = if event_list
+                     events2bitmask(event_list)
+                   else
+                     @@ALL_EVENTS_MASK
+                   end
+      cmd = <<-EOF.gsub(/^.*?: /, '')
+        1: def five; 5 end
+        2: p1 = #{@proc_template}
+        3: set_trace_func(p1, #{event_mask})
+        4: class Foo; end
+        5: [1,2,five].any? {|n| n}
+        6: clear_trace_func
+      EOF
+      eval(cmd % 'tuples')
+      expected = if event_list
+                   returned_tuples.select{|x| !([x[0]] & event_list).empty?}
+                 else
+                   returned_tuples
+                 end
+      assert_equal(expected, tuples, 
+                   "Error filtering #{event_list}")
+     # p tuples
+    end
+  end
+
+  def test_chained_hook
+    tuples1 = []
+    tuples2 = []
+    cmd = <<-EOF.gsub(/^.*?: /, '')
+        1: def five; 5 end
+        2: p1 = #{@proc_template}
+        3: p2 = #{@proc_template}
+        4: add_trace_func(p1, @@LINE_EVENT_MASK)
+        5: add_trace_func(p2, @@CALL_EVENT_MASK)
+        6: class Foo; end
+        7: [1,2,five].any? {|n| n}
+      EOF
+    eval(cmd % %w(tuples1 tuples2))
+    clear_trace_func
+    assert_equal([
+                  ["line", 7, :test_chained_hook, self.class], 
+                  ["line", 8, :test_chained_hook, self.class], 
+                  ["line", 9, :test_chained_hook, self.class], 
+                  ["line", 1, :five, self.class], 
+                  ["line", 9, :test_chained_hook, self.class], 
+                 ], tuples1[0..-2],
+                 'line filtering')
+    assert_equal([["call", 1, :five, self.class]], tuples2, 
+                 'call filtering')
+  end
+
+  def test_trace_insn
+    tuples = []
+    cmd = <<-EOF.gsub(/^.*?: /, '')
+        1: p = #{@proc_template}
+        2: add_trace_func(p, @@INSN_EVENT_MASK)
+        4: x = 1
+        3: y = 2
+      EOF
+    eval cmd % 'tuples'
+    clear_trace_func
+    assert_equal true, !tuples.empty?, 'triggered instruction events'
+    assert_equal true, tuples.all?{|t| 'vm-insn' == t[0]}, 'instruction events'
+  end
+end

data/test/ruby/test_tracefunc_raise.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+
+# tests that we a trace hook has access to the runtime exception Object
+# when it is called through a raise event
+
+class TestTracefuncRaise < Test::Unit::TestCase
+
+  def test_basic
+    tuples = []
+    p = Proc.new { 
+      |event, file, lineno, mid, binding, klass|
+      tuples << klass
+    }
+    msg = 'this is a message'
+    set_trace_func(p, 0x0080)
+    begin ; x = 1/0; rescue; end
+    begin ; raise RuntimeError, msg; rescue; end
+    clear_trace_func
+    assert_equal(2, tuples.size, 
+                 "Wrong number of tuples captured #{tuples.inspect}")
+    assert_equal msg, tuples[1].message
+    assert_equal([ZeroDivisionError, RuntimeError], tuples.map{|t| t.class},
+                 "Mismatched tuples classes in #{tuples.inspect}")
+    
+  end
+end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 38
-  version: "0.38"
+  - 39
+  version: "0.39"
 platform: ruby
 authors: 
 - R. Bernstein
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 -04:00
+date: 2011-10-27 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -69,6 +69,11 @@ files:
 - test/unit/test-thread-trace-masks.rb
 - test/unit/test-settracefunc.rb
 - test/unit/test-sp-size.rb
+- test/ruby/test_disasm.rb
+- test/ruby/test_iseq.rb
+- test/ruby/test_brkpt.rb
+- test/ruby/test_tracefunc_adds.rb
+- test/ruby/test_tracefunc_raise.rb
 - threadframe.rd
 - ext/extconf.rb
 has_rdoc: true
@@ -80,7 +85,7 @@ rdoc_options:
 - --main
 - README.md
 - --title
-- ThreadFrame 0.38 Documentation
+- ThreadFrame 0.39 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement