seafoam 0.8 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5cdd6b29d9c25bc7db525b2f49d6937fb996bc108a7bf18ddf0364575e6999
-  data.tar.gz: 510608b5d784ef4c58768aafb42372bdd33aad226a6123e9ad72ea77845a8050
+  metadata.gz: 5365ea61783b2be678609c214262d4df073fa4e66df60e9370b6fd33dd73825a
+  data.tar.gz: 322fe5170082c57d51120c3fa43910ca2e79a7839737167955ad1f330084af83
 SHA512:
-  metadata.gz: 125d9c14699c1a9a72bc1311b2673cf24d725af3c4da38eac1c2c89ebce4d6157c3e08ad7cc7b8769f8c755227cd04da4b9a6f53ae30f0f3ce38e7a1cf12d4b2
-  data.tar.gz: 2430c0b5f04378767c5bbbb51274900deae22291fd905831f4a5d5847edd5e7497e3df94a434ab803689ee4f9b3f6cd5d6740bdc28dbf96d7da329c8610ac6e5
+  metadata.gz: 33cdf9e0f73e9a41d11ee2c19f60b015f8fe5168ddd92eaee1a254c13c6296e8696514858e0fc0c77c583657c3d01b2292919077f9131768198801bd9610dbc9
+  data.tar.gz: 2354dd4f1c5d87c83d265577a0e64b5130cd9dc7de46e6222629b985bdac038b6977f3fe10ffc2624e45b2cc56dbd67ea243734a528a17eab780a80c00996621

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/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/bgv/bgv_parser.rb

@@ -162,8 +162,7 @@ module Seafoam
           count += 1
           arg
         end
-        components = groups_names + [name]
-        components.join('/')
+        groups_names + [name]
       end
 
       private

data/lib/seafoam/commands.rb

@@ -1,39 +1,29 @@
 require 'json'
+require 'set'
 
 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.
     def seafoam(*args)
       first, *args = args
+
+      if first == '--json'
+        formatter_module = Seafoam::Formatters::Json
+        first, *args = args
+      else
+        formatter_module = Seafoam::Formatters::Text
+      end
+
       case first
       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
@@ -43,21 +33,23 @@ module Seafoam
         when nil
           help(*args)
         when 'info'
-          info name, *args
+          info name, formatter_module, *args
         when 'list'
-          list name, *args
+          list name, formatter_module, *args
         when 'search'
           search name, *args
         when 'edges'
-          edges name, *args
+          edges name, formatter_module, *args
         when 'props'
           props name, *args
         when 'source'
-          source name, *args
+          source name, formatter_module, *args
         when 'render'
           render name, *args
         when 'debug'
           debug name, *args
+        when 'describe'
+          describe name, formatter_module, *args
         else
           raise ArgumentError, "unknown command #{command}"
         end
@@ -155,82 +147,42 @@ module Seafoam
       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
-    def info(name, *args)
+    def info(name, formatter_module, *args)
       file, *rest = parse_name(name)
       raise ArgumentError, 'info only works with a file' unless rest == [nil, nil, nil]
-
       raise ArgumentError, 'info does not take arguments' unless args.empty?
 
       parser = BGV::BGVParser.new(file)
       major, minor = parser.read_file_header(version_check: false)
-      @out.puts "BGV #{major}.#{minor}"
+      formatter = formatter_module::InfoFormatter.new(major, minor)
+
+      @out.puts formatter.format
     end
 
     # seafoam file.bgv list
-    def list(name, *args)
+    def list(name, formatter_module, *args)
       file, *rest = parse_name(name)
       raise ArgumentError, 'list only works with a file' unless rest == [nil, nil, nil]
-
       raise ArgumentError, 'list does not take arguments' unless args.empty?
 
       parser = BGV::BGVParser.new(file)
       parser.read_file_header
       parser.skip_document_props
+      entries = []
       loop do
         index, = parser.read_graph_preheader
         break unless index
 
         graph_header = parser.read_graph_header
-        @out.puts "#{file}:#{index}  #{parser.graph_name(graph_header)}"
+        entries << formatter_module::ListFormatter::Entry.new(file, parser.graph_name(graph_header), index)
         parser.skip_graph
       end
+
+      formatter = formatter_module::ListFormatter.new(entries)
+      @out.puts formatter.format
     end
 
     # seafoam file.bgv:n... search term...
@@ -263,7 +215,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|
@@ -289,17 +241,18 @@ module Seafoam
     end
 
     # seafoam file.bgv:n... edges
