Class: FFI::Pointer

Inherits:
AbstractMemory show all
Defined in:
ext/ffi_c/Pointer.c,
lib/ffi/pointer.rb,
ext/ffi_c/Pointer.c

Overview

Pointer class is used to manage C pointers with ease. A Pointer object is defined by his #address (as a C pointer). It permits additions with an integer for pointer arithmetic.

Autorelease

By default a pointer object frees its content when it’s garbage collected. Therefore it’s usually not necessary to call #free explicit. This behaviour may be changed with #autorelease= method. If it’s set to false, the memory isn’t freed by the garbage collector, but stays valid until free() is called on C level or when the process terminates.

Constant Summary collapse

SIZE =

Pointer size

Platform::ADDRESS_SIZE / 8
NULL =

NULL pointer

rbffi_NullPointerSingleton

Constants inherited from AbstractMemory

AbstractMemory::LONG_MAX

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractMemory

#[], #__copy_from__, #clear, #freeze, #get, #get_array_of_float32, #get_array_of_float64, #get_array_of_pointer, #get_array_of_string, #get_bytes, #get_float32, #get_float64, #get_pointer, #get_string, #put, #put_array_of_float32, #put_array_of_float64, #put_array_of_pointer, #put_bytes, #put_float32, #put_float64, #put_pointer, #put_string, #read_array_of_double, #read_array_of_float, #read_array_of_pointer, #read_bytes, #read_double, #read_float, #read_pointer, #size_limit?, #total, #write_array_of_double, #write_array_of_float, #write_array_of_pointer, #write_bytes, #write_double, #write_float, #write_pointer

Constructor Details

#initialize(pointer) ⇒ self #initialize(type, address) ⇒ self

A new instance of Pointer.

Overloads:

  • #initialize(pointer) ⇒ self

    Create a new pointer from another FFI::Pointer.

    Parameters:

    • pointer (Pointer)

      another pointer to initialize from

  • #initialize(type, address) ⇒ self

    Create a new pointer from a Type and a base address

    Parameters:

    • type (Type)

      type for pointer

    • address (Integer)

      base address for pointer



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
# File 'ext/ffi_c/Pointer.c', line 108

static VALUE
ptr_initialize(int argc, VALUE* argv, VALUE self)
{
    Pointer* p;
    VALUE rbType = Qnil, rbAddress = Qnil;
    int typeSize = 1;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, p);

    switch (rb_scan_args(argc, argv, "11", &rbType, &rbAddress)) {
        case 1:
            rbAddress = rbType;
            typeSize = 1;
            break;
        case 2:
            typeSize = rbffi_type_size(rbType);
            break;
        default:
            rb_raise(rb_eArgError, "Invalid arguments");
    }

    switch (TYPE(rbAddress)) {
        case T_FIXNUM:
        case T_BIGNUM:
            p->memory.address = (void*) (uintptr_t) NUM2ULL(rbAddress);
            p->memory.size = LONG_MAX;
            if (p->memory.address == NULL) {
                p->memory.flags = 0;
            }
            break;

        default:
            if (rb_obj_is_kind_of(rbAddress, rbffi_PointerClass)) {
                Pointer* orig;

                RB_OBJ_WRITE(self, &p->rbParent, rbAddress);
                TypedData_Get_Struct(rbAddress, Pointer, &rbffi_pointer_data_type, orig);
                p->memory = orig->memory;
            } else {
                rb_raise(rb_eTypeError, "wrong argument type, expected Integer or FFI::Pointer");
            }
            break;
    }

    p->memory.typeSize = typeSize;

    return self;
}

Class Method Details

.sizeNumeric

Return the size of a pointer on the current platform, in bytes

Returns:

  • (Numeric)


49
50
51
# File 'lib/ffi/pointer.rb', line 49

def self.size
  SIZE
end

Instance Method Details

#+(offset) ⇒ Pointer

Return a new FFI::Pointer from an existing pointer and an offset.

Parameters:

  • offset (Numeric)

Returns:



236
237
238
239
240
241
242
243
244
245
# File 'ext/ffi_c/Pointer.c', line 236

static VALUE
ptr_plus(VALUE self, VALUE offset)
{
    AbstractMemory* ptr;
    long off = NUM2LONG(offset);

    TypedData_Get_Struct(self, AbstractMemory, &rbffi_abstract_memory_data_type, ptr);

    return slice(self, off, ptr->size == LONG_MAX ? LONG_MAX : ptr->size - off);
}

