seafoam 0.2 → 0.7

data/lib/seafoam.rb

@@ -1,13 +1,17 @@
 require 'seafoam/version'
 require 'seafoam/binary/io_binary_reader'
-require 'seafoam/binary/binary_reader'
 require 'seafoam/bgv/bgv_parser'
+require 'seafoam/cfg/cfg_parser'
+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/spotlight'
+require 'seafoam/isabelle_writer'
+require 'seafoam/json_writer'
 require 'seafoam/graphviz_writer'
 require 'seafoam/config'
 require 'seafoam/commands'

data/lib/seafoam/annotators/graal.rb

@@ -357,7 +357,7 @@ module Seafoam
       TRIGGERS = %w[
         HostedGraphBuilderPhase
         GraalCompiler
-        TruffleCompilerThread
+        TruffleCompiler
       ]
 
       # Simple input node classes that may be inlined.

data/lib/seafoam/bgv/bgv_parser.rb

@@ -1,3 +1,6 @@
+require 'stringio'
+require 'zlib'
+
 module Seafoam
   module BGV
     # A parser for BGV files. It's a push-pull streaming interface that you need
@@ -5,8 +8,12 @@ module Seafoam
     # and some code is duplicated in order to support skipping over parts of the
     # file that you don't need.
     class BGVParser
-      def initialize(source)
-        @reader = Binary::BinaryReader.for(source)
+      def initialize(file)
+        data = File.read(file, encoding: Encoding::ASCII_8BIT)
+        if data[0..1].bytes == [0x1f, 0x8b]
+          data = Zlib.gunzip(data)
+        end
+        @reader = Binary::IOBinaryReader.new(StringIO.new(data))
         @group_stack = []
         @pool = {}
         @index = 0
@@ -164,6 +171,9 @@ module Seafoam
             break true
           when CLOSE_GROUP
             read_close_group
+          when BEGIN_DOCUMENT
+            # But what should we do with them?
+            skip_props
           else
             raise EncodingError, "unknown token 0x#{token.to_s(16)} beginning BGV object"
           end

data/lib/seafoam/cfg/cfg_parser.rb

@@ -0,0 +1,93 @@
+require 'stringio'
+require 'zlib'
+
+module Seafoam
+  module CFG
+    Code = Struct.new(:arch, :arch_width, :base, :code)
+    Comment = Struct.new(:offset, :comment)
+    NMethod = Struct.new(:code, :comments)
+
+    # A parser for CFG files.
+    class CFGParser
+      def initialize(out, file)
+        @out = out
+        data = File.read(file, encoding: Encoding::ASCII_8BIT)
+        if data[0..1].bytes == [0x1f, 0x8b]
+          data = Zlib.gunzip(data)
+        end
+        @reader = StringIO.new(data)
+        @state = :any
+        @cfg_name = nil
+      end
+
+      def skip_over_cfg(name)
+        loop do
+          line = @reader.readline("\n")
+          case line
+          when "begin_cfg\n"
+            @state = :cfg
+            @cfg_name = nil
+          when /  name "(.*)"\n/
+            if @state == :cfg
+              @cfg_name = Regexp.last_match(1)
+            end
+          when "end_cfg\n"
+            raise unless @state == :cfg
+
+            @state = :any
+            break if @cfg_name == name
+          else
+            next
+          end
+        end
+      end
+
+      def read_nmethod
+        raise unless @state == :any
+
+        arch = nil
+        arch_width = nil
+        code = nil
+        comments = []
+        raise unless @reader.readline == "begin_nmethod\n"
+
+        loop do
+          line = @reader.readline("\n")
+          case line
+          when /  Platform (.*) (.*)  <\|\|@\n/
+            arch = Regexp.last_match(1)
+            arch_width = Regexp.last_match(2)
+          when /  HexCode (.*) (.*)  <\|\|@\n/
+            base = Regexp.last_match(1).to_i(16)
+            code = [Regexp.last_match(2)].pack('H*')
+            raise if arch.nil? || arch_width.nil?
+
+            code = Code.new(arch, arch_width, base, code)
+          when /  Comment (\d*) (.*)  <\|\|@\n/
+            offset = Regexp.last_match(1).to_i
+            comment = Regexp.last_match(2)
+            comments.push Comment.new(offset, comment)
+          when "  <<<HexCodeFile\n"
+            next
+          when "  HexCodeFile>>> <|@\n"
+            next
+          when "end_nmethod\n"
+            break
+          when /  (.*)  <\|\|@\n/
+            offset = -1
+            comment = Regexp.last_match(1)
+            comments.push Comment.new(offset, comment)
+          when /  (.*)\n/
+            offset = -1
+            comment = Regexp.last_match(1)
+            comments.push Comment.new(offset, comment)
+          else
+            # In case anything was missed
+            raise 'There is currently no case for this line. Please open an issue so it can be addressed.'
+          end
+        end
+        NMethod.new(code, comments)
+      end
+    end
+  end
+end

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,31 @@ 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 '               --option key value'
+        @out.puts '        --help'
+        @out.puts '        --version'
       when 'version', '-v', '-version', '--version'
         version(*args)
       else
