fisk 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd9dadadf62c43af7898876779ad80e10ab4883cd69ea599b02631efb068e817
-  data.tar.gz: abf1ec8a5b3e61e5fc45abe9b59e74349e91924f9a073179f0db186a686229a6
+  metadata.gz: 69f19e819ce868069b32edffc8cadcbd3d37a4253fb0686e2533a8cbea7010d5
+  data.tar.gz: 1ff93558aa1c0d28c14a312e395ae0b8b675a8d0b11c650cc7cf6ee57bc52257
 SHA512:
-  metadata.gz: 1586760e58ade58534d5e22ca7ee56c0b5faa25d12ec3028c51c82543a65b86025f7d5bc35fe6dc14c8cc1cb9948cb736a669210b1c92e5fc96bb692e21e6837
-  data.tar.gz: 903f6d801e036ca5084e5111bafa06ebf601d5a27b8adc48e25b9200b67ef4de4be6f2998ed4589c934d54fddbdafe7fa7536ff649647fc1e04319270b85e3b0
+  metadata.gz: b5396abb6b83733b3bb6022f615ed51f6fe8120d557b0162e913dd7e958d01b5864db51f7ac41145e362a711eee25d38915882059dd206e161ca4e3590cf6420
+  data.tar.gz: d51e976bbc92c2682fe5287fc632618bb031805b0b1ace07f1a71481cc2cd2ae5f69c45fcab83821799cc0939f97b11761d237cfca7c3f6b360df82e1e14aa8f

data/README.md

@@ -1,4 +1,4 @@
-# Fisk - A Pure Ruby Assembler
+# Fisk - A Pure Ruby x86-64 Assembler
 
 Tired of writing Ruby in Ruby?  Now you can write assembly in Ruby with Fisk!
 

data/bin/instruction.rb.erb

@@ -3,7 +3,8 @@
 class Fisk
   module Instructions
 <%- name = instruction["name"] -%>
-    # Instruction <%= name %>
+<%- summary = instruction["summary"] -%>
+    # Instruction <%= name %>: <%= summary %>
     <%= name %> = Instruction.new(<%= name.dump %>, [
   <%-
     instruction.children.each do |form|

data/bin/instructions.rb.erb

@@ -6,14 +6,35 @@ require "fisk/encoding"
 
 class Fisk
   module Instructions
-    Operand     = Struct.new(:type, :input, :output)
+    Operand     = Struct.new(:type, :input, :output) do
+      def immediate?; false; end
+    end
+
+    class Immediate < Operand
+      attr_reader :size
+
+      def initialize type, input, output, size
+        super(type, input, output)
+        @size = size
+      end
+
+      def immediate?; true; end
+    end
+
     Form        = Struct.new(:operands, :encodings)
     Instruction = Struct.new(:name, :forms)
 
     OPERAND_TYPES = [
-<%- unique_operands.each do |u_op| -%>
+<%-
+  unique_operands.each do |u_op|
+    if u_op[0] =~ /^imm(\d+)$/
+      size = $1.to_i
+-%>
+      Immediate.new(<%= u_op[0].dump %>, <%= u_op[1] || "nil" %>, <%= u_op[2] || "nil" %>, <%= size %>),
+<%- else -%>
       Operand.new(<%= u_op[0].dump %>, <%= u_op[1] || "nil" %>, <%= u_op[2] || "nil" %>),
-<% end %>
+<%- end -%>
+<%- end -%>
     ]
 
     def self.instruction_names

data/lib/fisk/encoding.rb

@@ -3,28 +3,45 @@ class Fisk
     private
 
     def add_modrm buffer, mode, reg, rm, operands
-      offset_bytes = 0
       if mem = operands.find(&:memory?)
-        if mem.displacement != 0
-          if mem.displacement >= -0x7F - 1 && mem.displacement < 0x7F
-            offset_bytes = 1
-            mode |= 0x1
-          else
-            offset_bytes = 4
-            mode |= 0x2
-          end
+        add_modrm_mem mem, buffer, mode, reg, rm
+      else
+        buffer.putc ((mode << 6) | ((reg & 0x7) << 3) | (rm & 0x7))
+        1
+      end
+    end
+
+    def add_modrm_mem mem, buffer, mode, reg, rm
+      offset_bytes = 0
+      if mem.displacement != 0 || (rm & 0x7) == 5 # RBP / r13 needs an offset
+        if mem.displacement >= -0x7F - 1 && mem.displacement < 0x7F
+          offset_bytes = 1
+          mode |= 0x1
+        else
+          offset_bytes = 4
+          mode |= 0x2
         end
       end
-      reg = reg & 0x7
-      rm = rm & 0x7
-      buffer.putc ((mode << 6) | (reg << 3) | rm)
-      if mem && mem.displacement != 0
-        1 + write_num(buffer, mem.displacement, offset_bytes)
+
+      count = 1
+
+      modrm_byte = ((mode << 6) | ((reg & 0x7) << 3) | (rm & 0x7))
+      buffer.putc modrm_byte
+
+      # Needs SIB, Table 2-2
+      if rm & 0x7 == 4 # RSP register / r12
+        count += 1
+        buffer.putc 0x24
+      end
+
+      if mem && (mem.displacement != 0 || (rm & 0x7) == 5)
+        count + write_num(buffer, mem.displacement, offset_bytes)
       else
-        1
+        count
       end
     end
 
+
     # Add ModRM with one mem operand and one register operand
     def add_modrm_mem_reg buffer, mode, reg, rm, operands
       add_modrm_mem_reg_ buffer, mode, reg, rm, operands[0], operands[1]
@@ -36,32 +53,12 @@ class Fisk
     end
 
     def add_modrm_mem_reg_ buffer, mode, reg, rm, mem, reg_opnd
-      offset_bytes = 0
-
       if mem.rip?
         buffer.putc 0x5 + ((reg_opnd.value % 8) * 8)
         return 1 + write_num(buffer, mem.displacement, 4)
       end
 
-      if mem.displacement != 0
-        if mem.displacement >= -0x7F - 1 && mem.displacement < 0x7F
-          offset_bytes = 1
-          mode |= 0x1
-        else
-          offset_bytes = 4
-          mode |= 0x2
-        end
-      end
-
-      reg = reg & 0x7
-      rm = rm & 0x7
-      buffer.putc ((mode << 6) | (reg << 3) | rm)
-
-      if mem.displacement != 0
-        1 + write_num(buffer, mem.displacement, offset_bytes)
-      else
-        1
-      end
+      add_modrm_mem mem, buffer, mode, reg, rm
     end
 
     # Add ModRM with two register operands
@@ -92,6 +89,13 @@ class Fisk
     def add_rex buffer, operands, mandatory, w, r, x, b
       return 0 if mandatory == false && !operands.any?(&:extended_register?)
 
+      if mem = operands.find(&:memory?)
+        if mem.extended_register?
+          x = 0
+          b = 1
+        end
+      end
+
       rex = 0b0100
       rex = (rex << 1) | w
       rex = (rex << 1) | r
@@ -102,7 +106,7 @@ class Fisk
     end
 
     def add_opcode buffer, byte, addend
-      byte |= addend
+      byte |= (addend & 0x7)
       buffer.putc byte
       1
     end

data/lib/fisk/errors.rb

@@ -20,5 +20,16 @@ class Fisk
     # but it's used in the encoding process.
     class UnassignedRegister < Error
     end
+
+    # Raised when a label is used but the location is never defined.  For
+    # example, the `label` method is called, but there is no corresponding
+    # `put_label`
+    class MissingLabel < Error
+    end
+
+    # Raised when a label is defined multiple times.  For example, calling
+    # `put_label` with the same name twice
+    class LabelAlreadyDefined < Error
+    end
   end
 end

data/lib/fisk/helpers.rb

@@ -51,18 +51,21 @@ class Fisk
     class JITBuffer
       attr_reader :memory, :pos
 
-      def initialize memory
+      def initialize memory, size
         @memory = memory
         @pos = 0
+        @size = size
       end
 
       def putc byte
+        raise "Buffer full! #{pos} - #{@size}" if pos >= @size
         @memory[@pos] = byte
         @pos += 1
       end
 
       def seek pos, whence = IO::SEEK_SET
         raise NotImplementedError if whence != IO::SEEK_SET
+        raise if pos >= @size
 
         @pos = pos
         self
@@ -71,10 +74,38 @@ class Fisk
       def to_function params, ret
         Fiddle::Function.new memory.to_i, params, ret
       end
+
+      # Write a jump instruction at location +at+ that jumps to the location
+      # specified by +to+. +type+ specifies the type of jump.  This method
+      # maintains the current position of the cursor inside the memory chunk
+      def patch_jump at:, to:, type: :jmp
+        pos = self.pos
+        write_jump(to: to, at: at, type: type)
+        seek pos, IO::SEEK_SET
+      end
+
+      # Write a jump instruction at location +at+ that jumps to the location
+      # specified by +to+. +type+ specifies the type of jump.  Returns the
+      # position in the buffer where the jump instruction was written.
+      #
+      # This method does not maintain the current position of the cursor
+      def write_jump to:, at: self.pos, type: :jmp
+        rel_jump = 0xCAFE
+        2.times do
+          seek at, IO::SEEK_SET
+          Fisk.new { |__| __.public_send(type, __.rel32(rel_jump)) }.write_to(self)
+          rel_jump = to - address
+        end
+        self.pos
+      end
+
+      def address
+        memory.to_i + pos
+      end
     end
 
     def self.jitbuffer size
-      JITBuffer.new mmap_jit size
+      JITBuffer.new mmap_jit(size), size
     end
   end
 end

data/lib/fisk/instructions/adc.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADC
+    # Instruction ADC: Add with Carry
     ADC = Instruction.new("ADC", [
     # adcb: al, imm8
       Form.new([

data/lib/fisk/instructions/adcx.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADCX
+    # Instruction ADCX: Unsigned Integer Addition of Two Operands with Carry Flag
     ADCX = Instruction.new("ADCX", [
     # adcxl: r32, r32
       Form.new([

data/lib/fisk/instructions/add.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADD
+    # Instruction ADD: Add
     ADD = Instruction.new("ADD", [
     # addb: al, imm8
       Form.new([

data/lib/fisk/instructions/addpd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADDPD
+    # Instruction ADDPD: Add Packed Double-Precision Floating-Point Values
     ADDPD = Instruction.new("ADDPD", [
     # addpd: xmm, xmm
       Form.new([

data/lib/fisk/instructions/addps.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADDPS
+    # Instruction ADDPS: Add Packed Single-Precision Floating-Point Values
     ADDPS = Instruction.new("ADDPS", [
     # addps: xmm, xmm
       Form.new([

data/lib/fisk/instructions/addsd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADDSD
+    # Instruction ADDSD: Add Scalar Double-Precision Floating-Point Values
     ADDSD = Instruction.new("ADDSD", [
     # addsd: xmm, xmm
       Form.new([

data/lib/fisk/instructions/addss.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADDSS
+    # Instruction ADDSS: Add Scalar Single-Precision Floating-Point Values
     ADDSS = Instruction.new("ADDSS", [
     # addss: xmm, xmm
       Form.new([

data/lib/fisk/instructions/addsubpd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADDSUBPD
+    # Instruction ADDSUBPD: Packed Double-FP Add/Subtract
     ADDSUBPD = Instruction.new("ADDSUBPD", [
     # addsubpd: xmm, xmm
       Form.new([

data/lib/fisk/instructions/addsubps.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADDSUBPS
+    # Instruction ADDSUBPS: Packed Single-FP Add/Subtract
     ADDSUBPS = Instruction.new("ADDSUBPS", [
     # addsubps: xmm, xmm
       Form.new([

data/lib/fisk/instructions/adox.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ADOX
+    # Instruction ADOX: Unsigned Integer Addition of Two Operands with Overflow Flag
     ADOX = Instruction.new("ADOX", [
     # adoxl: r32, r32
       Form.new([

data/lib/fisk/instructions/aesdec.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AESDEC
+    # Instruction AESDEC: Perform One Round of an AES Decryption Flow
     AESDEC = Instruction.new("AESDEC", [
     # aesdec: xmm, xmm
       Form.new([

data/lib/fisk/instructions/aesdeclast.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AESDECLAST
+    # Instruction AESDECLAST: Perform Last Round of an AES Decryption Flow
     AESDECLAST = Instruction.new("AESDECLAST", [
     # aesdeclast: xmm, xmm
       Form.new([

data/lib/fisk/instructions/aesenc.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AESENC
+    # Instruction AESENC: Perform One Round of an AES Encryption Flow
     AESENC = Instruction.new("AESENC", [
     # aesenc: xmm, xmm
       Form.new([

data/lib/fisk/instructions/aesenclast.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AESENCLAST
+    # Instruction AESENCLAST: Perform Last Round of an AES Encryption Flow
     AESENCLAST = Instruction.new("AESENCLAST", [
     # aesenclast: xmm, xmm
       Form.new([

data/lib/fisk/instructions/aesimc.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AESIMC
+    # Instruction AESIMC: Perform the AES InvMixColumn Transformation
     AESIMC = Instruction.new("AESIMC", [
     # aesimc: xmm, xmm
       Form.new([

data/lib/fisk/instructions/aeskeygenassist.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AESKEYGENASSIST
+    # Instruction AESKEYGENASSIST: AES Round Key Generation Assist
     AESKEYGENASSIST = Instruction.new("AESKEYGENASSIST", [
     # aeskeygenassist: xmm, xmm, imm8
       Form.new([

data/lib/fisk/instructions/and.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction AND
+    # Instruction AND: Logical AND
     AND = Instruction.new("AND", [
     # andb: al, imm8
       Form.new([

data/lib/fisk/instructions/andn.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ANDN
+    # Instruction ANDN: Logical AND NOT
     ANDN = Instruction.new("ANDN", [
     # andnl: r32, r32, r32
       Form.new([

data/lib/fisk/instructions/andnpd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ANDNPD
+    # Instruction ANDNPD: Bitwise Logical AND NOT of Packed Double-Precision Floating-Point Values
     ANDNPD = Instruction.new("ANDNPD", [
     # andnpd: xmm, xmm
       Form.new([

data/lib/fisk/instructions/andnps.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ANDNPS
+    # Instruction ANDNPS: Bitwise Logical AND NOT of Packed Single-Precision Floating-Point Values
     ANDNPS = Instruction.new("ANDNPS", [
     # andnps: xmm, xmm
       Form.new([

data/lib/fisk/instructions/andpd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ANDPD
+    # Instruction ANDPD: Bitwise Logical AND of Packed Double-Precision Floating-Point Values
     ANDPD = Instruction.new("ANDPD", [
     # andpd: xmm, xmm
       Form.new([

data/lib/fisk/instructions/andps.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction ANDPS
+    # Instruction ANDPS: Bitwise Logical AND of Packed Single-Precision Floating-Point Values
     ANDPS = Instruction.new("ANDPS", [
     # andps: xmm, xmm
       Form.new([

data/lib/fisk/instructions/bextr.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BEXTR
+    # Instruction BEXTR: Bit Field Extract
     BEXTR = Instruction.new("BEXTR", [
     # bextr: r32, r32, imm32
       Form.new([

data/lib/fisk/instructions/blcfill.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLCFILL
+    # Instruction BLCFILL: Fill From Lowest Clear Bit
     BLCFILL = Instruction.new("BLCFILL", [
     # blcfill: r32, r32
       Form.new([

data/lib/fisk/instructions/blci.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLCI
+    # Instruction BLCI: Isolate Lowest Clear Bit
     BLCI = Instruction.new("BLCI", [
     # blci: r32, r32
       Form.new([

data/lib/fisk/instructions/blcic.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLCIC
+    # Instruction BLCIC: Isolate Lowest Set Bit and Complement
     BLCIC = Instruction.new("BLCIC", [
     # blcic: r32, r32
       Form.new([

data/lib/fisk/instructions/blcmsk.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLCMSK
+    # Instruction BLCMSK: Mask From Lowest Clear Bit
     BLCMSK = Instruction.new("BLCMSK", [
     # blcmsk: r32, r32
       Form.new([

data/lib/fisk/instructions/blcs.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLCS
+    # Instruction BLCS: Set Lowest Clear Bit
     BLCS = Instruction.new("BLCS", [
     # blcs: r32, r32
       Form.new([

data/lib/fisk/instructions/blendpd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLENDPD
+    # Instruction BLENDPD: Blend Packed Double Precision Floating-Point Values
     BLENDPD = Instruction.new("BLENDPD", [
     # blendpd: xmm, xmm, imm8
       Form.new([

data/lib/fisk/instructions/blendps.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLENDPS
+    # Instruction BLENDPS:  Blend Packed Single Precision Floating-Point Values
     BLENDPS = Instruction.new("BLENDPS", [
     # blendps: xmm, xmm, imm8
       Form.new([

data/lib/fisk/instructions/blendvpd.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLENDVPD
+    # Instruction BLENDVPD:  Variable Blend Packed Double Precision Floating-Point Values
     BLENDVPD = Instruction.new("BLENDVPD", [
     # blendvpd: xmm, xmm, xmm0
       Form.new([

data/lib/fisk/instructions/blendvps.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLENDVPS
+    # Instruction BLENDVPS:  Variable Blend Packed Single Precision Floating-Point Values
     BLENDVPS = Instruction.new("BLENDVPS", [
     # blendvps: xmm, xmm, xmm0
       Form.new([

data/lib/fisk/instructions/blsfill.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLSFILL
+    # Instruction BLSFILL: Fill From Lowest Set Bit
     BLSFILL = Instruction.new("BLSFILL", [
     # blsfill: r32, r32
       Form.new([

data/lib/fisk/instructions/blsi.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLSI
+    # Instruction BLSI: Isolate Lowest Set Bit
     BLSI = Instruction.new("BLSI", [
     # blsi: r32, r32
       Form.new([

data/lib/fisk/instructions/blsic.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLSIC
+    # Instruction BLSIC: Isolate Lowest Set Bit and Complement
     BLSIC = Instruction.new("BLSIC", [
     # blsic: r32, r32
       Form.new([

data/lib/fisk/instructions/blsmsk.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLSMSK
+    # Instruction BLSMSK: Mask From Lowest Set Bit
     BLSMSK = Instruction.new("BLSMSK", [
     # blsmsk: r32, r32
       Form.new([

data/lib/fisk/instructions/blsr.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BLSR
+    # Instruction BLSR: Reset Lowest Set Bit
     BLSR = Instruction.new("BLSR", [
     # blsr: r32, r32
       Form.new([

data/lib/fisk/instructions/bsf.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BSF
+    # Instruction BSF: Bit Scan Forward
     BSF = Instruction.new("BSF", [
     # bsfw: r16, r16
       Form.new([

data/lib/fisk/instructions/bsr.rb

@@ -2,7 +2,7 @@
 
 class Fisk
   module Instructions
-    # Instruction BSR
+    # Instruction BSR: Bit Scan Reverse
     BSR = Instruction.new("BSR", [
     # bsrw: r16, r16
       Form.new([