seafoam 0.8 → 0.12

data/lib/seafoam/formatters/text.rb

@@ -0,0 +1,70 @@
+module Seafoam
+  module Formatters
+    module Text
+      # A plain-text formatter for the `describe` command.
+      class DescribeFormatter < Seafoam::Formatters::Base::DescribeFormatter
+        def format
+          notes = Seafoam::Graal::GraphDescription::ATTRIBUTES.select { |attr| description.send(attr) }
+
+          ["#{graph.nodes.size} nodes", *notes].join(', ')
+        end
+      end
+
+      # A plain-text formatter for the `edges` command.
+      class EdgesFormatter < Seafoam::Formatters::Base::EdgesFormatter
+        def render_edges_entry(edges)
+          edges.map do |edge|
+            "#{edge.from.id_and_label} ->(#{edge.props[:label]}) #{edge.to.id_and_label}"
+          end.join("\n")
+        end
+
+        def render_node_entry(node)
+          ret = ['Input:']
+          ret += node.inputs.map do |input|
+            "  #{node.id_and_label} <-(#{input.props[:label]}) #{input.from.id_and_label}"
+          end
+
+          ret << 'Output:'
+          ret += node.outputs.map do |output|
+            "  #{node.id_and_label} ->(#{output.props[:label]}) #{output.to.id_and_label}"
+          end
+
+          ret.join("\n")
+        end
+
+        def render_summary_entry(node_count, edge_count)
+          "#{node_count} nodes, #{edge_count} edges"
+        end
+      end
+
+      # A plain-text formatter for the `info` command.
+      class InfoFormatter < Seafoam::Formatters::Base::InfoFormatter
+        def format
+          "BGV #{major_version}.#{minor_version}"
+        end
+      end
+
+      # A plain-text formatter for the `list` command.
+      class ListFormatter < Seafoam::Formatters::Base::ListFormatter
+        def format
+          entries.map do |entry|
+            "#{entry.file}:#{entry.index}  #{entry.graph_name_components.join('/')}"
+          end.join("\n")
+        end
+      end
+
+      # A plain-text formatter for the `source` command.
+      class SourceFormatter < Seafoam::Formatters::Base::SourceFormatter
+        def format
+          Seafoam::Graal::Source.walk(source_position, &method(:render_method)).join("\n")
+        end
+
+        def render_method(method)
+          declaring_class = method[:declaring_class]
+          name = method[:method_name]
+          "#{declaring_class}##{name}"
+        end
+      end
+    end
+  end
+end

data/lib/seafoam/graal/graph_description.rb

@@ -0,0 +1,22 @@
+module Seafoam
+  module Graal
+    # Provides a high level description of a Graal graph's features.
+    class GraphDescription
+      ATTRIBUTES = %i[branches calls deopts linear loops]
+
+      ATTRIBUTES.each { |attr| attr_accessor(attr) }
+
+      def initialize
+        @branches = false
+        @calls = false
+        @deopts = false
+        @linear = false
+        @loops = false
+      end
+
+      def linear
+        !branches && !loops
+      end
+    end
+  end
+end

data/lib/seafoam/graal/pi.rb

@@ -0,0 +1,18 @@
+module Seafoam
+  module Graal
+    # Routines for understanding pi nodes in Graal.
+    module Pi
+      # Find the actual value behind potentially a chain of pi nodes.
+      def self.follow_pi_object(node)
+        node = node.edges.find { |edge| edge.props[:name] == 'object' }.from while PI_NODES.include?(node.props.dig(:node_class, :node_class))
+        node
+      end
+
+      # Pi nodes add type information.
+      PI_NODES = [
+        'org.graalvm.compiler.nodes.PiNode',
+        'org.graalvm.compiler.nodes.PiArrayNode'
+      ]
+    end
+  end
+end

data/lib/seafoam/graal/source.rb

@@ -2,21 +2,17 @@ module Seafoam
   module Graal
     # Routines for understanding source positions in Graal.
     module Source
-      def self.render(source_position)
-        lines = []
+      def self.walk(source_position, &block)
+        results = []
+
         caller = source_position
         while caller
           method = caller[:method]
-          lines.push render_method(method)
+          results.push block.call(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}"
+        results
       end
     end
   end

data/lib/seafoam/graph.rb

@@ -2,13 +2,14 @@ module Seafoam
   # A graph, with properties, nodes, and edges. We don't encapsulate the graph
   # too much - be careful.
   class Graph
