asmrepl 1.0.0

data/lib/asmrepl/repl.rb

@@ -0,0 +1,105 @@
+require "fiddle"
+require "fisk/helpers"
+require "crabstone"
+require "reline"
+
+if RUBY_PLATFORM =~ /darwin/
+  require "asmrepl/macos"
+else
+  require "asmrepl/linux"
+end
+
+class Crabstone::Binding::Instruction
+  class << self
+    alias :old_release :release
+  end
+
+  # Squelch error in crabstone
+  def self.release obj
+    nil
+  end
+end
+
+module ASMREPL
+  class REPL
+    include Fiddle
+
+    if RUBY_PLATFORM =~ /darwin/
+      CFuncs = MacOS
+    else
+      CFuncs = Linux
+    end
+
+    def initialize
+      size = 1024 * 16 # 16k is enough for anyone!
+      @buffer = CFuncs.jitbuffer(size)
+      CFuncs.memset(@buffer.memory, 0xCC, size)
+      @parser    = ASMREPL::Parser.new
+      @assembler = ASMREPL::Assembler.new
+    end
+
+    def display_state state
+      puts " CPU STATE ".center(48, "=")
+      puts state
+      puts
+      puts "FLAGS: #{state.flags.inspect}"
+      puts
+    end
+
+    def start
+      pid = fork {
+        CFuncs.traceme
+        @buffer.to_function([], TYPE_INT).call
+      }
+
+      tracer = CFuncs::Tracer.new pid
+      should_cpu = true
+      while tracer.wait
+        state = tracer.state
+
+        # Show CPU state once on boot
+        if should_cpu
+          display_state state
+          should_cpu = false
+        end
+
+        # Move the JIT buffer to the current instruction pointer
+        pos = (state.rip - @buffer.memory.to_i)
+        @buffer.seek pos
+        use_history = true
+        loop do
+          cmd = nil
+          text = Reline.readmultiline(">> ", use_history) do |multiline_input|
+            if multiline_input =~ /\A\s*(\w+)\s*\Z/
+              register = $1
+              cmd = [:read, register]
+            else
+              cmd = :run
+            end
+            true
+          end
+
+          case cmd
+          in :run
+            break if text.chomp.empty?
+            binary = @assembler.assemble @parser.parse text.chomp
+            binary.bytes.each { |byte| @buffer.putc byte }
+            break
+          in [:read, "cpu"]
+            display_state state
+          in [:read, reg]
+            val = state[reg]
+            if val
+              puts sprintf("%#018x", state[reg])
+            else
+              puts "Unknown command: "
+              puts "  " + text
+            end
+          else
+          end
+        end
+        tracer.continue
+      end
+    end
+  end
+end

data/lib/asmrepl/version.rb

@@ -0,0 +1,3 @@
+module ASMREPL
+  VERSION = '1.0.0'
+end

data/lib/asmrepl.rb

@@ -0,0 +1,3 @@
+require "asmrepl/parser"
+require "asmrepl/assembler"
+require "asmrepl/repl"

data/test/asmrepl_test.rb

