seafoam 0.10 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8665fe768d4900820ca676269cd25028306e8253c2109c71ff4cb31dd7c6e44
-  data.tar.gz: fd8c52e5cf3daafa9b2673265067b743cc644755c3772c02904c2b815b3a93d2
+  metadata.gz: bc92671f5ea437e5afccf98c5874434251e6df05fde08e325e0b8b4a60d5d2b0
+  data.tar.gz: 77a8f71d631be2c02674784598a97d7da4b83c4556f2fc21c5d66496678b3792
 SHA512:
-  metadata.gz: 815e7031027718cea7a933b7fc5ad822f754f05e3ae5bdc2066775183a9ca98c841b54e682a148c4437a29b1f95c4ede5833a2a1f2995d2c55296a800e71b269
-  data.tar.gz: 462aaad5134c8b6cce229e8456742151354333c5e7c02283e2e90917fa7ad238f3f4f71770519357117f42b1579928ddb0bba3f04b31ddef68d7e41e92f8c016
+  metadata.gz: 2c9d7b5ccea117d2b1b686d66fffbeebe4282dde52f5c9880125f57911f4da4ed2e7660f1957597931e5bf714258b0c1a08e6c9fc0bfbc822915b2ae22c08964
+  data.tar.gz: 2c991ed3d87e80ccdb92630dfc3d2283b01ed2125c70883eec7b5e0cd6031d55acbb8930feb7cf6ef6e029b0e58ff2b01b2d2c81c0a2a0bca266070a2c28ba2c

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

@@ -11,6 +11,14 @@ module Seafoam
     # 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?
@@ -25,23 +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, *args
+          describe name, formatter_module, *args
         else
           raise ArgumentError, "unknown command #{command}"
         end
@@ -186,35 +194,39 @@ module Seafoam
     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...
@@ -273,12 +285,13 @@ 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
@@ -294,24 +307,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
@@ -360,7 +367,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
@@ -372,12 +379,13 @@ 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, *args)
+    def describe(name, formatter_module, *args)
       file, graph_index, *rest = parse_name(name)
 
       if graph_index.nil? || !rest.all?(&:nil?)
@@ -401,26 +409,25 @@ module Seafoam
         end
 
         graph = parser.read_graph
-        notes = Set.new
+        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'
-            notes.add 'branches'
+            description.branches = true
           when 'org.graalvm.compiler.nodes.LoopBeginNode'
-            notes.add 'loops'
+            description.loops = true
           when 'org.graalvm.compiler.nodes.InvokeNode', 'org.graalvm.compiler.nodes.InvokeWithExceptionNode'
-            notes.add 'calls'
+            description.calls = true
           end
         end
 
-        notes.add 'deopts' if graph.nodes[0].outputs.map(&:to)
-                                   .all? { |t| t.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.DeoptimizeNode' }
-
-        notes.add 'linear' unless notes.include?('branches') || notes.include?('loops')
+        description.deopts = graph.nodes[0].outputs.map(&:to)
+                                  .all? { |t| t.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.DeoptimizeNode' }
 
-        @out.puts ["#{graph.nodes.size} nodes", *notes].join(', ')
+        formatter = formatter_module::DescribeFormatter.new(graph, description)
+        @out.puts formatter.format
 
         break
       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

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/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/version.rb

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

data/lib/seafoam.rb

@@ -5,6 +5,7 @@ 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/graal/pi'
 require 'seafoam/passes'
@@ -16,3 +17,4 @@ require 'seafoam/isabelle_writer'
 require 'seafoam/json_writer'
 require 'seafoam/graphviz_writer'
 require 'seafoam/commands'
+require 'seafoam/formatters/formatters'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seafoam
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.11'
 platform: ruby
 authors:
 - Chris Seaton
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crabstone
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.74'
-description:
-email:
+description: 
+email: 
 executables:
 - seafoam
 - bgv2json
@@ -101,6 +101,11 @@ files:
 - lib/seafoam/cfg/disassembler.rb
 - lib/seafoam/colors.rb
 - lib/seafoam/commands.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
@@ -117,7 +122,7 @@ homepage: https://github.com/Shopify/seafoam
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6.3
+signing_key: 
 specification_version: 4
 summary: A tool for working with compiler graphs
 test_files: []