fisk 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f19e819ce868069b32edffc8cadcbd3d37a4253fb0686e2533a8cbea7010d5
-  data.tar.gz: 1ff93558aa1c0d28c14a312e395ae0b8b675a8d0b11c650cc7cf6ee57bc52257
+  metadata.gz: f39cf1256e6c2030ee2f0dee50d91995cb2efff76d457a5f4c9eb25ca543059b
+  data.tar.gz: c4b92832e08b09b3660efeea2f1c3a629053cc4651ce7f224404e3065a7c8640
 SHA512:
-  metadata.gz: b5396abb6b83733b3bb6022f615ed51f6fe8120d557b0162e913dd7e958d01b5864db51f7ac41145e362a711eee25d38915882059dd206e161ca4e3590cf6420
-  data.tar.gz: d51e976bbc92c2682fe5287fc632618bb031805b0b1ace07f1a71481cc2cd2ae5f69c45fcab83821799cc0939f97b11761d237cfca7c3f6b360df82e1e14aa8f
+  metadata.gz: a8d6c2be54f415b76997a3ffd76ee1f690a7088c17df3a83efb9b6b2830804e6621d89c8b1aeb2b935f954d6efade6d8cc5480bf203078663d1e5a17a75f311c
+  data.tar.gz: e1368e7bab672530a501aea3e201cdd2f72f5083708102d631165b4468df56a842a9a36d8399a901d4c46d750a4c16f195059b2a7868fbc97a216f222f8bada9

data/.github/workflows/ci.yml

@@ -29,7 +29,6 @@ jobs:
         uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
         with:
           ruby-version: 3.0
-      - name: Install dependencies
-        run: bundle install
+          bundler-cache: true # 'bundle install' and cache
       - name: Run tests
         run: bundle exec rake

data/README.md