@@ -0,0 +1,116 @@
+require "helper"
+
+class ParserTest < ASMREPL::Test
+  def setup
+    super
+    @parser    = ASMREPL::Parser.new
+    @assembler = ASMREPL::Assembler.new
+  end
+
+  def test_int3
+    assert_round_trip "int3 "
+  end
+
+  def test_and
+    assert_round_trip "and r9, 0xffff"
+  end
+
+  def test_negative
+    assert_round_trip "test qword ptr [r15], -9"
+  end
+
+  def test_mem_lhs
+    asm = disasm_for "mov [r15], r9"
+    assert_equal "mov qword ptr [r15], r9", asm
+    assert_round_trip "mov qword ptr [r15], r9"
+  end
+
+  def test_inc
+    assert_round_trip "inc r10"
+    assert_round_trip "inc qword ptr [r10]"
+    assert_round_trip "inc qword ptr [r10 + 8]"
+  end
+
+  def test_movabs
+    assert_round_trip "movabs r10, 0x6000014b1ae0"
+  end
+
+  def test_ret
+    assert_round_trip "ret "
+  end
+
+  def test_lea_rip
+    if RUBY_PLATFORM =~ /darwin/
+      assert_round_trip "lea rax, [rip]"
+      assert_round_trip "lea rax, [rip + 9]"
+    else
+      assert_round_trip "lea rax, qword ptr [rip]"
+      assert_round_trip "lea rax, qword ptr [rip + 9]"
+    end
+  end
+
+  def test_push_reg
+    assert_round_trip "push r13"
+  end
+
+  def test_int_4
+    assert_round_trip "int 4"
+  end
+
+  def test_shl_1
+    assert_round_trip "shl rax, 1"
+  end
+
+  def test_simple
+    assert_round_trip "mov rax, 0xff"
+    assert_round_trip "mov r8, 0xff"
+  end
+
+  def test_2_regs
+    assert_round_trip "mov r8, rax"
+  end
+
+  def test_memory_offset
+    assert_round_trip "mov r8, qword ptr [rax + 0x7b]"
+    assert_round_trip "mov r8, qword ptr [rax - 0x7b]"
+  end
+
+  def test_memory_defaults_64_offset
+    asm = disasm_for "mov rax, [rax + 0x7b]"
+    assert_equal "mov rax, qword ptr [rax + 0x7b]", asm
+
+    asm = disasm_for "mov rax, [rax - 0x7b]"
+    assert_equal "mov rax, qword ptr [rax - 0x7b]", asm
+  end
+
+  def test_memory_defaults_64
+    asm = disasm_for "mov rax, [rax]"
+    assert_equal "mov rax, qword ptr [rax]", asm
+  end
+
+  def test_memory_specify_width
+    assert_round_trip "mov r8, qword ptr [rax]"
+    assert_round_trip "mov r8d, dword ptr [r8]"
+    assert_round_trip "mov r8w, word ptr [r8]"
+    assert_round_trip "mov r8b, byte ptr [r8]"
+  end
+
+  def assert_round_trip asm
+    ast = @parser.parse asm
+    binary = @assembler.assemble ast
+    assert_equal asm, disasm(binary)
+  end
+
+  def disasm_for asm
+    ast = @parser.parse asm
+    binary = @assembler.assemble ast
+    disasm(binary)
+  end
+
+  def disasm binary
+    cs = Crabstone::Disassembler.new(Crabstone::ARCH_X86, Crabstone::MODE_64)
+    cs.disasm(binary, 0x0000).each {|i|
+      return "%s %s" % [i.mnemonic, i.op_str]
+    }
+  end
+end

data/test/helper.rb

@@ -0,0 +1,20 @@
+require "asmrepl"
+require "minitest"
+require "minitest/autorun"
+require "crabstone"
+
+class Crabstone::Binding::Instruction
+  class << self
+    alias :old_release :release
+  end
+
+  # Squelch error in crabstone
+  def self.release obj
+    nil
+  end
+end
+
+module ASMREPL
+  class Test < Minitest::Test
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: asmrepl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: crabstone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: fisk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Tired of writing assembly and them assembling it? Now you can write assembly
+  and evaluate it!
+email: tenderlove@ruby-lang.org
+executables:
+- asmrepl
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- asmrepl.gemspec
+- bin/asmrepl
+- lib/asmrepl.rb
+- lib/asmrepl/assembler.rb
+- lib/asmrepl/linux.rb
+- lib/asmrepl/macos.rb
+- lib/asmrepl/parser.rb
+- lib/asmrepl/parser.tab.rb
+- lib/asmrepl/parser.y
+- lib/asmrepl/repl.rb
+- lib/asmrepl/version.rb
+- test/asmrepl_test.rb
+- test/helper.rb
+homepage: https://github.com/tenderlove/asmrepl
+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 a REPL!
+test_files:
+- test/asmrepl_test.rb
+- test/helper.rb