-    attr_reader :props, :nodes, :edges, :blocks
+    attr_reader :props, :nodes, :edges, :blocks, :new_id
 
     def initialize(props = nil)
       @props = props || {}
       @nodes = {}
       @edges = []
       @blocks = []
+      @new_id = 0
     end
 
     # Create a node.
@@ -16,6 +17,7 @@ module Seafoam
       props ||= {}
       node = Node.new(id, props)
       @nodes[id] = node
+      @new_id = id + 1
       node
     end
 
@@ -36,6 +38,12 @@ module Seafoam
       @blocks.push block
       block
     end
+
+    def remove_edge(edge)
+      edge.from.outputs.delete edge
+      edge.to.inputs.delete edge
+      edges.delete edge
+    end
   end
 
   # A node, with properties, input edges, and output edges.

data/lib/seafoam/graphviz_writer.rb

@@ -100,6 +100,9 @@ module Seafoam
         # from a shaded node.
         next if edge.to.props[:hidden] && edge.from.props[:spotlight] != 'shaded'
 
+        # Skip the edge if it's hidden itself
+        next if edge.props[:hidden]
+
         write_edge inline_attrs, edge
       end
     end

data/lib/seafoam/json_writer.rb

@@ -36,9 +36,7 @@ module Seafoam
       @out.puts JSON.pretty_generate(prepare_json(object))
     end
 
-    private
-
-    def prepare_json(object)
+    def self.prepare_json(object)
       case object
       when Float
         if object.nan?

data/lib/seafoam/{annotators → passes}/fallback.rb

@@ -1,15 +1,15 @@
 module Seafoam
-  module Annotators
-    # The fallback annotator always applies, and adds some basic annotations.
+  module Passes
+    # The fallback pass always applies, and adds some basic properties.
     # Works for example with Truffle AST and call graphs, but also means anyone
     # can emit a graph with 'label' properties and we can do something useful
     # with it.
-    class FallbackAnnotator < Annotator
+    class FallbackPass < Pass
       def self.applies?(_graph)
         true
       end
 
-      def annotate(graph)
+      def apply(graph)
         graph.nodes.each_value do |node|
           if node.props[:label].nil? && node.props['label']
             node.props[:label] = node.props['label']

data/lib/seafoam/{annotators → passes}/graal.rb

@@ -1,18 +1,19 @@
 module Seafoam
-  module Annotators
-    # The Graal annotator applies if it looks like it was compiled by Graal or
+  module Passes
+    # The Graal pass applies if it looks like it was compiled by Graal or
     # Truffle.
-    class GraalAnnotator < Annotator
+    class GraalPass < Pass
       def self.applies?(graph)
         graph.props.values.any? do |v|
           TRIGGERS.any? { |t| v.to_s.include?(t) }
         end
       end
 
-      def annotate(graph)
-        annotate_nodes graph
-        annotate_edges graph
+      def apply(graph)
+        apply_nodes graph
+        apply_edges graph
         hide_frame_state graph if @options[:hide_frame_state]
+        hide_pi graph if @options[:hide_pi]
         hide_floating graph if @options[:hide_floating]
         reduce_edges graph if @options[:reduce_edges]
         hide_unused_nodes graph
@@ -21,8 +22,10 @@ module Seafoam
       private
 
       # Annotate nodes with their label and kind
-      def annotate_nodes(graph)
+      def apply_nodes(graph)
         graph.nodes.each_value do |node|
+          next if node.props[:label]
+
           # The Java class of the node.
           node_class = node.props.dig(:node_class, :node_class)
 
@@ -93,6 +96,11 @@ module Seafoam
             name_template = 'π'
           end
 
+          # Use a symbol for PiArrayNode.
+          if node_class == 'org.graalvm.compiler.nodes.PiArrayNode'
+            name_template = '[π]'
+          end
+
           # Use a symbol for PhiNode.
           if node_class == 'org.graalvm.compiler.nodes.ValuePhiNode'
             name_template = 'ϕ'
@@ -208,7 +216,7 @@ module Seafoam
       end
 
       # Annotate edges with their label and kind.
-      def annotate_edges(graph)
+      def apply_edges(graph)
         graph.edges.each do |edge|
           if edge.to.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.ValuePhiNode' && edge.props[:name] == 'values'
             merge_node = edge.to.edges.find { |e| e.props[:name] == 'merge' }.from
@@ -254,8 +262,6 @@ module Seafoam
           # loopBegin edges point from LoopEndNode (continue) and LoopExitNode
           # (break) to the LoopBeginNode. Both are drawn reversed.
           when 'loopBegin'
