14#include "internal/array.h"
15#include "internal/bits.h"
16#include "internal/error.h"
17#include "internal/numeric.h"
18#include "internal/string.h"
19#include "internal/thread.h"
22VALUE rb_eIOBufferLockedError;
23VALUE rb_eIOBufferAllocationError;
24VALUE rb_eIOBufferAccessError;
25VALUE rb_eIOBufferInvalidatedError;
26VALUE rb_eIOBufferMaskError;
28size_t RUBY_IO_BUFFER_PAGE_SIZE;
29size_t RUBY_IO_BUFFER_DEFAULT_SIZE;
40 enum rb_io_buffer_flags flags;
50io_buffer_map_memory(
size_t size,
int flags)
53 void * base = VirtualAlloc(0, size, MEM_COMMIT, PAGE_READWRITE);
59 int mmap_flags = MAP_ANONYMOUS;
60 if (flags & RB_IO_BUFFER_SHARED) {
61 mmap_flags |= MAP_SHARED;
63 mmap_flags |= MAP_PRIVATE;
66 void * base = mmap(NULL, size, PROT_READ | PROT_WRITE, mmap_flags, -1, 0);
68 if (base == MAP_FAILED) {
77io_buffer_map_file(
struct rb_io_buffer *data,
int descriptor,
size_t size, rb_off_t offset,
enum rb_io_buffer_flags flags)
80 HANDLE file = (HANDLE)_get_osfhandle(descriptor);
81 if (!file)
rb_sys_fail(
"io_buffer_map_descriptor:_get_osfhandle");
83 DWORD protect = PAGE_READONLY, access = FILE_MAP_READ;
85 if (flags & RB_IO_BUFFER_READONLY) {
86 data->flags |= RB_IO_BUFFER_READONLY;
89 protect = PAGE_READWRITE;
90 access = FILE_MAP_WRITE;
93 HANDLE mapping = CreateFileMapping(file, NULL, protect, 0, 0, NULL);
94 if (!mapping)
rb_sys_fail(
"io_buffer_map_descriptor:CreateFileMapping");
96 if (flags & RB_IO_BUFFER_PRIVATE) {
97 access |= FILE_MAP_COPY;
98 data->flags |= RB_IO_BUFFER_PRIVATE;
102 data->flags |= RB_IO_BUFFER_EXTERNAL;
103 data->flags |= RB_IO_BUFFER_SHARED;
106 void *base = MapViewOfFile(mapping, access, (DWORD)(offset >> 32), (DWORD)(offset & 0xFFFFFFFF), size);
109 CloseHandle(mapping);
113 data->mapping = mapping;
115 int protect = PROT_READ, access = 0;
117 if (flags & RB_IO_BUFFER_READONLY) {
118 data->flags |= RB_IO_BUFFER_READONLY;
121 protect |= PROT_WRITE;
124 if (flags & RB_IO_BUFFER_PRIVATE) {
125 data->flags |= RB_IO_BUFFER_PRIVATE;
129 data->flags |= RB_IO_BUFFER_EXTERNAL;
130 data->flags |= RB_IO_BUFFER_SHARED;
131 access |= MAP_SHARED;
134 void *base = mmap(NULL, size, protect, access, descriptor, offset);
136 if (base == MAP_FAILED) {
144 data->flags |= RB_IO_BUFFER_MAPPED;
148io_buffer_unmap(
void* base,
size_t size)
151 VirtualFree(base, 0, MEM_RELEASE);
158io_buffer_experimental(
void)
160 static int warned = 0;
168 "IO::Buffer is experimental and both the Ruby and C interface may change in the future!"
179 data->mapping = NULL;
185io_buffer_initialize(
struct rb_io_buffer *data,
void *base,
size_t size,
enum rb_io_buffer_flags flags,
VALUE source)
192 if (flags & RB_IO_BUFFER_INTERNAL) {
193 base = calloc(size, 1);
195 else if (flags & RB_IO_BUFFER_MAPPED) {
196 base = io_buffer_map_memory(size, flags);
200 rb_raise(rb_eIOBufferAllocationError,
"Could not allocate buffer!");
211 data->source = source;
218 if (data->flags & RB_IO_BUFFER_INTERNAL) {
222 if (data->flags & RB_IO_BUFFER_MAPPED) {
223 io_buffer_unmap(data->base, data->size);
236 CloseHandle(data->mapping);
237 data->mapping = NULL;
251rb_io_buffer_type_mark(
void *_data)
254 rb_gc_mark(data->source);
258rb_io_buffer_type_free(
void *_data)
262 io_buffer_free(data);
268rb_io_buffer_type_size(
const void *_data)
283 .dmark = rb_io_buffer_type_mark,
284 .dfree = rb_io_buffer_type_free,
285 .dsize = rb_io_buffer_type_size,
288 .flags = RUBY_TYPED_FREE_IMMEDIATELY,
292rb_io_buffer_type_allocate(
VALUE self)
297 io_buffer_zero(data);
302static VALUE io_buffer_for_make_instance(
VALUE klass,
VALUE string,
enum rb_io_buffer_flags flags)
304 VALUE instance = rb_io_buffer_type_allocate(klass);
309 flags |= RB_IO_BUFFER_EXTERNAL;
312 flags |= RB_IO_BUFFER_READONLY;
314 if (!(flags & RB_IO_BUFFER_READONLY))
326 enum rb_io_buffer_flags flags;
330io_buffer_for_yield_instance(
VALUE _arguments)
334 arguments->instance = io_buffer_for_make_instance(arguments->klass, arguments->string, arguments->flags);
338 return rb_yield(arguments->instance);
342io_buffer_for_yield_instance_ensure(
VALUE _arguments)
346 if (arguments->instance !=
Qnil) {
347 rb_io_buffer_free(arguments->instance);
392rb_io_buffer_type_for(
VALUE klass,
VALUE string)
406 return rb_ensure(io_buffer_for_yield_instance, (
VALUE)&arguments, io_buffer_for_yield_instance_ensure, (
VALUE)&arguments);
410 string = rb_str_tmp_frozen_acquire(
string);
411 return io_buffer_for_make_instance(klass,
string, RB_IO_BUFFER_READONLY);
416rb_io_buffer_new(
void *base,
size_t size,
enum rb_io_buffer_flags flags)
418 VALUE instance = rb_io_buffer_type_allocate(rb_cIOBuffer);
423 io_buffer_initialize(data, base, size, flags,
Qnil);
429rb_io_buffer_map(
VALUE io,
size_t size, rb_off_t offset,
enum rb_io_buffer_flags flags)
431 io_buffer_experimental();
433 VALUE instance = rb_io_buffer_type_allocate(rb_cIOBuffer);
440 io_buffer_map_file(data, descriptor, size, offset, flags);
485io_buffer_map(
int argc,
VALUE *argv,
VALUE klass)
493 if (argc >= 2 && !
RB_NIL_P(argv[1])) {
497 rb_off_t file_size = rb_file_size(io);
504 else if ((uintmax_t)file_size > SIZE_MAX) {
509 size = (size_t)file_size;
518 enum rb_io_buffer_flags flags = 0;
523 return rb_io_buffer_map(io, size, offset, flags);
527static inline enum rb_io_buffer_flags
528io_flags_for_size(
size_t size)
530 if (size >= RUBY_IO_BUFFER_PAGE_SIZE) {
531 return RB_IO_BUFFER_MAPPED;
534 return RB_IO_BUFFER_INTERNAL;
564rb_io_buffer_initialize(
int argc,
VALUE *argv,
VALUE self)
566 io_buffer_experimental();
579 size = RUBY_IO_BUFFER_DEFAULT_SIZE;
582 enum rb_io_buffer_flags flags = 0;
587 flags |= io_flags_for_size(size);
590 io_buffer_initialize(data, NULL, size, flags,
Qnil);
596io_buffer_validate_slice(
VALUE source,
void *base,
size_t size)
598 void *source_base = NULL;
599 size_t source_size = 0;
605 rb_io_buffer_get_bytes(source, &source_base, &source_size);
609 if (source_base == NULL)
return 0;
612 if (base < source_base)
return 0;
614 const void *source_end = (
char*)source_base + source_size;
615 const void *end = (
char*)base + size;
618 if (end > source_end)
return 0;
627 if (data->source !=
Qnil) {
629 return io_buffer_validate_slice(data->source, data->base, data->size);
646rb_io_buffer_to_s(
VALUE self)
654 rb_str_catf(result,
" %p+%"PRIdSIZE, data->base, data->size);
656 if (data->base == NULL) {
660 if (data->flags & RB_IO_BUFFER_EXTERNAL) {
664 if (data->flags & RB_IO_BUFFER_INTERNAL) {
668 if (data->flags & RB_IO_BUFFER_MAPPED) {
672 if (data->flags & RB_IO_BUFFER_SHARED) {
676 if (data->flags & RB_IO_BUFFER_LOCKED) {
680 if (data->flags & RB_IO_BUFFER_READONLY) {
684 if (data->source !=
Qnil) {
688 if (!io_buffer_validate(data)) {
696io_buffer_hexdump(
VALUE string,
size_t width,
char *base,
size_t size,
int first)
698 char *text = alloca(width+1);
701 for (
size_t offset = 0; offset < size; offset += width) {
702 memset(text,
'\0', width);
708 rb_str_catf(
string,
"\n0x%08" PRIxSIZE
" ", offset);
711 for (
size_t i = 0; i < width; i += 1) {
712 if (offset+i < size) {
713 unsigned char value = ((
unsigned char*)base)[offset+i];
715 if (value < 127 && isprint(value)) {
716 text[i] = (char)value;
736rb_io_buffer_hexdump(
VALUE self)
743 if (io_buffer_validate(data) && data->base) {
746 io_buffer_hexdump(result, 16, data->base, data->size, 1);
753rb_io_buffer_inspect(
VALUE self)
758 VALUE result = rb_io_buffer_to_s(self);
760 if (io_buffer_validate(data)) {
762 if (data->size <= 256) {
763 io_buffer_hexdump(result, 16, data->base, data->size, 0);
777rb_io_buffer_size(
VALUE self)
794rb_io_buffer_valid_p(
VALUE self)
799 return RBOOL(io_buffer_validate(data));
809rb_io_buffer_null_p(
VALUE self)
814 return RBOOL(data->base == NULL);
825rb_io_buffer_empty_p(
VALUE self)
830 return RBOOL(data->size == 0);
845rb_io_buffer_external_p(
VALUE self)
850 return RBOOL(data->flags & RB_IO_BUFFER_EXTERNAL);
870rb_io_buffer_internal_p(
VALUE self)
875 return RBOOL(data->flags & RB_IO_BUFFER_INTERNAL);
892rb_io_buffer_mapped_p(
VALUE self)
897 return RBOOL(data->flags & RB_IO_BUFFER_MAPPED);
908rb_io_buffer_shared_p(
VALUE self)
913 return RBOOL(data->flags & RB_IO_BUFFER_SHARED);
933rb_io_buffer_locked_p(
VALUE self)
938 return RBOOL(data->flags & RB_IO_BUFFER_LOCKED);
942rb_io_buffer_readonly_p(
VALUE self)
947 return data->flags & RB_IO_BUFFER_READONLY;
959io_buffer_readonly_p(
VALUE self)
961 return RBOOL(rb_io_buffer_readonly_p(self));
965rb_io_buffer_lock(
VALUE self)
970 if (data->flags & RB_IO_BUFFER_LOCKED) {
971 rb_raise(rb_eIOBufferLockedError,
"Buffer already locked!");
974 data->flags |= RB_IO_BUFFER_LOCKED;
980rb_io_buffer_unlock(
VALUE self)
985 if (!(data->flags & RB_IO_BUFFER_LOCKED)) {
986 rb_raise(rb_eIOBufferLockedError,
"Buffer not locked!");
989 data->flags &= ~RB_IO_BUFFER_LOCKED;
995rb_io_buffer_try_unlock(
VALUE self)
1000 if (data->flags & RB_IO_BUFFER_LOCKED) {
1001 data->flags &= ~RB_IO_BUFFER_LOCKED;
1041rb_io_buffer_locked(
VALUE self)
1046 if (data->flags & RB_IO_BUFFER_LOCKED) {
1047 rb_raise(rb_eIOBufferLockedError,
"Buffer already locked!");
1050 data->flags |= RB_IO_BUFFER_LOCKED;
1054 data->flags &= ~RB_IO_BUFFER_LOCKED;
1087rb_io_buffer_free(
VALUE self)
1092 if (data->flags & RB_IO_BUFFER_LOCKED) {
1093 rb_raise(rb_eIOBufferLockedError,
"Buffer is locked!");
1096 io_buffer_free(data);
1104io_buffer_validate_range(
struct rb_io_buffer *data,
size_t offset,
size_t length)
1106 if (offset > data->size) {
1109 if (offset + length > data->size) {
1115rb_io_buffer_slice(
struct rb_io_buffer *data,
VALUE self,
size_t offset,
size_t length)
1117 io_buffer_validate_range(data, offset, length);
1123 slice->base = (
char*)data->base + offset;
1124 slice->size = length;
1127 if (data->source !=
Qnil)
1128 slice->source = data->source;
1130 slice->source = self;
1192io_buffer_slice(
int argc,
VALUE *argv,
VALUE self)
1199 size_t offset = 0, length = 0;
1202 if (rb_int_negative_p(argv[0])) {
1210 if (rb_int_negative_p(argv[1])) {
1216 length = data->size - offset;
1219 return rb_io_buffer_slice(data, self, offset, length);
1223rb_io_buffer_get_bytes(
VALUE self,
void **base,
size_t *size)
1228 if (io_buffer_validate(data)) {
1244io_buffer_get_bytes_for_writing(
struct rb_io_buffer *data,
void **base,
size_t *size)
1246 if (data->flags & RB_IO_BUFFER_READONLY) {
1247 rb_raise(rb_eIOBufferAccessError,
"Buffer is not writable!");
1250 if (!io_buffer_validate(data)) {
1251 rb_raise(rb_eIOBufferInvalidatedError,
"Buffer is invalid!");
1261 rb_raise(rb_eIOBufferAllocationError,
"The buffer is not allocated!");
1265rb_io_buffer_get_bytes_for_writing(
VALUE self,
void **base,
size_t *size)
1270 io_buffer_get_bytes_for_writing(data, base, size);
1274io_buffer_get_bytes_for_reading(
struct rb_io_buffer *data,
const void **base,
size_t *size)
1276 if (!io_buffer_validate(data)) {
1277 rb_raise(rb_eIOBufferInvalidatedError,
"Buffer has been invalidated!");
1287 rb_raise(rb_eIOBufferAllocationError,
"The buffer is not allocated!");
1291rb_io_buffer_get_bytes_for_reading(
VALUE self,
const void **base,
size_t *size)
1296 io_buffer_get_bytes_for_reading(data, base, size);
1319rb_io_buffer_transfer(
VALUE self)
1324 if (data->flags & RB_IO_BUFFER_LOCKED) {
1325 rb_raise(rb_eIOBufferLockedError,
"Cannot transfer ownership of locked buffer!");
1332 *transferred = *data;
1333 io_buffer_zero(data);
1339io_buffer_resize_clear(
struct rb_io_buffer *data,
void* base,
size_t size)
1341 if (size > data->size) {
1342 memset((
unsigned char*)base+data->size, 0, size - data->size);
1347io_buffer_resize_copy(
struct rb_io_buffer *data,
size_t size)
1351 io_buffer_initialize(&resized, NULL, size, io_flags_for_size(size),
Qnil);
1354 size_t preserve = data->size;
1355 if (preserve > size) preserve = size;
1356 memcpy(resized.base, data->base, preserve);
1358 io_buffer_resize_clear(data, resized.base, size);
1361 io_buffer_free(data);
1366rb_io_buffer_resize(
VALUE self,
size_t size)
1371 if (data->flags & RB_IO_BUFFER_LOCKED) {
1372 rb_raise(rb_eIOBufferLockedError,
"Cannot resize locked buffer!");
1375 if (data->base == NULL) {
1376 io_buffer_initialize(data, NULL, size, io_flags_for_size(size),
Qnil);
1380 if (data->flags & RB_IO_BUFFER_EXTERNAL) {
1381 rb_raise(rb_eIOBufferAccessError,
"Cannot resize external buffer!");
1384#if defined(HAVE_MREMAP) && defined(MREMAP_MAYMOVE)
1385 if (data->flags & RB_IO_BUFFER_MAPPED) {
1386 void *base = mremap(data->base, data->size, size, MREMAP_MAYMOVE);
1388 if (base == MAP_FAILED) {
1392 io_buffer_resize_clear(data, base, size);
1401 if (data->flags & RB_IO_BUFFER_INTERNAL) {
1403 io_buffer_free(data);
1407 void *base = realloc(data->base, size);
1413 io_buffer_resize_clear(data, base, size);
1421 io_buffer_resize_copy(data, size);
1445 rb_io_buffer_resize(self,
NUM2SIZET(size));
1459 const void *ptr1, *ptr2;
1460 size_t size1, size2;
1462 rb_io_buffer_get_bytes_for_reading(self, &ptr1, &size1);
1463 rb_io_buffer_get_bytes_for_reading(other, &ptr2, &size2);
1465 if (size1 < size2) {
1469 if (size1 > size2) {
1473 return RB_INT2NUM(memcmp(ptr1, ptr2, size1));
1477io_buffer_validate_type(
size_t size,
size_t offset)
1479 if (offset > size) {
1480 rb_raise(
rb_eArgError,
"Type extends beyond end of buffer! (offset=%"PRIdSIZE
" > size=%"PRIdSIZE
")", offset, size);
1502#define ruby_swap8(value) value
1510ruby_swapf32(
float value)
1512 union swapf32 swap = {.value = value};
1513 swap.integral = ruby_swap32(swap.integral);
1523ruby_swapf64(
double value)
1525 union swapf64 swap = {.value = value};
1526 swap.integral = ruby_swap64(swap.integral);
1530#define IO_BUFFER_DECLARE_TYPE(name, type, endian, wrap, unwrap, swap) \
1531static ID RB_IO_BUFFER_DATA_TYPE_##name; \
1534io_buffer_read_##name(const void* base, size_t size, size_t *offset) \
1536 io_buffer_validate_type(size, *offset + sizeof(type)); \
1538 memcpy(&value, (char*)base + *offset, sizeof(type)); \
1539 if (endian != RB_IO_BUFFER_HOST_ENDIAN) value = swap(value); \
1540 *offset += sizeof(type); \
1541 return wrap(value); \
1545io_buffer_write_##name(const void* base, size_t size, size_t *offset, VALUE _value) \
1547 io_buffer_validate_type(size, *offset + sizeof(type)); \
1548 type value = unwrap(_value); \
1549 if (endian != RB_IO_BUFFER_HOST_ENDIAN) value = swap(value); \
1550 memcpy((char*)base + *offset, &value, sizeof(type)); \
1551 *offset += sizeof(type); \
1555 RB_IO_BUFFER_DATA_TYPE_##name##_SIZE = sizeof(type) \
1563IO_BUFFER_DECLARE_TYPE(s16, int16_t, RB_IO_BUFFER_LITTLE_ENDIAN,
RB_INT2NUM,
RB_NUM2INT, ruby_swap16)
1564IO_BUFFER_DECLARE_TYPE(S16, int16_t, RB_IO_BUFFER_BIG_ENDIAN,
RB_INT2NUM,
RB_NUM2INT, ruby_swap16)
1568IO_BUFFER_DECLARE_TYPE(s32, int32_t, RB_IO_BUFFER_LITTLE_ENDIAN,
RB_INT2NUM,
RB_NUM2INT, ruby_swap32)
1569IO_BUFFER_DECLARE_TYPE(S32, int32_t, RB_IO_BUFFER_BIG_ENDIAN,
RB_INT2NUM,
RB_NUM2INT, ruby_swap32)
1571IO_BUFFER_DECLARE_TYPE(u64, uint64_t, RB_IO_BUFFER_LITTLE_ENDIAN,
RB_ULL2NUM,
RB_NUM2ULL, ruby_swap64)
1572IO_BUFFER_DECLARE_TYPE(U64, uint64_t, RB_IO_BUFFER_BIG_ENDIAN,
RB_ULL2NUM,
RB_NUM2ULL, ruby_swap64)
1573IO_BUFFER_DECLARE_TYPE(s64, int64_t, RB_IO_BUFFER_LITTLE_ENDIAN,
RB_LL2NUM,
RB_NUM2LL, ruby_swap64)
1574IO_BUFFER_DECLARE_TYPE(S64, int64_t, RB_IO_BUFFER_BIG_ENDIAN,
RB_LL2NUM,
RB_NUM2LL, ruby_swap64)
1576IO_BUFFER_DECLARE_TYPE(f32,
float, RB_IO_BUFFER_LITTLE_ENDIAN,
DBL2NUM,
NUM2DBL, ruby_swapf32)
1577IO_BUFFER_DECLARE_TYPE(F32,
float, RB_IO_BUFFER_BIG_ENDIAN,
DBL2NUM,
NUM2DBL, ruby_swapf32)
1578IO_BUFFER_DECLARE_TYPE(f64,
double, RB_IO_BUFFER_LITTLE_ENDIAN,
DBL2NUM,
NUM2DBL, ruby_swapf64)
1579IO_BUFFER_DECLARE_TYPE(F64,
double, RB_IO_BUFFER_BIG_ENDIAN,
DBL2NUM,
NUM2DBL, ruby_swapf64)
1580#undef IO_BUFFER_DECLARE_TYPE
1583io_buffer_data_type_size(
ID data_type)
1585#define IO_BUFFER_DATA_TYPE_SIZE(name) if (data_type == RB_IO_BUFFER_DATA_TYPE_##name) return RB_IO_BUFFER_DATA_TYPE_##name##_SIZE;
1586 IO_BUFFER_DATA_TYPE_SIZE(U8)
1587 IO_BUFFER_DATA_TYPE_SIZE(S8)
1588 IO_BUFFER_DATA_TYPE_SIZE(u16)
1589 IO_BUFFER_DATA_TYPE_SIZE(U16)
1590 IO_BUFFER_DATA_TYPE_SIZE(s16)
1591 IO_BUFFER_DATA_TYPE_SIZE(S16)
1592 IO_BUFFER_DATA_TYPE_SIZE(u32)
1593 IO_BUFFER_DATA_TYPE_SIZE(U32)
1594 IO_BUFFER_DATA_TYPE_SIZE(s32)
1595 IO_BUFFER_DATA_TYPE_SIZE(S32)
1596 IO_BUFFER_DATA_TYPE_SIZE(u64)
1597 IO_BUFFER_DATA_TYPE_SIZE(U64)
1598 IO_BUFFER_DATA_TYPE_SIZE(s64)
1599 IO_BUFFER_DATA_TYPE_SIZE(S64)
1600 IO_BUFFER_DATA_TYPE_SIZE(f32)
1601 IO_BUFFER_DATA_TYPE_SIZE(F32)
1602 IO_BUFFER_DATA_TYPE_SIZE(f64)
1603 IO_BUFFER_DATA_TYPE_SIZE(F64)
1604#undef IO_BUFFER_DATA_TYPE_SIZE
1622io_buffer_size_of(
VALUE klass,
VALUE data_type)
1626 for (
long i = 0; i <
RARRAY_LEN(data_type); i++) {
1636rb_io_buffer_get_value(
const void* base,
size_t size,
ID data_type,
size_t *offset)
1638#define IO_BUFFER_GET_VALUE(name) if (data_type == RB_IO_BUFFER_DATA_TYPE_##name) return io_buffer_read_##name(base, size, offset);
1639 IO_BUFFER_GET_VALUE(U8)
1640 IO_BUFFER_GET_VALUE(S8)
1642 IO_BUFFER_GET_VALUE(u16)
1643 IO_BUFFER_GET_VALUE(U16)
1644 IO_BUFFER_GET_VALUE(s16)
1645 IO_BUFFER_GET_VALUE(S16)
1647 IO_BUFFER_GET_VALUE(u32)
1648 IO_BUFFER_GET_VALUE(U32)
1649 IO_BUFFER_GET_VALUE(s32)
1650 IO_BUFFER_GET_VALUE(S32)
1652 IO_BUFFER_GET_VALUE(u64)
1653 IO_BUFFER_GET_VALUE(U64)
1654 IO_BUFFER_GET_VALUE(s64)
1655 IO_BUFFER_GET_VALUE(S64)
1657 IO_BUFFER_GET_VALUE(f32)
1658 IO_BUFFER_GET_VALUE(F32)
1659 IO_BUFFER_GET_VALUE(f64)
1660 IO_BUFFER_GET_VALUE(F64)
1661#undef IO_BUFFER_GET_VALUE
1709 rb_io_buffer_get_bytes_for_reading(self, &base, &size);
1711 return rb_io_buffer_get_value(base, size,
RB_SYM2ID(
type), &offset);
1733 rb_io_buffer_get_bytes_for_reading(self, &base, &size);
1741 for (
long i = 0; i <
RARRAY_LEN(data_types); i++) {
1742 VALUE type = rb_ary_entry(data_types, i);
1744 rb_ary_push(array, value);
1769io_buffer_each(
int argc,
VALUE *argv,
VALUE self)
1776 rb_io_buffer_get_bytes_for_reading(self, &base, &size);
1782 data_type = RB_IO_BUFFER_DATA_TYPE_U8;
1796 count = (size - offset) / io_buffer_data_type_size(data_type);
1799 for (
size_t i = 0; i < count; i++) {
1800 size_t current_offset = offset;
1801 VALUE value = rb_io_buffer_get_value(base, size, data_type, &offset);
1821io_buffer_values(
int argc,
VALUE *argv,
VALUE self)
1826 rb_io_buffer_get_bytes_for_reading(self, &base, &size);
1832 data_type = RB_IO_BUFFER_DATA_TYPE_U8;
1846 count = (size - offset) / io_buffer_data_type_size(data_type);
1849 VALUE array = rb_ary_new_capa(count);
1851 for (
size_t i = 0; i < count; i++) {
1852 VALUE value = rb_io_buffer_get_value(base, size, data_type, &offset);
1853 rb_ary_push(array, value);
1877io_buffer_each_byte(
int argc,
VALUE *argv,
VALUE self)
1884 rb_io_buffer_get_bytes_for_reading(self, &base, &size);
1897 count = (size - offset);
1900 for (
size_t i = 0; i < count; i++) {
1901 unsigned char *value = (
unsigned char *)base + i + offset;
1909rb_io_buffer_set_value(
const void* base,
size_t size,
ID data_type,
size_t *offset,
VALUE value)
1911#define IO_BUFFER_SET_VALUE(name) if (data_type == RB_IO_BUFFER_DATA_TYPE_##name) {io_buffer_write_##name(base, size, offset, value); return;}
1912 IO_BUFFER_SET_VALUE(U8);
1913 IO_BUFFER_SET_VALUE(S8);
1915 IO_BUFFER_SET_VALUE(u16);
1916 IO_BUFFER_SET_VALUE(U16);
1917 IO_BUFFER_SET_VALUE(s16);
1918 IO_BUFFER_SET_VALUE(S16);
1920 IO_BUFFER_SET_VALUE(u32);
1921 IO_BUFFER_SET_VALUE(U32);
1922 IO_BUFFER_SET_VALUE(s32);
1923 IO_BUFFER_SET_VALUE(S32);
1925 IO_BUFFER_SET_VALUE(u64);
1926 IO_BUFFER_SET_VALUE(U64);
1927 IO_BUFFER_SET_VALUE(s64);
1928 IO_BUFFER_SET_VALUE(S64);
1930 IO_BUFFER_SET_VALUE(f32);
1931 IO_BUFFER_SET_VALUE(F32);
1932 IO_BUFFER_SET_VALUE(f64);
1933 IO_BUFFER_SET_VALUE(F64);
1934#undef IO_BUFFER_SET_VALUE
1976 rb_io_buffer_get_bytes_for_writing(self, &base, &size);
1978 rb_io_buffer_set_value(base, size,
RB_SYM2ID(
type), &offset, value);
2018 rb_io_buffer_get_bytes_for_writing(self, &base, &size);
2020 for (
long i = 0; i <
RARRAY_LEN(data_types); i++) {
2021 VALUE type = rb_ary_entry(data_types, i);
2022 VALUE value = rb_ary_entry(values, i);
2023 rb_io_buffer_set_value(base, size,
RB_SYM2ID(
type), &offset, value);
2030io_buffer_memcpy(
struct rb_io_buffer *data,
size_t offset,
const void *source_base,
size_t source_offset,
size_t source_size,
size_t length)
2034 io_buffer_get_bytes_for_writing(data, &base, &size);
2036 io_buffer_validate_range(data, offset, length);
2038 if (source_offset + length > source_size) {
2042 memcpy((
unsigned char*)base+offset, (
unsigned char*)source_base+source_offset, length);
2047io_buffer_copy_from(
struct rb_io_buffer *data,
const void *source_base,
size_t source_size,
int argc,
VALUE *argv)
2051 size_t source_offset;
2065 if (source_offset > source_size) {
2074 if (argc >= 2 && !
RB_NIL_P(argv[1])) {
2079 length = source_size - source_offset;
2082 io_buffer_memcpy(data, offset, source_base, source_offset, source_size, length);
2105rb_io_buffer_initialize_copy(
VALUE self,
VALUE source)
2110 const void *source_base;
2113 rb_io_buffer_get_bytes_for_reading(source, &source_base, &source_size);
2115 io_buffer_initialize(data, NULL, source_size, io_flags_for_size(source_size),
Qnil);
2117 return io_buffer_copy_from(data, source_base, source_size, 0, NULL);
2175io_buffer_copy(
int argc,
VALUE *argv,
VALUE self)
2182 VALUE source = argv[0];
2183 const void *source_base;
2186 rb_io_buffer_get_bytes_for_reading(source, &source_base, &source_size);
2188 return io_buffer_copy_from(data, source_base, source_size, argc-1, argv+1);
2206io_buffer_get_string(
int argc,
VALUE *argv,
VALUE self)
2215 io_buffer_get_bytes_for_reading(data, &base, &size);
2218 size_t length = size;
2225 if (argc >= 2 && !
RB_NIL_P(argv[1])) {
2229 length = size - offset;
2233 encoding = rb_find_encoding(argv[2]);
2236 io_buffer_validate_range(data, offset, length);
2238 return rb_enc_str_new((
const char*)base + offset, length, encoding);
2265io_buffer_set_string(
int argc,
VALUE *argv,
VALUE self)
2277 return io_buffer_copy_from(data, source_base, source_size, argc-1, argv+1);
2281rb_io_buffer_clear(
VALUE self, uint8_t value,
size_t offset,
size_t length)
2286 rb_io_buffer_get_bytes_for_writing(self, &base, &size);
2288 if (offset + length > size) {
2292 memset((
char*)base + offset, value, length);
2327io_buffer_clear(
int argc,
VALUE *argv,
VALUE self)
2349 length = data->size - offset;
2352 rb_io_buffer_clear(self, value, offset, length);
2358io_buffer_default_size(
size_t page_size)
2361 const size_t platform_agnostic_default_size = 64*1024;
2364 const char *default_size = getenv(
"RUBY_IO_BUFFER_DEFAULT_SIZE");
2367 int value = atoi(default_size);
2375 if (platform_agnostic_default_size < page_size) {
2379 return platform_agnostic_default_size;
2389io_buffer_read_internal(
void *_argument)
2392 ssize_t result = read(argument->descriptor, argument->base, argument->size);
2397rb_io_buffer_read(
VALUE self,
VALUE io,
size_t length,
size_t offset)
2400 if (scheduler !=
Qnil) {
2403 if (!UNDEF_P(result)) {
2411 io_buffer_validate_range(data, offset, length);
2417 io_buffer_get_bytes_for_writing(data, &base, &size);
2419 base = (
unsigned char*)base + offset;
2422 .descriptor = descriptor,
2427 return rb_thread_io_blocking_region(io_buffer_read_internal, &argument, descriptor);
2455io_buffer_read(
int argc,
VALUE *argv,
VALUE self)
2461 if (rb_int_negative_p(argv[1])) {
2468 if (rb_int_negative_p(argv[2])) {
2475 return rb_io_buffer_read(self, io, length, offset);
2486io_buffer_pread_internal(
void *_argument)
2490#if defined(HAVE_PREAD)
2491 ssize_t result = pread(argument->descriptor, argument->base, argument->size, argument->offset);
2494 rb_off_t offset = lseek(argument->descriptor, 0, SEEK_CUR);
2495 if (offset == (rb_off_t)-1)
2498 if (lseek(argument->descriptor, argument->offset, SEEK_SET) == (rb_off_t)-1)
2501 ssize_t result = read(argument->descriptor, argument->base, argument->size);
2503 if (lseek(argument->descriptor, offset, SEEK_SET) == (rb_off_t)-1)
2511rb_io_buffer_pread(
VALUE self,
VALUE io, rb_off_t from,
size_t length,
size_t offset)
2514 if (scheduler !=
Qnil) {
2517 if (!UNDEF_P(result)) {
2525 io_buffer_validate_range(data, offset, length);
2531 io_buffer_get_bytes_for_writing(data, &base, &size);
2534 .descriptor = descriptor,
2537 .base = (
unsigned char*)base + offset,
2546 return rb_thread_io_blocking_region(io_buffer_pread_internal, &argument, descriptor);
2576io_buffer_pread(
int argc,
VALUE *argv,
VALUE self)
2584 if (rb_int_negative_p(argv[2])) {
2591 if (rb_int_negative_p(argv[3])) {
2598 return rb_io_buffer_pread(self, io, from, length, offset);
2608io_buffer_write_internal(
void *_argument)
2611 ssize_t result = write(argument->descriptor, argument->base, argument->size);
2616rb_io_buffer_write(
VALUE self,
VALUE io,
size_t length,
size_t offset)
2619 if (scheduler !=
Qnil) {
2622 if (!UNDEF_P(result)) {
2630 io_buffer_validate_range(data, offset, length);
2636 io_buffer_get_bytes_for_reading(data, &base, &size);
2638 base = (
unsigned char *)base + offset;
2641 .descriptor = descriptor,
2646 return rb_thread_io_blocking_region(io_buffer_write_internal, &argument, descriptor);
2664io_buffer_write(
int argc,
VALUE *argv,
VALUE self)
2670 if (rb_int_negative_p(argv[1])) {
2677 if (rb_int_negative_p(argv[2])) {
2684 return rb_io_buffer_write(self, io, length, offset);
2695io_buffer_pwrite_internal(
void *_argument)
2699#if defined(HAVE_PWRITE)
2700 ssize_t result = pwrite(argument->descriptor, argument->base, argument->size, argument->offset);
2703 rb_off_t offset = lseek(argument->descriptor, 0, SEEK_CUR);
2704 if (offset == (rb_off_t)-1)
2707 if (lseek(argument->descriptor, argument->offset, SEEK_SET) == (rb_off_t)-1)
2710 ssize_t result = write(argument->descriptor, argument->base, argument->size);
2712 if (lseek(argument->descriptor, offset, SEEK_SET) == (rb_off_t)-1)
2720rb_io_buffer_pwrite(
VALUE self,
VALUE io, rb_off_t from,
size_t length,
size_t offset)
2723 if (scheduler !=
Qnil) {
2726 if (!UNDEF_P(result)) {
2734 io_buffer_validate_range(data, offset, length);
2740 io_buffer_get_bytes_for_reading(data, &base, &size);
2743 .descriptor = descriptor,
2746 .base = (
unsigned char *)base + offset,
2755 return rb_thread_io_blocking_region(io_buffer_pwrite_internal, &argument, descriptor);
2775io_buffer_pwrite(
int argc,
VALUE *argv,
VALUE self)
2783 if (rb_int_negative_p(argv[2])) {
2790 if (rb_int_negative_p(argv[3])) {
2797 return rb_io_buffer_pwrite(self, io, from, length, offset);
2803 if (buffer->size == 0)
2804 rb_raise(rb_eIOBufferMaskError,
"Zero-length mask given!");
2808memory_and(
unsigned char * restrict output,
unsigned char * restrict base,
size_t size,
unsigned char * restrict mask,
size_t mask_size)
2810 for (
size_t offset = 0; offset < size; offset += 1) {
2811 output[offset] = base[offset] & mask[offset % mask_size];
2836 io_buffer_check_mask(mask_data);
2838 VALUE output = rb_io_buffer_new(NULL, data->size, io_flags_for_size(data->size));
2842 memory_and(output_data->base, data->base, data->size, mask_data->base, mask_data->size);
2848memory_or(
unsigned char * restrict output,
unsigned char * restrict base,
size_t size,
unsigned char * restrict mask,
size_t mask_size)
2850 for (
size_t offset = 0; offset < size; offset += 1) {
2851 output[offset] = base[offset] | mask[offset % mask_size];
2876 io_buffer_check_mask(mask_data);
2878 VALUE output = rb_io_buffer_new(NULL, data->size, io_flags_for_size(data->size));
2882 memory_or(output_data->base, data->base, data->size, mask_data->base, mask_data->size);
2888memory_xor(
unsigned char * restrict output,
unsigned char * restrict base,
size_t size,
unsigned char * restrict mask,
size_t mask_size)
2890 for (
size_t offset = 0; offset < size; offset += 1) {
2891 output[offset] = base[offset] ^ mask[offset % mask_size];
2916 io_buffer_check_mask(mask_data);
2918 VALUE output = rb_io_buffer_new(NULL, data->size, io_flags_for_size(data->size));
2922 memory_xor(output_data->base, data->base, data->size, mask_data->base, mask_data->size);
2928memory_not(
unsigned char * restrict output,
unsigned char * restrict base,
size_t size)
2930 for (
size_t offset = 0; offset < size; offset += 1) {
2931 output[offset] = ~base[offset];
2948io_buffer_not(
VALUE self)
2953 VALUE output = rb_io_buffer_new(NULL, data->size, io_flags_for_size(data->size));
2957 memory_not(output_data->base, data->base, data->size);
2965 if (a->base > b->base) {
2966 return io_buffer_overlaps(b, a);
2969 return (b->base >= a->base) && (b->base <= (
void*)((
unsigned char *)a->base + a->size));
2975 if (io_buffer_overlaps(a, b))
2976 rb_raise(rb_eIOBufferMaskError,
"Mask overlaps source data!");
2980memory_and_inplace(
unsigned char * restrict base,
size_t size,
unsigned char * restrict mask,
size_t mask_size)
2982 for (
size_t offset = 0; offset < size; offset += 1) {
2983 base[offset] &= mask[offset % mask_size];
3013 io_buffer_check_mask(mask_data);
3014 io_buffer_check_overlaps(data, mask_data);
3018 io_buffer_get_bytes_for_writing(data, &base, &size);
3020 memory_and_inplace(base, size, mask_data->base, mask_data->size);
3026memory_or_inplace(
unsigned char * restrict base,
size_t size,
unsigned char * restrict mask,
size_t mask_size)
3028 for (
size_t offset = 0; offset < size; offset += 1) {
3029 base[offset] |= mask[offset % mask_size];
3059 io_buffer_check_mask(mask_data);
3060 io_buffer_check_overlaps(data, mask_data);
3064 io_buffer_get_bytes_for_writing(data, &base, &size);
3066 memory_or_inplace(base, size, mask_data->base, mask_data->size);
3072memory_xor_inplace(
unsigned char * restrict base,
size_t size,
unsigned char * restrict mask,
size_t mask_size)
3074 for (
size_t offset = 0; offset < size; offset += 1) {
3075 base[offset] ^= mask[offset % mask_size];
3105 io_buffer_check_mask(mask_data);
3106 io_buffer_check_overlaps(data, mask_data);
3110 io_buffer_get_bytes_for_writing(data, &base, &size);
3112 memory_xor_inplace(base, size, mask_data->base, mask_data->size);
3118memory_not_inplace(
unsigned char * restrict base,
size_t size)
3120 for (
size_t offset = 0; offset < size; offset += 1) {
3121 base[offset] = ~base[offset];
3143io_buffer_not_inplace(
VALUE self)
3150 io_buffer_get_bytes_for_writing(data, &base, &size);
3152 memory_not_inplace(base, size);
3255 GetSystemInfo(&info);
3256 RUBY_IO_BUFFER_PAGE_SIZE = info.dwPageSize;
3258 RUBY_IO_BUFFER_PAGE_SIZE = sysconf(_SC_PAGESIZE);
3261 RUBY_IO_BUFFER_DEFAULT_SIZE = io_buffer_default_size(RUBY_IO_BUFFER_PAGE_SIZE);
3271 rb_define_method(rb_cIOBuffer,
"initialize_copy", rb_io_buffer_initialize_copy, 1);
3319#define IO_BUFFER_DEFINE_DATA_TYPE(name) RB_IO_BUFFER_DATA_TYPE_##name = rb_intern_const(#name)
3320 IO_BUFFER_DEFINE_DATA_TYPE(U8);
3321 IO_BUFFER_DEFINE_DATA_TYPE(S8);
3323 IO_BUFFER_DEFINE_DATA_TYPE(u16);
3324 IO_BUFFER_DEFINE_DATA_TYPE(U16);
3325 IO_BUFFER_DEFINE_DATA_TYPE(s16);
3326 IO_BUFFER_DEFINE_DATA_TYPE(S16);
3328 IO_BUFFER_DEFINE_DATA_TYPE(u32);
3329 IO_BUFFER_DEFINE_DATA_TYPE(U32);
3330 IO_BUFFER_DEFINE_DATA_TYPE(s32);
3331 IO_BUFFER_DEFINE_DATA_TYPE(S32);
3333 IO_BUFFER_DEFINE_DATA_TYPE(u64);
3334 IO_BUFFER_DEFINE_DATA_TYPE(U64);
3335 IO_BUFFER_DEFINE_DATA_TYPE(s64);
3336 IO_BUFFER_DEFINE_DATA_TYPE(S64);
3338 IO_BUFFER_DEFINE_DATA_TYPE(f32);
3339 IO_BUFFER_DEFINE_DATA_TYPE(F32);
3340 IO_BUFFER_DEFINE_DATA_TYPE(f64);
3341 IO_BUFFER_DEFINE_DATA_TYPE(F64);
3342#undef IO_BUFFER_DEFINE_DATA_TYPE
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
static bool RB_OBJ_FROZEN(VALUE obj)
Checks if an object is frozen.
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
int rb_block_given_p(void)
Determines if the current method is given a block.
#define T_STRING
Old name of RUBY_T_STRING.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define CLASS_OF
Old name of rb_class_of.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define NUM2UINT
Old name of RB_NUM2UINT.
#define NUM2DBL
Old name of rb_num2dbl.
#define Qnil
Old name of RUBY_Qnil.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define DBL2NUM
Old name of rb_float_new.
#define NUM2SIZET
Old name of RB_NUM2SIZE.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports always regardless of runtime -W flag.
void rb_raise(VALUE exc, const char *fmt,...)
Exception entry point.
void rb_sys_fail(const char *mesg)
Converts a C errno into a Ruby exception, then raises it.
VALUE rb_eRuntimeError
RuntimeError exception.
VALUE rb_eArgError
ArgumentError exception.
@ RB_WARN_CATEGORY_EXPERIMENTAL
Warning is for experimental features.
static VALUE rb_class_of(VALUE obj)
Object to class mapping function.
VALUE rb_mComparable
Comparable module.
VALUE rb_enc_str_new(const char *ptr, long len, rb_encoding *enc)
Identical to rb_enc_str_new(), except it additionally takes an encoding.
#define RETURN_ENUMERATOR_KW(obj, argc, argv, kw_splat)
Identical to RETURN_SIZED_ENUMERATOR_KW(), except its size is unknown.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
void rb_str_modify(VALUE str)
Declares that the string is about to be modified.
VALUE rb_str_locktmp(VALUE str)
Obtains a "temporary lock" of the string.
VALUE rb_str_unlocktmp(VALUE str)
Releases a lock formerly obtained by rb_str_locktmp().
VALUE rb_str_buf_new(long capa)
Allocates a "string buffer".
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
#define RB_SYM2ID
Just another name of rb_sym2id.
void rb_define_const(VALUE klass, const char *name, VALUE val)
Defines a Ruby level constant under a namespace.
int rb_io_descriptor(VALUE io)
Returns an integer representing the numeric file descriptor for io.
#define RB_NUM2INT
Just another name of rb_num2int_inline.
#define RB_UINT2NUM
Just another name of rb_uint2num_inline.
#define RB_INT2NUM
Just another name of rb_int2num_inline.
static unsigned int RB_NUM2UINT(VALUE x)
Converts an instance of rb_cNumeric into C's unsigned int.
VALUE rb_str_catf(VALUE dst, const char *fmt,...)
Identical to rb_sprintf(), except it renders the output to the specified object rather than creating ...
#define RB_LL2NUM
Just another name of rb_ll2num_inline.
#define RB_ULL2NUM
Just another name of rb_ull2num_inline.
#define RB_NUM2ULL
Just another name of rb_num2ull_inline.
#define RB_NUM2LL
Just another name of rb_num2ll_inline.
VALUE rb_yield_values(int n,...)
Identical to rb_yield(), except it takes variadic number of parameters and pass them to the block.
VALUE rb_yield(VALUE val)
Yields the block.
static VALUE RB_INT2FIX(long i)
Converts a C's long into an instance of rb_cInteger.
VALUE type(ANYARGS)
ANYARGS-ed function type.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
#define NUM2OFFT
Converts an instance of rb_cNumeric into C's off_t.
#define RARRAY_LEN
Just another name of rb_array_len.
#define RARRAY_AREF(a, i)
#define StringValue(v)
Ensures that the parameter object is a String.
#define RSTRING_GETMEM(str, ptrvar, lenvar)
Convenient macro to obtain the contents and length at once.
static long RSTRING_LEN(VALUE str)
Queries the length of the string.
VALUE rb_str_to_str(VALUE obj)
Identical to rb_check_string_type(), except it raises exceptions in case of conversion failures.
static char * RSTRING_PTR(VALUE str)
Queries the contents pointer of the string.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
#define RB_NO_KEYWORDS
Do not pass keywords.
VALUE rb_fiber_scheduler_current(void)
Identical to rb_fiber_scheduler_get(), except it also returns RUBY_Qnil in case of a blocking fiber.
VALUE rb_fiber_scheduler_io_pwrite(VALUE scheduler, VALUE io, rb_off_t from, VALUE buffer, size_t length, size_t offset)
Non-blocking write to the passed IO at the specified offset.
VALUE rb_fiber_scheduler_io_read(VALUE scheduler, VALUE io, VALUE buffer, size_t length, size_t offset)
Non-blocking read from the passed IO.
static VALUE rb_fiber_scheduler_io_result(ssize_t result, int error)
Wrap a ssize_t and int errno into a single VALUE.
VALUE rb_fiber_scheduler_io_pread(VALUE scheduler, VALUE io, rb_off_t from, VALUE buffer, size_t length, size_t offset)
Non-blocking read from the passed IO at the specified offset.
VALUE rb_fiber_scheduler_io_write(VALUE scheduler, VALUE io, VALUE buffer, size_t length, size_t offset)
Non-blocking write to the passed IO.
#define RB_NUM2SIZE
Converts an instance of rb_cInteger into C's size_t.
static bool RB_NIL_P(VALUE obj)
Checks if the given object is nil.
This is the struct that holds necessary info for a struct.
const char * wrap_struct_name
Name of structs of this kind.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.