1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
# frozen_string_literal: true
require 'test/unit'
require 'envutil'
require 'tmpdir'
return unless YJIT.enabled?
# Tests for YJIT with assertions on compilation and side exits
# insipired by the MJIT tests in test/ruby/test_jit.rb
class TestYJIT < Test::Unit::TestCase
def test_compile_putnil
assert_compiles('nil', insns: %i[putnil], result: nil)
end
def test_compile_putobject
assert_compiles('true', insns: %i[putobject], result: true)
assert_compiles('123', insns: %i[putobject], result: 123)
assert_compiles(':foo', insns: %i[putobject], result: :foo)
end
def test_compile_opt_not
assert_compiles('!false', insns: %i[opt_not], result: true)
assert_compiles('!nil', insns: %i[opt_not], result: true)
assert_compiles('!true', insns: %i[opt_not], result: false)
assert_compiles('![]', insns: %i[opt_not], result: false)
end
def test_compile_opt_newarray
assert_compiles('[]', insns: %i[newarray], result: [])
assert_compiles('[1+1]', insns: %i[newarray opt_plus], result: [2])
assert_compiles('[1,1+1,3,4,5,6]', insns: %i[newarray opt_plus], result: [1, 2, 3, 4, 5, 6])
end
def test_compile_opt_duparray
assert_compiles('[1]', insns: %i[duparray], result: [1])
assert_compiles('[1, 2, 3]', insns: %i[duparray], result: [1, 2, 3])
end
def test_compile_newrange
assert_compiles('s = 1; (s..5)', insns: %i[newrange], result: 1..5)
assert_compiles('s = 1; e = 5; (s..e)', insns: %i[newrange], result: 1..5)
assert_compiles('s = 1; (s...5)', insns: %i[newrange], result: 1...5)
assert_compiles('s = 1; (s..)', insns: %i[newrange], result: 1..)
assert_compiles('e = 5; (..e)', insns: %i[newrange], result: ..5)
end
def test_compile_opt_nil_p
assert_compiles('nil.nil?', insns: %i[opt_nil_p], result: true)
assert_compiles('false.nil?', insns: %i[opt_nil_p], result: false)
assert_compiles('true.nil?', insns: %i[opt_nil_p], result: false)
assert_compiles('(-"").nil?', insns: %i[opt_nil_p], result: false)
assert_compiles('123.nil?', insns: %i[opt_nil_p], result: false)
end
def test_compile_eq_fixnum
assert_compiles('123 == 123', insns: %i[opt_eq], result: true)
assert_compiles('123 == 456', insns: %i[opt_eq], result: false)
end
def test_compile_eq_string
assert_compiles('-"" == -""', insns: %i[opt_eq], result: true)
assert_compiles('-"foo" == -"foo"', insns: %i[opt_eq], result: true)
assert_compiles('-"foo" == -"bar"', insns: %i[opt_eq], result: false)
end
def test_compile_set_and_get_global
assert_compiles('$foo = 123; $foo', insns: %i[setglobal], result: 123)
end
def test_compile_putspecialobject
assert_compiles('-> {}', insns: %i[putspecialobject])
end
def test_compile_tostring
assert_no_exits('"i am a string #{true}"')
end
def test_compile_regexp
assert_no_exits('/#{true}/')
end
def test_getlocal_with_level
assert_compiles(<<~RUBY, insns: %i[getlocal opt_plus], result: [[7]])
def foo(foo, bar)
[1].map do |x|
[1].map do |y|
foo + bar
end
end
end
foo(5, 2)
RUBY
end
def test_string_then_nil
assert_compiles(<<~RUBY, insns: %i[opt_nil_p], result: true)
def foo(val)
val.nil?
end
foo("foo")
foo(nil)
RUBY
end
def test_nil_then_string
assert_compiles(<<~RUBY, insns: %i[opt_nil_p], result: false)
def foo(val)
val.nil?
end
foo(nil)
foo("foo")
RUBY
end
def test_opt_length_in_method
assert_compiles(<<~RUBY, insns: %i[opt_length], result: 5)
def foo(str)
str.length
end
foo("hello, ")
foo("world")
RUBY
end
def test_opt_regexpmatch2
assert_compiles(<<~RUBY, insns: %i[opt_regexpmatch2], result: 0)
def foo(str)
str =~ /foo/
end
foo("foobar")
RUBY
end
def test_expandarray
assert_compiles(<<~'RUBY', insns: %i[expandarray], result: [1, 2])
a, b = [1, 2]
RUBY
end
def test_expandarray_nil
assert_compiles(<<~'RUBY', insns: %i[expandarray], result: [nil, nil])
a, b = nil
[a, b]
RUBY
end
def test_compile_opt_getinlinecache
assert_compiles(<<~RUBY, insns: %i[opt_getinlinecache], result: 123, min_calls: 2)
def get_foo
FOO
end
FOO = 123
get_foo # warm inline cache
get_foo
RUBY
end
def test_string_interpolation
assert_compiles(<<~'RUBY', insns: %i[checktype concatstrings], result: "foobar", min_calls: 2)
def make_str(foo, bar)
"#{foo}#{bar}"
end
make_str("foo", "bar")
make_str("foo", "bar")
RUBY
end
def test_string_interpolation_cast
assert_compiles(<<~'RUBY', insns: %i[checktype concatstrings tostring], result: "123")
def make_str(foo, bar)
"#{foo}#{bar}"
end
make_str(1, 23)
RUBY
end
def test_super_iseq
assert_compiles(<<~'RUBY', insns: %i[invokesuper opt_plus opt_mult], result: 15)
class A
def foo
1 + 2
end
end
class B < A
def foo
super * 5
end
end
B.new.foo
RUBY
end
def test_super_cfunc
assert_compiles(<<~'RUBY', insns: %i[invokesuper], result: "Hello")
class Gnirts < String
def initialize
super(-"olleH")
end
def to_s
super().reverse
end
end
Gnirts.new.to_s
RUBY
end
# Tests calling a variadic cfunc with many args
def test_build_large_struct
assert_compiles(<<~RUBY, insns: %i[opt_send_without_block], min_calls: 2)
::Foo = Struct.new(:a, :b, :c, :d, :e, :f, :g, :h)
def build_foo
::Foo.new(:a, :b, :c, :d, :e, :f, :g, :h)
end
build_foo
build_foo
RUBY
end
def test_fib_recursion
assert_compiles(<<~'RUBY', insns: %i[opt_le opt_minus opt_plus opt_send_without_block], result: 34)
def fib(n)
return n if n <= 1
fib(n-1) + fib(n-2)
end
fib(9)
RUBY
end
def test_ctx_different_mappings
# regression test simplified from URI::Generic#hostname=
assert_compiles(<<~'RUBY', frozen_string_literal: true)
def foo(v)
!(v&.start_with?('[')) && v&.index(':')
end
foo(nil)
foo("example.com")
RUBY
end
def assert_no_exits(script)
assert_compiles(script)
end
ANY = Object.new
def assert_compiles(test_script, insns: [], min_calls: 1, stdout: nil, exits: {}, result: ANY, frozen_string_literal: nil)
reset_stats = <<~RUBY
YJIT.runtime_stats
YJIT.reset_stats!
RUBY
write_results = <<~RUBY
stats = YJIT.runtime_stats
def collect_blocks(blocks)
blocks.sort_by(&:address).map { |b| [b.iseq_start_index, b.iseq_end_index] }
end
def collect_iseqs(iseq)
iseq_array = iseq.to_a
insns = iseq_array.last.grep(Array)
blocks = YJIT.blocks_for(iseq)
h = {
name: iseq_array[5],
insns: insns,
blocks: collect_blocks(blocks),
}
arr = [h]
iseq.each_child { |c| arr.concat collect_iseqs(c) }
arr
end
iseq = RubyVM::InstructionSequence.of(_test_proc)
IO.open(3).write Marshal.dump({
result: #{result == ANY ? "nil" : "result"},
stats: stats,
iseqs: collect_iseqs(iseq),
disasm: iseq.disasm
})
RUBY
script = <<~RUBY
#{"# frozen_string_literal: true" if frozen_string_literal}
_test_proc = proc {
#{test_script}
}
#{reset_stats}
result = _test_proc.call
#{write_results}
RUBY
status, out, err, stats = eval_with_jit(script, min_calls: min_calls)
assert status.success?, "exited with status #{status.to_i}, stderr:\n#{err}"
assert_equal stdout.chomp, out.chomp if stdout
unless ANY.equal?(result)
assert_equal result, stats[:result]
end
runtime_stats = stats[:stats]
iseqs = stats[:iseqs]
disasm = stats[:disasm]
# Only available when RUBY_DEBUG enabled
if runtime_stats[:all_stats]
recorded_exits = runtime_stats.select { |k, v| k.to_s.start_with?("exit_") }
recorded_exits = recorded_exits.reject { |k, v| v == 0 }
recorded_exits.transform_keys! { |k| k.to_s.gsub("exit_", "").to_sym }
if exits != :any && exits != recorded_exits
flunk "Expected #{exits.empty? ? "no" : exits.inspect} exits" \
", but got\n#{recorded_exits.inspect}"
end
end
# Only available when RUBY_DEBUG enabled
if runtime_stats[:all_stats]
missed_insns = insns.dup
all_compiled_blocks = {}
iseqs.each do |iseq|
compiled_blocks = iseq[:blocks].map { |from, to| (from...to) }
all_compiled_blocks[iseq[:name]] = compiled_blocks
compiled_insns = iseq[:insns]
next_idx = 0
compiled_insns.map! do |insn|
# TODO: not sure this is accurate for determining insn size
idx = next_idx
next_idx += insn.length
[idx, *insn]
end
compiled_insns.each do |idx, op, *arguments|
next unless missed_insns.include?(op)
next unless compiled_blocks.any? { |block| block === idx }
# This instruction was compiled
missed_insns.delete(op)
end
end
unless missed_insns.empty?
flunk "Expected to compile instructions #{missed_insns.join(", ")} but didn't.\nCompiled ranges: #{all_compiled_blocks.inspect}\niseq:\n#{disasm}"
end
end
end
def eval_with_jit(script, min_calls: 1, timeout: 1000)
args = [
"--disable-gems",
"--yjit-call-threshold=#{min_calls}",
"--yjit-stats"
]
args << "-e" << script
stats_r, stats_w = IO.pipe
out, err, status = EnvUtil.invoke_ruby(args,
'', true, true, timeout: timeout, ios: {3 => stats_w}
)
stats_w.close
stats = stats_r.read
stats = Marshal.load(stats) if !stats.empty?
stats_r.close
[status, out, err, stats]
end
end
|