-            edge.props[:hidden] = true
-
             case edge.to.props.dig(:node_class, :node_class)
             when 'org.graalvm.compiler.nodes.LoopEndNode'
               # If it's from the LoopEnd then it's the control edge to follow.
@@ -311,6 +317,24 @@ module Seafoam
         end
       end
 
+      # Hide pi nodes - they add information for optimisation, but not generally
+      # useful day-to-day for understanding the graph. Connect the user to the
+      # actual object, which may be several steps away.
+      def hide_pi(graph)
+        loop do
+          umodified = true
+          graph.edges.each do |edge|
+            next unless Graal::Pi::PI_NODES.include?(edge.from.props.dig(:node_class, :node_class))
+
+            object = Graal::Pi.follow_pi_object(edge.from)
+            graph.create_edge object, edge.to, edge.props.merge({ synthetic: true })
+            graph.remove_edge edge
+            umodified = false
+          end
+          break if umodified
+        end
+      end
+
       # Hide floating nodes. This highlights just the control flow backbone.
       def hide_floating(graph)
         graph.nodes.each_value do |node|
@@ -332,15 +356,19 @@ module Seafoam
         end
       end
 
-      # Hide nodes that have no non-hidden users and no control flow in. These
-      # would display as a node floating unconnected to the rest of the graph
-      # otherwise. An exception is made for node with an anchor edge coming in,
-      # as some guards are anchored like this.
+      # Hide nodes that have no non-hidden users or edges and no control flow
+      # in. These would display as a node floating unconnected to the rest of
+      # the graph otherwise. An exception is made for node with an anchor edge
+      # coming in, as some guards are anchored like this.
       def hide_unused_nodes(graph)
         loop do
           modified = false
           graph.nodes.each_value do |node|
-            next unless node.outputs.all? { |edge| edge.to.props[:hidden] } &&
+            # Call trees are like Graal graphs but don't have these edges -
+            # don't hide them.
+            next if node.props['truffleCallees']
+
+            next unless node.outputs.all? { |edge| edge.to.props[:hidden] || edge.props[:hidden] } &&
                         node.inputs.none? { |edge| edge.props[:kind] == 'control' } &&
                         node.inputs.none? { |edge| edge.props[:name] == 'anchor' }
 

data/lib/seafoam/passes/truffle.rb

@@ -0,0 +1,58 @@
+module Seafoam
+  module Passes
+    # The Truffle pass applies if it looks like it was compiled by Truffle.
+    class TrufflePass < Pass
+      def self.applies?(graph)
+        graph.props.values.any? do |v|
+          TRIGGERS.any? { |t| v.to_s.include?(t) }
+        end
+      end
+
+      def apply(graph)
+        simplify_truffle_args graph if @options[:simplify_truffle_args]
+      end
+
+      private
+
+      # Simplify a Truffle argument load into a single, inlined, node very much
+      # like a Graal parameter node.
+      def simplify_truffle_args(graph)
+        graph.nodes.dup.each_value do |node|
+          next unless node.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.java.LoadIndexedNode'
+
+          index_node = node.inputs.find { |edge| edge.props[:name] == 'index' }.from
+          array_node = Graal::Pi.follow_pi_object(node.inputs.find { |edge| edge.props[:name] == 'array' }.from)
+
+          next unless index_node.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.ConstantNode'
+          next unless array_node.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.ParameterNode'
+
+          node.props[:truffle_arg_load] = true
+
+          index = index_node.props['rawvalue']
+
+          arg_node = graph.create_node(graph.new_id, { synthetic: true, inlined: true, label: "T(#{index})", kind: 'input' })
+
+          node.outputs.each do |output|
+            next if output.props[:name] == 'next'
+
+            graph.create_edge arg_node, output.to, output.props.dup
+            graph.remove_edge output
+          end
+        end
+
+        graph.nodes.each_value.select { |node| node.props[:truffle_arg_load] }.each do |node|
+          control_in = node.inputs.find { |edge| edge.props[:name] == 'next' }
+          control_out = node.outputs.find { |edge| edge.props[:name] == 'next' }
+          graph.create_edge control_in.from, control_out.to, { name: 'next' }
+          graph.remove_edge control_in
+          graph.remove_edge control_out
+        end
+      end
+
+      # If we see these in the graph properties it's probably a Truffle graph.
+      TRIGGERS = %w[
+        TruffleCompiler
+      ]
+    end
+  end
+end

data/lib/seafoam/passes.rb

