ractor.h

Go to the documentation of this file.

#ifndef RUBY_RACTOR_H                                /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY_RACTOR_H 1
 
#include "internal/dllexport.h"      /* RUBY_EXTERN is here */
#include "internal/fl_type.h"        /* FL_TEST_RAW is here */
#include "internal/special_consts.h" /* RB_SPECIAL_CONSTS_P is here */
#include "internal/stdbool.h"        /* bool is here */
#include "internal/value.h"          /* VALUE is here */
 
struct rb_ractor_local_storage_type {
 
    void (*mark)(void *ptr);
 
    void (*free)(void *ptr);
    // TODO: update
};
 
typedef struct rb_ractor_local_key_struct *rb_ractor_local_key_t;
 
RBIMPL_SYMBOL_EXPORT_BEGIN()
 
 
RUBY_EXTERN VALUE rb_cRactor;
 
VALUE rb_ractor_stdin(void);
 
VALUE rb_ractor_stdout(void);
 
VALUE rb_ractor_stderr(void);
 
void rb_ractor_stdin_set(VALUE io);
 
void rb_ractor_stdout_set(VALUE io);
 
void rb_ractor_stderr_set(VALUE io);
 
rb_ractor_local_key_t rb_ractor_local_storage_value_newkey(void);
 
VALUE rb_ractor_local_storage_value(rb_ractor_local_key_t key);
 
bool rb_ractor_local_storage_value_lookup(rb_ractor_local_key_t key, VALUE *val);
 
void  rb_ractor_local_storage_value_set(rb_ractor_local_key_t key, VALUE val);
 
RUBY_EXTERN const struct rb_ractor_local_storage_type rb_ractor_local_storage_type_free;
 
#define RB_RACTOR_LOCAL_STORAGE_TYPE_FREE (&rb_ractor_local_storage_type_free)
 
rb_ractor_local_key_t rb_ractor_local_storage_ptr_newkey(const struct rb_ractor_local_storage_type *type);
 
void *rb_ractor_local_storage_ptr(rb_ractor_local_key_t key);
 
void  rb_ractor_local_storage_ptr_set(rb_ractor_local_key_t key, void *ptr);
 
VALUE rb_ractor_make_shareable(VALUE obj);
 
VALUE rb_ractor_make_shareable_copy(VALUE obj);
 
RBIMPL_SYMBOL_EXPORT_END()
 
 
#define RB_OBJ_SHAREABLE_P(obj) FL_TEST_RAW((obj), RUBY_FL_SHAREABLE)
 
static inline bool
rb_ractor_shareable_p(VALUE obj)
{
    bool rb_ractor_shareable_p_continue(VALUE obj);
 
    if (RB_SPECIAL_CONST_P(obj)) {
        return true;
    }
    else if (RB_OBJ_SHAREABLE_P(obj)) {
        return true;
    }
    else {
        return rb_ractor_shareable_p_continue(obj);
    }
}
 
#endif /* RUBY_RACTOR_H */