seafoam 0.3 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85ce198d6b6117c1e691ea871829e0d93d480ab26709f6ba494aa8f73957fefb
-  data.tar.gz: 83275a9095d3827a6f5c7d8eab9d9ea49ed35b6fe3f527d6c6299f6719a65956
+  metadata.gz: 6f5cdd6b29d9c25bc7db525b2f49d6937fb996bc108a7bf18ddf0364575e6999
+  data.tar.gz: 510608b5d784ef4c58768aafb42372bdd33aad226a6123e9ad72ea77845a8050
 SHA512:
-  metadata.gz: d5b74e656d6a80af67233f4fcae60bbdfc291bab4a6d4a92ce283450b5dd4e318da59440a4d78d539033910cba2560068c57f112213e4ce8b493e731e92ff799
-  data.tar.gz: a7acdd55bcb41bc5f78b0f06583cb678d7e1d2beaadab02c6e2e42945fac8d6d4c4dfccddabe64c9b47f223722e7808b5fb9dd1353d4912fdbe757ece60950c5
+  metadata.gz: 125d9c14699c1a9a72bc1311b2673cf24d725af3c4da38eac1c2c89ebce4d6157c3e08ad7cc7b8769f8c755227cd04da4b9a6f53ae30f0f3ce38e7a1cf12d4b2
+  data.tar.gz: 2430c0b5f04378767c5bbbb51274900deae22291fd905831f4a5d5847edd5e7497e3df94a434ab803689ee4f9b3f6cd5d6740bdc28dbf96d7da329c8610ac6e5

data/.github/workflows/workflows.yml

@@ -0,0 +1,40 @@
+name: Workflows
+on: [push]
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    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, 3.0]
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle install
+    - run: if [[ $(uname) == "Darwin" ]]; then brew install graphviz capstone; else sudo apt-get install graphviz libcapstone3; fi
+    - run: bundle exec rspec
+  specs-no-dependencies:
+    strategy:
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle install
+    - run: NO_DEPENDENCIES_INSTALLED=true bundle exec rspec

data/.gitignore

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

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.5
   Exclude:
-    - examples/*
+    - examples/**/*.rb
 
 Style/FrozenStringLiteralComment:
   Enabled: false

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

@@ -14,15 +14,18 @@ IGV, Seafoam:
 * is able to some extent seek BGV files to load specific graphs without loading the rest of the file
 * has a command-line interface
 * can be used as a library
-* has easy PDF, SVG and PNG output
+* has easy PDF, SVG, PNG and JSON output
 * is designed for accessibility
 * looks prettier, in our opinion
 
+Additionally, Seafoam adds:
+
+* support for disassembling CFG files
+
 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
 
@@ -53,7 +56,7 @@ seafoam 0.1
 seafoam 0.1
 ```
 
-#### RedHat
+### RedHat
 
 ```
 % sudo yum install ruby graphviz
@@ -62,6 +65,15 @@ seafoam 0.1
 seafoam 0.1
 ```
 
+### Capstone
+
+To use the `cfg2asm` disassembler, you'll then need to install Capstone.
+
+```
+% brew install capstone               # macOS
+% sudo apt-get install libcapstone3   # Ubuntu
+```
+
 ## Quick-start demo
 
 ```
@@ -183,6 +195,26 @@ Output:
 }
 ```
 
+#### Print node source information
+
+```
+% seafoam examples/fib-ruby.bgv:8:2443 source
+java.lang.Math#addExact
+org.truffleruby.core.numeric.IntegerNodes$AddNode#add
+org.truffleruby.core.numeric.IntegerNodesFactory$AddNodeFactory$AddNodeGen#executeAdd
+org.truffleruby.core.inlined.InlinedAddNode#intAdd
+org.truffleruby.core.inlined.InlinedAddNodeGen#execute
+org.truffleruby.language.control.IfElseNode#execute
+org.truffleruby.language.control.SequenceNode#execute
+org.truffleruby.language.arguments.CheckArityNode#execute
+org.truffleruby.language.control.SequenceNode#execute
+org.truffleruby.language.methods.CatchForMethodNode#execute
+org.truffleruby.language.methods.ExceptionTranslatingNode#execute
+org.truffleruby.language.RubyRootNode#execute
+org.graalvm.compiler.truffle.runtime.OptimizedCallTarget#executeRootNode
+org.graalvm.compiler.truffle.runtime.OptimizedCallTarget#profiledPERoot
+```
+
 #### Render a graph
 
 Render a graph as a PDF image and have it opened automatically.
@@ -227,11 +259,52 @@ graph0 = # 2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhas
 ...
 ```
 
