seafoam 0.4 → 0.5

data/spec/seafoam/cfg/cfg_parser_spec.rb

@@ -0,0 +1,21 @@
+require 'seafoam'
+
+require 'rspec'
+
+require_relative '../spec_helpers'
+
+describe Seafoam::CFG::CFGParser do
+  before :all do
+    @example_cfg = File.expand_path('../../../examples/java/exampleIf.cfg', __dir__)
+  end
+
+  it 'correctly parses information from an nmethod' do
+    parser = Seafoam::CFG::CFGParser.new($stdout, @example_cfg)
+    parser.skip_over_cfg 'After code installation'
+    nmethod = parser.read_nmethod
+    expect(nmethod.code.arch).to eq 'AMD64'
+    expect(nmethod.code.arch_width).to eq '64'
+    expect(nmethod.code.base).to eq 0x1183037a0
+    expect(nmethod.comments.size).to eq 25
+  end
+end

data/spec/seafoam/cfg/disassembler_spec.rb

@@ -0,0 +1,32 @@
+require 'seafoam'
+
+require 'rspec'
+
+require_relative '../spec_helpers'
+
+describe Seafoam::CFG::Disassembler do
+  if Seafoam::SpecHelpers.dependencies_installed?
+    it 'can start Capstone Disassembler disassemble an nmethod with and without comments' do
+      @example_cfg = File.expand_path('../../../examples/java/exampleIf.cfg', __dir__)
+      @file = File.open('tempfile_disassembler_spec.txt', 'w')
+      parser = Seafoam::CFG::CFGParser.new(@file, @example_cfg)
+      parser.skip_over_cfg 'After code installation'
+      @nmethod = parser.read_nmethod
+
+      disassembler = Seafoam::CFG::Disassembler.new(@file)
+      disassembler.disassemble(@nmethod, 0)
+      @file.close
+
+      expect(`wc -l 'tempfile_disassembler_spec.txt'`.to_i).to eq 46
+
+      @file = File.open('tempfile_disassembler_spec.txt', 'w')
+      disassembler = Seafoam::CFG::Disassembler.new(@file)
+      disassembler.disassemble(@nmethod, 2)
+      @file.close
+
+      expect(`wc -l 'tempfile_disassembler_spec.txt'`.to_i).to eq 46
+
+      File.delete(@file)
+    end
+  end
+end

data/spec/seafoam/command_spec.rb

@@ -8,6 +8,7 @@ require 'rspec'
 describe Seafoam::Commands do
   before :all do
     @fib_java = File.expand_path('../../examples/fib-java.bgv', __dir__)
+    @fib_ruby = File.expand_path('../../examples/fib-ruby.bgv', __dir__)
   end
 
   before :each do
@@ -19,7 +20,7 @@ describe Seafoam::Commands do
     it 'prints format and version' do
       @commands.send :info, @fib_java
       lines = @out.string.lines.map(&:rstrip)
-      expect(lines.first).to eq 'BGV 6.1'
+      expect(lines.first).to eq 'BGV 7.0'
     end
 
     it 'does not work on a graph' do
@@ -39,11 +40,11 @@ describe Seafoam::Commands do
         "#{@fib_java}:4  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.CanonicalizerPhase"
       ]
       expect(lines.drop(lines.length - 5)).to eq [
-        "#{@fib_java}:46  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.PropagateDeoptimizeProbabilityPhase",
-        "#{@fib_java}:47  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.InsertMembarsPhase",
-        "#{@fib_java}:48  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.schedule.SchedulePhase",
-        "#{@fib_java}:49  2:Fib.fib(int)/After phase org.graalvm.compiler.core.phases.LowTier",
-        "#{@fib_java}:50  2:Fib.fib(int)/After low tier"
+        "#{@fib_java}:49  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
+        "#{@fib_java}:50  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.PropagateDeoptimizeProbabilityPhase",
+        "#{@fib_java}:51  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.schedule.SchedulePhase",
+        "#{@fib_java}:52  2:Fib.fib(int)/After phase org.graalvm.compiler.core.phases.LowTier",
+        "#{@fib_java}:53  2:Fib.fib(int)/After low tier"
       ]
     end
 
