rb-threadframe 0.33 → 0.34

data/Makefile

@@ -3,7 +3,6 @@
 .PHONY: all test
 
 all: test
-	rake $@
 
 check: 
 	rake test

data/NEWS

@@ -1,5 +1,17 @@
-October 27 2010 (0.33)
-- Revise rvm install script to be more roboust
+December 10, 2010 (0.34)  Giant Madagascar Day Release
+
+  - 1.9.2 patches: 
+   * Save source string eval types
+   * Add RubyVM::OS_ARGV and RubyVM::OS_STARTUP_DIR to allow Ruby
+     programs to reliably restart themselves via exec().
+   * Save instruction sequence compile options 
+
+  - Add routines for finding instruction sequences and offsets:
+      iseq#lines() iseq#find_iseq_with_line(), and 
+      seq#locate_line_with_children() 
+
+October 27, 2010 (0.33)
+- Revise rvm install script to be more rooust
 - Change bug report location so we don't spam Ruby's redmine 
 - Add RubyVM::InstructionSequence#parent and #local_iseq fields
 

data/README.md

@@ -1,6 +1,7 @@
 # rb-threadframe
 
-rb-threadframe gives introspection access for frames of a thread.
+rb-threadframe is a set of patches to Ruby 1.9.2 and a C extension
+that gives introspection access for method call frames.
 
 ## Requirements
 

data/ext/extconf.rb

@@ -4,9 +4,11 @@ fail "You need to install a threadframe-patched Ruby.
 See http://github.com/rocky/rb-threadframe/wiki/How-to-Install" unless 
   RbConfig::CONFIG.member?('rb-threadframe')
 
-config_file = File.join(File.dirname(__FILE__), 'config_options')
+# Allow use customization of compile options. For example, the 
+# following lines could be put in config_options:
+# CONFIG['optflags'] = ''   # Or -O3
+# CONFIG['debugflags'] = '-g3 -ggdb' 
+config_file = File.join(File.dirname(__FILE__), 'config_options.rb')
 load config_file if File.exist?(config_file)
 
-# Temporary: to turn off optimization
-# $CFLAGS='-fno-strict-aliasing -g -fPIC'
 create_makefile("thread_frame")

data/ext/iseq_extra.c

