seafoam 0.7 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17a259b362af5eef7c3c874e6d796f647c6017d413cba708ac0a27e18043681
-  data.tar.gz: 39eba465ba4ed92b3085a276d541072ccff48d62fdd00a317961c7401bcb0ee0
+  metadata.gz: 6f5cdd6b29d9c25bc7db525b2f49d6937fb996bc108a7bf18ddf0364575e6999
+  data.tar.gz: 510608b5d784ef4c58768aafb42372bdd33aad226a6123e9ad72ea77845a8050
 SHA512:
-  metadata.gz: e55cdfa1eea817f24bbaa22ef80916923441393529351df21c258987354cafe98d07ed4bff2fd3e6fc5ab5656ea7f85b938d7a906ee511cd9f06fa19c335431f
-  data.tar.gz: '070468e7e9c1fd55b6429c07d8c226e1c0c0e4225a0f9a90bd577e7b57bb8320bcd0a59e1da223632986245f6eb5482a1320b11e6b786f41f456187766664b9b'
+  metadata.gz: 125d9c14699c1a9a72bc1311b2673cf24d725af3c4da38eac1c2c89ebce4d6157c3e08ad7cc7b8769f8c755227cd04da4b9a6f53ae30f0f3ce38e7a1cf12d4b2
+  data.tar.gz: 2430c0b5f04378767c5bbbb51274900deae22291fd905831f4a5d5847edd5e7497e3df94a434ab803689ee4f9b3f6cd5d6740bdc28dbf96d7da329c8610ac6e5

data/.github/workflows/workflows.yml

@@ -6,13 +6,14 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
+    - run: gem install bundler:1.17.2
     - run: bundle install
     - run: bundle exec rubocop
   specs:
     strategy:
       matrix:
         os: [ubuntu, macos]
-        ruby: [2.5, 2.6, 2.7]
+        ruby: [2.5, 2.6, 2.7, 3.0]
     runs-on: ${{ matrix.os }}-latest
     steps:
     - uses: actions/checkout@v2
@@ -27,7 +28,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu, macos]
-        ruby: [2.5, 2.6, 2.7]
+        ruby: [2.5, 2.6, 2.7, 3.0]
     runs-on: ${{ matrix.os }}-latest
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -4,4 +4,3 @@
 *.svg
 *.class
 /.idea