@@ -127,8 +128,8 @@ describe Seafoam::Commands do
 
   describe '#props' do
     it 'prints properties for a file' do
-      @commands.send :props, @fib_java.to_s
-      expect(@out.string.gsub(/\n\n/, "\n")).to eq "{\n}\n"
+      @commands.send :props, @fib_java
+      expect(@out.string.gsub(/\n\n/, "\n")).to eq "{\n  \"vm.uuid\": \"28729\"\n}\n"
     end
 
     it 'prints properties for a graph' do
@@ -150,6 +151,28 @@ describe Seafoam::Commands do
     end
   end
 
+  describe '#source' do
+    it 'prints source information for a node' do
+      @commands.send :source, "#{@fib_ruby}:8:2443"
+      expect(@out.string).to eq <<~SOURCE
+        java.lang.Math#addExact
+        org.truffleruby.core.numeric.IntegerNodes$AddNode#add
+        org.truffleruby.core.numeric.IntegerNodesFactory$AddNodeFactory$AddNodeGen#executeAdd
+        org.truffleruby.core.inlined.InlinedAddNode#intAdd
+        org.truffleruby.core.inlined.InlinedAddNodeGen#execute
+        org.truffleruby.language.control.IfElseNode#execute
+        org.truffleruby.language.control.SequenceNode#execute
+        org.truffleruby.language.arguments.CheckArityNode#execute
+        org.truffleruby.language.control.SequenceNode#execute
+        org.truffleruby.language.methods.CatchForMethodNode#execute
+        org.truffleruby.language.methods.ExceptionTranslatingNode#execute
+        org.truffleruby.language.RubyRootNode#execute
+        org.graalvm.compiler.truffle.runtime.OptimizedCallTarget#executeRootNode
+        org.graalvm.compiler.truffle.runtime.OptimizedCallTarget#profiledPERoot
+      SOURCE
+    end
+  end
+
   describe '#render' do
     it 'does not work on a file' do
       expect { @commands.send :render, @fib_java }.to raise_error(ArgumentError)
@@ -161,32 +184,57 @@ describe Seafoam::Commands do
       end
     end
 
-    it 'supports -o out.pdf' do
-      @commands.send :render, "#{@fib_java}:0", '--out', 'out.pdf'
-      expect(`file out.pdf`).to start_with 'out.pdf: PDF document'
-    end
+    if Seafoam::SpecHelpers.dependencies_installed?
+      it 'supports -o out.pdf' do
+        @commands.send :render, "#{@fib_java}:0", '--out', 'out.pdf'
+        expect(`file out.pdf`).to start_with 'out.pdf: PDF document'
+      end
 
-    it 'supports -o out.svg' do
-      @commands.send :render, "#{@fib_java}:0", '--out', 'out.svg'
-      expect(`file out.svg`).to start_with 'out.svg: SVG Scalable Vector Graphics image'
-    end
+      it 'supports -o out.svg' do
+        @commands.send :render, "#{@fib_java}:0", '--out', 'out.svg'
+        expect(`file out.svg`).to start_with 'out.svg: SVG Scalable Vector Graphics image'
+      end
 
-    it 'supports -o out.png' do
-      @commands.send :render, "#{@fib_java}:0", '--out', 'out.png'
-      expect(`file out.png`).to start_with 'out.png: PNG image data'
-    end
+      it 'supports -o out.png' do
+        @commands.send :render, "#{@fib_java}:0", '--out', 'out.png'
+        expect(`file out.png`).to start_with 'out.png: PNG image data'
+      end
 
