seafoam 0.6 → 0.10

data/lib/seafoam/passes/truffle.rb

@@ -0,0 +1,58 @@
+module Seafoam
+  module Passes
+    # The Truffle pass applies if it looks like it was compiled by Truffle.
+    class TrufflePass < Pass
+      def self.applies?(graph)
+        graph.props.values.any? do |v|
+          TRIGGERS.any? { |t| v.to_s.include?(t) }
+        end
+      end
+
+      def apply(graph)
+        simplify_truffle_args graph if @options[:simplify_truffle_args]
+      end
+
+      private
+
+      # Simplify a Truffle argument load into a single, inlined, node very much
+      # like a Graal parameter node.
+      def simplify_truffle_args(graph)
+        graph.nodes.dup.each_value do |node|
+          next unless node.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.java.LoadIndexedNode'
+
+          index_node = node.inputs.find { |edge| edge.props[:name] == 'index' }.from
+          array_node = Graal::Pi.follow_pi_object(node.inputs.find { |edge| edge.props[:name] == 'array' }.from)
+
+          next unless index_node.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.ConstantNode'
+          next unless array_node.props.dig(:node_class, :node_class) == 'org.graalvm.compiler.nodes.ParameterNode'
+
+          node.props[:truffle_arg_load] = true
+
+          index = index_node.props['rawvalue']
+
+          arg_node = graph.create_node(graph.new_id, { synthetic: true, inlined: true, label: "T(#{index})", kind: 'input' })
+
+          node.outputs.each do |output|
+            next if output.props[:name] == 'next'
+
+            graph.create_edge arg_node, output.to, output.props.dup
+            graph.remove_edge output
+          end
+        end
+
+        graph.nodes.each_value.select { |node| node.props[:truffle_arg_load] }.each do |node|
+          control_in = node.inputs.find { |edge| edge.props[:name] == 'next' }
+          control_out = node.outputs.find { |edge| edge.props[:name] == 'next' }
+          graph.create_edge control_in.from, control_out.to, { name: 'next' }
+          graph.remove_edge control_in
+          graph.remove_edge control_out
+        end
+      end
+
+      # If we see these in the graph properties it's probably a Truffle graph.
+      TRIGGERS = %w[
+        TruffleCompiler
+      ]
+    end
+  end
+end

data/lib/seafoam/passes.rb

@@ -0,0 +1,61 @@
+module Seafoam
+  # Passes are routines to read the graph and apply properties which tools,
+  # such as the render command, can use to show more understandable output.
+  module Passes
+    # Apply all applicable passes to a graph.
+    def self.apply(graph, options = {})
+      passes.each do |pass|
+        next unless pass.applies?(graph)
+
+        # Record for information that the pass was applied this graph.
+        passes_applied = graph.props[:passes_applied] ||= []
+        passes_applied.push pass
+
+        # Run the pass.
+        instance = pass.new(options)
+        instance.apply graph
+      end
+    end
+
+    # Get a list of all passes in the system.
+    def self.passes
+      # We have a defined order for passes to run - these passes at the start.
+      pre_passes = [
+        TrufflePass,
+        GraalPass
+      ]
+
+      # The fallback pass runs last.
+      post_passes = [
+        FallbackPass
+      ]
+
+      # Any extra passes in the middle.
+      extra_passes = Pass::SUBCLASSES.dup - pre_passes - post_passes
+
+      pre_passes + extra_passes + post_passes
+    end
+  end
+
+  # The base class for all passes. You must subclass this to be recognized
+  # as an pass.
+  class Pass
+    SUBCLASSES = []
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def applies?(_graph)
+      raise NotImplementedError
+    end
+
+    def apply(_graph)
+      raise NotImplementedError
+    end
+
+    def self.inherited(pass)
+      SUBCLASSES.push pass
+    end
+  end
+end

data/lib/seafoam/version.rb

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

data/lib/seafoam.rb

@@ -6,12 +6,13 @@ require 'seafoam/cfg/disassembler'
 require 'seafoam/colors'
 require 'seafoam/graph'
 require 'seafoam/graal/source'
-require 'seafoam/annotators'
-require 'seafoam/annotators/graal'
-require 'seafoam/annotators/fallback'
+require 'seafoam/graal/pi'
+require 'seafoam/passes'
+require 'seafoam/passes/truffle'
+require 'seafoam/passes/graal'
+require 'seafoam/passes/fallback'
 require 'seafoam/spotlight'
 require 'seafoam/isabelle_writer'
 require 'seafoam/json_writer'
 require 'seafoam/graphviz_writer'
