jit_buffer 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34c56015392868597d86a358c2db6427ac291e2a1824328977142f2c3badccdf
-  data.tar.gz: 2b17329aea7966304cf009634fbd572bdc746471d6771ee741209b86a618ae5d
+  metadata.gz: 042d1a4c8ee681237a3829d1ae950a726558383b26262d828aab558e6bb51bfa
+  data.tar.gz: 7ef264b37a228f8845938c7d10162bb4b39aee153dd8f8a11b59774a1688423b
 SHA512:
-  metadata.gz: 1ee6388bf6a313f18b3ada0039eba6b9c065966009b8f19f1c3ffe7522a0faabef7e912e189414917a8e6a0e3019142f1efb76f8ea388f14b140e2411cd55d13
-  data.tar.gz: 5087a35a661273910c5be37dcd868113a5ef39ce6beeeb38c919b4cb2403fc589a122a8f9f60b83a970b7d0706d14b3fbfe1c90e7259ecb4a043f174b78165aa
+  metadata.gz: 5c3eb5c03d5c91ed27cb1dd13448e6a5ef95ade94388e9fd0f50c6bcda6d7d449432b0d1c06425ca5c795f9df74e19465ca6823f6d34a18023557437ae3e7bc3
+  data.tar.gz: c57d3e2fc3c0102b3de9a9f6a132b11d3b77d0d57653845ede834035b8fdff95ea2e633e140240fab56e01e50cef99d385c97eea0241d4ab2a219a737efb3d93

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Rakefile

@@ -6,6 +6,3 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
   t.warning = true
 end
-
-require 'rake/extensiontask'
-Rake::ExtensionTask.new("jit_buffer")

data/jit_buffer.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
   spec.require_paths = ["lib"]
-  spec.extensions = ["ext/jit_buffer/extconf.rb"]
 
   spec.add_development_dependency "rake", '~> 13.0'
   spec.add_development_dependency "minitest", '~> 5.15'

data/lib/jit_buffer.rb

@@ -1,4 +1,3 @@
-require "jit_buffer.so"
 require "fiddle"
 
 class Fiddle::Function
@@ -9,7 +8,7 @@ class Fiddle::Function
 end unless Fiddle::Function.method_defined?(:to_proc)
 
 class JITBuffer
-  VERSION = '1.0.0'
+  VERSION = '1.0.3'
 
   class Exception < StandardError
   end
@@ -23,6 +22,20 @@ class JITBuffer
   module MMAP
     include Fiddle
 
+    PROT_READ   = 0x01
+    PROT_WRITE  = 0x02
+    PROT_EXEC   = 0x04
+
+    MAP_PRIVATE = 0x02
+
+    if RUBY_PLATFORM =~ /darwin/
+      MAP_ANON    = 0x1000
+      MAP_JIT     = 0x800
+    else
+      MAP_ANON    = 0x20
+      MAP_JIT     = 0x0
+    end
+
     def self.make_function name, args, ret
       ptr = Handle::DEFAULT[name]
       func = Function.new ptr, args, ret, name: name
@@ -42,26 +55,52 @@ class JITBuffer
 
     make_function "mprotect", [TYPE_VOIDP, TYPE_SIZE_T, TYPE_INT], TYPE_INT
 
+    begin
+      make_function "pthread_jit_write_protect_np", [TYPE_INT], TYPE_VOID
+      make_function "sys_icache_invalidate", [TYPE_VOIDP, -TYPE_INT], TYPE_VOID
+    rescue Fiddle::DLError
+    end
+
     def self.mmap_buffer size
       ptr = mmap 0, size, PROT_READ | PROT_WRITE | PROT_EXEC, MAP_PRIVATE | MAP_ANON | MAP_JIT, -1, 0
       ptr.size = size
       ptr
     end
+
+    if respond_to?(:pthread_jit_write_protect_np)
+      # MacOS
+      def self.set_writeable ptr
+        MMAP.pthread_jit_write_protect_np 0
+      end
+
+      def self.set_executable ptr
+        MMAP.pthread_jit_write_protect_np 1
+        MMAP.sys_icache_invalidate ptr, ptr.size
+      end
+    else
+      # Linux
+      def self.set_writeable ptr
+        MMAP.mprotect ptr, ptr.size, PROT_READ | PROT_WRITE
+      end
+
+      def self.set_executable ptr
+        MMAP.mprotect ptr, ptr.size, PROT_READ | PROT_EXEC
+      end
+    end
   end
 
   def self.new size