#==(other) ⇒ Object

Check equality between self and other. Equality is tested on #address.

Parameters:



306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'ext/ffi_c/Pointer.c', line 306

static VALUE
ptr_equals(VALUE self, VALUE other)
{
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    if (NIL_P(other)) {
        return ptr->memory.address == NULL ? Qtrue : Qfalse;
    }

    return ptr->memory.address == POINTER(other)->address ? Qtrue : Qfalse;
}

#addressNumeric Also known as: to_i

Return self‘s base address (alias: #to_i).

Returns:

  • (Numeric)

    pointer’s base address



325
326
327
328
329
330
331
332
333
# File 'ext/ffi_c/Pointer.c', line 325

static VALUE
ptr_address(VALUE self)
{
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    return ULL2NUM((uintptr_t) ptr->memory.address);
}

#autorelease=(autorelease) ⇒ Boolean

Set autorelease attribute. See also Autorelease section.

Parameters:

  • autorelease (Boolean)

Returns:

  • (Boolean)

    autorelease



436
437
438
439
440
441
442
443
444
445
446
# File 'ext/ffi_c/Pointer.c', line 436

static VALUE
ptr_autorelease(VALUE self, VALUE autorelease)
{
    Pointer* ptr;

    rb_check_frozen(self);
    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);
    ptr->autorelease = autorelease == Qtrue;

    return autorelease;
}

#autorelease?Boolean

Get autorelease attribute. See also Autorelease section.

Returns:

  • (Boolean)


453
454
455
456
457
458
459
460
461
# File 'ext/ffi_c/Pointer.c', line 453

static VALUE
ptr_autorelease_p(VALUE self)
{
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    return ptr->autorelease ? Qtrue : Qfalse;
}

#freeself

Free memory pointed by self.

Returns:

  • (self)


396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'ext/ffi_c/Pointer.c', line 396

static VALUE
ptr_free(VALUE self)
{
    Pointer* ptr;

    rb_check_frozen(self);
    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    if (ptr->allocated) {
        if (ptr->storage != NULL) {
            xfree(ptr->storage);
            ptr->storage = NULL;
        }
        ptr->allocated = false;

    } else {
        VALUE caller = rb_funcall(rb_funcall(Qnil, rb_intern("caller"), 0), rb_intern("first"), 0);

        rb_warn("calling free on non allocated pointer %s from %s", RSTRING_PTR(ptr_inspect(self)), RSTRING_PTR(rb_str_to_str(caller)));
    }

    return self;
}

#initialize_copy(other) ⇒ self

DO NOT CALL THIS METHOD.

This method is internally used by #dup and #clone. Memory content is copied from other.

Parameters:

  • other (Pointer)

    source for cloning or dupping

Returns:

  • (self)

Raises:

  • (RuntimeError)

    if other is an unbounded memory area, or is unreadable/unwritable

  • (NoMemError)

    if failed to allocate memory for new object



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
# File 'ext/ffi_c/Pointer.c', line 167

static VALUE
ptr_initialize_copy(VALUE self, VALUE other)
{
    AbstractMemory* src;
    Pointer* dst;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, dst);
    src = POINTER(other);
    if (src->size == LONG_MAX) {
        rb_raise(rb_eRuntimeError, "cannot duplicate unbounded memory area");
        return Qnil;
    }

    if ((dst->memory.flags & (MEM_RD | MEM_WR)) != (MEM_RD | MEM_WR)) {
        rb_raise(rb_eRuntimeError, "cannot duplicate unreadable/unwritable memory area");
        return Qnil;
    }

    if (dst->storage != NULL) {
        xfree(dst->storage);
        dst->storage = NULL;
    }

    dst->storage = xmalloc(src->size + 7);
    if (dst->storage == NULL) {
        rb_raise(rb_eNoMemError, "failed to allocate memory size=%lu bytes", src->size);
        return Qnil;
    }

    dst->allocated = true;
    dst->autorelease = true;
    dst->memory.address = (void *) (((uintptr_t) dst->storage + 0x7) & (uintptr_t) ~0x7ULL);
    dst->memory.size = src->size;
    dst->memory.typeSize = src->typeSize;

    /* finally, copy the actual memory contents */
    memcpy(dst->memory.address, src->address, src->size);

    return self;
}