-    def edges(name, *args)
+    def edges(name, formatter_module, *args)
       file, graph_index, node_id, edge_id = parse_name(name)
       raise ArgumentError, 'edges needs at least a graph' unless graph_index
-
       raise ArgumentError, 'edges does not take arguments' unless args.empty?
 
+      entry = nil
+
       with_graph(file, graph_index) do |parser|
         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
 
@@ -310,24 +263,18 @@ module Seafoam
             edges = node.outputs.select { |edge| edge.to == to }
             raise ArgumentError, 'edge not found' if edges.empty?
 
-            edges.each do |edge|
-              @out.puts "#{edge.from.id_and_label} ->(#{edge.props[:label]}) #{edge.to.id_and_label}"
-            end
+            entry = formatter_module::EdgesFormatter::EdgesEntry.new(edges)
           else
-            @out.puts 'Input:'
-            node.inputs.each do |input|
-              @out.puts "  #{node.id_and_label} <-(#{input.props[:label]}) #{input.from.id_and_label}"
-            end
-            @out.puts 'Output:'
-            node.outputs.each do |output|
-              @out.puts "  #{node.id_and_label} ->(#{output.props[:label]}) #{output.to.id_and_label}"
-            end
+            entry = formatter_module::EdgesFormatter::NodeEntry.new(node)
           end
           break
         else
-          @out.puts "#{graph.nodes.count} nodes, #{graph.edges.count} edges"
+          entry = formatter_module::EdgesFormatter::SummaryEntry.new(graph.nodes.count, graph.edges.count)
         end
       end
+
+      formatter = formatter_module::EdgesFormatter.new(entry)
+      @out.puts formatter.format
     end
 
     # seafoam file.bgv... props
@@ -376,7 +323,7 @@ module Seafoam
     end
 
     # seafoam file.bgv:n:n source