@@ -10,8 +10,6 @@ VALUE rb_cIseq = rb_define_class_under(rb_cRubyVM, "InstructionSequence",
 #endif
 
 #include "../include/vm_core_mini.h"   /* Pulls in ruby.h and node.h */
-#ifdef HAVE_COMPILE_OPTIONS
-#endif
 #include "iseq_mini.h"  /* Pulls in ruby.h */
 #include "../include/ruby19_externs.h"
 #include <string.h>       /* For strlen() */
@@ -22,7 +20,10 @@ struct iseq_insn_info_entry {
     unsigned short sp;
 };
 
-#ifdef HAVE_COMPILE_OPTIONS
+#define COMPILE_OPTS_BOOL_SET_HASH(FIELD) \
+    rb_hash_aset(hash_opts, rb_str_new2(#FIELD), \
+		 (compile_opts->FIELD) ? Qtrue : Qfalse)
+    
 /* 
  *  Document-method: RubyVM::InstructionSequence::compile_options
  *
@@ -43,13 +44,17 @@ iseq_compile_options(VALUE iseqval)
 	GetISeqPtr(iseqval, iseq);
 	if (!iseq->compile_data) return Qnil;
 	compile_opts = iseq->compile_data->option;
-	rb_hash_aset(hash_opts, rb_str_new2("inline_const_cache"), 
-		     (compile_opts->inline_const_cache) ? Qtrue : Qfalse);
+	COMPILE_OPTS_BOOL_SET_HASH(inline_const_cache);
+	COMPILE_OPTS_BOOL_SET_HASH(peephole_optimization);
+	COMPILE_OPTS_BOOL_SET_HASH(tailcall_optimization);
+	COMPILE_OPTS_BOOL_SET_HASH(specialized_instruction);
+	COMPILE_OPTS_BOOL_SET_HASH(operands_unification);
+	COMPILE_OPTS_BOOL_SET_HASH(stack_caching);
+	COMPILE_OPTS_BOOL_SET_HASH(trace_instruction);
+	COMPILE_OPTS_BOOL_SET_HASH(debug_level);
 	return hash_opts;
     }
-    
 }
-#endif
 
 /* 
  *  Document-method: RubyVM::InstructionSequence::encoded
@@ -410,9 +415,7 @@ Init_iseq_extra(void)
     rb_define_method(rb_cISeq, "arg_rest",         iseq_arg_rest, 0) ;
     rb_define_method(rb_cISeq, "arg_simple",       iseq_arg_simple, 0) ;
     rb_define_method(rb_cISeq, "argc",             iseq_argc, 0) ;
-#ifdef HAVE_COMPILE_OPTIONS
     rb_define_method(rb_cISeq, "compile_options",  iseq_compile_options, 0) ;
-#endif
     rb_define_method(rb_cISeq, "equal?",           iseq_equal, 1) ;
     rb_define_method(rb_cISeq, "encoded",          iseq_iseq_encoded, 0) ;
     rb_define_method(rb_cISeq, "iseq_size",        iseq_iseq_size, 0) ;

data/ext/thread_frame.c

@@ -6,7 +6,7 @@
  */
 
 /* What release we got? */
-#define THREADFRAME_VERSION "0.33"
+#define THREADFRAME_VERSION "0.34"
 
 #include <string.h>
 #include "../include/vm_core_mini.h"   /* Pulls in ruby.h and node.h */

data/lib/iseq_extra.rb

@@ -60,6 +60,86 @@ class RubyVM::InstructionSequence
     Digest::SHA1.hexdigest(encoded)
   end
 
+
+  ##
+  # Locates the instruction address offset of the first instruction on
+  # the specified line or nil if no match for the specified line is
+  # found.
+  #
+  # @return [Fixnum, NilClass] returns
+  #   nil if nothing is found, else the first offset for the line
+  def locate_line(line)
+    offsetlines.each_pair do |offset, val|
+      return offset if val.member?(line)
+    end
+    nil
+  end
+
+  # iseq and instruction address offset of the first instruction on
+  # the specified line. This method recursively examines child
+  # compiled methods until an exact match for the searched line is
+  # found.  It returns both the matching CompiledMethod and the OFFSET
+  # of the first instruction on the requested line, or nil if no match
+  # for the specified line is found.
+  #
+  # @return [(RubyVM::InstructionSequence, Fixnum), NilClass] returns
+  #   nil if nothing is found, else an array of size 2 containing the method
+  #   the line was found in and the offset pointing there.
+  def locate_line_with_children(line)
+    iseq = self
+    offset = iseq.locate_line(line)
+    p ['++++1', offset, iseq]
+    return iseq, offset if offset
+    
+    # Didn't find line in this iseq, so check if a contained
+    # InstructionSequence encompasses the line searched for
+    until offset
+      child_iseq = iseq
+      iseq = iseq.parent
+      unless iseq
+        # child_iseq is the top-most scope. Search down from here.
+        top_iseq = child_iseq
+        top_iseq.child_iseqs.each do |child_iseq|
+          p ['++++2', offset, child_iseq, child_iseq.parent]
+          next if child_iseq.equal? top_iseq
+          if res = child_iseq.locate_line_with_children(line)
+            return res
+          end
+        end
+        # No child method is a match - fail
+        return nil
+      end
+      offset = iseq.locate_line(line)
+    end
+    return parent_iseq, offset
+  end
+
+  def lines
+    offsetlines.values.flatten.uniq
+  end
+
+  # Returns an InstructionSequence for the specified line. We search the
+  # current method +meth+ and then up the parent scope.  If we hit
+  # the top and we can't find +line+ that way, then we
+  # reverse the search from the top and search down. This will add
+  # all siblings of ancestors of +meth+.
+  def find_iseq_with_line(line)
+
+    lines = self.lines
+    iseq = self
+    until lines.member?(line) do
+      child_iseq = iseq
+      iseq = iseq.parent
+      unless iseq
+        # child is the top-most scope. Search down from here.
+        pair = child_iseq.locate_line_with_children(line)
+        ## pair = iseq.locate_line(line)
+        return pair ? pair[0] : nil
+      end
+      lines = iseq.lines
+    end
+    return iseq
+  end
 end
 
 if __FILE__ == $0
@@ -85,5 +165,21 @@ if __FILE__ == $0
     end
   end
   show_type
+  puts '-' * 40
+  
+  line = __LINE__
+  def find_line(line) # :nodoc
+    tf = RubyVM::ThreadFrame.current
+    puts "find_line has lines: #{tf.iseq.lines}"
+    p tf.iseq.find_iseq_with_line(line)
+  end
+
+  tf = RubyVM::ThreadFrame.current
+  puts tf.iseq.disassemble
+  puts("offset %d above should be at line %d" % 
+       [tf.iseq.locate_line(line), line])
+  find_line(line+2)
+  find_line(line)
+  p tf.iseq.find_iseq_with_line(line+2)
 end
 

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

@@ -0,0 +1,20 @@
+require 'test/unit'
+require_relative '../../ext/thread_frame'
+
+class TestISeqSave < Test::Unit::TestCase
+
+  def test_ISEQS__
+    Object.const_set("ISEQS__", {})
+    eval "def five; 5 end"
+    iseq = Object.const_get('ISEQS__')['five'][0]
+    assert_equal RubyVM::InstructionSequence, iseq.class
+    assert_equal Hash, iseq.compile_options.class
+    old_verbose = $VERBOSE
+    $VERBOSE = nil
+    Object.const_set("ISEQS__", nil)
+    $VERBOSE = old_verbose
+  end
+end
+
+# We want to double-check we didn't mess up any pointers somewhere.
+at_exit { GC.start  }

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

@@ -0,0 +1,55 @@
+require 'test/unit'
+require_relative '../../ext/thread_frame'
+require_relative '../../lib/thread_frame'
+
+$global_test_line = __LINE__
+
+class TestLibISeq < Test::Unit::TestCase
+
+  TEST_LINE = __LINE__
+
+  def test_sha1
+    iseq1 = RubyVM::ThreadFrame::current.iseq
+    iseq2 = RubyVM::ThreadFrame::current.iseq
+    assert_equal(iseq1.sha1, iseq2.sha1, 
+                 "SHA1 for same threadframe should match")
+  end
+
+  def test_lines
+    line = __LINE__
+    iseq = RubyVM::ThreadFrame::current.iseq
+    assert_equal((line-1..__LINE__+2).to_a, iseq.lines,
+                 "lines of test_lines() don't match")
+  end
+
+  def test_locate_line
+    line = __LINE__
+    iseq = RubyVM::ThreadFrame::current.iseq
+    assert iseq.locate_line(line)
+    assert_nil iseq.locate_line(line - 2)
+  end
+
+  def test_iseq_with_line
+    # FIXME: We get a more stringent test if we test of offset.
+    # It is lame how little we can do here.
+    line = __LINE__
+    def find_line(line) # :nodoc
+      tf = RubyVM::ThreadFrame.current
+      assert(tf.iseq.find_iseq_with_line(line), 
+             "should have found line #{line}")
+    end
+    tf = RubyVM::ThreadFrame.current
+    find_line(line+2)
+    # line2 = nil
+    # 1.times do 
+    #   line2 = __LINE__
+    # end
+    # find_line(line2)
+    # find_line(TEST_LINE)
+    # find_line($global_test_line)
+  end
+
+end
+
+# We want to double-check we didn't mess up any pointers somewhere.
+at_exit { GC.start  }

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 33
-  version: "0.33"
+  - 34
+  version: "0.34"
 platform: ruby
 authors: 
 - R. Bernstein
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 -04:00
+date: 2010-12-10 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -52,8 +52,10 @@ files:
 - ext/iseq_extra.h
 - ext/iseq_mini.h
 - test/unit/test-trace.rb
+- test/unit/test-iseq-save.rb
 - test/unit/test-prev.rb
 - test/unit/test-source.rb
+- test/unit/test-lib-iseq.rb
 - test/unit/test-return-stop.rb
 - test/unit/test-proc.rb
 - test/unit/test-invalid.rb
@@ -78,19 +80,19 @@ rdoc_options:
 - --main
 - README.md
 - --title
-- ThreadFrame 0.33 Documentation
+- ThreadFrame 0.34 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - "="
+  - - ~>
     - !ruby/object:Gem::Version 
       segments: 
       - 1
       - 9
-      - 2
-      version: 1.9.2
+      - 2frame
+      version: 1.9.2frame
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: