seafoam 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5cdd6b29d9c25bc7db525b2f49d6937fb996bc108a7bf18ddf0364575e6999
-  data.tar.gz: 510608b5d784ef4c58768aafb42372bdd33aad226a6123e9ad72ea77845a8050
+  metadata.gz: 49d090779b04322f8c82aae0cf11ea2e39cd4cef1f3d9dc2b51de1f27e565f9c
+  data.tar.gz: 121f1c7bb327c30f1a388960012c43dab49e0f1079d5a420811ab2332de9663b
 SHA512:
-  metadata.gz: 125d9c14699c1a9a72bc1311b2673cf24d725af3c4da38eac1c2c89ebce4d6157c3e08ad7cc7b8769f8c755227cd04da4b9a6f53ae30f0f3ce38e7a1cf12d4b2
-  data.tar.gz: 2430c0b5f04378767c5bbbb51274900deae22291fd905831f4a5d5847edd5e7497e3df94a434ab803689ee4f9b3f6cd5d6740bdc28dbf96d7da329c8610ac6e5
+  metadata.gz: dd13ee2efe4fe4118fc5f6bdb56c55b3c1c5f28b86a3d37ce3cf4fc72bcdcbeb161968260b62626047b9f9f9eedec53cbc743d79512a11bd77b195f054c54262
+  data.tar.gz: 67e06a4e89fdf9e6297e3d68da7f7b0e7d4f1de95a97c9be17c12e6c9114476ee6e747c6306c3bc472e549317f20c19c315c9789d1814c68fdd85501327c432b

data/bin/bgv2isabelle

@@ -5,12 +5,8 @@ require 'seafoam'
 # This is the 'bgv2isabelle' command line entry point.
 
 begin
-  # Load configuraiton.
-  config = Seafoam::Config.new
-  config.load_config
-
   # Run the command line.
-  commands = Seafoam::Commands.new($stdout, config)
+  commands = Seafoam::Commands.new($stdout)
   commands.bgv2isabelle(*ARGV)
 rescue StandardError => e
   if $DEBUG

data/bin/bgv2json

@@ -5,12 +5,8 @@ require 'seafoam'
 # This is the 'bgv2json' command line entry point.
 
 begin
-  # Load configuraiton.
-  config = Seafoam::Config.new
-  config.load_config
-
   # Run the command line.
-  commands = Seafoam::Commands.new($stdout, config)
+  commands = Seafoam::Commands.new($stdout)
   commands.bgv2json(*ARGV)
 rescue StandardError => e
   if $DEBUG

data/bin/cfg2asm

@@ -5,12 +5,8 @@ require 'seafoam'
 # This is the 'cfg2asm' command line entry point.
 
 begin
-  # Load configuraiton.
-  config = Seafoam::Config.new
-  config.load_config
-
   # Run the command line.
-  commands = Seafoam::Commands.new($stdout, config)
+  commands = Seafoam::Commands.new($stdout)
   commands.cfg2asm(*ARGV)
 rescue StandardError => e
   if $DEBUG

data/bin/seafoam

@@ -5,12 +5,8 @@ require 'seafoam'
 # This is the 'seafoam' command line entry point.
 
 begin
-  # Load configuraiton.
-  config = Seafoam::Config.new
-  config.load_config
-
   # Run the command line.
-  commands = Seafoam::Commands.new($stdout, config)
+  commands = Seafoam::Commands.new($stdout)
   commands.seafoam(*ARGV)
 rescue StandardError => e
   if $DEBUG

data/lib/seafoam/commands.rb

@@ -3,9 +3,8 @@ require 'json'
 module Seafoam
   # Implementations of the command-line commands that you can run in Seafoam.
   class Commands
-    def initialize(out, config)
+    def initialize(out)
       @out = out
-      @config = config
     end
 
     # Run the general seafoam command.
@@ -15,25 +14,7 @@ module Seafoam
       when nil, 'help', '-h', '--help', '-help'
         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 '               --draw-blocks'
