jit_buffer 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 34c56015392868597d86a358c2db6427ac291e2a1824328977142f2c3badccdf
4
+ data.tar.gz: 2b17329aea7966304cf009634fbd572bdc746471d6771ee741209b86a618ae5d
5
+ SHA512:
6
+ metadata.gz: 1ee6388bf6a313f18b3ada0039eba6b9c065966009b8f19f1c3ffe7522a0faabef7e912e189414917a8e6a0e3019142f1efb76f8ea388f14b140e2411cd55d13
7
+ data.tar.gz: 5087a35a661273910c5be37dcd868113a5ef39ce6beeeb38c919b4cb2403fc589a122a8f9f60b83a970b7d0706d14b3fbfe1c90e7259ecb4a043f174b78165aa
@@ -0,0 +1,77 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to make participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, sex characteristics, gender identity and expression,
9
+ level of experience, education, socio-economic status, nationality, personal
10
+ appearance, race, religion, or sexual identity and orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies within all project spaces, and it also applies when
49
+ an individual is representing the project or its community in public spaces.
50
+ Examples of representing a project or community include using an official
51
+ project e-mail address, posting via an official social media account, or acting
52
+ as an appointed representative at an online or offline event. Representation of
53
+ a project may be further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at aaron.patterson at gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72
+
73
+ [homepage]: https://www.contributor-covenant.org
74
+
75
+ For answers to common questions about this code of conduct, see
76
+ https://www.contributor-covenant.org/faq
77
+
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2021 Aaron Patterson
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,64 @@
1
+ # JIT Buffer
2
+
3
+ This is a general purpose JIT Buffer object for building JITs in Ruby.
4
+
5
+ Currently only works on macOS though I'll make it work on Linux too.
6
+
7
+ ## Usage
8
+
9
+ Create a JIT Buffer, then specify the size. The JIT Buffer can only be
10
+ writeable or executable, but not both at the same time.
11
+
12
+ It starts life as executable, so you need to mark it writeable before writing.
13
+
14
+ ```ruby
15
+ # Make a buffer of size 4096
16
+ buffer = JITBuffer.new 4096
17
+
18
+ # Make writeable
19
+ buffer.writeable!
20
+
21
+ # Write some stuff
22
+ buffer.write "hello"
23
+ ```
24
+
25
+ If you want to execute the JIT instructions, you need to mark it executable
26
+ again.
27
+
28
+ Here is a full example that only works on ARM64:
29
+
30
+ ```ruby
31
+ require "jit_buffer"
32
+
33
+ # ARM instructions
34
+ def movz reg, imm
35
+ insn = 0b0_10_100101_00_0000000000000000_00000
36
+ insn |= (1 << 31) # 64 bit
37
+ insn |= (imm << 5) # immediate
38
+ insn |= reg # reg
39
+ end
40
+
41
+ def ret xn = 30
42
+ insn = 0b1101011_0_0_10_11111_0000_0_0_00000_00000
43
+ insn |= (xn << 5)
44
+ insn
45
+ end
46
+
47
+ buffer = JITBuffer.new 4096
48
+
49
+ # Assemble some instructions
50
+ insns = [
51
+ movz(0, 42), # mov X0, 42
52
+ ret # ret
53
+ ].pack("L<L<")
54
+
55
+ # Write the instructions to the JIT buffer
56
+ buffer.writeable!
57
+ buffer.write insns
58
+ buffer.executable!
59
+
60
+ # Call the instructions. We JIT'd a function that
61
+ # returns an integer "42"
62
+ func = buffer.to_function([], Fiddle::TYPE_INT)
63
+ puts func.call # returns 42
64
+ ```
data/Rakefile ADDED
@@ -0,0 +1,11 @@
1
+ require "rake/testtask"
2
+
3
+ Rake::TestTask.new(:test) do |t|
4
+ t.libs << "test/lib" << "test"
5
+ t.test_files = FileList['test/**/*_test.rb']
6
+ t.verbose = true
7
+ t.warning = true
8
+ end
9
+
10
+ require 'rake/extensiontask'
11
+ Rake::ExtensionTask.new("jit_buffer")
@@ -0,0 +1,10 @@
1
+ require 'mkmf'
2
+
3
+ raise unless have_header "sys/mman.h"
4
+
5
+ have_const 'MAP_JIT', 'sys/mman.h'
6
+
7
+ have_func 'pthread_jit_write_protect_np'
8
+ have_func 'sys_icache_invalidate'
9
+
10
+ create_makefile('jit_buffer')
@@ -0,0 +1,59 @@
1
+ #include <ruby.h>
2
+ #include <sys/mman.h>
3
+ #include <mach/vm_prot.h>
4
+ #include <mach/mach_init.h>
5
+ #include <pthread.h>
6
+
7
+ #if HAVE_SYS_ICACHE_INVALIDATE
8
+ #include <libkern/OSCacheControl.h>
9
+ #endif
10
+
11
+ #if HAVE_PTHREAD_JIT_WRITE_PROTECT_NP
12
+ static VALUE
13
+ rb_pthread_jit_write_protect_np(VALUE mod, VALUE v)
14
+ {
15
+ if (RTEST(v)) {
16
+ pthread_jit_write_protect_np(1);
17
+ }
18
+ else {
19
+ pthread_jit_write_protect_np(0);
20
+ }
21
+
22
+ return Qnil;
23
+ }
24
+ #endif
25
+
26
+ #if HAVE_SYS_ICACHE_INVALIDATE
27
+ static VALUE
28
+ rb_sys_icache_invalidate(VALUE mod, VALUE addr, VALUE len)
29
+ {
30
+ sys_icache_invalidate((void *)(NUM2ULONG(addr)), NUM2INT(len));
31
+
32
+ return Qnil;
33
+ }
34
+ #endif
35
+
36
+ void Init_jit_buffer() {
37
+ VALUE rb_cJITBuffer = rb_define_class("JITBuffer", rb_cObject);
38
+ VALUE rb_mMMap = rb_define_module_under(rb_cJITBuffer, "MMAP");
39
+
40
+ rb_define_const(rb_mMMap, "PROT_READ", INT2NUM(PROT_READ));
41
+ rb_define_const(rb_mMMap, "PROT_WRITE", INT2NUM(PROT_WRITE));
42
+ rb_define_const(rb_mMMap, "PROT_EXEC", INT2NUM(PROT_EXEC));
43
+ rb_define_const(rb_mMMap, "VM_PROT_COPY", INT2NUM(VM_PROT_COPY));
44
+ rb_define_const(rb_mMMap, "VM_PROT_READ", INT2NUM(VM_PROT_READ));
45
+ rb_define_const(rb_mMMap, "VM_PROT_EXECUTE", INT2NUM(VM_PROT_EXECUTE));
46
+ rb_define_const(rb_mMMap, "MAP_PRIVATE", INT2NUM(MAP_PRIVATE));
47
+ rb_define_const(rb_mMMap, "MAP_ANON", INT2NUM(MAP_ANON));
48
+ #if HAVE_CONST_MAP_JIT
49
+ rb_define_const(rb_mMMap, "MAP_JIT", INT2NUM(MAP_JIT));
50
+ #endif
51
+
52
+ #if HAVE_PTHREAD_JIT_WRITE_PROTECT_NP
53
+ rb_define_module_function(rb_mMMap, "pthread_jit_write_protect_np", rb_pthread_jit_write_protect_np, 1);
54
+ #endif
55
+
56
+ #if HAVE_SYS_ICACHE_INVALIDATE
57
+ rb_define_module_function(rb_mMMap, "sys_icache_invalidate", rb_sys_icache_invalidate, 2);
58
+ #endif
59
+ }
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ version = File.readlines("lib/jit_buffer.rb").grep(/VERSION = /).first[/[\d.]+/]
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "jit_buffer"
7
+ spec.version = version
8
+ spec.authors = ["Aaron Patterson"]
9
+ spec.email = ["tenderlove@ruby-lang.org"]
10
+
11
+ spec.summary = %q{A JIT Buffer object for Ruby.}
12
+ spec.description = %q{A JIT Buffer object for Ruby.}
13
+ spec.homepage = "https://github.com/tenderlove/jit_buffer"
14
+ spec.licenses = ["Apache-2.0"]
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+
20
+ spec.require_paths = ["lib"]
21
+ spec.extensions = ["ext/jit_buffer/extconf.rb"]
22
+
23
+ spec.add_development_dependency "rake", '~> 13.0'
24
+ spec.add_development_dependency "minitest", '~> 5.15'
25
+ spec.add_dependency "fiddle", '~> 1.1'
26
+ end
data/lib/jit_buffer.rb ADDED
@@ -0,0 +1,117 @@
1
+ require "jit_buffer.so"
2
+ require "fiddle"
3
+
4
+ class Fiddle::Function
5
+ def to_proc
6
+ this = self
7
+ lambda { |*args| this.call(*args) }
8
+ end
9
+ end unless Fiddle::Function.method_defined?(:to_proc)
10
+
11
+ class JITBuffer
12
+ VERSION = '1.0.0'
13
+
14
+ class Exception < StandardError
15
+ end
16
+
17
+ class OutOfBoundsException < Exception
18
+ end
19
+
20
+ class ReadOnlyException < Exception
21
+ end
22
+
23
+ module MMAP
24
+ include Fiddle
25
+
26
+ def self.make_function name, args, ret
27
+ ptr = Handle::DEFAULT[name]
28
+ func = Function.new ptr, args, ret, name: name
29
+ define_singleton_method name, &func.to_proc
30
+ end
31
+
32
+ make_function "munmap", [TYPE_VOIDP, # addr
33
+ TYPE_SIZE_T], # len
34
+ TYPE_INT
35
+
36
+ make_function "mmap", [TYPE_VOIDP,
37
+ TYPE_SIZE_T,
38
+ TYPE_INT,
39
+ TYPE_INT,
40
+ TYPE_INT,
41
+ TYPE_INT], TYPE_VOIDP
42
+
43
+ make_function "mprotect", [TYPE_VOIDP, TYPE_SIZE_T, TYPE_INT], TYPE_INT
44
+
45
+ def self.mmap_buffer size
46
+ ptr = mmap 0, size, PROT_READ | PROT_WRITE | PROT_EXEC, MAP_PRIVATE | MAP_ANON | MAP_JIT, -1, 0
47
+ ptr.size = size
48
+ ptr
49
+ end
50
+ end
51
+
52
+ def self.new size
53
+ x = super(MMAP.mmap_buffer(size), size)
54
+ MMAP.pthread_jit_write_protect_np(true)
55
+ x
56
+ end
57
+
58
+ attr_reader :pos
59
+
60
+ def initialize memory, size
61
+ @writeable = false
62
+ @memory = memory
63
+ @size = size
64
+ @pos = 0
65
+ end
66
+
67
+ def putc byte
68
+ raise(ReadOnlyException, "Buffer is read only!") unless @writeable
69
+ raise(OutOfBoundsException, "Buffer full! #{pos} - #{@size}") if pos >= @size
70
+ @memory[pos] = byte
71
+ @pos += 1
72
+ end
73
+
74
+ def write bytes
75
+ raise(ReadOnlyException, "Buffer is read only!") unless @writeable
76
+ raise OutOfBoundsException if pos + bytes.bytesize >= @size
77
+ @memory[pos, bytes.length] = bytes
78
+ @pos += bytes.bytesize
79
+ end
80
+
81
+ def getc
82
+ raise(OutOfBoundsException, "You've gone too far!") if pos >= @size
83
+ x = @memory[pos]
84
+ @pos += 1
85
+ x
86
+ end
87
+
88
+ def read len
89
+ raise(OutOfBoundsException, "You've gone too far!") if pos + len >= @size
90
+ x = @memory[pos, pos + len]
91
+ @pos += len
92
+ x
93
+ end
94
+
95
+ def seek pos, whence = IO::SEEK_SET
96
+ raise NotImplementedError if whence != IO::SEEK_SET
97
+ raise OutOfBoundsException if pos >= @size
98
+
99
+ @pos = pos
100
+ self
101
+ end
102
+
103
+ def executable!
104
+ MMAP.pthread_jit_write_protect_np true
105
+ MMAP.sys_icache_invalidate @memory.to_i, @size
106
+ @writeable = false
107
+ end
108
+
109
+ def writeable!
110
+ MMAP.pthread_jit_write_protect_np false
111
+ @writeable = true
112
+ end
113
+
114
+ def to_function params, ret
115
+ Fiddle::Function.new @memory.to_i, params, ret
116
+ end
117
+ end
data/test/helper.rb ADDED
@@ -0,0 +1 @@
1
+ require "minitest/autorun"
@@ -0,0 +1,128 @@
1
+ require "helper"
2
+ require "jit_buffer"
3
+
4
+ class JITBufferTest < Minitest::Test
5
+ def test_make_writeable
6
+ jit = JITBuffer.new 4096
7
+ jit.writeable!
8
+ jit.putc 46
9
+ end
10
+
11
+ def test_putc
12
+ jit = JITBuffer.new 4096
13
+ jit.writeable!
14
+ assert_equal 0, jit.pos
15
+ jit.putc 46
16
+ assert_equal 1, jit.pos
17
+ jit.seek 0
18
+ assert_equal 46, jit.getc
19
+ end
20
+
21
+ def test_seek_too_far
22
+ jit = JITBuffer.new 4096
23
+ assert_raises do
24
+ jit.seek 4097
25
+ end
26
+ end
27
+
28
+ def test_write_too_far
29
+ jit = JITBuffer.new 4096
30
+ jit.writeable!
31
+ jit.seek 4095
32
+ jit.putc 46
33
+ assert_raises do
34
+ jit.putc 46
35
+ end
36
+ end
37
+
38
+ def test_read_too_far
39
+ jit = JITBuffer.new 4096
40
+ jit.seek 4095
41
+ jit.getc
42
+ assert_raises do
43
+ jit.getc
44
+ end
45
+ end
46
+
47
+ def test_execute
48
+ jit = JITBuffer.new 4096
49
+ insns = [
50
+ movz(0, 42),
51
+ ret
52
+ ].pack("L<L<")
53
+
54
+ jit.writeable!
55
+
56
+ jit.write insns
57
+
58
+ jit.executable!
59
+ func = jit.to_function([], Fiddle::TYPE_INT)
60
+ assert_equal 42, func.call
61
+ end
62
+
63
+ def test_invalid_write
64
+ jit = JITBuffer.new 4096
65
+ assert_raises do
66
+ jit.write "foo"
67
+ end
68
+ end
69
+
70
+ def test_oob_write
71
+ jit = JITBuffer.new 4096
72
+ jit.seek 4095
73
+
74
+ jit.writeable!
75
+ assert_raises(JITBuffer::OutOfBoundsException) do
76
+ jit.write "foooooo"
77
+ end
78
+ end
79
+
80
+ def test_write
81
+ jit = JITBuffer.new 4096
82
+
83
+ bytes = "foo".b
84
+ jit.writeable!
85
+ pos = jit.pos
86
+ jit.write bytes
87
+ assert_equal pos + bytes.bytesize, jit.pos
88
+
89
+ jit.seek pos
90
+ assert_equal bytes, jit.read(bytes.bytesize)
91
+ end
92
+
93
+ def test_read
94
+ jit = JITBuffer.new 4096
95
+
96
+ bytes = "foo".b
97
+ jit.writeable!
98
+ pos = jit.pos
99
+ jit.write bytes
100
+ jit.seek pos
101
+ assert_equal pos, jit.pos
102
+ assert_equal bytes, jit.read(bytes.bytesize)
103
+ assert_equal pos + bytes.bytesize, jit.pos
104
+ end
105
+
106
+ def test_read_oob
107
+ jit = JITBuffer.new 4096
108
+
109
+ jit.seek 4095
110
+ assert_raises do
111
+ jit.read 3
112
+ end
113
+ end
114
+
115
+ # ARM instructions
116
+ def movz reg, imm
117
+ insn = 0b0_10_100101_00_0000000000000000_00000
118
+ insn |= (1 << 31) # 64 bit
119
+ insn |= (imm << 5) # immediate
120
+ insn |= reg # reg
121
+ end
122
+
123
+ def ret xn = 30
124
+ insn = 0b1101011_0_0_10_11111_0000_0_0_00000_00000
125
+ insn |= (xn << 5)
126
+ insn
127
+ end
128
+ end
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jit_buffer
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Aaron Patterson
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-03-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rake
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '13.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '13.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: minitest
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '5.15'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '5.15'
41
+ - !ruby/object:Gem::Dependency
42
+ name: fiddle
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.1'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.1'
55
+ description: A JIT Buffer object for Ruby.
56
+ email:
57
+ - tenderlove@ruby-lang.org
58
+ executables: []
59
+ extensions:
60
+ - ext/jit_buffer/extconf.rb
61
+ extra_rdoc_files: []
62
+ files:
63
+ - CODE_OF_CONDUCT.md
64
+ - LICENSE
65
+ - README.md
66
+ - Rakefile
67
+ - ext/jit_buffer/extconf.rb
68
+ - ext/jit_buffer/jit_buffer.c
69
+ - jit_buffer.gemspec
70
+ - lib/jit_buffer.rb
71
+ - test/helper.rb
72
+ - test/jit_buffer_test.rb
73
+ homepage: https://github.com/tenderlove/jit_buffer
74
+ licenses:
75
+ - Apache-2.0
76
+ metadata: {}
77
+ post_install_message:
78
+ rdoc_options: []
79
+ require_paths:
80
+ - lib
81
+ required_ruby_version: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - ">="
84
+ - !ruby/object:Gem::Version
85
+ version: '0'
86
+ required_rubygems_version: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ requirements: []
92
+ rubygems_version: 3.4.0.dev
93
+ signing_key:
94
+ specification_version: 4
95
+ summary: A JIT Buffer object for Ruby.
96
+ test_files:
97
+ - test/helper.rb
98
+ - test/jit_buffer_test.rb