-    it 'supports -o out.dot' do
-      @commands.send :render, "#{@fib_java}:0", '--out', 'out.dot'
-      expect(`file out.dot`).to start_with 'out.dot: ASCII text'
-    end
+      it 'supports -o out.dot' do
+        @commands.send :render, "#{@fib_java}:0", '--out', 'out.dot'
+        expect(`file out.dot`).to start_with 'out.dot: ASCII text'
+      end
+
+      it 'supports spotlighting nodes' do
+        @commands.send :render, "#{@fib_java}:0", '--spotlight', '13'
+      end
 
-    it 'supports spotlighting nodes' do
-      @commands.send :render, "#{@fib_java}:0", '--spotlight', '13'
+      it 'does not work on a node' do
+        expect { @commands.send :render, "#{@fib_java}:0:13" }.to raise_error(ArgumentError)
+      end
+    else
+      it 'raises an exception if Graphviz is not installed' do
+        expect do
+          @commands.send :render, "#{@fib_java}:0", '--out', 'out.pdf'
+        end.to raise_error(RuntimeError, /Could not run Graphviz - is it installed?/)
+      end
     end
+  end
 
-    it 'does not work on a node' do
-      expect { @commands.send :render, "#{@fib_java}:0:13" }.to raise_error(ArgumentError)
+  describe '#cfg2asm' do
+    if Seafoam::SpecHelpers.dependencies_installed?
+      it 'prints format and version' do
+        @commands.cfg2asm(File.expand_path('../../examples/java/exampleWhile.cfg', __dir__), '--no-comments')
+        lines = @out.string.lines.map(&:rstrip)
+        expect(lines[1]).to include "0x117df59e0:\tnop	dword ptr [rax + rax]"
+        expect(lines[-1]).to include "0x117df5a47:\thlt"
+      end
+    else
+      it 'raises an exception if Capstone is not installed' do
+        expect do
+          @commands.cfg2asm(File.expand_path('../../examples/java/exampleWhile.cfg', __dir__), '--no-comments')
+        end.to raise_error(RuntimeError, /Could not load Capstone - is it installed?/)
+      end
     end
   end
 
@@ -198,13 +246,13 @@ describe Seafoam::Commands do
 
   describe '#help' do
     it 'does not take any arguments' do
-      expect { @commands.send :help, 'foo' }.to raise_error(ArgumentError)
+      expect { @commands.send :seafoam, '--help', 'foo' }.to raise_error(ArgumentError)
     end
   end
 
   describe '#version' do
     it 'does not take any arguments' do
-      expect { @commands.send :help, 'foo' }.to raise_error(ArgumentError)
+      expect { @commands.send :version, 'foo' }.to raise_error(ArgumentError)
     end
   end
 

data/spec/seafoam/json_writer_spec.rb

@@ -0,0 +1,14 @@
+require 'seafoam'
+
+require 'rspec'
+
+require_relative 'spec_helpers'
+
+describe Seafoam::JSONWriter do
+  describe '#prepare_json' do
+    it 'transforms a NaN to the string [NaN]' do
+      writer = Seafoam::JSONWriter.new(nil)
+      expect(writer.send(:prepare_json, { a: 1.0, b: Float::NAN, c: 2.0 })).to eq({ a: 1.0, b: '[NaN]', c: 2.0 })
+    end
+  end
+end

data/spec/seafoam/spec_helpers.rb

@@ -26,5 +26,9 @@ module Seafoam
         end
       end
     end
+
+    def self.dependencies_installed?
+      ENV['NO_DEPENDENCIES_INSTALLED'].nil?
+    end
   end
 end

data/tools/render-all

@@ -30,7 +30,7 @@ Dir.glob(File.expand_path('../examples/java/*.bgv', __dir__)).each do |bgv|
     extra_options.push '--show-frame-state'
   end
   phases.each do |phase|