#inspectString

Inspect pointer object.

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'ext/ffi_c/Pointer.c', line 266

static VALUE
ptr_inspect(VALUE self)
{
    char buf[100];
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    if (ptr->memory.size != LONG_MAX) {
        snprintf(buf, sizeof(buf), "#<%s address=%p size=%lu>",
                rb_obj_classname(self), ptr->memory.address, ptr->memory.size);
    } else {
        snprintf(buf, sizeof(buf), "#<%s address=%p>", rb_obj_classname(self), ptr->memory.address);
    }

    return rb_str_new2(buf);
}

#null?Boolean

Return true if self is a NULL pointer.

Returns:

  • (Boolean)


290
291
292
293
294
295
296
297
298
# File 'ext/ffi_c/Pointer.c', line 290

static VALUE
ptr_null_p(VALUE self)
{
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    return ptr->memory.address == NULL ? Qtrue : Qfalse;
}

#order:big, :little #order(order) ⇒ Object

Get or set self‘s endianness

Overloads:

  • #order:big, :little

    Returns endianness of self.

    Returns:

    • (:big, :little)

      endianness of self

  • #order(order) ⇒ Object

    Returns a new pointer with the new order.

    Parameters:

    • order (Symbol)

      endianness to set (:little, :big or :network). :big and :network are synonymous.

    Returns:

    • a new pointer with the new order



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
# File 'ext/ffi_c/Pointer.c', line 350

static VALUE
ptr_order(int argc, VALUE* argv, VALUE self)
{
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);
    if (argc == 0) {
        int order = (ptr->memory.flags & MEM_SWAP) == 0 ? BYTE_ORDER : SWAPPED_ORDER;
        return order == BIG_ENDIAN ? ID2SYM(rb_intern("big")) : ID2SYM(rb_intern("little"));
    } else {
        VALUE rbOrder = Qnil;
        int order = BYTE_ORDER;

        if (rb_scan_args(argc, argv, "1", &rbOrder) < 1) {
            rb_raise(rb_eArgError, "need byte order");
        }
        if (SYMBOL_P(rbOrder)) {
            ID id = SYM2ID(rbOrder);
            if (id == rb_intern("little")) {
                order = LITTLE_ENDIAN;

            } else if (id == rb_intern("big") || id == rb_intern("network")) {
                order = BIG_ENDIAN;
            } else {
                rb_raise(rb_eArgError, "unknown byte order");
            }
        }
        if (order != BYTE_ORDER) {
            Pointer* p2;
            VALUE retval = slice(self, 0, ptr->memory.size);

            TypedData_Get_Struct(retval, Pointer, &rbffi_pointer_data_type, p2);
            p2->memory.flags |= MEM_SWAP;
            return retval;
        }

        return self;
    }
}

#read(type) ⇒ Object

Read pointer’s contents as type

Same as:

ptr.get(type, 0)

Parameters:

  • type (Symbol, Type)

    of data to read

Returns:

  • (Object)


152
153
154
# File 'lib/ffi/pointer.rb', line 152

def read(type)
  get(type, 0)
end

#read_array_of_type(type, reader, length) ⇒ Array

Read an array of type of length length.

Examples:

ptr.read_array_of_type(TYPE_UINT8, :read_uint8, 4) # -> [1, 2, 3, 4]

Parameters:

  • type (Type)

    type of data to read from pointer’s contents

  • reader (Symbol)

    method to send to self to read type

  • length (Numeric)

Returns:

  • (Array)


114
115
116
117
118
119
120
121
122
123
# File 'lib/ffi/pointer.rb', line 114

def read_array_of_type(type, reader, length)
  ary = []
  size = FFI.type_size(type)
  tmp = self
  length.times { |j|
    ary << tmp.send(reader)
    tmp += size unless j == length-1 # avoid OOB
  }
  ary
end

#read_string(len = nil) ⇒ String

Read pointer’s contents as a string, or the first len bytes of the equivalent string if len is not nil.

Parameters:

  • len (nil, Numeric) (defaults to: nil)

    length of string to return

Returns:

  • (String)


57
58
59
60
61
62
63
64
# File 'lib/ffi/pointer.rb', line 57

