seafoam 0.4 → 0.5

data/lib/seafoam/commands.rb

@@ -8,12 +8,31 @@ module Seafoam
       @config = config
     end
 
-    # Run any command.
-    def run(*args)
+    # Run the general seafoam command.
+    def seafoam(*args)
       first, *args = args
       case first
       when nil, 'help', '-h', '--help', '-help'
-        help(*args)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'seafoam file.bgv info'
+        @out.puts '        file.bgv list'
+        @out.puts '        file.bgv[:graph][:node[-edge]] search term...'
+        @out.puts '        file.bgv[:graph][:node[-edge]] edges'
+        @out.puts '        file.bgv[:graph][:node[-edge]] props'
+        @out.puts '        file.bgv:graph:node source'
+        @out.puts '        file.bgv:graph render'
+        @out.puts '              --spotlight n,n,n...'
+        @out.puts '              --out graph.pdf'
+        @out.puts '                    graph.svg'
+        @out.puts '                    graph.png'
+        @out.puts '                    graph.dot'
+        @out.puts '               --show-frame-state'
+        @out.puts '               --hide-floating'
+        @out.puts '               --no-reduce-edges'
+        @out.puts '               --option key value'
+        @out.puts '        --help'
+        @out.puts '        --version'
       when 'version', '-v', '-version', '--version'
         version(*args)
       else
@@ -32,6 +51,8 @@ module Seafoam
           edges name, *args
         when 'props'
           props name, *args
+        when 'source'
+          source name, *args
         when 'render'
           render name, *args
         when 'debug'
@@ -42,6 +63,141 @@ module Seafoam
       end
     end
 
+    # Run the bgv2isabelle command.
+    def bgv2isabelle(*args)
+      case args.first
+      when nil, 'help', '-h', '--help', '-help'
+        args = args.drop(1)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'bgv2isabelle file.bgv...'
+        @out.puts '             --help'
+        @out.puts '             --version'
+      when 'version', '-v', '-version', '--version'
+        args = args.drop(1)
+        version(*args)
+      else
+        files = []
+
+        until args.empty?
+          arg = args.shift
+          if arg.start_with?('-')
+            raise ArgumentError, "unknown option #{arg}"
+          else
+            files.push arg
+          end
+        end
+
+        writer = IsabelleWriter.new(@out)
+
+        files.each do |file|
+          parser = Seafoam::BGV::BGVParser.new(file)
+          parser.read_file_header
+          parser.skip_document_props
+
+          loop do
+            index, = parser.read_graph_preheader
+            break unless index
+
+            graph_header = parser.read_graph_header
+            name = parser.graph_name(graph_header)
+            graph = parser.read_graph
+
+            writer.write index, name, graph
+          end
+        end
+      end
+    end
+
+    def bgv2json(*args)
+      case args.first
+      when nil, 'help', '-h', '--help', '-help'
+        args = args.drop(1)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'bgv2json file.bgv...'
+        @out.puts '         --help'
+        @out.puts '         --version'
+      when 'version', '-v', '-version', '--version'
+        args = args.drop(1)
+        version(*args)
+      else
+        files = []
+
+        until args.empty?
+          arg = args.shift
+          if arg.start_with?('-')
+            raise ArgumentError, "unknown option #{arg}"
+          else
+            files.push arg
+          end
+        end
+
+        writer = JSONWriter.new(@out)
+
+        files.each do |file|
+          parser = Seafoam::BGV::BGVParser.new(file)
+          parser.read_file_header
+          parser.skip_document_props
+
+          loop do
+            index, = parser.read_graph_preheader
+            break unless index
+
+            graph_header = parser.read_graph_header
+            name = parser.graph_name(graph_header)
+            graph = parser.read_graph
+
+            writer.write name, graph
+          end
+        end
+      end
+    end
+
+    def cfg2asm(*args)
+      case args.first
+      when nil, 'help', '-h', '--help', '-help'
+        args = args.drop(1)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'cfg2asm file.bgv...'
+        @out.puts '            --no-comments'
+        @out.puts '        --help'
+        @out.puts '        --version'
+      when 'version', '-v', '-version', '--version'
+        args = args.drop(1)
+        version(*args)
+      else
+        comments = true
+        files = []
+
+        until args.empty?
+          arg = args.shift
+          if arg.start_with?('-')
+            case arg
+            when '--no-comments'
+              comments = false
+            else
+              raise ArgumentError, "unknown option #{arg}"
+            end
+          else
+            files.push arg
+          end
+        end
+
+        files.each_with_index do |file, n|
+          parser = Seafoam::CFG::CFGParser.new(@out, file)
+          parser.skip_over_cfg 'After code installation'
+          nmethod = parser.read_nmethod
+
+          disassembler = Seafoam::CFG::Disassembler.new(@out)
+          @out.puts if n.positive?
+          @out.puts "[#{file}]"
+          disassembler.disassemble(nmethod, comments)
+        end
+      end
+    end
+
     private
 
     # seafoam file.bgv info