-    commands.run "#{bgv}:#{phase}", 'render', *extra_options, '--out', File.expand_path("../#{basename}@#{phase}.png", __dir__)
-    commands.run "#{bgv}:#{phase}", 'render', *extra_options, '--out', File.expand_path("../#{basename}@#{phase}.svg", __dir__)
+    commands.seafoam "#{bgv}:#{phase}", 'render', *extra_options, '--out', File.expand_path("../#{basename}@#{phase}.png", __dir__)
+    commands.seafoam "#{bgv}:#{phase}", 'render', *extra_options, '--out', File.expand_path("../#{basename}@#{phase}.svg", __dir__)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seafoam
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Chris Seaton
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: crabstone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.74'
-description:
-email:
+description: 
+email: 
 executables:
 - seafoam
 - bgv2json
@@ -62,8 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/probots.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/specs.yml"
+- ".github/workflows/workflows.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -75,7 +88,9 @@ files:
 - README.md
 - bin/bgv2isabelle
 - bin/bgv2json
+- bin/cfg2asm
 - bin/seafoam
+- demos/box-unbox-stats
 - docs/annotators.md
 - docs/bgv.md
 - docs/getting-graphs.md
@@ -86,116 +101,35 @@ files:
 - docs/json.md
 - examples/Fib.java
 - examples/MatMult.java
-- examples/fib-java.bgv
 - examples/fib-java.bgv.gz
-- examples/fib-js.bgv
-- examples/fib-ruby.bgv
 - examples/fib.js
 - examples/fib.rb
-- examples/identity.bgv
 - examples/identity.rb
 - examples/java/Irreducible.class
 - examples/java/Irreducible.j
 - examples/java/IrreducibleDecompiled.java
 - examples/java/JavaExamples.java
-- examples/java/exampleArithOperator.bgv
-- examples/java/exampleArithOperator.cfg
-- examples/java/exampleArrayAllocation.bgv
-- examples/java/exampleArrayAllocation.cfg
-- examples/java/exampleArrayRead.bgv
-- examples/java/exampleArrayRead.cfg
-- examples/java/exampleArrayWrite.bgv
-- examples/java/exampleArrayWrite.cfg
-- examples/java/exampleCatch.bgv
-- examples/java/exampleCatch.cfg
-- examples/java/exampleCompareOperator.bgv
-- examples/java/exampleCompareOperator.cfg
-- examples/java/exampleDoubleSynchronized.bgv
-- examples/java/exampleDoubleSynchronized.cfg
-- examples/java/exampleExactArith.bgv
-- examples/java/exampleExactArith.cfg
-- examples/java/exampleFieldRead.bgv
-- examples/java/exampleFieldRead.cfg
-- examples/java/exampleFieldWrite.bgv
-- examples/java/exampleFieldWrite.cfg
-- examples/java/exampleFor.bgv
-- examples/java/exampleFor.cfg
-- examples/java/exampleFullEscape.bgv
-- examples/java/exampleFullEscape.cfg
-- examples/java/exampleIf.bgv
-- examples/java/exampleIf.cfg
-- examples/java/exampleIfNeverTaken.bgv
-- examples/java/exampleIfNeverTaken.cfg
-- examples/java/exampleInstanceOfManyImpls.bgv
-- examples/java/exampleInstanceOfManyImpls.cfg
-- examples/java/exampleInstanceOfOneImpl.bgv
-- examples/java/exampleInstanceOfOneImpl.cfg
-- examples/java/exampleIntSwitch.bgv
-- examples/java/exampleIntSwitch.cfg
-- examples/java/exampleInterfaceCallManyImpls.bgv
-- examples/java/exampleInterfaceCallManyImpls.cfg
-- examples/java/exampleInterfaceCallOneImpl.bgv
-- examples/java/exampleInterfaceCallOneImpl.cfg
-- examples/java/exampleLocalInstanceOf.bgv
-- examples/java/exampleLocalInstanceOf.cfg
-- examples/java/exampleLocalSynchronized.bgv
-- examples/java/exampleLocalSynchronized.cfg
-- examples/java/exampleLocalVariables.bgv
-- examples/java/exampleLocalVariables.cfg
-- examples/java/exampleLocalVariablesState.bgv
-- examples/java/exampleLocalVariablesState.cfg
-- examples/java/exampleNestedWhile.bgv
-- examples/java/exampleNestedWhile.cfg
-- examples/java/exampleNestedWhileBreak.bgv
-- examples/java/exampleNestedWhileBreak.cfg
-- examples/java/exampleNoEscape.bgv
-- examples/java/exampleNoEscape.cfg
-- examples/java/exampleObjectAllocation.bgv
-- examples/java/exampleObjectAllocation.cfg
-- examples/java/examplePartialEscape.bgv
-- examples/java/examplePartialEscape.cfg
-- examples/java/examplePhi.bgv
-- examples/java/examplePhi.cfg
-- examples/java/exampleReducible.bgv
-- examples/java/exampleReducible.cfg
-- examples/java/exampleSimpleCall.bgv
-- examples/java/exampleSimpleCall.cfg
-- examples/java/exampleStamp.bgv
-- examples/java/exampleStamp.cfg
-- examples/java/exampleStaticCall.bgv
-- examples/java/exampleStaticCall.cfg
-- examples/java/exampleStringSwitch.bgv
-- examples/java/exampleStringSwitch.cfg
-- examples/java/exampleSynchronized.bgv
-- examples/java/exampleSynchronized.cfg
-- examples/java/exampleThrow.bgv
-- examples/java/exampleThrow.cfg
-- examples/java/exampleThrowCatch.bgv
-- examples/java/exampleThrowCatch.cfg
-- examples/java/exampleUnsafeRead.bgv
-- examples/java/exampleUnsafeRead.cfg
-- examples/java/exampleUnsafeWrite.bgv
-- examples/java/exampleUnsafeWrite.cfg
-- examples/java/exampleWhile.bgv
-- examples/java/exampleWhile.cfg
-- examples/java/exampleWhileBreak.bgv
-- examples/java/exampleWhileBreak.cfg
-- examples/matmult-java.bgv
-- examples/matmult-ruby.bgv
 - examples/matmult.rb
