seafoam 0.3 → 0.8

data/lib/seafoam/cfg/disassembler.rb

@@ -0,0 +1,70 @@
+require 'stringio'
+
+module Seafoam
+  module CFG
+    # Disassemble and print comments from cfg files
+    class Disassembler
+      def initialize(out)
+        @out = out
+      end
+
+      def disassemble(nmethod, print_comments)
+        require_crabstone
+
+        comments = nmethod.comments
+        comments_n = 0
+
+        case [nmethod.code.arch, nmethod.code.arch_width]
+        when %w[AMD64 64]
+          crabstone_arch = [Crabstone::ARCH_X86, Crabstone::MODE_64]
+        else
+          raise "Unknown architecture #{nmethod.code.arch} and bit width #{nmethod.code.arch_width}"
+        end
+
+        cs = Crabstone::Disassembler.new(*crabstone_arch)
+        begin
+          cs.disasm(nmethod.code.code, nmethod.code.base).each do |i|
+            if print_comments
+              # Print comments associated to the instruction.
+              last_comment = i.address + i.bytes.length - nmethod.code.base
+              while comments_n < comments.length && comments[comments_n].offset < last_comment
+                if comments[comments_n].offset == -1
+                  @out.printf("\t\t\t\t;%<comment>s\n", comment: comments[comments_n].comment)
+                else
+                  @out.printf(
+                    "\t\t\t\t;Comment %<loc>i:\t%<comment>s\n",
+                    loc: comments[comments_n].offset,
+                    comment: comments[comments_n].comment
+                  )
+                end
+                comments_n += 1
+              end
+            end
+
+            # Print the instruction.
+            @out.printf(
+              "\t0x%<address>x:\t%<instruction>s\t%<details>s\n",
+              address: i.address,
+              instruction: i.mnemonic,
+              details: i.op_str
+            )
+          end
+        rescue StandardError => e
+          raise "Disassembly error: #{e.message}"
+        ensure
+          cs.close
+        end
+      end
+
+      def require_crabstone
+        require 'crabstone'
+      rescue LoadError => e
+        if $DEBUG
+          raise e
+        else
+          raise 'Could not load Capstone - is it installed?'
+        end
+      end
+    end
+  end
+end

data/lib/seafoam/commands.rb

@@ -8,12 +8,32 @@ module Seafoam
       @config = config
     end
 
-    # Run any command.
-    def run(*args)
+    # Run the general seafoam command.
+    def seafoam(*args)
       first, *args = args
       case first
       when nil, 'help', '-h', '--help', '-help'
-        help(*args)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'seafoam file.bgv info'
+        @out.puts '        file.bgv list'
+        @out.puts '        file.bgv[:graph][:node[-edge]] search term...'
+        @out.puts '        file.bgv[:graph][:node[-edge]] edges'
+        @out.puts '        file.bgv[:graph][:node[-edge]] props'
+        @out.puts '        file.bgv:graph:node source'
+        @out.puts '        file.bgv:graph render'
+        @out.puts '              --spotlight n,n,n...'
+        @out.puts '              --out graph.pdf'
+        @out.puts '                    graph.svg'
+        @out.puts '                    graph.png'
+        @out.puts '                    graph.dot'
+        @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'
       when 'version', '-v', '-version', '--version'
         version(*args)
       else
@@ -32,6 +52,8 @@ module Seafoam
           edges name, *args
         when 'props'
           props name, *args
+        when 'source'
+          source name, *args
         when 'render'
           render name, *args
         when 'debug'
@@ -42,6 +64,141 @@ module Seafoam
       end
     end
 