+Convert a BGV file to JSON.
+
+```
+% bgv2json examples/fib-java.bgv
+graph0 = # 2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase
+ (add_node 0 StartNode [2] [8]
+ (add_node 1 (ParameterNode 0) [] [2, 5, 9, 11, 14, 16]
+ (add_node 2 FrameState [1] [0]
+ (add_node 3 (ConstantNode 1) [] []
+ (add_node 4 (ConstantNode 2) [] [5]
+ (add_node 5 IntegerLessThanNode [1, 4] [8]
+ (add_node 6 BeginNode [8] [13]
+ (add_node 7 BeginNode [8] [9]
+ (add_node 8 IfNode [0, 5] [7, 6]
+...
+```
+
+#### Disassembling
+
+```
+% cfg2asm examples/java/exampleArithOperator.cfg
+[examples/java/exampleArithOperator.cfg]
+				;Comment 0:	3
+				;Comment 0:	1
+	0x112e2f660:	nop	dword ptr [rax + rax]
+				;Comment 5:	block B0 null
+				;Comment 5:	0 [rsi|DWORD, rdx|DWORD, rbp|QWORD] = LABEL numbPhis: 0 align: false label: ?
+				;Comment 5:	4 [] = HOTSPOTLOCKSTACK frameMapBuilder: org.graalvm.compiler.lir.amd64.AMD64FrameMapBuilder@143082de0 slotKind: QWORD
+				;Comment 5:	10 rsi|DWORD = ADD (x: rsi|DWORD, y: rdx|DWORD) size: DWORD
+	0x112e2f665:	add	esi, edx
+				;Comment 7:	12 rax|DWORD = MOVE rsi|DWORD moveKind: DWORD
+	0x112e2f667:	mov	eax, esi
+				;Comment 9:	14 RETURN (savedRbp: rbp|QWORD, value: rax|DWORD) isStub: false requiresReservedStackAccessCheck: false thread: r15 scratchForSafepointOnReturn: rcx config: org.graalvm.compiler.hotspot.GraalHotSpotVMConfig@137f187d8
+				;Comment 9:	12
+	0x112e2f669:	test	dword ptr [rip - 0x46c4669], eax
+	0x112e2f66f:	vzeroupper	
+	0x112e2f672:	ret	
+...
+```
+
 ## Options for GraalVM graphs
 
 * `--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/bin/bgv2isabelle

@@ -2,52 +2,23 @@
 
 require 'seafoam'
 
-# definition eg_short_cut_or1 :: IRGraph where
-#   "eg_short_cut_or1 =
-#     (add_node 14 ReturnNode [13] []
-#     (add_node 13 PhiNode [10, 11, 12] []
-#     (add_node 12 (ConstantNode 0) [] []
-#     (add_node 11 (ConstantNode 42) [] []
-#     (add_node 10 MergeNode [7, 9] [14]
-#     (add_node 9 EndNode [] []
-#     (add_node 8 BeginNode [] [9]
-#     (add_node 7 EndNode [] []
-#     (add_node 6 BeginNode [] [7]
-#     (add_node 5 IfNode [3] [6, 8]
-#     (add_node 3 (ShortCircuitOrNode False False) [1, 2] []
-#     (add_node 2 (ParameterNode 1) [] []
-#     (add_node 1 (ParameterNode 0) [] []
-#     (add_node 0 StartNode [] [5]
-#     empty_graph))))))))))))))"
+# This is the 'bgv2isabelle' command line entry point.
 
-ARGV.each do |file|
-  parser = Seafoam::BGV::BGVParser.new(file)
-  parser.read_file_header
-  parser.skip_document_props
+begin
+  # Load configuraiton.
+  config = Seafoam::Config.new
+  config.load_config
 
-  loop do
-    index, = parser.read_graph_preheader
-    break unless index
-
-    graph_header = parser.read_graph_header
-    graph = parser.read_graph
-
-    puts "graph#{index} = # #{parser.graph_name(graph_header)}"
-
-    graph.nodes.each_value do |node|
-      node_class = node.props[:node_class][:node_class]
-      case node_class
-      when 'org.graalvm.compiler.nodes.ConstantNode'
-        desc = "(ConstantNode #{node.props['rawvalue']})"
-      when 'org.graalvm.compiler.nodes.ParameterNode'
-        desc = "(ParameterNode #{node.props['index']})"
-      else
-        desc = node_class.split('.').last
-      end
-      inputs = node.inputs.map(&:from).map(&:id)
-      outputs = node.outputs.map(&:to).map(&:id)
-      puts " (add_node #{node.id} #{desc} #{inputs.inspect} #{outputs.inspect}"
-    end
-    puts ' empty_graph' + (')' * graph.nodes.size)
+  # Run the command line.
+  commands = Seafoam::Commands.new($stdout, config)
+  commands.bgv2isabelle(*ARGV)
+rescue StandardError => e
+  if $DEBUG
+    # Re-raise the exception so the user sees it, if debugging is
+    # enabled (ruby -d).
+    raise e
+  else
+    # Otherwise, just print the message.
+    warn "seafoam: #{e.message}"
   end
 end

data/bin/bgv2json

@@ -1,42 +1,24 @@
 #!/usr/bin/env ruby
 
 require 'seafoam'
-require 'json'
 
-ARGV.each do |file|
-  parser = Seafoam::BGV::BGVParser.new(file)
-  parser.read_file_header
-  parser.skip_document_props
-
-  loop do
-    index, = parser.read_graph_preheader
-    break unless index
-
-    graph_header = parser.read_graph_header
-
-    graph = parser.read_graph
-    Seafoam::Annotators.apply graph
-
-    name = parser.graph_name(graph_header)
-
-    nodes = []
-    edges = []
-
-    graph.nodes.each_value do |node|
-      nodes.push(
-        id: node.id,
-        props: node.props
-      )
-
-      node.outputs.each do |edge|
-        edges.push(
-          from: edge.from.id,
-          to: edge.to.id,
-          props: edge.props
-        )
-      end
-    end
-
-    puts JSON.generate(name: name, props: graph.props, nodes: nodes, edges: edges)
+# 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.bgv2json(*ARGV)
+rescue StandardError => e
+  if $DEBUG
+    # Re-raise the exception so the user sees it, if debugging is
+    # enabled (ruby -d).
+    raise e
+  else
+    # Otherwise, just print the message.
+    warn "seafoam: #{e.message}"
   end
 end

data/bin/cfg2asm

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+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.cfg2asm(*ARGV)
+rescue StandardError => e
+  if $DEBUG
+    # Re-raise the exception so the user sees it, if debugging is
+    # enabled (ruby -d).
+    raise e
+  else
+    # Otherwise, just print the message.
+    warn "seafoam: #{e.message}"
+  end
+end

data/bin/seafoam

@@ -11,7 +11,7 @@ begin
 
   # Run the command line.
   commands = Seafoam::Commands.new($stdout, config)
-  commands.run(*ARGV)
+  commands.seafoam(*ARGV)
 rescue StandardError => e
   if $DEBUG
     # Re-raise the exception so the user sees it, if debugging is

data/demos/box-unbox-stats

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+# This demo analyses a directory full of graphs and looks for how many box nodes
+# take their value directly from an unbox node.
+
+require 'seafoam'
+
+box_nodes_count = 0
+box_nodes_from_unbox_count = 0
+
+graph_count = 0
+graph_match_count = 0
+
+ARGV.each do |dir|
+  Dir.glob(['*.bgv', '*.bgv.gz'], base: dir) do |file|
+    parser = Seafoam::BGV::BGVParser.new(File.join(dir, file))
+    parser.read_file_header
+    parser.skip_document_props
+
+    loop do
+      index, = parser.read_graph_preheader
+      break unless index
+
+      parser.skip_graph_header
+      graph = parser.read_graph
+
+      contains_box_unbox = false
+
+      graph.nodes.each_value do |node|
+        next unless node.props.dig(:node_class, :node_class).start_with?('org.graalvm.compiler.nodes.extended.BoxNode')
+
+        box_node = node
+        box_nodes_count += 1
+        value_edge = node.edges.find { |e| e.props[:name] == 'value' }
+        raise unless value_edge
+
+        value_node = value_edge.from
+        next unless value_node.props.dig(:node_class, :node_class).start_with?('org.graalvm.compiler.nodes.extended.UnboxNode')
+
+        unbox_node = value_node
+        box_nodes_from_unbox_count += 1
+        contains_box_unbox = true
+        puts "seafoam '#{File.join(dir, file)}:#{index}' render --spotlight #{box_node.id},#{unbox_node.id}"
+      end
+
+      graph_count += 1
+      graph_match_count += 1 if contains_box_unbox
+    end
+  end
+end
+
+if box_nodes_count.positive?
+  box_nodes_percent = (box_nodes_from_unbox_count / box_nodes_count.to_f) * 100
+else
+  box_nodes_percent = 0.0
+end
+
+if graph_count.positive?
+  graph_percent = (graph_match_count / graph_count.to_f) * 100
+else
+  graph_percent = 0.0
+end
+
+puts "     How many boxes take a value from an unbox?  #{box_nodes_percent.round(1)}%"
+puts "How many graphs contain at least one box-unbox?  #{graph_percent.round(1)}%"