-    def source(name, *args)
+    def source(name, formatter_module, *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
@@ -388,7 +335,57 @@ module Seafoam
         node = graph.nodes[node_id]
         raise ArgumentError, 'node not found' unless node
 
-        @out.puts Graal::Source.render(node.props['nodeSourcePosition'])
+        formatter = formatter_module::SourceFormatter.new(node.props['nodeSourcePosition'])
+        @out.puts formatter.format
+      end
+    end
+
+    # seafoam file.bgv:n describe
+    def describe(name, formatter_module, *args)
+      file, graph_index, *rest = parse_name(name)
+
+      if graph_index.nil? || !rest.all?(&:nil?)
+        raise ArgumentError, 'describe only works with a graph'
+      end
+      raise ArgumentError, 'describe does not take arguments' unless args.empty?
+
+      parser = BGV::BGVParser.new(file)
+      parser.read_file_header
+      parser.skip_document_props
+
+      loop do
+        index, = parser.read_graph_preheader
+        break unless index
+
+        parser.skip_graph_header
+
+        if index != graph_index
+          parser.skip_graph
+          next
+        end
+
+        graph = parser.read_graph
+        description = Seafoam::Graal::GraphDescription.new
+
+        graph.nodes.each_value do |node|
+          node_class = node.props.dig(:node_class, :node_class)
+          case node_class
+          when 'org.graalvm.compiler.nodes.IfNode'
+            description.branches = true
+          when 'org.graalvm.compiler.nodes.LoopBeginNode'
+            description.loops = true
+          when 'org.graalvm.compiler.nodes.InvokeNode', 'org.graalvm.compiler.nodes.InvokeWithExceptionNode'
+            description.calls = true
+          end
+        end
+
+        description.deopts = graph.nodes[0].outputs.map(&:to)
+                                  .all? { |t| t.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.DeoptimizeNode' }
+
+        formatter = formatter_module::DescribeFormatter.new(graph, description)
+        @out.puts formatter.format
+
+        break
       end
     end
 
@@ -398,8 +395,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 +419,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 +439,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 +462,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 +572,32 @@ 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 describe'
+      @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 +631,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/formatters/base.rb

@@ -0,0 +1,88 @@
+module Seafoam
+  module Formatters
+    module Base
+      # Formats the output of the `describe` command.
+      class DescribeFormatter
+        attr_reader :graph, :description
+
+        def initialize(graph, description)
+          @graph = graph
+          @description = description
+        end
+      end
+
+      # Formats the output of the `edges` command.
+      class EdgesFormatter
+        EdgesEntry = Struct.new(:edges) do
+          def render(formatter)
+            formatter.render_edges_entry(edges)
+          end
+        end
+
+        NodeEntry = Struct.new(:node) do
+          def render(formatter)
+            formatter.render_node_entry(node)
+          end
+        end
+
+        SummaryEntry = Struct.new(:node_count, :edge_count) do
+          def render(formatter)
+            formatter.render_summary_entry(node_count, edge_count)
+          end
+        end
+
+        attr_reader :entry
+
+        def initialize(entry)
+          @entry = entry
+        end
+
+        def format
+          entry.render(self)
+        end
+
+        def render_edges_entry(edges)
+          raise NotImplementedError
+        end
+
+        def render_node_entry(node)
+          raise NotImplementedError
+        end
+
+        def render_summary_entry(node_count, edge_count)
+          raise NotImplementedError
+        end
+      end
+
+      # Formats the output of the `info` command.
+      class InfoFormatter
+        attr_reader :major_version, :minor_version
+
+        def initialize(major_version, minor_version)
+          @major_version = major_version
+          @minor_version = minor_version
+        end
+      end
+
+      # Formats the output of the `list` command.
+      class ListFormatter
+        Entry = Struct.new(:file, :graph_name_components, :index)
+
+        attr_reader :entries
+
+        def initialize(entries)
+          @entries = entries
+        end
+      end
+
+      # Formats the output of the `source` command.
+      class SourceFormatter
+        attr_reader :source_position
+
+        def initialize(source_position)
+          @source_position = source_position
+        end
+      end
+    end
+  end
+end

data/lib/seafoam/formatters/formatters.rb

@@ -0,0 +1,8 @@
+module Seafoam
+  # Formatters are the mechanism by which `seafoam` command output is presented to the user.
+  module Formatters
+    autoload :Base, 'seafoam/formatters/base'
+    autoload :Json, 'seafoam/formatters/json'
+    autoload :Text, 'seafoam/formatters/text'
+  end
+end

data/lib/seafoam/formatters/json.rb

@@ -0,0 +1,82 @@
+require 'json'
+
+module Seafoam
+  module Formatters
+    module Json
+      # A JSON-based formatter for the `describe` command.
+      class DescribeFormatter < Seafoam::Formatters::Base::DescribeFormatter
+        def format
+          ret = Seafoam::Graal::GraphDescription::ATTRIBUTES.map { |attr| [attr, description.send(attr)] }.to_h
+          ret[:node_count] = graph.nodes.size
+
+          ret.to_json
+        end
+      end
+
+      # A JSON-based formatter for the `edges` command.
+      class EdgesFormatter < Seafoam::Formatters::Base::EdgesFormatter
+        def render_edges_entry(edges)
+          edges.map { |edge| build_edge(edge) }.to_json
+        end
+
+        def render_node_entry(node)
+          {
+            input: node.inputs.map { |input| build_edge(input) },
+            output: node.outputs.map { |output| build_edge(output) }
+          }.to_json
+        end
+
+        def render_summary_entry(node_count, edge_count)
+          { node_count: node_count, edge_count: edge_count }.to_json
+        end
+
+        def build_node(node)
+          { id: node.id.to_s, label: node.props[:label] }
+        end
+
+        def build_edge(edge)
+          { from: build_node(edge.from), to: build_node(edge.to), label: edge.props[:label] }
+        end
+      end
+
+      # A JSON-based formatter for the `info` command.
+      class InfoFormatter < Seafoam::Formatters::Base::InfoFormatter
+        def format
+          {
+            major_version: major_version,
+            minor_version: minor_version
+          }.to_json
+        end
+      end
+
+      # A JSON-based formatter for the `list` command.
+      class ListFormatter < Seafoam::Formatters::Base::ListFormatter
+        def format
+          entries.map do |entry|
+            {
+              graph_index: entry.index,
+              graph_file: entry.file,
+              graph_name_components: entry.graph_name_components
+            }
+          end.to_json
+        end
+      end
+
+      # A JSON-based formatter for the `source` command.
+      class SourceFormatter < Seafoam::Formatters::Base::SourceFormatter
+        def format
+          Seafoam::Graal::Source.walk(source_position, &method(:render_method)).to_json
+        end
+
+        def render_method(method)
+          declaring_class = method[:declaring_class]
+          name = method[:method_name]
+          {
+            class: declaring_class,
+            method: name
+          }
+        end
+      end
+    end
+  end
+end