rubinius-compiler 2.1.0 → 2.1.1

data/spec/custom/matchers/compile_as.rb

@@ -0,0 +1,46 @@
+require 'spec/custom/helpers/generator'
+
+# The CompileAsMatcher wraps the logic for checking that a string of Ruby code
+# is converted to the expected bytecode. It is combined with the #compile_as
+# spec helper and enables specs of the form:
+#
+#   "a = 1".should compile_as(<some bytecode>)
+#
+class CompileAsMatcher
+  def initialize(expected, plugins)
+    @expected = expected
+    @plugins = plugins
+  end
+
+  def matches?(actual)
+    @actual = Rubinius::ToolSets::Spec::Compiler.compile_test_bytecode actual, @plugins
+    @actual == @expected
+  end
+
+  def diff(actual, expected)
+    actual = actual.pretty_inspect.each_line.to_a
+    expected = expected.pretty_inspect.each_line.to_a
+
+    line = actual.each_with_index do |item, index|
+      break index unless item == expected[index]
+    end
+
+    /^( +)/ =~ actual[line]
+    marker = "#{' ' * $1.size if $1}^ differs\n\n"
+    actual.insert line+1, marker
+    expected.insert line+1, marker
+
+    return actual.join, expected.join
+  end
+
+  def failure_message
+    actual, expected = diff @actual, @expected
+    ["Expected:\n#{actual}\n", "to equal:\n#{expected}"]
+  end
+end
+
+class Object
+  def compile_as(bytecode, *plugins)
+    CompileAsMatcher.new bytecode, plugins
+  end
+end

data/spec/custom/mspec.rb

@@ -0,0 +1,15 @@
+require 'spec/custom/utils/options'
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  require 'spec/custom/matchers/compile_as'
+  require 'spec/custom/helpers/generator'
+  require 'spec/custom/guards/profiler'
+  require 'spec/custom/runner/relates'
+  require 'spec/custom/runner/actions/debug'
+  require 'spec/custom/runner/actions/gcstats'
+  require 'spec/custom/runner/actions/memory'
+  require 'spec/custom/runner/actions/parser'
+  require 'spec/custom/runner/actions/profiler'
+end
+
+require 'spec/custom/utils/script'

data/spec/custom/runner/actions/debug.rb

@@ -0,0 +1,10 @@
+class DebugAction < ActionFilter
+  def initialize(tags=nil, descs=nil)
+    super
+    require 'rubinius/debugger'
+  end
+
+  def before(state)
+    Rubinius::Debugger.start if self === state.description
+  end
+end

data/spec/custom/runner/actions/gcstats.rb

@@ -0,0 +1,17 @@
+# Custom MSpec action that prints GC stats after a spec run
+#
+class GCStatsAction
+  def register
+    MSpec.register :start,  self
+    MSpec.register :finish, self
+  end
+
+  def start
+    @stats = Rubinius::Stats::GC.new
+    @stats.clear
+  end
+
+  def finish
+    @stats.show
+  end
+end

data/spec/custom/runner/actions/memory.rb

@@ -0,0 +1,11 @@
+class MemoryAction
+  def register
+    MSpec.register :finish, self
+  end
+
+  def finish
+    require 'rubinius/analyst'
+
+    puts "\nTotal memory: #{Rubinius::Analyst.new.total_memory}"
+  end
+end

data/spec/custom/runner/actions/parser.rb

@@ -0,0 +1,14 @@
+class Parser19Action
+  def register
+    MSpec.register :load,   self
+    MSpec.register :unload, self
+  end
+
+  def load
+    SpecGuard.ruby_version_override = "1.9.2"
+  end
+
+  def unload
+    SpecGuard.ruby_version_override = nil
+  end
+end

data/spec/custom/runner/actions/profiler.rb

@@ -0,0 +1,19 @@
+# Custom MSpec action that prints profiler stats after a spec run
+#
+class ProfilerAction
+  def register
+    MSpec.register :start,  self
+    MSpec.register :finish, self
+  end
+
+  def start
+    @profiler = Rubinius::Profiler::Instrumenter.new(
+      :sort => [:self_seconds, :calls])
+    @profiler.start
+  end
+
+  def finish
+    @profiler.stop
+    @profiler.show
+  end
+end

data/spec/custom/runner/relates.rb

