cfg2asm 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fe9c7d9795d226dbb31a45071c764468a29e04d416c060145660acd79c1ccf0
+  data.tar.gz: dcac08b911bc46c252629bf150079d81c648d02f0c6be93b36612a5b344907d5
+SHA512:
+  metadata.gz: 1b1c86cc939e77ae3ee16fb0ba796dcc2f6a0bae19287f88f2a121cb125bed6a1fcac8e7030a04aa212cfcea2bb6b07b8f45dbfdbbe398af18b877eff5cfdf24
+  data.tar.gz: 5b3433186dbf48aab5d00b817f4ba3151ee663394dfac98c22cee9ac57e1e8bcfd456abdd381f05693b8a429751c16856eb3b2dde9a4ae8e725cf938e26d9bc3

data/bin/cfg2asm

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'cfg2asm'
+
+# This is the 'cfg2asm' command line entry point.
+
+begin
+  # Run the command line.
+  commands = Cfg2asm::Commands.new($stdout)
+  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/lib/cfg2asm/cfg/cfg_parser.rb

@@ -0,0 +1,93 @@
+require 'stringio'
+require 'zlib'
+
+module Cfg2asm
+  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/cfg2asm/cfg/disassembler.rb

@@ -0,0 +1,70 @@
+require 'stringio'
+
+module Cfg2asm
+  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/cfg2asm/commands.rb

@@ -0,0 +1,62 @@
+require 'json'
+require 'set'
+
+module Cfg2asm
+  # Implementations of the command-line commands that you can run in Seafoam.
+  class Commands
+    def initialize(out)
+      @out = out
+    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 = Cfg2asm::CFG::CFGParser.new(@out, file)
+          parser.skip_over_cfg 'After code installation'
+          nmethod = parser.read_nmethod
+
+          disassembler = Cfg2asm::CFG::Disassembler.new(@out)
+          @out.puts if n.positive?
+          @out.puts "[#{file}]"
+          disassembler.disassemble(nmethod, comments)
+        end
+      end
+    end
+
+    # Prints the version.
+    def version(*args)
+      raise ArgumentError, "unexpected arguments #{args.join(' ')}" unless args.empty?
+
+      @out.puts "cfg2asm #{VERSION}"
+    end
+  end
+end

data/lib/cfg2asm/version.rb

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

data/lib/cfg2asm.rb

@@ -0,0 +1,4 @@
+require 'cfg2asm/version'
+require 'cfg2asm/cfg/cfg_parser'
+require 'cfg2asm/cfg/disassembler'
+require 'cfg2asm/commands'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: cfg2asm
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Chris Seaton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-16 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.81'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.81'
+description:
+email:
+executables:
+- cfg2asm
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cfg2asm
+- lib/cfg2asm.rb
+- lib/cfg2asm/cfg/cfg_parser.rb
+- lib/cfg2asm/cfg/disassembler.rb
+- lib/cfg2asm/commands.rb
+- lib/cfg2asm/version.rb
+homepage: https://github.com/Shopify/cfg2asm
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A tool for disassembling Graal CFG files
+test_files: []