-- examples/overflow.bgv
 - examples/overflow.rb
+- examples/ruby/clamps.rb
+- examples/ruby/graal.patch
+- examples/ruby/ruby_examples.rb
 - lib/seafoam.rb
 - lib/seafoam/annotators.rb
 - lib/seafoam/annotators/fallback.rb
 - lib/seafoam/annotators/graal.rb
 - lib/seafoam/bgv/bgv_parser.rb
 - lib/seafoam/binary/io_binary_reader.rb
+- lib/seafoam/cfg/cfg_parser.rb
+- lib/seafoam/cfg/disassembler.rb
 - lib/seafoam/colors.rb
 - lib/seafoam/commands.rb
 - lib/seafoam/config.rb
+- lib/seafoam/graal/source.rb
 - lib/seafoam/graph.rb
 - lib/seafoam/graphviz_writer.rb
+- lib/seafoam/isabelle_writer.rb
+- lib/seafoam/json_writer.rb
 - lib/seafoam/spotlight.rb
 - lib/seafoam/version.rb
 - seafoam.gemspec
@@ -203,12 +137,13 @@ files:
 - spec/seafoam/annotators/graal_spec.rb
 - spec/seafoam/annotators_spec.rb
 - spec/seafoam/bgv/bgv_parser_spec.rb
-- spec/seafoam/bgv/fixtures/not.bgv
-- spec/seafoam/bgv/fixtures/unsupported.bgv
 - spec/seafoam/binary/io_binary_reader_spec.rb
+- spec/seafoam/cfg/cfg_parser_spec.rb
+- spec/seafoam/cfg/disassembler_spec.rb
 - spec/seafoam/command_spec.rb
 - spec/seafoam/graph_spec.rb
 - spec/seafoam/graphviz_writer_spec.rb
+- spec/seafoam/json_writer_spec.rb
 - spec/seafoam/spec_helpers.rb
 - spec/seafoam/spotlight_spec.rb
 - tools/render-all
@@ -216,7 +151,7 @@ homepage: https://github.com/Shopify/seafoam
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -231,9 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: A tool for working with compiler graphs
 test_files: []