seafoam 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e76a6115614baaa5be993aa488f4aa245f8442066dc0bb92c6b7b9f9e1b78cad
-  data.tar.gz: 987fdd58f2d0f7d5023c9760295fb458dabcd70a724567eb8445dcf2ff1ba271
+  metadata.gz: '08ef3412a15721b9bfd6184645579568626e2079ff1aaaeb9d9181270c25209f'
+  data.tar.gz: a139c2adb73d4912131b886a61482d2c67ee2090f1117a51669cfe334202ea37
 SHA512:
-  metadata.gz: 1e81bcd44349ac1e6dd738e234fc31498ea47c2382d3682bf71535af2a9f54f3f6a3d06ff32a939abbd25112ccb366bacc9870a5ce599664e31be0efceb6e240
-  data.tar.gz: 33e76594a4e77aebf5065f53c885bbe5212ab009f1a089b155d7a9859181461b794f057beb0af2ae5760031eecb7b5c422da967c1eec1073a8f0ab7a9a8c11b5
+  metadata.gz: 1939c6d23e19bb930475a33c7b1fd690c2e3c57b6fcfaed3eafd3c01d4c2e2775398f796f6a22c62012e6133a27dc4575df0f3afc96785efd1fdfbd3a8203203
+  data.tar.gz: 9fb0c9552c3df825ab9dde3b76480d08a4ef5587ccb85f1e9024e0fff85fd71b8707bd0d7cecccde69d35a6662e736ee1fbeb332f95745ca8e34a40d260da702

data/.github/workflows/workflows.yml

@@ -0,0 +1,39 @@
+name: Workflows
+on: [push]
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+    - run: bundle install
+    - run: bundle exec rubocop
+  specs:
+    strategy:
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.5, 2.6, 2.7]
+    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]
+    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/.rubocop.yml

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

data/README.md

@@ -14,10 +14,14 @@ 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
@@ -53,7 +57,7 @@ seafoam 0.1
 seafoam 0.1
 ```
 
-#### RedHat
+### RedHat
 
 ```
 % sudo yum install ruby graphviz
@@ -62,6 +66,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 +196,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,6 +260,46 @@ 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

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)}%"

data/docs/getting-graphs.md

@@ -53,3 +53,7 @@ You may want to disable on-stack-replacement and inlining with
 easier to understand.
 
 You may need to use `--experimental-options`.
+
+## Getting CFG files
+
+To also get CFG files, add `-Dgraal.PrintBackendCFG=true`, or `--vm.Dgraal.PrintBackendCFG=true` for Truffle.

data/examples/fib.js

@@ -1,4 +1,4 @@
-// % node --experimental-options --engine.CompileOnly=fib --engine.Inlining=false --vm.Dgraal.Dump=Truffle:2 -f fib.js 14
+// % node --experimental-options --engine.CompileOnly=fib --engine.Inlining=false --vm.Dgraal.Dump=Truffle:2 fib.js 14
 
 function fib(n) {
   if (n <= 1) {

data/examples/java/JavaExamples.java

@@ -1,6 +1,6 @@
 /*
  * % javac JavaExamples.java
- * % java -XX:-UseOnStackReplacement '-XX:CompileCommand=dontinline,*::*' -XX:+PrintCompilation -Dgraal.Dump=:3 JavaExamples
+ * % java -XX:-UseOnStackReplacement '-XX:CompileCommand=dontinline,*::*' -XX:+PrintCompilation -Dgraal.PrintBackendCFG=true -Dgraal.Dump=:3 JavaExamples
  */
 
 import java.lang.reflect.Field;

data/examples/ruby/clamps.rb

@@ -0,0 +1,20 @@
+# ruby --experimental-options --engine.CompileOnly=clamp_low,clamp_high --vm.Dgraal.Dump=Truffle:2 --vm.Dgraal.PrintBackendCFG=true clamps.rb 
+
+def clamp_high(min, max, value)
+  [min, max, value].sort[1]
+end
+
+def clamp_low(min, max, value)
+  if value > max
+    max
+  elsif value < min
+    min
+  else
+    value
+  end
+end
+
+loop do
+  clamp_high(10, 90, rand(100))
+  clamp_low(10, 90, rand(100))
+end