-require 'seafoam/config'
 require 'seafoam/commands'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: seafoam
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.10'
 platform: ruby
 authors:
 - Chris Seaton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: crabstone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: crabstone
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -76,78 +90,29 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/probots.yml"
-- ".github/workflows/workflows.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".seafoam/config"
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- LICENSE.md
-- README.md
 - bin/bgv2isabelle
 - bin/bgv2json
 - bin/cfg2asm
 - bin/seafoam
-- demos/box-unbox-stats
-- docs/annotators.md
-- docs/bgv.md
-- docs/getting-graphs.md
-- docs/images/igv.png
-- docs/images/seafoam.png
-- docs/images/spotlight-igv.png
-- docs/images/spotlight-seafoam.png
-- docs/json.md
-- examples/Fib.java
-- examples/MatMult.java
-- examples/fib-java.bgv.gz
-- examples/fib.js
-- examples/fib.rb
-- examples/identity.rb
-- examples/java/Irreducible.class
-- examples/java/Irreducible.j
-- examples/java/IrreducibleDecompiled.java
-- examples/java/JavaExamples.java
-- examples/matmult.rb
-- examples/overflow.rb
-- examples/ruby/clamps.rb
-- examples/ruby/graal.patch
-- examples/ruby/ruby_examples.rb
 - lib/seafoam.rb
-- lib/seafoam/annotators.rb
-- lib/seafoam/annotators/fallback.rb
-- lib/seafoam/annotators/graal.rb
 - lib/seafoam/bgv/bgv_parser.rb
 - lib/seafoam/binary/io_binary_reader.rb
 - lib/seafoam/cfg/cfg_parser.rb
 - lib/seafoam/cfg/disassembler.rb
 - lib/seafoam/colors.rb
 - lib/seafoam/commands.rb
-- lib/seafoam/config.rb
+- lib/seafoam/graal/pi.rb
 - lib/seafoam/graal/source.rb
 - lib/seafoam/graph.rb
 - lib/seafoam/graphviz_writer.rb
 - lib/seafoam/isabelle_writer.rb
 - lib/seafoam/json_writer.rb
+- lib/seafoam/passes.rb
+- lib/seafoam/passes/fallback.rb
+- lib/seafoam/passes/graal.rb
+- lib/seafoam/passes/truffle.rb
 - lib/seafoam/spotlight.rb
 - lib/seafoam/version.rb
-- seafoam.gemspec
-- spec/seafoam/annotators/fallback_spec.rb
-- spec/seafoam/annotators/graal_spec.rb
-- spec/seafoam/annotators_spec.rb
-- spec/seafoam/bgv/bgv_parser_spec.rb
-- spec/seafoam/binary/io_binary_reader_spec.rb
-- spec/seafoam/cfg/cfg_parser_spec.rb
-- spec/seafoam/cfg/disassembler_spec.rb
-- spec/seafoam/command_spec.rb
-- spec/seafoam/graph_spec.rb
-- spec/seafoam/graphviz_writer_spec.rb
-- spec/seafoam/json_writer_spec.rb
-- spec/seafoam/spec_helpers.rb
-- spec/seafoam/spotlight_spec.rb
-- tools/render-all
 homepage: https://github.com/Shopify/seafoam
 licenses:
 - MIT
@@ -160,15 +125,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.8
+      version: 2.5.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A tool for working with compiler graphs

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla

data/.github/workflows/workflows.yml

@@ -1,39 +0,0 @@
-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/.gitignore

@@ -1,7 +0,0 @@
-*.pdf
-*.dot
-*.png
-*.svg
-*.class
-/.idea
-/Gemfile.lock

data/.rubocop.yml

@@ -1,37 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - examples/**/*.rb
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/MutableConstant:
-  Enabled: false
-
-Metrics:
-  Enabled: false
-
-Lint/EmptyWhen:
-  Enabled: false
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Lint/InterpolationCheck:
-  Enabled: false
-
-Security/Eval:
-  Enabled: false
-
-Naming/FileName:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 300

data/.ruby-version

@@ -1 +0,0 @@
-2.5.8

data/.seafoam/config

@@ -1 +0,0 @@
-# Empty configuration file

data/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-opensource@shopify.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -1,5 +0,0 @@
-# Contribution
-
-Contributions welcome. Please discuss big ideas in an issue first.
-
-You'll need to sign the Shopify Contributor License Agreement (CLA) https://cla.shopify.com/.

data/Gemfile

@@ -1,2 +0,0 @@
-source 'https://rubygems.org'
-gemspec

data/LICENSE.md

@@ -1,7 +0,0 @@
-Copyright 2019-present, Shopify Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.