thread.h

Go to the documentation of this file.

#ifndef RUBY_THREAD_H                                /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY_THREAD_H 1
#include "ruby/internal/attr/nonnull.h"
#include "ruby/internal/intern/thread.h" /* rb_unblock_function_t */
#include "ruby/internal/dllexport.h"
 
#define RB_NOGVL_INTR_FAIL       (0x1)
 
#define RB_NOGVL_UBF_ASYNC_SAFE  (0x2)
 
#define RB_NOGVL_OFFLOAD_SAFE  (0x4)
 
RBIMPL_SYMBOL_EXPORT_BEGIN()
 
RBIMPL_ATTR_NONNULL((1))
void *rb_thread_call_with_gvl(void *(*func)(void *), void *data1);
 
RBIMPL_ATTR_NONNULL((1))
void *rb_thread_call_without_gvl(void *(*func)(void *), void *data1,
                                 rb_unblock_function_t *ubf, void *data2);
 
RBIMPL_ATTR_NONNULL((1))
void *rb_thread_call_without_gvl2(void *(*func)(void *), void *data1,
                                  rb_unblock_function_t *ubf, void *data2);
 
/*
 * XXX: unstable/unapproved - out-of-tree code should NOT not depend
 * on this until it hits Ruby 2.6.1
 */
 
RBIMPL_ATTR_NONNULL((1))
void *rb_nogvl(void *(*func)(void *), void *data1,
               rb_unblock_function_t *ubf, void *data2,
               int flags);
 
#define RUBY_CALL_WO_GVL_FLAG_SKIP_CHECK_INTS_AFTER 0x01
 
#define RUBY_CALL_WO_GVL_FLAG_SKIP_CHECK_INTS_
 
bool rb_thread_lock_native_thread(void);
 
#define RUBY_INTERNAL_THREAD_EVENT_STARTED    1 << 0
 
#define RUBY_INTERNAL_THREAD_EVENT_READY      1 << 1 
#define RUBY_INTERNAL_THREAD_EVENT_RESUMED    1 << 2 
#define RUBY_INTERNAL_THREAD_EVENT_SUSPENDED  1 << 3 
#define RUBY_INTERNAL_THREAD_EVENT_EXITED     1 << 4 
#define RUBY_INTERNAL_THREAD_EVENT_MASK       0xff 
typedef struct rb_internal_thread_event_data {
   VALUE thread;
} rb_internal_thread_event_data_t;
 
typedef void (*rb_internal_thread_event_callback)(rb_event_flag_t event,
              const rb_internal_thread_event_data_t *event_data,
              void *user_data);
typedef struct rb_internal_thread_event_hook rb_internal_thread_event_hook_t;
 
rb_internal_thread_event_hook_t *rb_internal_thread_add_event_hook(
        rb_internal_thread_event_callback func, rb_event_flag_t events,
        void *data);
 
 
bool rb_internal_thread_remove_event_hook(
        rb_internal_thread_event_hook_t * hook);
 
 
typedef int rb_internal_thread_specific_key_t;
#define RB_INTERNAL_THREAD_SPECIFIC_KEY_MAX 8
rb_internal_thread_specific_key_t rb_internal_thread_specific_key_create(void);
 
void *rb_internal_thread_specific_get(VALUE thread_val, rb_internal_thread_specific_key_t key);
 
void rb_internal_thread_specific_set(VALUE thread_val, rb_internal_thread_specific_key_t key, void *data);
 
int ruby_thread_has_gvl_p(void);
 
RBIMPL_SYMBOL_EXPORT_END()
 
#endif /* RUBY_THREAD_H */