seafoam 0.3 → 0.8

data/lib/seafoam/isabelle_writer.rb

@@ -0,0 +1,46 @@
+module Seafoam
+  # Write graphs in the Isabelle file format.
+  class IsabelleWriter
+    def initialize(out)
+      @out = out
+    end
+
+    def write(index, name, graph)
+      # definition eg_short_cut_or1 :: IRGraph where
+      #   "eg_short_cut_or1 =
+      #     (add_node 14 ReturnNode [13] []
+      #     (add_node 13 PhiNode [10, 11, 12] []
+      #     (add_node 12 (ConstantNode 0) [] []
+      #     (add_node 11 (ConstantNode 42) [] []
+      #     (add_node 10 MergeNode [7, 9] [14]
+      #     (add_node 9 EndNode [] []
+      #     (add_node 8 BeginNode [] [9]
+      #     (add_node 7 EndNode [] []
+      #     (add_node 6 BeginNode [] [7]
+      #     (add_node 5 IfNode [3] [6, 8]
+      #     (add_node 3 (ShortCircuitOrNode False False) [1, 2] []
+      #     (add_node 2 (ParameterNode 1) [] []
+      #     (add_node 1 (ParameterNode 0) [] []
+      #     (add_node 0 StartNode [] [5]
+      #     empty_graph))))))))))))))"
+
+      @out.puts "graph#{index} = # #{name}"
+
+      graph.nodes.each_value do |node|
+        node_class = node.props[:node_class][:node_class]
+        case node_class
+        when 'org.graalvm.compiler.nodes.ConstantNode'
+          desc = "(ConstantNode #{node.props['rawvalue']})"
+        when 'org.graalvm.compiler.nodes.ParameterNode'
+          desc = "(ParameterNode #{node.props['index']})"
+        else
+          desc = node_class.split('.').last
+        end
+        inputs = node.inputs.map(&:from).map(&:id)
+        outputs = node.outputs.map(&:to).map(&:id)
+        @out.puts " (add_node #{node.id} #{desc} #{inputs.inspect} #{outputs.inspect}"
+      end
+      @out.puts ' empty_graph' + (')' * graph.nodes.size)
+    end
+  end
+end

data/lib/seafoam/json_writer.rb

@@ -0,0 +1,58 @@
+require 'json'
+
+module Seafoam
+  # Write files in a JSON format.
+  class JSONWriter
+    def initialize(out)
+      @out = out
+    end
+
+    def write(name, graph)
+      nodes = []
+      edges = []
+
+      graph.nodes.each_value do |node|
+        nodes.push(
+          id: node.id,
+          props: node.props
+        )
+
+        node.outputs.each do |edge|
+          edges.push(
+            from: edge.from.id,
+            to: edge.to.id,
+            props: edge.props
+          )
+        end
+      end
+
+      object = {
+        name: name,
+        props: graph.props,
+        nodes: nodes,
+        edges: edges
+      }
+
+      @out.puts JSON.pretty_generate(prepare_json(object))
+    end
+
+    private
+
+    def prepare_json(object)
+      case object
+      when Float
+        if object.nan?
+          '[NaN]'
+        else
+          object
+        end
+      when Array
+        object.map { |o| prepare_json(o) }
+      when Hash
+        object.transform_values { |v| prepare_json(v) }
+      else
+        object
+      end
+    end
+  end
+end

data/lib/seafoam/version.rb

@@ -1,5 +1,5 @@
 module Seafoam
   MAJOR_VERSION = 0
-  MINOR_VERSION = 3
+  MINOR_VERSION = 8
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}"
 end

data/seafoam.gemspec

@@ -8,12 +8,14 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/Shopify/seafoam'
   spec.license = 'MIT'
 
-  spec.files = `git ls-files`.split("\n")
+  spec.files = `git ls-files`.split("\n").reject { |f| f.end_with?('.bgv') || f.end_with?('.cfg') }
   spec.bindir = 'bin'
-  spec.executables = %w[seafoam bgv2json bgv2isabelle]
+  spec.executables = %w[seafoam bgv2json bgv2isabelle cfg2asm]
 
   spec.required_ruby_version = '>= 2.5.8'
 
+  spec.add_dependency 'crabstone', '~> 4.0'
+
   spec.add_development_dependency 'benchmark-ips', '~> 2.7'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.74'

data/spec/seafoam/annotators/graal_spec.rb

@@ -20,7 +20,7 @@ describe Seafoam::Annotators::GraalAnnotator do
   describe 'when run' do
     describe 'without options' do
       before :all do
-        @graph = Seafoam::SpecHelpers.example_graph('matmult-ruby', 2)
+        @graph = Seafoam::SpecHelpers.example_graph('matmult-ruby', 8)
         annotator = Seafoam::Annotators::GraalAnnotator.new({})
         annotator.annotate @graph
       end
@@ -37,14 +37,14 @@ describe Seafoam::Annotators::GraalAnnotator do
         expect(@graph.edges.any? { |e| e.props[:kind].nil? }).to be_falsey
       end
 
-      it 'annotates negated GuardNodes with "Guard not, else ..."' do
-        expect(@graph.nodes[561].props['negated']).to be true
-        expect(@graph.nodes[561].props[:label]).to start_with 'Guard not, else'
+      it 'annotates not negated GuardNodes with "Guard, else ..."' do
+        expect(@graph.nodes[7101].props['negated']).to be false
+        expect(@graph.nodes[7101].props[:label]).to start_with 'Guard, else'
       end
 
