memory_view.h

Go to the documentation of this file.

#ifndef RUBY_MEMORY_VIEW_H                           /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY_MEMORY_VIEW_H 1
#include "ruby/internal/config.h"
 
#ifdef STDC_HEADERS
# include <stddef.h>                       /* size_t */
#endif
 
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>                    /* ssize_t */
#endif
 
#include "ruby/internal/attr/pure.h"       /* RBIMPL_ATTR_PURE */
#include "ruby/internal/core/rtypeddata.h" /* rb_data_type_t */
#include "ruby/internal/dllexport.h"       /* RUBY_EXTERN */
#include "ruby/internal/stdbool.h"         /* bool */
#include "ruby/internal/value.h"           /* VALUE */
 
enum ruby_memory_view_flags {
    RUBY_MEMORY_VIEW_SIMPLE            = 0,
    RUBY_MEMORY_VIEW_WRITABLE          = (1<<0),
    RUBY_MEMORY_VIEW_FORMAT            = (1<<1),
    RUBY_MEMORY_VIEW_MULTI_DIMENSIONAL = (1<<2),
    RUBY_MEMORY_VIEW_STRIDES           = (1<<3) | RUBY_MEMORY_VIEW_MULTI_DIMENSIONAL,
    RUBY_MEMORY_VIEW_ROW_MAJOR         = (1<<4) | RUBY_MEMORY_VIEW_STRIDES,
    RUBY_MEMORY_VIEW_COLUMN_MAJOR      = (1<<5) | RUBY_MEMORY_VIEW_STRIDES,
    RUBY_MEMORY_VIEW_ANY_CONTIGUOUS    = RUBY_MEMORY_VIEW_ROW_MAJOR | RUBY_MEMORY_VIEW_COLUMN_MAJOR,
    RUBY_MEMORY_VIEW_INDIRECT          = (1<<6) | RUBY_MEMORY_VIEW_STRIDES,
};
 
typedef struct {
    char format;
 
    bool native_size_p;
 
    bool little_endian_p;
 
    size_t offset;
 
    size_t size;
 
    size_t repeat;
} rb_memory_view_item_component_t;
 
typedef struct {
    VALUE obj;
 
    void *data;
 
    ssize_t byte_size;
 
    bool readonly;
 
    const char *format;
 
    ssize_t item_size;
 
    struct {
        const rb_memory_view_item_component_t *components;
 
        size_t length;
    } item_desc;
 
    ssize_t ndim;
 
    const ssize_t *shape;
 
    const ssize_t *strides;
 
    const ssize_t *sub_offsets;
 
    void *private_data;
 
    const struct rb_memory_view_entry *_memory_view_entry;
} rb_memory_view_t;
 
typedef bool (* rb_memory_view_get_func_t)(VALUE obj, rb_memory_view_t *view, int flags);
 
typedef bool (* rb_memory_view_release_func_t)(VALUE obj, rb_memory_view_t *view);
 
typedef bool (* rb_memory_view_available_p_func_t)(VALUE obj);
 
typedef struct rb_memory_view_entry {
    rb_memory_view_get_func_t get_func;
 
    rb_memory_view_release_func_t release_func;
 
    rb_memory_view_available_p_func_t available_p_func;
} rb_memory_view_entry_t;
 
RBIMPL_SYMBOL_EXPORT_BEGIN()
 
/* memory_view.c */
 
 
bool rb_memory_view_register(VALUE klass, const rb_memory_view_entry_t *entry);
 
RBIMPL_ATTR_PURE()
bool rb_memory_view_is_row_major_contiguous(const rb_memory_view_t *view);
 
RBIMPL_ATTR_PURE()
bool rb_memory_view_is_column_major_contiguous(const rb_memory_view_t *view);
 
RBIMPL_ATTR_NOALIAS()
void rb_memory_view_fill_contiguous_strides(const ssize_t ndim, const ssize_t item_size, const ssize_t *const shape, const bool row_major_p, ssize_t *const strides);
 
RBIMPL_ATTR_NOALIAS()
bool rb_memory_view_init_as_byte_array(rb_memory_view_t *view, VALUE obj, void *data, const ssize_t len, const bool readonly);
 
ssize_t rb_memory_view_parse_item_format(const char *format,
                                         rb_memory_view_item_component_t **members,
                                         size_t *n_members, const char **err);
 
ssize_t rb_memory_view_item_size_from_format(const char *format, const char **err);
 
void *rb_memory_view_get_item_pointer(rb_memory_view_t *view, const ssize_t *indices);
 
VALUE rb_memory_view_extract_item_members(const void *ptr, const rb_memory_view_item_component_t *members, const size_t n_members);
 
void rb_memory_view_prepare_item_desc(rb_memory_view_t *view);
 
VALUE rb_memory_view_get_item(rb_memory_view_t *view, const ssize_t *indices);
 
bool rb_memory_view_available_p(VALUE obj);
 
bool rb_memory_view_get(VALUE obj, rb_memory_view_t* memory_view, int flags);
 
bool rb_memory_view_release(rb_memory_view_t* memory_view);
 
/* for testing */
RUBY_EXTERN VALUE rb_memory_view_exported_object_registry;
RUBY_EXTERN const rb_data_type_t rb_memory_view_exported_object_registry_data_type;
RBIMPL_SYMBOL_EXPORT_END()
 
RBIMPL_ATTR_PURE()
static inline bool
rb_memory_view_is_contiguous(const rb_memory_view_t *view)
{
    if (rb_memory_view_is_row_major_contiguous(view)) {
        return true;
    }
    else if (rb_memory_view_is_column_major_contiguous(view)) {
        return true;
    }
    else {
        return false;
    }
}
 
#endif /* RUBY_BUFFER_H */