@@ -0,0 +1,86 @@
+# SpecDataRelation enables concise specs that involve several different forms
+# of the same data. This is specifically useful for the parser and compiler
+# specs where the output of each stage is essentially related to the input
+# Ruby source. Together with the #relates spec method, it enables specs like:
+#
+#   describe "An If node" do
+#     relates "a if b" do
+#       parse do
+#         # return the expected sexp
+#       end
+#
+#       compile do |g|
+#         # return the expected bytecode
+#       end
+#
+#       jit do |as|
+#         # return the expected asm/machine code
+#       end
+#     end
+#
+#     relates "if a; b; end" do
+#       # ...
+#     end
+#   end
+
+class SpecDataRelation
+  # Provides a simple configurability so that any one or more of the possible
+  # processes can be run. See the custom options in custom/utils/options.rb.
+  def self.enable(process)
+    @processors ||= []
+    @processors << process
+  end
+
+  # Returns true if no process is specifically set or if +process+ is in the
+  # list of enabled processes. In other words, all processes are enabled by
+  # default, or any combination of them may be enabled.
+  def self.enabled?(process)
+    @processors.nil? or @processors.include?(process)
+  end
+
+  def initialize(ruby)
+    @ruby = ruby
+  end
+
+  # Formats the Ruby source code for reabable output in the -fs formatter
+  # option. If the source contains no newline characters, wraps the source in
+  # single quotes to set if off from the rest of the description string. If
+  # the source does contain newline characters, sets the indent level to four
+  # characters.
+  def format(ruby)
+    if /\n/ =~ ruby
+      lines = ruby.rstrip.each_line.to_a
+      if /( *)/ =~ lines.first
+        if $1.size > 4
+          dedent = $1.size - 4
+          ruby = lines.map { |l| l[dedent..-1] }.join
+        else
+          indent = " " * (4 - $1.size)
+          ruby = lines.map { |l| "#{indent}#{l}" }.join
+        end
+      end
+      "\n#{ruby}"
+    else
+      "'#{ruby}'"
+    end
+  end
+
+  # Creates spec example blocks if the compile process is enabled.
+  def compile(*plugins, &block)
+    return unless self.class.enabled? :compiler
+
+    ruby = @ruby
+    it "is compiled from #{format ruby}" do
+      generator = Rubinius::TestGenerator.new
+      generator.instance_eval(&block)
+
+      ruby.should compile_as(generator, *plugins)
+    end
+  end
+end
+
+class Object
+  def relates(str, &block)
+    SpecDataRelation.new(str).instance_eval(&block)
+  end
+end

data/spec/custom/utils/options.rb

@@ -0,0 +1,40 @@
+# Custom MSpec options
+#
+class MSpecOptions
+  def compiler
+    on("--compiler", "Run only the compile part of the compiler specs") do
+      SpecDataRelation.enable :compiler
+    end
+  end
+
+  def parser_19
+    on("--parser-1.9", "Run the compiler specs with the 1.9 parser") do
+      require 'spec/custom/matchers/compile_as_19'
+      config[:parser_19] = true
+    end
+  end
+
+  def memory
+    on("--memory", "Display total memory in use before exiting") do
+      config[:memory] = true
+    end
+  end
+
+  def gc_stats
+    on("--gc-stats", "Show GC stats at the end") do
+      config[:gc_stats] = true
+    end
+  end
+
+  def profiler
+    on("--profiler", "Show profiler data at the end") do
+      config[:profiler] = true
+    end
+  end
+
+  def agent
+    on("--agent", "Start the Rubinius agent") do
+      config[:launch] << "-Xagent.start"
+    end
+  end
+end

data/spec/custom/utils/script.rb

@@ -0,0 +1,50 @@
+# Registers custom actions, etc. for all MSpec scripts
+#
+class MSpecScript
+  def custom_register
+    GCStatsAction.new.register if config[:gc_stats]
+    ProfilerAction.new.register if config[:profiler]
+    Parser19Action.new.register if config[:parser_19]
+    MemoryAction.new.register if config[:memory]
+  end
+end
+
+# Custom options for mspec
+#
+class MSpecMain
+  def custom_options(options)
+    options.agent
+  end
+end
+
+# Custom options for mspec-run
+#
+class MSpecRun
+  def custom_options(options)
+    options.compiler
+    options.parser_19
+    options.memory
+    options.gc_stats
+    options.profiler
+  end
+end
+
+# Custom options for mspec-ci
+#
+class MSpecCI
+  def custom_options(options)
+    options.compiler
+    options.parser_19
+    options.memory
+    options.gc_stats
+    options.profiler
+  end
+end
+
+# Custom options for mspec-tag
+#
+class MSpecTag
+  def custom_options(options)
+    options.compiler
+  end
+end