-    x = super(MMAP.mmap_buffer(size), size)
-    MMAP.pthread_jit_write_protect_np(true)
-    x
+    super(MMAP.mmap_buffer(size), size)
   end
 
-  attr_reader :pos
+  attr_reader :pos, :size
 
   def initialize memory, size
     @writeable = false
     @memory = memory
     @size   = size
     @pos    = 0
+    executable!
   end
 
   def putc byte
@@ -73,7 +112,7 @@ class JITBuffer
 
   def write bytes
     raise(ReadOnlyException, "Buffer is read only!") unless @writeable
-    raise OutOfBoundsException if pos + bytes.bytesize >= @size
+    raise OutOfBoundsException if pos + bytes.bytesize > @size
     @memory[pos, bytes.length] = bytes
     @pos += bytes.bytesize
   end
@@ -86,7 +125,7 @@ class JITBuffer
   end
 
   def read len
-    raise(OutOfBoundsException, "You've gone too far!") if pos + len >= @size
+    raise(OutOfBoundsException, "You've gone too far!") if pos + len > @size
     x = @memory[pos, pos + len]
     @pos += len
     x
@@ -101,17 +140,21 @@ class JITBuffer
   end
 
   def executable!
-    MMAP.pthread_jit_write_protect_np true
-    MMAP.sys_icache_invalidate @memory.to_i, @size
+    MMAP.set_executable @memory.to_i
     @writeable = false
   end
 
   def writeable!
-    MMAP.pthread_jit_write_protect_np false
+    MMAP.set_writeable @memory.to_i
     @writeable = true
   end
 
   def to_function params, ret
     Fiddle::Function.new @memory.to_i, params, ret
   end
+
+  # Get the address of the executable memory
+  def to_i
+    @memory.to_i
+  end
 end

data/test/jit_buffer_test.rb

@@ -2,6 +2,49 @@ require "helper"
 require "jit_buffer"
 
 class JITBufferTest < Minitest::Test
+  def test_fill_buffer_with_putc
+    jit = JITBuffer.new 4096
+    str = [0xCC] * 4096
+    jit.writeable!
+    str.each { |c| jit.putc c }
+    assert_equal 4096, jit.pos
+    jit.seek 0
+
+    bytes = []
+    4096.times { bytes << (jit.getc & 0xFF) }
+    assert_equal 4096, jit.pos
+    assert_equal str, bytes
+  end
+
+  def test_fill_buffer_read_with_getc
+    jit = JITBuffer.new 4096
+    str = ([0xCC] * 4096).pack("C*")
+    jit.writeable!
+    jit.write(str)
+    assert_equal 4096, jit.pos
+    jit.seek 0
+
+    bytes = []
+    4096.times { bytes << jit.getc }
+    assert_equal 4096, jit.pos
+    assert_equal str, bytes.pack("C*")
+  end
+
+  def test_fill_buffer
+    jit = JITBuffer.new 4096
+    str = ([0xCC] * 4096).pack("C*")
+    jit.writeable!
+    jit.write(str)
+    assert_equal 4096, jit.pos
+    jit.seek 0
+    assert_equal str, jit.read(4096)
+  end
+
+  def test_size
+    jit = JITBuffer.new 4096
+    assert_equal 4096, jit.size
+  end
+
   def test_make_writeable
     jit = JITBuffer.new 4096
     jit.writeable!
@@ -46,18 +89,21 @@ class JITBufferTest < Minitest::Test
 
   def test_execute
     jit = JITBuffer.new 4096
-    insns = [
-      movz(0, 42),
-      ret
-    ].pack("L<L<")
+
+    bytes = [0x48, 0xc7, 0xc0, 0x2b, 0x00, 0x00, 0x00, # x86_64 mov rax, 0x2b
+             0xc3,                                     # x86_64 ret
+             0xeb, 0xf6,                               # x86 jmp
+             0x80, 0xd2,                               # ARM movz X11, 0x7b7
+             0x60, 0x05, 0x80, 0xd2,                   # ARM movz X0, #0x2b
+             0xc0, 0x03, 0x5f, 0xd6]                   # ARM ret
 
     jit.writeable!
 
-    jit.write insns
+    jit.write bytes.pack("C*")
 
     jit.executable!
-    func = jit.to_function([], Fiddle::TYPE_INT)
-    assert_equal 42, func.call
+    func = Fiddle::Function.new(jit.to_i + 8, [], Fiddle::TYPE_INT)
+    assert_equal 0x2b, func.call
   end
 
   def test_invalid_write