@@ -32,6 +51,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 +63,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
@@ -51,7 +207,7 @@ module Seafoam
 
       raise ArgumentError, 'info does not take arguments' unless args.empty?
 
-      parser = BGV::BGVParser.new(File.new(file))
+      parser = BGV::BGVParser.new(file)
       major, minor = parser.read_file_header(version_check: false)
       @out.puts "BGV #{major}.#{minor}"
     end
@@ -63,7 +219,7 @@ module Seafoam
 
       raise ArgumentError, 'list does not take arguments' unless args.empty?
 
-      parser = BGV::BGVParser.new(File.new(file))
+      parser = BGV::BGVParser.new(file)
       parser.read_file_header
       parser.skip_document_props
       loop do
@@ -81,7 +237,7 @@ module Seafoam
       file, graph_index, node_id, = parse_name(name)
       raise ArgumentError, 'search only works with a file or graph' if node_id
 
-      parser = BGV::BGVParser.new(File.new(file))
+      parser = BGV::BGVParser.new(file)
       parser.read_file_header
       parser.skip_document_props
       loop do
@@ -211,14 +367,31 @@ module Seafoam
           end
         end
       else
-        parser = BGV::BGVParser.new(File.new(file))
+        parser = BGV::BGVParser.new(file)
         parser.read_file_header
         document_props = parser.read_document_props
         pretty_print document_props || {}
       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
@@ -299,10 +472,14 @@ module Seafoam
             writer.write_graph graph
           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
+            end
+          rescue Errno::ENOENT
+            raise 'Could not run Graphviz - is it installed?'
           end
           autoopen out_file unless explicit_out_file
         end
@@ -368,7 +545,7 @@ module Seafoam
     # Reads a file and yields just the graph requested by the index - skipping
     # the rest of the file as best as possible.
     def with_graph(file, graph_index)
-      parser = BGV::BGVParser.new(File.new(file))
+      parser = BGV::BGVParser.new(file)
       parser.read_file_header
       parser.skip_document_props
       graph_found = false
@@ -388,27 +565,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?
@@ -418,8 +574,12 @@ module Seafoam
 
     # Parse a name like file.bgv:g:n-e to [file.bgv, g, n, e].
     def parse_name(name)
-      *pre, file, graph, node = name.split(':')
-      file = [*pre, file].join(':')
+      *pre, post = name.split('.')
+
+      file_ext, graph, node, *rest = post.split(':')
+      raise ArgumentError, "too many parts to .ext:g:n-e in #{name}" unless rest.empty?
+
+      file = [*pre, file_ext].join('.')
 
       if node
         node, edge, *rest = node.split('-')