def read_string(len=nil)
  if len
    return ''.b if len == 0
    get_bytes(0, len)
  else
    get_string(0)
  end
end

#read_string_length(len) ⇒ String

Read the first len bytes of pointer’s contents as a string.

Same as:

ptr.read_string(len)  # with len not nil

Parameters:

  • len (Numeric)

    length of string to return

Returns:

  • (String)


72
73
74
# File 'lib/ffi/pointer.rb', line 72

def read_string_length(len)
  get_bytes(0, len)
end

#read_string_to_nullString

Read pointer’s contents as a string.

Same as:

ptr.read_string  # with no len

Returns:

  • (String)


81
82
83
# File 'lib/ffi/pointer.rb', line 81

def read_string_to_null
  get_string(0)
end

#slice(offset, length) ⇒ Pointer

Return a new FFI::Pointer from an existing one. This pointer points on same contents from offset for a length length.

Parameters:

  • offset (Numeric)
  • length (Numeric)

Returns:



255
256
257
258
259
# File 'ext/ffi_c/Pointer.c', line 255

static VALUE
ptr_slice(VALUE self, VALUE rbOffset, VALUE rbLength)
{
    return slice(self, NUM2LONG(rbOffset), NUM2LONG(rbLength));
}

#to_ptrself

Returns:

  • (self)


142
143
144
# File 'lib/ffi/pointer.rb', line 142

def to_ptr
  self
end

#inspectString

Inspect pointer object.

Returns:

  • (String)


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'ext/ffi_c/Pointer.c', line 266

static VALUE
ptr_inspect(VALUE self)
{
    char buf[100];
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    if (ptr->memory.size != LONG_MAX) {
        snprintf(buf, sizeof(buf), "#<%s address=%p size=%lu>",
                rb_obj_classname(self), ptr->memory.address, ptr->memory.size);
    } else {
        snprintf(buf, sizeof(buf), "#<%s address=%p>", rb_obj_classname(self), ptr->memory.address);
    }

    return rb_str_new2(buf);
}

#type_sizeObject



420
421
422
423
424
425
426
427
428
# File 'ext/ffi_c/Pointer.c', line 420

static VALUE
ptr_type_size(VALUE self)
{
    Pointer* ptr;

    TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);

    return INT2NUM(ptr->memory.typeSize);
}

#write(type, value) ⇒ nil

Write value of type type to pointer’s content

Same as:

ptr.put(type, 0)

Parameters:

  • type (Symbol, Type)

    of data to read

  • value (Object)

    to write

Returns:

  • (nil)


163
164
165
# File 'lib/ffi/pointer.rb', line 163

def write(type, value)
  put(type, 0, value)
end

#write_array_of_type(type, writer, ary) ⇒ self

Write ary in pointer’s contents as type.

Examples:

ptr.write_array_of_type(TYPE_UINT8, :put_uint8, [1, 2, 3 ,4])

Parameters:

  • type (Type)

    type of data to write to pointer’s contents

  • writer (Symbol)

    method to send to self to write type

  • ary (Array)

Returns:

  • (self)


132
133
134
135
136
137
138
139
# File 'lib/ffi/pointer.rb', line 132

def write_array_of_type(type, writer, ary)
  size = FFI.type_size(type)
  ary.each_with_index { |val, i|
    break unless i < self.size
    self.send(writer, i * size, val)
  }
  self
end

#write_string(str, len = nil) ⇒ self

Write str in pointer’s contents, or first len bytes if len is not nil.

Parameters:

  • str (String)

    string to write

  • len (Numeric) (defaults to: nil)

    length of string to return

Returns:

  • (self)


101
102
103
104
105
# File 'lib/ffi/pointer.rb', line 101

def write_string(str, len=nil)
  len = str.bytesize unless len
  # Write the string data without NUL termination
  put_bytes(0, str, 0, len)
end

#write_string_length(str, len) ⇒ self

Write len first bytes of str in pointer’s contents.

Same as:

ptr.write_string(str, len)   # with len not nil

Parameters:

  • str (String)

    string to write

  • len (Numeric)

    length of string to return

Returns:

  • (self)


92
93
94
# File 'lib/ffi/pointer.rb', line 92

def write_string_length(str, len)
  put_bytes(0, str, 0, len)
end