-      it 'annotates not negated GuardNodes with "Guard, else ..."' do
-        expect(@graph.nodes[559].props['negated']).to be false
-        expect(@graph.nodes[559].props[:label]).to start_with 'Guard, else'
+      it 'annotates negated GuardNodes with "Guard not, else ..."' do
+        expect(@graph.nodes[7102].props['negated']).to be true
+        expect(@graph.nodes[7102].props[:label]).to start_with 'Guard not, else'
       end
     end
 

data/spec/seafoam/bgv/bgv_parser_spec.rb

@@ -52,6 +52,16 @@ describe Seafoam::BGV::BGVParser do
     end
   end
 
+  it 'can read basic blocks' do
+    parser = Seafoam::BGV::BGVParser.new(File.expand_path('../../../examples/fib-java.bgv', __dir__))
+    parser.read_file_header
+    parser.skip_document_props
+    parser.read_graph_preheader
+    parser.skip_graph_header
+    graph = parser.read_graph
+    expect(graph.blocks.size).to eq 3
+  end
+
   it 'can alternate skipping and reading full files' do
     Seafoam::SpecHelpers::SAMPLE_BGV.each do |file|
       parser = Seafoam::BGV::BGVParser.new(file)
@@ -77,7 +87,7 @@ describe Seafoam::BGV::BGVParser do
   describe '#read_file_header' do
     it 'produces a version' do
       parser = Seafoam::BGV::BGVParser.new(@fib_java_bgv)
-      expect(parser.read_file_header).to eq [6, 1]
+      expect(parser.read_file_header).to eq [7, 0]
     end
 
     it 'raises an error for files which are not BGV' do
@@ -108,7 +118,7 @@ describe Seafoam::BGV::BGVParser do
       parser = Seafoam::BGV::BGVParser.new(@fib_java_bgv)
       parser.read_file_header
       parser.skip_document_props
-      51.times do
+      56.times do
         expect(parser.read_graph_preheader).to_not be_nil
         parser.skip_graph_header
         parser.skip_graph
@@ -150,7 +160,7 @@ describe Seafoam::BGV::BGVParser do
       parser.read_graph_preheader
       parser.read_graph_header
       graph = parser.read_graph
-      expect(graph.nodes.size).to eq 22
+      expect(graph.nodes.size).to eq 21
       expect(graph.edges.size).to eq 30
     end
   end

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
@@ -32,18 +33,18 @@ describe Seafoam::Commands do
       @commands.send :list, @fib_java
       lines = @out.string.lines.map(&:rstrip)
       expect(lines.take(5)).to eq [
-        "#{@fib_java}:0  2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase",
-        "#{@fib_java}:1  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.PhaseSuite",
-        "#{@fib_java}:2  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
-        "#{@fib_java}:3  2:Fib.fib(int)/After parsing",
-        "#{@fib_java}:4  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.CanonicalizerPhase"
+        "#{@fib_java}:0  17:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase",
+        "#{@fib_java}:1  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.PhaseSuite",
+        "#{@fib_java}:2  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
+        "#{@fib_java}:3  17:Fib.fib(int)/After parsing",
+        "#{@fib_java}:4  17: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}:51  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
+        "#{@fib_java}:52  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.PropagateDeoptimizeProbabilityPhase",
+        "#{@fib_java}:53  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.schedule.SchedulePhase",
+        "#{@fib_java}:54  17:Fib.fib(int)/After phase org.graalvm.compiler.core.phases.LowTier",
+        "#{@fib_java}:55  17:Fib.fib(int)/After low tier"
       ]
     end
 
@@ -95,7 +96,7 @@ describe Seafoam::Commands do
     it 'prints the number of edges and nodes for a graph' do
       @commands.send :edges, "#{@fib_java}:0"
       lines = @out.string.lines.map(&:rstrip)
-      expect(lines.first).to eq '22 nodes, 30 edges'
+      expect(lines.first).to eq '21 nodes, 30 edges'
     end
 
     it 'prints the edges for a node' do
@@ -127,20 +128,18 @@ 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\": \"94468\"\n}\n"
     end
 
     it 'prints properties for a graph' do
       @commands.send :props, "#{@fib_java}:0"
-      lines = @out.string.lines.map(&:rstrip)
-      expect(lines[3]).to include '"name": "2:Fib.fib(int)"'
+      expect(@out.string).to include '"scope": "main.Compiling.GraalCompiler.FrontEnd.PhaseSuite.GraphBuilderPhase"'
     end
 
     it 'prints properties for a node' do
       @commands.send :props, "#{@fib_java}:0:13"
-      lines = @out.string.lines.map(&:rstrip)
-      expect(lines[3]).to include '"declaring_class": "Fib"'
+      expect(@out.string).to include '"declaring_class": "Fib"'
     end
 
     it 'prints properties for an edge' do
@@ -150,6 +149,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 +182,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'
+      it 'supports spotlighting nodes' do
+        @commands.send :render, "#{@fib_java}:0", '--spotlight', '13'
+      end
+
+      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 +244,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