@@ -218,7 +374,24 @@ module Seafoam
       end
     end
 
-    # seafoam file.bgv:0 render options...
+    # seafoam file.bgv:n:n source
+    def source(name, *args)
+      file, graph_index, node_id, edge_id = parse_name(name)
+      raise ArgumentError, 'source needs a node' unless node_id
+      raise ArgumentError, 'source only works with a node' if edge_id
+      raise ArgumentError, 'source does not take arguments' unless args.empty?
+
+      with_graph(file, graph_index) do |parser|
+        parser.read_graph_header
+        graph = parser.read_graph
+        node = graph.nodes[node_id]
+        raise ArgumentError, 'node not found' unless node
+
+        @out.puts Graal::Source.render(node.props['nodeSourcePosition'])
+      end
+    end
+
+    # seafoam file.bgv:n render options...
     def render(name, *args)
       file, graph_index, *rest = parse_name(name)
       raise ArgumentError, 'render needs at least a graph' unless graph_index
@@ -299,10 +472,14 @@ module Seafoam
             writer.write_graph graph
           end
         else
-          IO.popen(['dot', "-T#{out_format}", '-o', out_file], 'w') do |stream|
-            writer = GraphvizWriter.new(stream)
-            hidpi = out_format == :png
-            writer.write_graph graph, hidpi
+          begin
+            IO.popen(['dot', "-T#{out_format}", '-o', out_file], 'w') do |stream|
+              writer = GraphvizWriter.new(stream)
+              hidpi = out_format == :png
+              writer.write_graph graph, hidpi
+            end
+          rescue Errno::ENOENT
+            raise 'Could not run Graphviz - is it installed?'
           end
           autoopen out_file unless explicit_out_file
         end
@@ -388,27 +565,6 @@ module Seafoam
       raise ArgumentError, 'graph not found' unless graph_found
     end
 
-    # Prints help.
-    def help(*args)
-      raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
-
-      @out.puts 'seafoam file.bgv info'
-      @out.puts '        file.bgv list'
-      @out.puts '        file.bgv[:graph][:node[-edge]] search term...'
-      @out.puts '        file.bgv[:graph][:node[-edge]] edges'
-      @out.puts '        file.bgv[:graph][:node[-edge]] props'
-      @out.puts '        file.bgv:graph render'
-      @out.puts '              --spotlight n,n,n...'
-      @out.puts '              --out graph.pdf'
-      @out.puts '                    graph.svg'
-      @out.puts '                    graph.png'
-      @out.puts '                    graph.dot'
-      @out.puts '               --show-frame-state'
-      @out.puts '               --hide-floating'
-      @out.puts '               --no-reduce-edges'
-      @out.puts '               --option key value'
-    end
-
     # Prints the version.
     def version(*args)
       raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?

data/lib/seafoam/graal/source.rb

@@ -0,0 +1,23 @@
+module Seafoam
+  module Graal
+    # Routines for understanding source positions in Graal.
+    module Source
+      def self.render(source_position)
+        lines = []
+        caller = source_position
+        while caller
+          method = caller[:method]
+          lines.push render_method(method)
+          caller = caller[:caller]
+        end
+        lines.join("\n")
+      end
+
+      def self.render_method(method)
+        declaring_class = method[:declaring_class]
+        name = method[:method_name]
+        "#{declaring_class}##{name}"
+      end
+    end
+  end
+end

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 = 4
+  MINOR_VERSION = 5
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}"
 end

data/seafoam.gemspec

@@ -8,13 +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.required_ruby_version = '>= 2.5.8'
 
   spec.add_development_dependency 'benchmark-ips', '~> 2.7'
+  spec.add_development_dependency 'crabstone', '~> 4.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.74'
 end

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

@@ -77,7 +77,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 +108,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
+      54.times do
         expect(parser.read_graph_preheader).to_not be_nil
         parser.skip_graph_header
         parser.skip_graph