@@ -171,3 +171,8 @@ Target 0: (ruby) stopped.
     frame #32: 0x00007fff20530621 libdyld.dylib`start + 1
     frame #33: 0x00007fff20530621 libdyld.dylib`start + 1
 ```
+
+Note that in order to produce a stack trace like the above, the Ruby binary must include the debugging symbols (otherwise, the `ruby` frames will not be displayed); this is accomplished by specifying the `--ggdb3` compiler flag:
+
+- if compiling Ruby from source, use `./configure optflags=-gddb3` in the build process
+- if using a version manager, refer to the help; example for RVM: `optflags="-ggdb3" rvm install 3.0.2 --disable-binary`

data/bin/instructions.rb.erb

@@ -22,7 +22,16 @@ class Fisk
     end
 
     Form        = Struct.new(:operands, :encodings)
-    Instruction = Struct.new(:name, :forms)
+    Instruction = Struct.new(:name, :forms) do
+      def check_performance(operands)
+        case name
+        when Instructions::MOV.name
+          if operands[0].register? && operands[1].register? && operands[0].name == operands[1].name
+            return "MOV with same register (#{operands[0].name})"
+          end
+        end
+      end
+    end
 
     OPERAND_TYPES = [
 <%-

data/lib/fisk/errors.rb

@@ -3,6 +3,10 @@ class Fisk
     class Error < StandardError
     end
 
+    # Raised when an instruction isn't found or can't be generated
+    class InvalidInstructionError < Error
+    end
+
     # Raised when a temporary register is released more than once
     class AlreadyReleasedError < Error
     end
@@ -31,5 +35,16 @@ class Fisk
     # `put_label` with the same name twice
     class LabelAlreadyDefined < Error
     end
+
+    # Raised when the performance check is enabled, and suboptimal instructions
+    # are found.
+    class SuboptimalPerformance < Error
+      attr_reader :warnings
+
+      def initialize(warnings)
+        super "Suboptimal instructions found!"
+        @warnings = warnings
+      end
+    end
   end
 end

data/lib/fisk/instructions.rb

@@ -36,7 +36,16 @@ class Fisk
     end
 
     Form        = Struct.new(:operands, :encodings)
-    Instruction = Struct.new(:name, :forms)
+    Instruction = Struct.new(:name, :forms) do
+      def check_performance(operands)
+        case name
+        when Instructions::MOV.name
+          if operands[0].register? && operands[1].register? && operands[0].name == operands[1].name
+            return "MOV with same register (#{operands[0].name})"
+          end
+        end
+      end
+    end
 
     OPERAND_TYPES = [
       Operand.new("al", true, true),

data/lib/fisk/version.rb

@@ -1,3 +1,3 @@
 class Fisk
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/lib/fisk.rb

@@ -20,6 +20,22 @@ class Fisk
     def absolute_location?; false; end
   end
 
+  module OperandSize
+    def compute_size type
+      return 128 if type.start_with?('xmm')
+
+      bits = type[/^r(\d+)$/, 1]&.to_i
+
+      if bits.nil?
+        raise ArgumentError, "Unexpected register type (#{type}); 'r<bits>' expected"
+      elsif bits % 8 != 0
+        raise ArgumentError, "Unexpected register size (#{bits}); multiple of 8 expected"
+      else
+        bits
+      end
+    end
+  end
+
   class Operand
     include OperandPredicates
 
@@ -47,12 +63,15 @@ class Fisk
 
   module Registers
     class Register < Operand
-      attr_reader :name, :type, :value
+      include OperandSize
+
+      attr_reader :name, :type, :value, :size
 
       def initialize name, type, value
         @name = name
         @type = type
         @value = value
+        @size = compute_size(type)
       end
 
       def works? op
@@ -104,7 +123,9 @@ class Fisk
     end
 
     class Temp < Operand
-      attr_reader :name, :type
+      include OperandSize
+
+      attr_reader :name, :type, :size
       attr_accessor :register, :start_point, :end_point
 
       def initialize name, type
@@ -112,6 +133,7 @@ class Fisk
         @type        = type
         @start_point = nil
         @end_point   = nil
+        @size        = compute_size(type)
       end
 
       def temp_register?; true; end
@@ -508,9 +530,15 @@ class Fisk
     end
   end
 
-  def initialize
+  # params:
+  #   :check_performance: Raise a SuboptimalPerformance error on write if suboptimal
+  #                       instructions are detected.
+  #
+  def initialize check_performance: false
     @instructions = []
     @labels = {}
+    @check_performance = check_performance
+    @performance_warnings = []
     # A set of temp registers recorded as we see them (not at allocation time)
     @temp_registers = Set.new
     yield self if block_given?
@@ -763,6 +791,8 @@ class Fisk
 
   # Encode all instructions and write them to +buffer+.  +buffer+ should be an
   # IO object.
+  # If the performance check is enabled, a runtime error is raised if suboptimal
+  # instructions are found.
   def write_to buffer, metadata: {}
     labels = {}
     comments = {}
@@ -777,7 +807,7 @@ class Fisk
       elsif insn.comment?
         comments.update({buffer.pos => insn.message}) { |_, *lines| lines.join($/) }
       elsif insn.lazy?
-        insn.encode buffer, labels
+        write_instruction insn, buffer, labels
         instructions.unshift(*@instructions)
         @instructions.clear
       else
@@ -793,19 +823,24 @@ class Fisk
     metadata[:comments] = comments
     @instructions = backup
 
-    return if unresolved.empty?
+    if !unresolved.empty?
+      pos = buffer.pos
+      unresolved.each do |req|
+        insn = req.insn
+        buffer.seek req.io_seek_pos, IO::SEEK_SET
+        write_instruction insn, buffer, labels
+      end
+      buffer.seek pos, IO::SEEK_SET
+    end
 
-    pos = buffer.pos
-    unresolved.each do |req|
-      insn = req.insn
-      buffer.seek req.io_seek_pos, IO::SEEK_SET
-      insn.encode buffer, labels
+    if !@performance_warnings.empty?
+      raise Errors::SuboptimalPerformance.new(@performance_warnings)
     end
-    buffer.seek pos, IO::SEEK_SET
 
     buffer
   end
 
+  # If the performance check is enabled, warnings are added to @performance_warnings.
   def gen_with_insn insns, params
     forms = insns.forms.find_all do |insn|
       if insn.operands.length == params.length
@@ -826,7 +861,7 @@ class Fisk
       Valid forms:
       #{valid_forms}
       eostr
-      raise NotImplementedError, msg
+      raise Errors::InvalidInstructionError, msg
     end
 
     form = forms.first
@@ -857,7 +892,14 @@ class Fisk
       end
     end
 
-    insn ||= Instruction.new(insns, form, params)
+    if insn.nil?
+      insn = Instruction.new(insns, form, params)
+
+      if @check_performance
+        warning = insns.check_performance(params)
+        @performance_warnings << warning if warning
+      end
+    end
 
     @instructions << insn
 

data/test/helper.rb

@@ -4,6 +4,18 @@ require "crabstone"
 ENV["MT_NO_PLUGINS"] = "1"
 require "minitest/autorun"
 
+# https://github.com/bnagy/crabstone/issues/10
+class Crabstone::Binding::Instruction
+  class << self
+    alias :old_release :release
+  end
+
+  # Squelch error in crabstone
+  def self.release obj
+    nil
+  end
+end
+
 class Fisk::Test < Minitest::Test
   def print_disasm binary
     cs = Crabstone::Disassembler.new(Crabstone::ARCH_X86, Crabstone::MODE_64)

data/test/test_fisk.rb

@@ -163,6 +163,12 @@ class FiskTest < Fisk::Test
     assert_equal sprintf("%#02x", expected_pos), i.op_str.to_s
   end
 
+  def test_invalid_instruction
+    assert_raises(Fisk::Errors::InvalidInstructionError) do
+      fisk.mov(fisk.imm(5), fisk.imm(5))
+    end
+  end
+
   %w{ rax rcx rdx rbx rsp rbp rsi rdi r8 r9 r10 }.each do |reg|
     define_method "test_#{reg}_to_offset" do
       fisk.lea(fisk.send(reg), fisk.rip(15))

data/test/test_fisk_written_size.rb

@@ -9,7 +9,12 @@ class Fisk
       def write_instruction insn, buffer, labels
         pos = buffer.pos
         x = insn.encode buffer, labels
-        raise unless x == buffer.pos - pos
+
+        if insn.lazy?
+          raise unless buffer.pos = pos
+        else
+          raise unless x == buffer.pos - pos
+        end
       end
     end
 

data/test/test_performance_check.rb

@@ -0,0 +1,32 @@
+require "helper"
+
+class Fisk
+  class PerformanceCheckTest < Fisk::Test
+    include Registers
+
+    attr_reader :fisk
+
+    def setup
+      super
+      @fisk = Fisk.new check_performance: true
+    end
+
+    def test_mov_same_register
+      buf = StringIO.new(''.b)
+
+      fisk.mov R9, R9
+      fisk.mov RAX, RAX
+
+      error = assert_raises Errors::SuboptimalPerformance do
+        fisk.write_to buf
+      end
+
+      expected_warnings = [
+        "MOV with same register (r9)",
+        "MOV with same register (rax)",
+      ]
+
+      assert_equal error.warnings, expected_warnings
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fisk
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Aaron Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -1321,6 +1321,7 @@ files:
 - test/test_cfg.rb
 - test/test_fisk.rb
 - test/test_fisk_written_size.rb
+- test/test_performance_check.rb
 - test/test_register_allocation.rb
 - test/test_run_fisk.rb
 homepage: https://github.com/tenderlove/fisk
@@ -1351,5 +1352,6 @@ test_files:
 - test/test_cfg.rb
 - test/test_fisk.rb
 - test/test_fisk_written_size.rb
+- test/test_performance_check.rb
 - test/test_register_allocation.rb
 - test/test_run_fisk.rb