+    # Run the bgv2isabelle command.
+    def bgv2isabelle(*args)
+      case args.first
+      when nil, 'help', '-h', '--help', '-help'
+        args = args.drop(1)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'bgv2isabelle file.bgv...'
+        @out.puts '             --help'
+        @out.puts '             --version'
+      when 'version', '-v', '-version', '--version'
+        args = args.drop(1)
+        version(*args)
+      else
+        files = []
+
+        until args.empty?
+          arg = args.shift
+          if arg.start_with?('-')
+            raise ArgumentError, "unknown option #{arg}"
+          else
+            files.push arg
+          end
+        end
+
+        writer = IsabelleWriter.new(@out)
+
+        files.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
+            name = parser.graph_name(graph_header)
+            graph = parser.read_graph
+
+            writer.write index, name, graph
+          end
+        end
+      end
+    end
+
+    def bgv2json(*args)
+      case args.first
+      when nil, 'help', '-h', '--help', '-help'
+        args = args.drop(1)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'bgv2json file.bgv...'
+        @out.puts '         --help'
+        @out.puts '         --version'
+      when 'version', '-v', '-version', '--version'
+        args = args.drop(1)
+        version(*args)
+      else
+        files = []
+
+        until args.empty?
+          arg = args.shift
+          if arg.start_with?('-')
+            raise ArgumentError, "unknown option #{arg}"
+          else
+            files.push arg
+          end
+        end
+
+        writer = JSONWriter.new(@out)
+
+        files.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
+            name = parser.graph_name(graph_header)
+            graph = parser.read_graph
+
+            writer.write name, graph
+          end
+        end
+      end
+    end
+
+    def cfg2asm(*args)
+      case args.first
+      when nil, 'help', '-h', '--help', '-help'
+        args = args.drop(1)
+        raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+        @out.puts 'cfg2asm file.bgv...'
+        @out.puts '            --no-comments'
+        @out.puts '        --help'
+        @out.puts '        --version'
+      when 'version', '-v', '-version', '--version'
+        args = args.drop(1)
+        version(*args)
+      else
+        comments = true
+        files = []
+
+        until args.empty?
+          arg = args.shift
+          if arg.start_with?('-')
+            case arg
+            when '--no-comments'
+              comments = false
+            else
+              raise ArgumentError, "unknown option #{arg}"
+            end
+          else
+            files.push arg
+          end
+        end
+
+        files.each_with_index do |file, n|
+          parser = Seafoam::CFG::CFGParser.new(@out, file)
+          parser.skip_over_cfg 'After code installation'
+          nmethod = parser.read_nmethod
+
+          disassembler = Seafoam::CFG::Disassembler.new(@out)
+          @out.puts if n.positive?
+          @out.puts "[#{file}]"
+          disassembler.disassemble(nmethod, comments)
+        end
+      end
+    end
+
     private
 
     # seafoam file.bgv info
@@ -218,7 +375,24 @@ module Seafoam
       end
     end
 
-    # seafoam file.bgv:0 render options...
+    # seafoam file.bgv:n:n source
+    def source(name, *args)
+      file, graph_index, node_id, edge_id = parse_name(name)
+      raise ArgumentError, 'source needs a node' unless node_id
+      raise ArgumentError, 'source only works with a node' if edge_id
+      raise ArgumentError, 'source does not take arguments' unless args.empty?
+
+      with_graph(file, graph_index) do |parser|
+        parser.read_graph_header
+        graph = parser.read_graph
+        node = graph.nodes[node_id]
+        raise ArgumentError, 'node not found' unless node
+
+        @out.puts Graal::Source.render(node.props['nodeSourcePosition'])
+      end
+    end
+
+    # seafoam file.bgv:n render options...
     def render(name, *args)
       file, graph_index, *rest = parse_name(name)
       raise ArgumentError, 'render needs at least a graph' unless graph_index
@@ -233,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
@@ -251,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
@@ -296,13 +473,17 @@ 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
-          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
+          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, draw_blocks
+            end
+          rescue Errno::ENOENT
+            raise 'Could not run Graphviz - is it installed?'
           end
           autoopen out_file unless explicit_out_file
         end
@@ -388,27 +569,6 @@ module Seafoam
       raise ArgumentError, 'graph not found' unless graph_found
     end
 
-    # Prints help.
-    def help(*args)
-      raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
-
-      @out.puts 'seafoam file.bgv info'
-      @out.puts '        file.bgv list'
-      @out.puts '        file.bgv[:graph][:node[-edge]] search term...'
-      @out.puts '        file.bgv[:graph][:node[-edge]] edges'
-      @out.puts '        file.bgv[:graph][:node[-edge]] props'
-      @out.puts '        file.bgv:graph render'
-      @out.puts '              --spotlight n,n,n...'
-      @out.puts '              --out graph.pdf'
-      @out.puts '                    graph.svg'
-      @out.puts '                    graph.png'
-      @out.puts '                    graph.dot'
-      @out.puts '               --show-frame-state'
-      @out.puts '               --hide-floating'
-      @out.puts '               --no-reduce-edges'
-      @out.puts '               --option key value'
-    end
-
     # Prints the version.
     def version(*args)
       raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?

data/lib/seafoam/graal/source.rb

@@ -0,0 +1,23 @@
+module Seafoam
+  module Graal
+    # Routines for understanding source positions in Graal.
+    module Source
+      def self.render(source_position)
+        lines = []
+        caller = source_position
+        while caller
+          method = caller[:method]
+          lines.push render_method(method)
+          caller = caller[:caller]
+        end
+        lines.join("\n")
+      end
+
+      def self.render_method(method)
+        declaring_class = method[:declaring_class]
+        name = method[:method_name]
+        "#{declaring_class}##{name}"
+      end
+    end
+  end
+end

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)