@@ -112,17 +158,8 @@ class JITBufferTest < Minitest::Test
     end
   end
 
-  # ARM instructions
-  def movz reg, imm
-    insn = 0b0_10_100101_00_0000000000000000_00000
-    insn |= (1 << 31)  # 64 bit
-    insn |= (imm << 5) # immediate
-    insn |= reg        # reg
-  end
-
-  def ret xn = 30
-    insn = 0b1101011_0_0_10_11111_0000_0_0_00000_00000
-    insn |= (xn << 5)
-    insn
+  def test_to_i
+    jit = JITBuffer.new 4096
+    assert jit.to_i
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_buffer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Aaron Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,16 +56,14 @@ description: A JIT Buffer object for Ruby.
 email:
 - tenderlove@ruby-lang.org
 executables: []
-extensions:
-- ext/jit_buffer/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- ext/jit_buffer/extconf.rb
-- ext/jit_buffer/jit_buffer.c
 - jit_buffer.gemspec
 - lib/jit_buffer.rb
 - test/helper.rb

data/ext/jit_buffer/extconf.rb

@@ -1,10 +0,0 @@
-require 'mkmf'
-
-raise unless have_header "sys/mman.h"
-
-have_const 'MAP_JIT', 'sys/mman.h'
-
-have_func 'pthread_jit_write_protect_np'
-have_func 'sys_icache_invalidate'
-
-create_makefile('jit_buffer')

data/ext/jit_buffer/jit_buffer.c

@@ -1,59 +0,0 @@
-#include <ruby.h>
-#include <sys/mman.h>
-#include <mach/vm_prot.h>
-#include <mach/mach_init.h>
-#include <pthread.h>
-
-#if HAVE_SYS_ICACHE_INVALIDATE
-#include <libkern/OSCacheControl.h>
-#endif
-
-#if HAVE_PTHREAD_JIT_WRITE_PROTECT_NP
-static VALUE
-rb_pthread_jit_write_protect_np(VALUE mod, VALUE v)
-{
-    if (RTEST(v)) {
-        pthread_jit_write_protect_np(1);
-    }
-    else {
-        pthread_jit_write_protect_np(0);
-    }
-
-    return Qnil;
-}
-#endif
-
-#if HAVE_SYS_ICACHE_INVALIDATE
-static VALUE
-rb_sys_icache_invalidate(VALUE mod, VALUE addr, VALUE len)
-{
-    sys_icache_invalidate((void *)(NUM2ULONG(addr)), NUM2INT(len));
-
-    return Qnil;
-}
-#endif
-
-void Init_jit_buffer() {
-    VALUE rb_cJITBuffer = rb_define_class("JITBuffer", rb_cObject);
-    VALUE rb_mMMap = rb_define_module_under(rb_cJITBuffer, "MMAP");
-
-    rb_define_const(rb_mMMap, "PROT_READ", INT2NUM(PROT_READ));
-    rb_define_const(rb_mMMap, "PROT_WRITE", INT2NUM(PROT_WRITE));
-    rb_define_const(rb_mMMap, "PROT_EXEC", INT2NUM(PROT_EXEC));
-    rb_define_const(rb_mMMap, "VM_PROT_COPY", INT2NUM(VM_PROT_COPY));
-    rb_define_const(rb_mMMap, "VM_PROT_READ", INT2NUM(VM_PROT_READ));
-    rb_define_const(rb_mMMap, "VM_PROT_EXECUTE", INT2NUM(VM_PROT_EXECUTE));
-    rb_define_const(rb_mMMap, "MAP_PRIVATE", INT2NUM(MAP_PRIVATE));
-    rb_define_const(rb_mMMap, "MAP_ANON", INT2NUM(MAP_ANON));
-#if HAVE_CONST_MAP_JIT
-    rb_define_const(rb_mMMap, "MAP_JIT", INT2NUM(MAP_JIT));
-#endif
-
-#if HAVE_PTHREAD_JIT_WRITE_PROTECT_NP
-    rb_define_module_function(rb_mMMap, "pthread_jit_write_protect_np", rb_pthread_jit_write_protect_np, 1);
-#endif
-
-#if HAVE_SYS_ICACHE_INVALIDATE
-    rb_define_module_function(rb_mMMap, "sys_icache_invalidate", rb_sys_icache_invalidate, 2);
-#endif
-}