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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
# -*- encoding: utf-8 -*-
#
# This file is part of ruby-ffi.
# For licensing, see LICENSE.SPECS
#
require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
require 'delegate'
module PointerTestLib
extend FFI::Library
ffi_lib TestLibrary::PATH
begin
attach_function :ptr_ret_int32_t, [ :pointer, :int ], :int
rescue FFI::NotFoundError
# NetBSD uses #define instead of typedef for these
attach_function :ptr_ret_int32_t, :ptr_ret___int32_t, [ :pointer, :int ], :int
end
attach_function :ptr_ret_int64_t, [ :pointer, :int ], :int64_t
attach_function :ptr_from_address, [ FFI::Platform::ADDRESS_SIZE == 32 ? :uint : :ulong_long ], :pointer
attach_function :ptr_set_pointer, [ :pointer, :int, :pointer ], :void
attach_function :ptr_ret_pointer, [ :pointer, :int ], :pointer
end
describe "Pointer" do
include FFI
class ToPtrTest
def initialize(ptr)
@ptr = ptr
end
def to_ptr
@ptr
end
end
it "Any object implementing #to_ptr can be passed as a :pointer parameter" do
memory = FFI::MemoryPointer.new :long_long
magic = 0x12345678
memory.put_int32(0, magic)
tp = ToPtrTest.new(memory)
expect(PointerTestLib.ptr_ret_int32_t(tp, 0)).to eq(magic)
end
class PointerDelegate < DelegateClass(FFI::Pointer)
def initialize(ptr)
@ptr = ptr
end
def to_ptr
@ptr
end
end
it "A DelegateClass(Pointer) can be passed as a :pointer parameter" do
memory = FFI::MemoryPointer.new :long_long
magic = 0x12345678
memory.put_int32(0, magic)
ptr = PointerDelegate.new(memory)
expect(PointerTestLib.ptr_ret_int32_t(ptr, 0)).to eq(magic)
end
it "Fixnum cannot be used as a Pointer argument" do
expect { PointerTestLib.ptr_ret_int32_t(0, 0) }.to raise_error(ArgumentError)
end
it "Bignum cannot be used as a Pointer argument" do
expect { PointerTestLib.ptr_ret_int32_t(0xfee1deadbeefcafebabe, 0) }.to raise_error(ArgumentError)
end
it "String can be used as a Pointer argument" do
s = "123\0abö"
expect( PointerTestLib.ptr_ret_int64_t(s, 0) ).to eq(s.unpack("q")[0])
end
it "#to_ptr" do
memory = FFI::MemoryPointer.new :pointer
expect(memory.to_ptr).to eq(memory)
expect(FFI::Pointer::NULL.to_ptr).to eq(FFI::Pointer::NULL)
end
describe "pointer type methods" do
it "#read_pointer" do
memory = FFI::MemoryPointer.new :pointer
PointerTestLib.ptr_set_pointer(memory, 0, PointerTestLib.ptr_from_address(0xdeadbeef))
expect(memory.read_pointer.address).to eq(0xdeadbeef)
end
it "#write_pointer" do
memory = FFI::MemoryPointer.new :pointer
memory.write_pointer(PointerTestLib.ptr_from_address(0xdeadbeef))
expect(PointerTestLib.ptr_ret_pointer(memory, 0).address).to eq(0xdeadbeef)
end
it "#read_array_of_pointer" do
values = [0x12345678, 0xfeedf00d, 0xdeadbeef]
memory = FFI::MemoryPointer.new :pointer, values.size
values.each_with_index do |address, j|
PointerTestLib.ptr_set_pointer(memory, j * FFI.type_size(:pointer), PointerTestLib.ptr_from_address(address))
end
array = memory.read_array_of_pointer(values.size)
values.each_with_index do |address, j|
expect(array[j].address).to eq(address)
end
end
it "#write_array_of_type for uint8" do
values = [10, 227, 32]
memory = FFI::MemoryPointer.new FFI::TYPE_UINT8, values.size
memory.write_array_of_type(FFI::TYPE_UINT8, :put_uint8, values)
array = memory.read_array_of_type(FFI::TYPE_UINT8, :read_uint8, values.size)
values.each_with_index do |val, j|
expect(array[j]).to eq(val)
end
end
it "#write_array_of_type for uint32" do
values = [10, 227, 32]
memory = FFI::MemoryPointer.new FFI::TYPE_UINT32, values.size
memory.write_array_of_type(FFI::TYPE_UINT32, :put_uint32, values)
array = memory.read_array_of_type(FFI::TYPE_UINT32, :read_uint32, values.size)
values.each_with_index do |val, j|
expect(array[j]).to eq(val)
end
end
it "#write_array_of_type should raise an error with non-array argument" do
memory = FFI::MemoryPointer.new FFI::TYPE_INT8, 1
expect { memory.write_array_of_int8(0) }.to raise_error(TypeError)
end
end
describe 'NULL' do
it 'should be obtained using Pointer::NULL constant' do
null_ptr = FFI::Pointer::NULL
expect(null_ptr).to be_null
end
it 'should be obtained passing address 0 to constructor' do
expect(FFI::Pointer.new(0)).to be_null
end
it 'should raise an error when attempting read/write operations on it' do
null_ptr = FFI::Pointer::NULL
expect { null_ptr.read_int }.to raise_error(FFI::NullPointerError)
expect { null_ptr.write_int(0xff1) }.to raise_error(FFI::NullPointerError)
end
it 'returns true when compared with nil' do
expect((FFI::Pointer::NULL == nil)).to be true
end
it 'should not raise an error when attempting read/write zero length array' do
null_ptr = FFI::Pointer::NULL
expect( null_ptr.read_array_of_uint(0) ).to eq([])
null_ptr.write_array_of_uint([])
end
end
it "Pointer.size returns sizeof pointer on platform" do
expect(FFI::Pointer.size).to eq((FFI::Platform::ADDRESS_SIZE / 8))
end
describe "#slice" do
before(:each) do
@mptr = FFI::MemoryPointer.new(:char, 12)
@mptr.put_uint(0, 0x12345678)
@mptr.put_uint(4, 0xdeadbeef)
end
it "contents of sliced pointer matches original pointer at offset" do
expect(@mptr.slice(4, 4).get_uint(0)).to eq(0xdeadbeef)
end
it "modifying sliced pointer is reflected in original pointer" do
@mptr.slice(4, 4).put_uint(0, 0xfee1dead)
expect(@mptr.get_uint(4)).to eq(0xfee1dead)
end
it "access beyond bounds should raise IndexError" do
expect { @mptr.slice(4, 4).get_int(4) }.to raise_error(IndexError)
end
end
describe "#type_size" do
it "should be same as FFI.type_size(type)" do
expect(FFI::MemoryPointer.new(:int, 1).type_size).to eq(FFI.type_size(:int))
end
end
describe "#order" do
it "should return the system order by default" do
expect(FFI::Pointer.new(0x0).order).to eq(OrderHelper::ORDER)
end
it "should return self if there is no change" do
pointer = FFI::Pointer.new(0x0)
expect(pointer.order(OrderHelper::ORDER)).to be pointer
end
it "should return a new pointer if there is a change" do
pointer = FFI::Pointer.new(0x0)
expect(pointer.order(OrderHelper::OTHER_ORDER)).to_not be pointer
end
it "can be set to :little" do
expect(FFI::Pointer.new(0x0).order(:little).order).to eq(:little)
end
it "can be set to :big" do
expect(FFI::Pointer.new(0x0).order(:big).order).to eq(:big)
end
it "can be set to :network, which sets it to :big" do
expect(FFI::Pointer.new(0x0).order(:network).order).to eq(:big)
end
it "cannot be set to other symbols" do
expect { FFI::Pointer.new(0x0).order(:unknown) }.to raise_error(ArgumentError)
end
it "can be used to read in little order" do
pointer = FFI::MemoryPointer.from_string("\x1\x2\x3\x4").order(:little)
expect(pointer.read_int32).to eq(67305985)
end
it "can be used to read in big order" do
pointer = FFI::MemoryPointer.from_string("\x1\x2\x3\x4").order(:big)
expect(pointer.read_int32).to eq(16909060)
end
it "can be used to read in network order" do
pointer = FFI::MemoryPointer.from_string("\x1\x2\x3\x4").order(:network)
expect(pointer.read_int32).to eq(16909060)
end
end if RUBY_ENGINE != "truffleruby"
describe "#size_limit?" do
it "should not have size limit" do
expect(FFI::Pointer.new(0).size_limit?).to be false
end
it "should have size limit" do
expect(FFI::Pointer.new(0).slice(0, 10).size_limit?).to be true
end
end
describe "#initialise" do
it 'can use adresses with high bit set' do
max_address = 2**FFI::Platform::ADDRESS_SIZE - 1
pointer = FFI::Pointer.new(:uint8, max_address)
expect(pointer.address).to eq(max_address)
end
end if (RUBY_ENGINE != "truffleruby" && RUBY_ENGINE != "jruby")
end
describe "AutoPointer" do
loop_count = 30
wiggle_room = 5 # GC rarely cleans up all objects. we can get most of them, and that's enough to determine if the basic functionality is working.
magic = 0x12345678
class AutoPointerTestHelper
@@count = 0
def self.release
@@count += 1 if @@count > 0
end
private_class_method(:release)
def self.reset
@@count = 0
end
def self.gc_everything(count)
loop = 5
while @@count < count && loop > 0
loop -= 1
TestLibrary.force_gc
sleep 0.05 unless @@count == count
end
@@count = 0
end
def self.finalizer
self.method(:release).to_proc
end
end
class AutoPointerSubclass < FFI::AutoPointer
def self.release(ptr); end
private_class_method(:release)
end
# see #427
it "cleanup via default release method", gc_dependent: true do
expect(AutoPointerSubclass).to receive(:release).at_least(loop_count-wiggle_room).times
AutoPointerTestHelper.reset
loop_count.times do
# note that if we called
# AutoPointerTestHelper.method(:release).to_proc inline, we'd
# have a reference to the pointer and it would never get GC'd.
AutoPointerSubclass.new(PointerTestLib.ptr_from_address(magic))
end
AutoPointerTestHelper.gc_everything loop_count
end
# see #427
it "cleanup when passed a proc", gc_dependent: true do
# NOTE: passing a proc is touchy, because it's so easy to create a memory leak.
#
# specifically, if we made an inline call to
#
# AutoPointerTestHelper.method(:release).to_proc
#
# we'd have a reference to the pointer and it would
# never get GC'd.
expect(AutoPointerTestHelper).to receive(:release).at_least(loop_count-wiggle_room).times
AutoPointerTestHelper.reset
loop_count.times do
FFI::AutoPointer.new(PointerTestLib.ptr_from_address(magic),
AutoPointerTestHelper.finalizer)
end
AutoPointerTestHelper.gc_everything loop_count
end
# see #427
it "cleanup when passed a method", gc_dependent: true do
expect(AutoPointerTestHelper).to receive(:release).at_least(loop_count-wiggle_room).times
AutoPointerTestHelper.reset
loop_count.times do
FFI::AutoPointer.new(PointerTestLib.ptr_from_address(magic),
AutoPointerTestHelper.method(:release))
end
AutoPointerTestHelper.gc_everything loop_count
end
it "can be used as the return type of a function" do
expect do
Module.new do
extend FFI::Library
ffi_lib TestLibrary::PATH
class CustomAutoPointer < FFI::AutoPointer
def self.release(ptr); end
private_class_method(:release)
end
attach_function :ptr_from_address, [ FFI::Platform::ADDRESS_SIZE == 32 ? :uint : :ulong_long ], CustomAutoPointer
end
end.not_to raise_error
end
describe "#new" do
it "MemoryPointer argument raises TypeError" do
expect { FFI::AutoPointer.new(FFI::MemoryPointer.new(:int))}.to raise_error(::TypeError)
end
it "AutoPointer argument raises TypeError" do
expect { AutoPointerSubclass.new(AutoPointerSubclass.new(PointerTestLib.ptr_from_address(0))) }.to raise_error(::TypeError)
end
it "Buffer argument raises TypeError" do
expect { FFI::AutoPointer.new(FFI::Buffer.new(:int))}.to raise_error(::TypeError)
end
end
describe "#autorelease?" do
ptr_class = Class.new(FFI::AutoPointer) do
def self.release(ptr); end
private_class_method(:release)
end
it "should be true by default" do
expect(ptr_class.new(FFI::Pointer.new(0xdeadbeef)).autorelease?).to be true
end
it "should return false when autorelease=(false)" do
ptr = ptr_class.new(FFI::Pointer.new(0xdeadbeef))
ptr.autorelease = false
expect(ptr.autorelease?).to be false
end
end
describe "#type_size" do
ptr_class = Class.new(FFI::AutoPointer) do
def self.release(ptr); end
private_class_method(:release)
end
it "type_size of AutoPointer should match wrapped Pointer" do
aptr = ptr_class.new(FFI::Pointer.new(:int, 0xdeadbeef))
expect(aptr.type_size).to eq(FFI.type_size(:int))
end
it "[] offset should match wrapped Pointer" do
mptr = FFI::MemoryPointer.new(:int, 1024)
aptr = ptr_class.new(FFI::Pointer.new(:int, mptr))
aptr[0].write_uint(0xfee1dead)
aptr[1].write_uint(0xcafebabe)
expect(mptr[0].read_uint).to eq(0xfee1dead)
expect(mptr[1].read_uint).to eq(0xcafebabe)
end
end
it "has a memsize function", skip: RUBY_ENGINE != "ruby" do
base_size = ObjectSpace.memsize_of(Object.new)
pointer = FFI::Pointer.new(:int, 0xdeadbeef)
size = ObjectSpace.memsize_of(pointer)
expect(size).to be > base_size
end
end
|