-        @out.puts '               --option key value'
-        @out.puts '        --help'
-        @out.puts '        --version'
+        help(*args)
       when 'version', '-v', '-version', '--version'
         version(*args)
       else
@@ -263,7 +244,7 @@ module Seafoam
     end
 
     def search_object(tag, object, terms)
-      full_text = JSON.generate(object)
+      full_text = JSON.generate(JSONWriter.prepare_json(object))
       full_text_down = full_text.downcase
       start = 0
       terms.each do |t|
@@ -299,7 +280,7 @@ module Seafoam
         parser.read_graph_header
         graph = parser.read_graph
         if node_id
-          Annotators.apply graph
+          Passes.apply graph
           node = graph.nodes[node_id]
           raise ArgumentError, 'node not found' unless node
 
@@ -398,8 +379,10 @@ module Seafoam
       raise ArgumentError, 'render needs at least a graph' unless graph_index
       raise ArgumentError, 'render only works with a graph' unless rest == [nil, nil]
 
-      annotator_options = {
+      pass_options = {
+        simplify_truffle_args: true,
         hide_frame_state: true,
+        hide_pi: true,
         hide_floating: false,
         reduce_edges: true
       }
@@ -420,12 +403,16 @@ module Seafoam
           raise ArgumentError, 'no list for --spotlight' unless spotlight_arg
 
           spotlight_nodes = spotlight_arg.split(',').map { |n| Integer(n) }
+        when '--full-truffle-args'
+          pass_options[:simplify_truffle_args] = false
         when '--show-frame-state'
-          annotator_options[:hide_frame_state] = false
+          pass_options[:hide_frame_state] = false
+        when '--show-pi'
+          pass_options[:hide_pi] = false
         when '--hide-floating'
-          annotator_options[:hide_floating] = true
+          pass_options[:hide_floating] = true
         when '--no-reduce-edges'
-          annotator_options[:reduce_edges] = false
+          pass_options[:reduce_edges] = false
         when '--draw-blocks'
           draw_blocks = true
         when '--option'
@@ -436,7 +423,7 @@ module Seafoam
           raise ArgumentError, "no value for --option #{key}" unless out_file
 
           value = { 'true' => true, 'false' => 'false' }.fetch(key, value)
-          annotator_options[key.to_sym] = value
+          pass_options[key.to_sym] = value
         else
           raise ArgumentError, "unexpected option #{arg}"
         end
@@ -459,7 +446,7 @@ module Seafoam
       with_graph(file, graph_index) do |parser|
         parser.skip_graph_header
         graph = parser.read_graph
-        Annotators.apply graph, annotator_options
+        Passes.apply graph, pass_options
         if spotlight_nodes
           spotlight = Spotlight.new(graph)
           spotlight_nodes.each do |node_id|
@@ -569,6 +556,31 @@ module Seafoam
       raise ArgumentError, 'graph not found' unless graph_found
     end
 
+    # Prints help.
+    def help(*_args)
+      @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 '               --full-truffle-args'
+      @out.puts '               --show-frame-state'
+      @out.puts '               --show-pi'
+      @out.puts '               --hide-floating'
+      @out.puts '               --no-reduce-edges'
+      @out.puts '               --draw-blocks'
+      @out.puts '               --option key value'
+      @out.puts '        --help'
+      @out.puts '        --version'
+    end
+
     # Prints the version.
     def version(*args)
       raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
@@ -602,10 +614,15 @@ module Seafoam
 
     # Open a file for the user if possible.
     def autoopen(file)
-      if RUBY_PLATFORM.include?('darwin') && @out.tty?
+      return unless @out.tty?
+
+      case RUBY_PLATFORM
+      when /darwin/
         system 'open', file
-        # Don't worry if it fails.
+      when /linux/
+        system 'xdg-open', file
       end
+      # Don't worry if it fails.
     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/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
@@ -311,6 +319,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 +358,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 = 9
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}"
 end

data/lib/seafoam.rb

@@ -6,12 +6,13 @@ require 'seafoam/cfg/disassembler'
 require 'seafoam/colors'
 require 'seafoam/graph'
 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'