data/spec/cvar_spec.rb

@@ -0,0 +1,39 @@
+describe "A Cvar node" do
+  relates "@@x" do
+    compile do |g|
+      g.push_scope
+      g.push_literal :@@x
+      g.send :class_variable_get, 1
+    end
+  end
+
+  relates <<-ruby do
+      class A
+        @@a
+      end
+    ruby
+
+    compile do |g|
+      in_class :A do |d|
+        d.push :self
+        d.push_literal :@@a
+        d.send :class_variable_get, 1
+      end
+    end
+  end
+
+  relates <<-ruby do
+      module M
+        @@a
+      end
+    ruby
+
+    compile do |g|
+      in_module :M do |d|
+        d.push :self
+        d.push_literal :@@a
+        d.send :class_variable_get, 1
+      end
+    end
+  end
+end

data/spec/cvasgn_spec.rb

@@ -0,0 +1,33 @@
+describe "A Cvasgn node" do
+  relates <<-ruby do
+      def x
+        @@blah = 1
+      end
+    ruby
+
+    compile do |g|
+      in_method :x do |d|
+        d.push_scope
+        d.push_literal :@@blah
+        d.push 1
+        d.send :class_variable_set, 2
+      end
+    end
+  end
+
+  relates <<-ruby do
+      def self.quiet_mode=(boolean)
+        @@quiet_mode = boolean
+      end
+    ruby
+
+    compile do |g|
+      in_singleton_method :quiet_mode=, [:push, :self] do |d|
+        d.push_scope
+        d.push_literal :@@quiet_mode
+        d.push_local 0
+        d.send :class_variable_set, 2
+      end
+    end
+  end
+end

data/spec/cvdecl_spec.rb

@@ -0,0 +1,17 @@
+describe "A Cvdecl node" do
+  relates <<-ruby do
+      class X
+        @@blah = 1
+      end
+    ruby
+
+    compile do |g|
+      in_class :X do |d|
+        d.push :self
+        d.push_literal :@@blah
+        d.push 1
+        d.send :class_variable_set, 2
+      end
+    end
+  end
+end

data/spec/defined_spec.rb

