seafoam 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 841e61f7601b4121b7367e9974b9920f8b8513fd6ca7a827c1be0e340bc2b3cf
+  data.tar.gz: 559e28e6b6a49964f31ac73bc1b1ed8c72fefae9d81381bb3e433bc39d57d0d7
+SHA512:
+  metadata.gz: 75c306c0d6b9b8dffae51f62538a6b5e529150b59e5b6ea6ccbcf1b27ca9505fc8b7548086f2826d4f9bb8589648e2281e750a2caabd7b91f7da164065756883
+  data.tar.gz: c0c307acef6945d1841cc23d2cf5c00bbc52ed70cd74aaa95fc9365f83e796379b86009a16eef522b849e6a279b147e4d8350291b5fcdbebfa81d2ef4178bed5

data/.github/probots.yml

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

data/.github/workflows/rubocop.yml

@@ -0,0 +1,10 @@
+name: Rubocop
+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

data/.github/workflows/specs.yml

@@ -0,0 +1,19 @@
+name: Specs
+on: [push]
+jobs:
+  specs:
+    strategy:
+      fail-fast: false
+      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: if [[ $(uname) == "Darwin" ]]; then brew install graphviz; else sudo apt-get install graphviz; fi
+    - run: bundle install
+    - run: bundle exec rspec

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - examples/*
+
+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

data/.ruby-version

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

data/.seafoam/config

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# 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

@@ -0,0 +1,5 @@
+# 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

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

data/LICENSE.md

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

data/README.md

@@ -0,0 +1,298 @@
+# Seafoam
+
+*Seafoam* is a tool for working with compiler graphs. It's designed primarily
+for working with the graph files dumped by the GraalVM compiler, such as in
+TruffleRuby, but it could be used with other compilers and graph dump file
+formats.
+
+The *Ideal Graph Visualizer*, or *IGV*, is the tool usually used to work with
+GraalVM compiler graphs. Seafoam aims to solve several problems with IGV. Unlike
+IGV, Seafoam:
+
+* is open source and can be used according to the MIT license
+* 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
+* is designed for accessibility
+* looks prettier, in our opinion
+
+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
+
+## Seafoam compared to IGV
+
+<p>
+<img src="docs/images/seafoam.png" width="350">
+<img src="docs/images/igv.png" width="350">
+</p>
+
+## Installation
+
+### macOS
+
+```
+$ brew install graphviz
+$ gem install seafoam
+$ seafoam --version
+seafoam 0.1
+```
+
+### Ubuntu
+
+```
+$ sudo apt-get install ruby graphviz
+$ gem install seafoam
+$ seafoam --version
+seafoam 0.1
+```
+
+#### RedHat
+
+```
+$ sudo yum install ruby graphviz
+$ gem install seafoam
+$ seafoam --version
+seafoam 0.1
+```
+
+## Quick-start demo
+
+```
+$ seafoam examples/fib-java.bgv:0 render
+```
+
+## Getting compiler graphs
+
+If you are just experimenting, there are example graphs such as
+`examples/fib-java.bgv`.
+
+This is just a quick summary - see more information on
+[getting graphs out of compilers](docs/getting-graphs.md).
+
+### GraalVM for Java
+
+```
+$ javac Fib.java
+$ java -XX:CompileOnly=::fib -Dgraal.Dump=:2 Fib 14
+```
+
+### TruffleRuby and other Truffle languages
+
+```
+$ ruby --experimental-options --engine.CompileOnly=fib --engine.Inlining=false --engine.OSR=false --vm.Dgraal.Dump=Truffle:2 fib.rb 14
+```
+
+You will usually want to look at the *After TruffleTier* graph.
+
+## Name syntax
+
+When using a command-line interface, Seafoam refers to
+`file.bgv[:graph][:node[-edge]]`, where `file.bgv` is a file, `graph` is a graph
+index, `node` is a node index, and `to` is another node index to form an edge
+from `node` to another node `edge`.
+
+Note that a *graph ID* is an ID found in BGV files, but is not unique. A
+*graph index* is what we use in names, and is unique.
+
+## Use cases
+
+#### Print information about a file
+
+```
+$ seafoam examples/fib-java.bgv info
+BGV 6.1
+```
+
+#### List graphs in a file
+
+```
+$ seafoam examples/fib-java.bgv list
+examples/fib-java.bgv:0  2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase
+examples/fib-java.bgv:1  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.PhaseSuite
+examples/fib-java.bgv:2  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase
+examples/fib-java.bgv:3  2:Fib.fib(int)/After parsing
+examples/fib-java.bgv:4  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.CanonicalizerPhase
+examples/fib-java.bgv:5  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.inlining.InliningPhase
+...
+```
+
+#### Search for strings in a graph, or node or edge within a graph
+
+```
+$ seafoam examples/fib-java.bgv:0 search Start
+examples/fib-java.bgv:0:0  ...node_class":"org.graalvm.compiler.nodes.StartNode","name_template":"Start","inputs":[...
+examples/fib-java.bgv:0:0  ...piler.nodes.StartNode","name_template":"Start","inputs":[{"direct":true,"name":"state...
+```
+
+#### Print edges of a graph, or node or edge within a graph
+
+```
+$ seafoam examples/fib-java.bgv:0 edges
+22 nodes, 30 edges
+$ seafoam examples/fib-java.bgv:0:13 edges
+Input:
+  13 (Call Fib.fib) <-() 6 (Begin)
+  13 (Call Fib.fib) <-() 14 (@{:declaring_class=>"Fib", :method_name=>"fib", :signature=>{:args=>["I"], :ret=>"I"}, :modifiers=>9}:13)
+  13 (Call Fib.fib) <-() 12 (MethodCallTarget)
+Output:
+  13 (Call Fib.fib) ->() 18 (Call Fib.fib)
+  13 (Call Fib.fib) ->(values) 14 (@{:declaring_class=>"Fib", :method_name=>"fib", :signature=>{:args=>["I"], :ret=>"I"}, :modifiers=>9}:13)
+  13 (Call Fib.fib) ->(values) 19 (@{:declaring_class=>"Fib", :method_name=>"fib", :signature=>{:args=>["I"], :ret=>"I"}, :modifiers=>9}:19)
+  13 (Call Fib.fib) ->(x) 20 (+)
+$ seafoam examples/fib-java.bgv:0:13-20 edges
+13 (Call Fib.fib) ->(x) 20 (+)
+```
+
+#### Print properties of a file, graph, or node or edge within a graph
+
+```
+$ seafoam examples/fib-java.bgv:0 props
+{
+  "group": [
+    {
+      "name": "2:Fib.fib(int)",
+      "short_name": "2:Fib.fib(int)",
+      "method": null,
+...
+$ seafoam examples/fib-java.bgv:0:13 props
+{
+  "nodeSourcePosition": {
+    "method": {
+      "declaring_class": "Fib",
+      "method_name": "fib",
+      "signature": {
+...
+$ seafoam examples/fib-java.bgv:0:13-20 props
+{
+  "direct": true,
+  "name": "x",
+  "type": "Value"
+}
+```
+
+#### Render a graph
+
+Render a graph as a PDF image and have it opened automatically.
+
+```
+$ seafoam examples/fib-java.bgv:0 render
+```
+
+Render a graph showing just a few nodes and those surrounding them, similar to
+the IGV feature of gradually revealing nodes.
+
+```
+$ seafoam examples/fib-java.bgv:0 render --spotlight 13,20
+```
+
+<p>
+<img src="docs/images/spotlight-seafoam.png" width="200">
+<img src="docs/images/spotlight-igv.png" width="350">
+</p>
+
+`render` supports these options:
+
+* `--out filename.pdf` or `.pdf`, `.svg`, `.png`, `.dot`
+* `--option key value` for custom annotators
+
+#### Convert a file
+
+Convert a BGV file to the Isabelle graph format.
+
+```
+$ bgv2isabelle 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]
+...
+```
+
+## 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
+
+## Configuration
+
+Seafoam loads and runs a Ruby script called `~/.seafoam/config` in the first
+directory it finds starting with the current working directory and moving up.
+You can require or configure extra [annotators](docs/annotators.md) in this
+file.
+
+## Debugging
+
+Exception backtraces are printed if `$DEBUG` (`-d`) is set.
+
+Use `seafoam file.bgv debug` to debug file parsing.
+
+## More documentation
+
+* [Graph annotators](docs/annotators.md)
+* [Details of the BGV file format](docs/bgv.md)
+* [How to get graphs from various compilers](docs/getting-graphs.md)
+
+## Frequently asked questions
+
+#### Why is it called *Seafoam*?
+
+GraalVM graphs are *seas of nodes*. Seafoam is a shade of green, and Seafoam was
+written at Shopify, which has green as a brand colour. Graphs can sometimes be
+very complicated, appearing like a foam without any structure - Seafoam tries to
+help you make sense of it all.
+
+#### What do you mean by *graphs*, and *seas* or *soups* of nodes?
+
+Graphs, as in edges and nodes, are the data structure some compilers use to
+represent your program while they're compiling it. It's a form of *intermediate
+representation*. Graphs are how the compiler understands the programs and if the
+compiler isn't doing what you want you need to look at the graph and make sense
+of it. Some graphs are loosely structured and large, making them like a sea or
+soup of nodes.
+
+#### Doesn't *reduce edges* actually introduce more edges?
+
+Yes, but they're shorter edges, and it achieves the intended effect of less
+edges crossing over the graph.
+
+## Related work
+
+The graph layout algorithm we use, via Graphviz, is
+
+* E. R. Gansner, et al, [*A Technique for Drawing Directed Graphs*](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.3.8982), IEEE Transactions on Software Engineering, 1993
+
+IGV is the existing tool for working with Graal graphs. It uses a *hierarchical*
+layout algorithm, rather than the *force directed* algorithm we use when we use
+Graphviz. It's based on the NetBeans IDE platform. It's related to the *C1
+Visualiser*, for control-flow graphs. The C1 Visualiser can also be used with
+Graal as the backend of Graal is similar enough to C1. IGV is closed-source and
+available under a proprietary licence.
+
+* T. Würthinger, [*Visualization of Program Dependence Graphs*](http://www.ssw.uni-linz.ac.at/Research/Papers/Wuerthinger07Master/), Master Thesis, Linz 2007
+* T. Würthinger, [*Visualization of Java Control Flow Graphs*](http://www.ssw.uni-linz.ac.at/General/Staff/TW/Wuerthinger06Bachelor.pdf), Bachelor Thesis, Linz 2006
+
+[*Turbolizer*][turbolizer] is a similar tool for the intermediate representation
+in the V8 JavaScript compiler.
+
+[turbolizer]: https://github.com/v8/v8/blob/4b9b23521e6fd42373ebbcb20ebe03bf445494f9/tools/turbolizer
+
+## Author
+
+Seafoam was written by Chris Seaton at Shopify, chris.seaton@shopify.com.
+
+## License
+
+MIT