@@ -0,0 +1,61 @@
+module Seafoam
+  # Passes are routines to read the graph and apply properties which tools,
+  # such as the render command, can use to show more understandable output.
+  module Passes
+    # Apply all applicable passes to a graph.
+    def self.apply(graph, options = {})
+      passes.each do |pass|
+        next unless pass.applies?(graph)
+
+        # Record for information that the pass was applied this graph.
+        passes_applied = graph.props[:passes_applied] ||= []
+        passes_applied.push pass
+
+        # Run the pass.
+        instance = pass.new(options)
+        instance.apply graph
+      end
+    end
+
+    # Get a list of all passes in the system.
+    def self.passes
+      # We have a defined order for passes to run - these passes at the start.
+      pre_passes = [
+        TrufflePass,
+        GraalPass
+      ]
+
+      # The fallback pass runs last.
+      post_passes = [
+        FallbackPass
+      ]
+
+      # Any extra passes in the middle.
+      extra_passes = Pass::SUBCLASSES.dup - pre_passes - post_passes
+
+      pre_passes + extra_passes + post_passes
+    end
+  end
+
+  # The base class for all passes. You must subclass this to be recognized
+  # as an pass.
+  class Pass
+    SUBCLASSES = []
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def applies?(_graph)
+      raise NotImplementedError
+    end
+
+    def apply(_graph)
+      raise NotImplementedError
+    end
+
+    def self.inherited(pass)
+      SUBCLASSES.push pass
+    end
+  end
+end

data/lib/seafoam/version.rb

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

data/lib/seafoam.rb

@@ -1,17 +1,18 @@
 require 'seafoam/version'
 require 'seafoam/binary/io_binary_reader'
 require 'seafoam/bgv/bgv_parser'
-require 'seafoam/cfg/cfg_parser'
-require 'seafoam/cfg/disassembler'
 require 'seafoam/colors'
 require 'seafoam/graph'
+require 'seafoam/graal/graph_description'
 require 'seafoam/graal/source'
-require 'seafoam/annotators'
-require 'seafoam/annotators/graal'
-require 'seafoam/annotators/fallback'
+require 'seafoam/graal/pi'
+require 'seafoam/passes'
+require 'seafoam/passes/truffle'
+require 'seafoam/passes/graal'
+require 'seafoam/passes/fallback'
 require 'seafoam/spotlight'
 require 'seafoam/isabelle_writer'
 require 'seafoam/json_writer'
 require 'seafoam/graphviz_writer'
-require 'seafoam/config'
 require 'seafoam/commands'
+require 'seafoam/formatters/formatters'

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: seafoam
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.12'
 platform: ruby
 authors:
 - Chris Seaton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: crabstone
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,83 +58,34 @@ executables:
 - seafoam
 - bgv2json
 - bgv2isabelle
-- cfg2asm
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/probots.yml"
-- ".github/workflows/workflows.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".seafoam/config"
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.md
-- README.md
 - bin/bgv2isabelle
 - bin/bgv2json
-- bin/cfg2asm
 - bin/seafoam
-- demos/box-unbox-stats
-- docs/annotators.md
-- docs/bgv.md
-- docs/getting-graphs.md
-- docs/images/igv.png
-- docs/images/seafoam.png
-- docs/images/spotlight-igv.png
-- docs/images/spotlight-seafoam.png
-- docs/json.md
-- examples/Fib.java
-- examples/MatMult.java
-- examples/fib-java.bgv.gz
-- examples/fib.js
-- examples/fib.rb
-- examples/identity.rb
-- examples/java/Irreducible.class
-- examples/java/Irreducible.j
-- examples/java/IrreducibleDecompiled.java
-- examples/java/JavaExamples.java
-- examples/matmult.rb
-- 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/formatters/base.rb
+- lib/seafoam/formatters/formatters.rb
+- lib/seafoam/formatters/json.rb
+- lib/seafoam/formatters/text.rb
+- lib/seafoam/graal/graph_description.rb
+- lib/seafoam/graal/pi.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/passes.rb
+- lib/seafoam/passes/fallback.rb
+- lib/seafoam/passes/graal.rb
+- lib/seafoam/passes/truffle.rb
 - lib/seafoam/spotlight.rb
 - lib/seafoam/version.rb
-- seafoam.gemspec
-- spec/seafoam/annotators/fallback_spec.rb
-- spec/seafoam/annotators/graal_spec.rb
-- spec/seafoam/annotators_spec.rb
-- spec/seafoam/bgv/bgv_parser_spec.rb
-- 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
 homepage: https://github.com/Shopify/seafoam
 licenses:
 - MIT
@@ -161,15 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.8
+      version: 2.5.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A tool for working with compiler graphs

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla