fisk 1.0.0

data/test/helper.rb

@@ -0,0 +1,8 @@
+require "fisk"
+require "crabstone"
+
+ENV["MT_NO_PLUGINS"] = "1"
+require "minitest/autorun"
+
+class Fisk::Test < Minitest::Test
+end

data/test/test_fisk.rb

@@ -0,0 +1,153 @@
+require "helper"
+
+class FiskTest < Fisk::Test
+  attr_reader :fisk
+
+  def setup
+    super
+    @fisk = Fisk.new
+  end
+
+  def test_sub
+    fisk.sub fisk.rsp, fisk.imm8(16)
+    i = disasm(fisk.to_binary).first
+    assert_equal "sub", i.mnemonic.to_s
+    assert_equal "rsp, 0x10", i.op_str.to_s
+  end
+
+  def test_lol
+    binary = fisk.asm do
+      push rbp
+      mov rsp, rbp
+      int lit(3)
+      pop rbp
+      ret
+    end
+    assert_equal "UH\x89\xEC\xCC]\xC3".b, binary.string
+  end
+
+  def test_add_eax
+    fisk.add fisk.eax, fisk.imm32(0x4351ff23)
+    i = disasm(fisk.to_binary).first
+    assert_equal "add", i.mnemonic.to_s
+    assert_equal "eax, 0x4351ff23", i.op_str.to_s
+  end
+
+  def test_add_ecx_esi
+    fisk.add fisk.ecx, fisk.esi
+    i = disasm(fisk.to_binary).first
+    assert_equal "add", i.mnemonic.to_s
+    assert_equal "ecx, esi", i.op_str.to_s
+  end
+
+  def test_add_rcx_rsi
+    fisk.add fisk.rcx, fisk.rsi
+    i = disasm(fisk.to_binary).first
+    assert_equal "add", i.mnemonic.to_s
+    assert_equal "rcx, rsi".b, i.op_str.to_s.b
+  end
+
+  def test_add_rax
+    fisk.add fisk.rax, fisk.imm32(0x4351ff23)
+    i = disasm(fisk.to_binary).first
+    assert_equal "add", i.mnemonic.to_s
+    assert_equal "rax, 0x4351ff23", i.op_str.to_s
+  end
+
+  def test_add_rax_rcx
+    fisk.add fisk.rax, fisk.rcx
+    i = disasm(fisk.to_binary).first
+    assert_equal "add", i.mnemonic.to_s
+    assert_equal "rax, rcx", i.op_str.to_s
+  end
+
+  def test_add_rcx_r9
+    fisk.add fisk.rcx, fisk.r9
+    i = disasm(fisk.to_binary).first
+    assert_equal "add", i.mnemonic.to_s
+    assert_equal "rcx, r9", i.op_str.to_s
+  end
+
+  def test_adc_rcx_r9
+    fisk.adc fisk.rcx, fisk.r9
+    i = disasm(fisk.to_binary).first
+    assert_equal "adc", i.mnemonic.to_s
+    assert_equal "rcx, r9", i.op_str.to_s
+  end
+
+  def test_int3
+    fisk.int fisk.lit(3)
+    i = disasm(fisk.to_binary).first
+    assert_equal "int3", i.mnemonic.to_s
+    assert_equal "", i.op_str.to_s
+  end
+
+  def test_int5
+    fisk.int fisk.imm8(5)
+    i = disasm(fisk.to_binary).first
+    assert_equal "int", i.mnemonic.to_s
+    assert_equal "5", i.op_str.to_s
+  end
+
+  def test_push_rbp
+    fisk.push fisk.rbp
+    i = disasm(fisk.to_binary).first
+    assert_equal "push", i.mnemonic.to_s
+    assert_equal "rbp", i.op_str.to_s
+  end
+
+  def test_mov_rsp_rbp
+    fisk.mov fisk.rsp, fisk.rbp
+    i = disasm(fisk.to_binary).first
+    assert_equal "mov", i.mnemonic.to_s
+    assert_equal "rsp, rbp", i.op_str.to_s
+  end
+
+  def test_popq
+    fisk.pop fisk.rbp
+    i = disasm(fisk.to_binary).first
+    assert_equal "pop", i.mnemonic.to_s
+    assert_equal "rbp", i.op_str.to_s
+  end
+
+  def test_ret
+    fisk.ret
+    i = disasm(fisk.to_binary).first
+    assert_equal "ret", i.mnemonic.to_s
+  end
+
+  def test_jmp
+    fisk.jmp fisk.rel32(0)
+    binary = fisk.to_binary
+    i = disasm(binary).first
+    assert_equal "jmp", i.mnemonic.to_s
+    assert_equal binary.bytesize.to_s, i.op_str.to_s
+  end
+
+  def test_jmp_rel8
+    fisk.jmp fisk.rel8(-2)
+    binary = fisk.to_binary
+    assert_equal "\xEB\xFE".b, binary
+  end
+
+  def test_jbe_rel8
+    fisk.jbe fisk.rel8(2)
+    binary = fisk.to_binary
+    i = disasm(binary).first
+    assert_equal "jbe", i.mnemonic.to_s
+    assert_equal "4", i.op_str.to_s
+  end
+
+  def test_jbe_rel32
+    fisk.jbe fisk.rel32(2)
+    binary = fisk.to_binary
+    i = disasm(binary).first
+    assert_equal "jbe", i.mnemonic.to_s
+    assert_equal "8", i.op_str.to_s
+  end
+
+  def disasm binary
+    cs = Crabstone::Disassembler.new(Crabstone::ARCH_X86, Crabstone::MODE_64)
+    cs.disasm binary, 0
+  end
+end

data/test/test_run_fisk.rb

@@ -0,0 +1,128 @@
+require "helper"
+require "fisk/helpers"
+
+class RunFiskTest < Fisk::Test
+  def disasm binary
+    cs = Crabstone::Disassembler.new(Crabstone::ARCH_X86, Crabstone::MODE_64)
+    cs.disasm(binary, 0x0000).each {|i|
+      printf("0x%x:\t%s\t\t%s\n",i.address, i.mnemonic, i.op_str)
+    }
+  end
+
+  def test_sum
+    fisk = Fisk.new
+    jitbuf = Fisk::Helpers.jitbuffer 4096
+
+    fisk.asm jitbuf do
+      push rbp
+      mov rbp, rsp
+      mov rdx, imm32(1)
+      xor rax, rax
+    make_label :loop
+      add rax, rdx
+      inc rdx
+      cmp rdx, imm32(10)
+      jbe label(:loop)
+      pop rbp
+      ret
+    end
+
+    func = jitbuf.to_function [], Fiddle::TYPE_INT
+    assert_equal 11.times.inject(:+), func.call
+  end
+
+  def test_jmp
+    fisk = Fisk.new
+    jitbuf = Fisk::Helpers.jitbuffer 4096
+
+    fisk.asm jitbuf do
+      push rbp
+      mov rbp, rsp
+      jmp label(:foo)
+      make_label(:bar)
+      mov rax, imm32(100)
+      pop rbp
+      ret
+      make_label(:foo)
+      jmp label(:bar)
+      mov rax, imm32(42)
+      pop rbp
+      ret
+    end
+
+    func = jitbuf.to_function [], Fiddle::TYPE_INT
+    assert_equal 100, func.call
+  end
+
+  def test_run_fisk
+    fisk = Fisk.new
+    mem = Fisk::Helpers.mmap_jit 4096
+
+    binary = fisk.asm do
+      push rbp
+      mov rbp, rsp
+      mov rax, imm32(100)
+      pop rbp
+      ret
+    end
+
+    Fisk::Helpers.memcpy mem, binary.string, binary.string.bytesize
+    func = Fiddle::Function.new mem.to_i, [], Fiddle::TYPE_INT
+    assert_equal 100, func.call
+  end
+
+  def test_jit_memory_has_size
+    mem = Fisk::Helpers.mmap_jit 100
+    assert_equal 100, mem.size
+  end
+
+  def test_get_address
+    fisk = Fisk.new
+    jitbuf = Fisk::Helpers.jitbuffer 4096
+
+    fisk.asm jitbuf do
+      push rbp
+      mov rbp, rsp
+      mov rax, rdi
+      pop rbp
+      ret
+    end
+
+    func = jitbuf.to_function [Fiddle::TYPE_VOIDP], Fiddle::TYPE_LONG
+    x = Object.new
+    wrapped = Fiddle.dlwrap x
+    assert_equal wrapped.to_i, func.call(wrapped)
+  end
+
+  def test_fisk_jit
+    fisk = Fisk.new
+    jitbuf = Fisk::Helpers.jitbuffer 4096
+
+    fisk.asm jitbuf do
+      push rbp
+      mov rbp, rsp
+      mov rax, imm32(100)
+      pop rbp
+      ret
+    end
+
+    func = jitbuf.to_function [], Fiddle::TYPE_INT
+    assert_equal 100, func.call
+  end
+
+  def test_fisk_get_param
+    fisk = Fisk.new
+    jitbuf = Fisk::Helpers.jitbuffer 4096
+
+    fisk.asm jitbuf do
+      push rbp
+      mov rbp, rsp
+      mov rax, imm32(100)
+      pop rbp
+      ret
+    end
+
+    func = jitbuf.to_function [], Fiddle::TYPE_INT
+    assert_equal 100, func.call
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: fisk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-02 00:00:00.000000000 Z
+dependencies: []
+description: Tired of writing Ruby in Ruby? Now you can write assembly in Ruby!
+email: tenderlove@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/build-machine.rb
+- bin/machine.rb.erb
+- examples/print-string.rb
+- lib/fisk.rb
+- lib/fisk/helpers.rb
+- lib/fisk/machine.rb
+- lib/fisk/machine/encoding.rb
+- lib/fisk/machine/generated.rb
+- test/helper.rb
+- test/test_fisk.rb
+- test/test_run_fisk.rb
+homepage: https://github.com/tenderlove/fisk
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.0.dev
+signing_key:
+specification_version: 4
+summary: Write assembly in Ruby!
+test_files:
+- test/helper.rb
+- test/test_fisk.rb
+- test/test_run_fisk.rb