-/Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.5.9

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    seafoam (0.7)
+      crabstone (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    benchmark-ips (2.8.4)
+    crabstone (4.0.3)
+      ffi
+    diff-lcs (1.4.4)
+    ffi (1.15.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips (~> 2.7)
+  rspec (~> 3.8)
+  rubocop (~> 0.74)
+  seafoam!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -26,7 +26,6 @@ Admittedly, Seafoam does not yet have:
 
 * an interactive user interface
 * diffing of graphs
-* visualization of basic blocks
 * breaking of edges for very congested graphs
 * the same speed in rendering big graphs - Seafoam is best suited for looking at graphs before lowering, which is what language developers are usually doing, or use spotlight
 
@@ -305,6 +304,7 @@ graph0 = # 2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhas
 * `--show-frame-state` shows frame state nodes, which are hidden by default
 * `--hide-floating` hides nodes that aren't fixed by control flow
 * `--no-reduce-edges` turns off the option to reduce the number of edges by inlining simple nodes above their users
+* `--draw-blocks` to draw basic block information if available
 
 ## Configuration
 

data/docs/bgv.md

@@ -57,7 +57,8 @@ GraphBody {
   Props props
   sint32 nodes_count
   Node[nodes_count] nodes
-  Blocks blocks
+  sint32 blocks_count
+  Blocks[blocks_count] blocks
 }
 
 Node {

data/docs/getting-graphs.md

@@ -54,6 +54,10 @@ easier to understand.
 
 You may need to use `--experimental-options`.
 
+## Getting basic blocks
+
+To get the graph when scheduled, so that you can see basic blocks, use `-Dgraal.PrintGraphWithSchedule=true`. Truffle graphs beyond the initial stages have scheduling information by default.
+
 ## Getting CFG files
 
 To also get CFG files, add `-Dgraal.PrintBackendCFG=true`, or `--vm.Dgraal.PrintBackendCFG=true` for Truffle.

data/examples/Fib.java

@@ -1,6 +1,6 @@
 /*
  * % javac Fib.java
- * % java -XX:CompileOnly=::fib -Dgraal.Dump=:2 Fib 14
+ * % java -XX:CompileOnly=::fib -Dgraal.Dump=:2 -Dgraal.PrintGraphWithSchedule=true Fib 14
  */
 
 class Fib {

data/lib/seafoam/bgv/bgv_parser.rb

@@ -127,13 +127,21 @@ module Seafoam
             end
           end
         end
-        skip_blocks
+
+        # Read block information.
+        @reader.read_sint32.times do
+          block_id = @reader.read_sint32
+          block_nodes = @reader.read_sint32.times.map { @reader.read_sint32 }
+          # Followers aren't used but could be.
+          @reader.read_sint32.times.map { @reader.read_sint32 }
+          graph.create_block block_id, block_nodes
+        end
         graph
       end
 
       # Skip over a graph, having read or skipped its headers.
       def skip_graph
-        # Already read BEGIN_GRAPH, id, format, args, and props
+        # Already read BEGIN_GRAPH, id, format, args, and props.
         @reader.read_sint32.times do
           @reader.skip_int32
           node_class = read_pool_object

data/lib/seafoam/commands.rb

@@ -30,6 +30,7 @@ module Seafoam
         @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'
@@ -406,6 +407,7 @@ module Seafoam
       args = args.dup
       out_file = nil
       explicit_out_file = false
+      draw_blocks = false
       until args.empty?
         arg = args.shift
         case arg
@@ -424,6 +426,8 @@ module Seafoam
           annotator_options[:hide_floating] = true
         when '--no-reduce-edges'
           annotator_options[:reduce_edges] = false
+        when '--draw-blocks'
+          draw_blocks = true
         when '--option'
           key = args.shift
           raise ArgumentError, 'no key for --option' unless key
@@ -469,14 +473,14 @@ module Seafoam
         if out_format == :dot
           File.open(out_file, 'w') do |stream|
             writer = GraphvizWriter.new(stream)
-            writer.write_graph graph
+            writer.write_graph graph, false, draw_blocks
           end
         else
           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
+              writer.write_graph graph, hidpi, draw_blocks
             end
           rescue Errno::ENOENT
             raise 'Could not run Graphviz - is it installed?'

data/lib/seafoam/graph.rb

@@ -2,12 +2,13 @@ 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
+    attr_reader :props, :nodes, :edges, :blocks
 
     def initialize(props = nil)
       @props = props || {}
       @nodes = {}
       @edges = []
+      @blocks = []
     end
 
     # Create a node.
@@ -27,6 +28,14 @@ module Seafoam
       to.inputs.push edge
       edge
     end
+
+    # Add a new basic block with given id and node id list.
+    def create_block(id, node_ids)
+      nodes = node_ids.select { |n| @nodes.key? n }.map { |n| @nodes[n] }
+      block = Block.new(id, nodes)
+      @blocks.push block
+      block
+    end
   end
 
   # A node, with properties, input edges, and output edges.
@@ -88,4 +97,19 @@ module Seafoam
       "<Edge #{from.id} -> #{to.id}>"
     end
   end
+
+  # A control-flow basic block
+  class Block
+    attr_reader :id, :nodes
+
+    def initialize(id, nodes)
+      @id = id
+      @nodes = nodes
+    end
+
+    # Inspect.
+    def inspect
+      "<Block #{id}>"
+    end
+  end
 end

data/lib/seafoam/graphviz_writer.rb

@@ -7,15 +7,16 @@ module Seafoam
     end
 
     # Write a graph.
-    def write_graph(graph, hidpi = false)
+    def write_graph(graph, hidpi = false, draw_blocks = false)
       inline_attrs = {}
       attrs = {}
       attrs[:dpi] = 200 if hidpi
-      attrs[:bgcolor] = 'transparent'
+      attrs[:bgcolor] = 'white'
       @stream.puts 'digraph G {'
       @stream.puts "  graph #{write_attrs(attrs)};"
       write_nodes inline_attrs, graph
       write_edges inline_attrs, graph
+      write_blocks graph if draw_blocks
       @stream.puts '}'
     end
 
@@ -166,6 +167,24 @@ module Seafoam
       end
     end
 
+    # Write basic block outlines.
+    def write_blocks(graph)
+      graph.blocks.each do |block|
+        @stream.puts "  subgraph cluster_block#{block.id} {"
+        @stream.puts '    fontname = "Arial";'
+        @stream.puts "    label = \"B#{block.id}\";"
+        @stream.puts '    style=dotted;'
+
+        block.nodes.each do |node|
+          next if node.props[:hidden] || node.props[:inlined]
+
+          @stream.puts "    node#{node.id};"
+        end
+
+        @stream.puts '  }'
+      end
+    end
+
     # Return attributes for a node or edge modified to 'shade' them in terms
     # the spotlight functionality - so basically make them light grey.
     def shade(attrs)

data/lib/seafoam/version.rb

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

data/spec/seafoam/bgv/bgv_parser_spec.rb

@@ -52,6 +52,16 @@ describe Seafoam::BGV::BGVParser do
     end
   end
 
+  it 'can read basic blocks' do
+    parser = Seafoam::BGV::BGVParser.new(File.expand_path('../../../examples/fib-java.bgv', __dir__))
+    parser.read_file_header
+    parser.skip_document_props
+    parser.read_graph_preheader
+    parser.skip_graph_header
+    graph = parser.read_graph
+    expect(graph.blocks.size).to eq 3
+  end
+
   it 'can alternate skipping and reading full files' do
     Seafoam::SpecHelpers::SAMPLE_BGV.each do |file|
       parser = Seafoam::BGV::BGVParser.new(file)
@@ -108,7 +118,7 @@ describe Seafoam::BGV::BGVParser do
       parser = Seafoam::BGV::BGVParser.new(@fib_java_bgv)
       parser.read_file_header
       parser.skip_document_props
-      54.times do
+      56.times do
         expect(parser.read_graph_preheader).to_not be_nil
         parser.skip_graph_header
         parser.skip_graph
@@ -150,7 +160,7 @@ describe Seafoam::BGV::BGVParser do
       parser.read_graph_preheader
       parser.read_graph_header
       graph = parser.read_graph
-      expect(graph.nodes.size).to eq 22
+      expect(graph.nodes.size).to eq 21
       expect(graph.edges.size).to eq 30
     end
   end

data/spec/seafoam/command_spec.rb

@@ -33,18 +33,18 @@ describe Seafoam::Commands do
       @commands.send :list, @fib_java
       lines = @out.string.lines.map(&:rstrip)
       expect(lines.take(5)).to eq [
-        "#{@fib_java}:0  2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase",
-        "#{@fib_java}:1  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.PhaseSuite",
-        "#{@fib_java}:2  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
-        "#{@fib_java}:3  2:Fib.fib(int)/After parsing",
-        "#{@fib_java}:4  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.CanonicalizerPhase"
+        "#{@fib_java}:0  17:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase",
+        "#{@fib_java}:1  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.PhaseSuite",
+        "#{@fib_java}:2  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
+        "#{@fib_java}:3  17:Fib.fib(int)/After parsing",
+        "#{@fib_java}:4  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.CanonicalizerPhase"
       ]
       expect(lines.drop(lines.length - 5)).to eq [
-        "#{@fib_java}:49  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
-        "#{@fib_java}:50  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.PropagateDeoptimizeProbabilityPhase",
-        "#{@fib_java}:51  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.schedule.SchedulePhase",
-        "#{@fib_java}:52  2:Fib.fib(int)/After phase org.graalvm.compiler.core.phases.LowTier",
-        "#{@fib_java}:53  2:Fib.fib(int)/After low tier"
+        "#{@fib_java}:51  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
+        "#{@fib_java}:52  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.PropagateDeoptimizeProbabilityPhase",
+        "#{@fib_java}:53  17:Fib.fib(int)/After phase org.graalvm.compiler.phases.schedule.SchedulePhase",
+        "#{@fib_java}:54  17:Fib.fib(int)/After phase org.graalvm.compiler.core.phases.LowTier",
+        "#{@fib_java}:55  17:Fib.fib(int)/After low tier"
       ]
     end
 
@@ -96,7 +96,7 @@ describe Seafoam::Commands do
     it 'prints the number of edges and nodes for a graph' do
       @commands.send :edges, "#{@fib_java}:0"
       lines = @out.string.lines.map(&:rstrip)
-      expect(lines.first).to eq '22 nodes, 30 edges'
+      expect(lines.first).to eq '21 nodes, 30 edges'
     end
 
     it 'prints the edges for a node' do
@@ -129,19 +129,17 @@ describe Seafoam::Commands do
   describe '#props' do
     it 'prints properties for a file' do
       @commands.send :props, @fib_java
-      expect(@out.string.gsub(/\n\n/, "\n")).to eq "{\n  \"vm.uuid\": \"28729\"\n}\n"
+      expect(@out.string.gsub(/\n\n/, "\n")).to eq "{\n  \"vm.uuid\": \"94468\"\n}\n"
     end
 
     it 'prints properties for a graph' do
       @commands.send :props, "#{@fib_java}:0"
-      lines = @out.string.lines.map(&:rstrip)
-      expect(lines[3]).to include '"name": "2:Fib.fib(int)"'
+      expect(@out.string).to include '"scope": "main.Compiling.GraalCompiler.FrontEnd.PhaseSuite.GraphBuilderPhase"'
     end
 
     it 'prints properties for a node' do
       @commands.send :props, "#{@fib_java}:0:13"
-      lines = @out.string.lines.map(&:rstrip)
-      expect(lines[3]).to include '"declaring_class": "Fib"'
+      expect(@out.string).to include '"declaring_class": "Fib"'
     end
 
     it 'prints properties for an edge' do

data/spec/seafoam/spotlight_spec.rb

@@ -33,6 +33,6 @@ describe Seafoam::Spotlight do
     spotlight.shade
     expect(@graph.nodes.values
       .select { |n| n.props[:hidden] }
-      .map(&:id).sort).to eq [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 15, 16, 17, 21]
+      .map(&:id).sort).to eq [0, 1, 2, 4, 5, 7, 8, 9, 10, 11, 15, 16, 17, 21]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seafoam
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
 platform: ruby
 authors:
 - Chris Seaton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crabstone
@@ -85,6 +85,7 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
 - README.md
 - bin/bgv2isabelle
@@ -167,7 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project:
+rubygems_version: 2.7.6.3
 signing_key:
 specification_version: 4
 summary: A tool for working with compiler graphs