@@ -0,0 +1,616 @@
+describe "A Defined node" do
+  relates "defined? $x" do
+    compile do |g|
+      f = g.new_label
+      done = g.new_label
+
+      g.push_rubinius
+      g.find_const :Globals
+      g.push_literal :$x
+      g.send :key?, 1
+      g.gif f
+      g.push_literal "global-variable"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? a" do
+    compile do |g|
+      f = g.new_label
+      done = g.new_label
+
+      g.push :self
+      g.push_literal :a
+      g.push :true
+      g.send :__respond_to_p__, 2
+      g.gif f
+      g.push_literal "method"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates <<-ruby do
+      a = 1
+      defined? a
+    ruby
+
+    compile do |g|
+      g.push 1
+      g.set_local 0
+      g.pop
+
+      g.push_literal "local-variable"
+    end
+  end
+
+  relates "defined? x = 1" do
+    compile do |g|
+      g.push_literal "assignment"
+    end
+  end
+
+  relates "defined? x += 1" do
+    compile do |g|
+      g.push_literal "assignment"
+    end
+  end
+
+  relates "defined? x ||= 1" do
+    compile do |g|
+      g.push_literal "assignment"
+    end
+  end
+
+  relates "defined? x &&= 1" do
+    compile do |g|
+      g.push_literal "assignment"
+    end
+  end
+
+  relates "defined? X" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_literal :X
+      g.invoke_primitive :vm_const_defined, 1
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.pop
+      g.push_literal "constant"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? ::X" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_cpath_top
+      g.push_literal :X
+      g.push :false
+      g.invoke_primitive :vm_const_defined_under, 3
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.pop
+      g.push_literal "constant"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? X::Y" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_const :X
+      g.push_literal :Y
+      g.push :false
+      g.invoke_primitive :vm_const_defined_under, 3
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.pop
+      g.push_literal "constant"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? X::Y::Z" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_const :X
+      g.find_const :Y
+      g.push_literal :Z
+      g.push :false
+      g.invoke_primitive :vm_const_defined_under, 3
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.pop
+      g.push_literal "constant"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? self::A" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push :self
+      g.push_literal :A
+      g.push :false
+      g.invoke_primitive :vm_const_defined_under, 3
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.pop
+      g.push_literal "constant"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? self" do
+    compile do |g|
+      g.push_literal "self"
+    end
+  end
+
+  relates "defined? true" do
+    compile do |g|
+      g.push_literal "true"
+    end
+  end
+
+  relates "defined? false" do
+    compile do |g|
+      g.push_literal "false"
+    end
+  end
+
+  relates "defined? nil" do
+    compile do |g|
+      g.push_literal "nil"
+    end
+  end
+
+  relates "defined? @var" do
+    compile do |g|
+      f = g.new_label
+      done = g.new_label
+
+      g.push :self
+      g.push_literal :@var
+      g.send :__instance_variable_defined_p__, 1
+      g.gif f
+      g.push_literal "instance-variable"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? @@var" do
+    compile do |g|
+      f = g.new_label
+      done = g.new_label
+
+      g.push_scope
+      g.push_literal :@@var
+      g.send :class_variable_defined?, 1
+      g.gif f
+      g.push_literal "class variable"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? :a" do
+    compile do |g|
+      g.push_literal "expression"
+    end
+  end
+
+  relates "defined? 'a'" do
+    compile do |g|
+      g.push_literal "expression"
+    end
+  end
+
+  relates "defined? 0" do
+    compile do |g|
+      g.push_literal "expression"
+    end
+  end
+
+  relates "defined? yield" do
+    compile do |g|
+      t = g.new_label
+      f = g.new_label
+
+      g.push_block
+      g.git t
+      g.push :nil
+      g.goto f
+
+      t.set!
+      g.push_literal "yield"
+
+      f.set!
+    end
+  end
+
+  relates "defined? A.m" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_literal :A
+      g.invoke_primitive :vm_const_defined, 1
+
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.push_literal :m
+      g.push_self
+      g.invoke_primitive :vm_check_callable, 3
+      g.gif f
+      g.push_literal "method"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? ::A.m" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_cpath_top
+      g.push_literal :A
+      g.push :false
+      g.invoke_primitive :vm_const_defined_under, 3
+
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.push_literal :m
+      g.push_self
+      g.invoke_primitive :vm_check_callable, 3
+      g.gif f
+      g.push_literal "method"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? A::B.m" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_const :A
+      g.push_literal :B
+      g.push :true
+      g.invoke_primitive :vm_const_defined_under, 3
+
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.push_literal :m
+      g.push_self
+      g.invoke_primitive :vm_check_callable, 3
+      g.gif f
+      g.push_literal "method"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? a.b" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push :self
+      g.send :a, 0, true
+
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.push_literal :b
+      g.push_self
+      g.invoke_primitive :vm_check_callable, 3
+      g.gif f
+      g.push_literal "method"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+
+  relates "defined? [X]" do
+    compile do |g|
+      g.push_exception_state
+      outer_exc_state = g.new_stack_local
+      g.set_stack_local outer_exc_state
+      g.pop
+
+      f = g.new_label
+      done = g.new_label
+
+      ex = g.new_label
+      ok = g.new_label
+      g.setup_unwind ex
+
+      g.push_literal :X
+      g.invoke_primitive :vm_const_defined, 1
+      g.pop_unwind
+      g.goto ok
+
+      ex.set!
+      g.clear_exception
+      g.push_stack_local outer_exc_state
+      g.restore_exception_state
+      g.goto f
+
+      ok.set!
+      g.pop
+      g.push_literal "constant"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+
+      not_found = g.new_label
+      finished  = g.new_label
+
+      g.gif not_found
+      g.push_literal "expression"
+      g.goto finished
+
+      not_found.set!
+      g.push_nil
+      g.goto finished
+
+      finished.set!
+    end
+  end
+
+  relates <<-ruby do
+      a = 1
+      defined? a.to_s
+    ruby
+
+    compile do |g|
+      f = g.new_label
+      done = g.new_label
+
+      g.push 1
+      g.set_local 0
+      g.pop
+
+      g.push_local 0
+      g.push_literal :to_s
+      g.push_self
+      g.invoke_primitive :vm_check_callable, 3
+      g.gif f
+      g.push_literal "method"
+      g.goto done
+
+      f.set!
+      g.push :nil
+
+      done.set!
+    end
+  end
+end