diff options
Diffstat (limited to 'vm_sync.h')
| -rw-r--r-- | vm_sync.h | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/vm_sync.h b/vm_sync.h new file mode 100644 index 0000000000..314a2238a9 --- /dev/null +++ b/vm_sync.h @@ -0,0 +1,160 @@ +#ifndef RUBY_VM_SYNC_H +#define RUBY_VM_SYNC_H + +#include "vm_debug.h" +#include "debug_counter.h" + +#if USE_RUBY_DEBUG_LOG +#define LOCATION_ARGS const char *file, int line +#define LOCATION_PARAMS file, line +#define APPEND_LOCATION_ARGS , const char *file, int line +#define APPEND_LOCATION_PARAMS , file, line +#else +#define LOCATION_ARGS void +#define LOCATION_PARAMS +#define APPEND_LOCATION_ARGS +#define APPEND_LOCATION_PARAMS +#endif + +bool rb_vm_locked_p(void); +void rb_vm_lock_body(LOCATION_ARGS); +void rb_vm_unlock_body(LOCATION_ARGS); + +struct rb_ractor_struct; +NOINLINE(void rb_vm_lock_enter_body_cr(struct rb_ractor_struct *cr, unsigned int *lev APPEND_LOCATION_ARGS)); +NOINLINE(void rb_vm_lock_enter_body_nb(unsigned int *lev APPEND_LOCATION_ARGS)); +NOINLINE(void rb_vm_lock_enter_body(unsigned int *lev APPEND_LOCATION_ARGS)); +void rb_vm_lock_leave_body_nb(unsigned int *lev APPEND_LOCATION_ARGS); +void rb_vm_lock_leave_body(unsigned int *lev APPEND_LOCATION_ARGS); +void rb_vm_barrier(void); + +RUBY_SYMBOL_EXPORT_BEGIN +VALUE rb_vm_lock_with_barrier(VALUE (*func)(void *args), void *args); +RUBY_SYMBOL_EXPORT_END + +#if RUBY_DEBUG +// GET_VM() +#include "vm_core.h" +#endif + +RUBY_EXTERN struct rb_ractor_struct *ruby_single_main_ractor; // ractor.c + +static inline bool +rb_multi_ractor_p(void) +{ + if (LIKELY(ruby_single_main_ractor)) { + // 0 on boot time. + RUBY_ASSERT(GET_VM()->ractor.cnt <= 1); + return false; + } + else { + // multi-ractor mode can run ractor.cnt == 1 + return true; + } +} + +static inline void +rb_vm_lock(const char *file, int line) +{ + RB_DEBUG_COUNTER_INC(vm_sync_lock); + + if (rb_multi_ractor_p()) { + rb_vm_lock_body(LOCATION_PARAMS); + } +} + +static inline void +rb_vm_unlock(const char *file, int line) +{ + if (rb_multi_ractor_p()) { + rb_vm_unlock_body(LOCATION_PARAMS); + } +} + +static inline void +rb_vm_lock_enter(unsigned int *lev, const char *file, int line) +{ + RB_DEBUG_COUNTER_INC(vm_sync_lock_enter); + + if (rb_multi_ractor_p()) { + rb_vm_lock_enter_body(lev APPEND_LOCATION_PARAMS); + } +} + +static inline void +rb_vm_lock_enter_nb(unsigned int *lev, const char *file, int line) +{ + RB_DEBUG_COUNTER_INC(vm_sync_lock_enter_nb); + + if (rb_multi_ractor_p()) { + rb_vm_lock_enter_body_nb(lev APPEND_LOCATION_PARAMS); + } +} + +static inline void +rb_vm_lock_leave_nb(unsigned int *lev, const char *file, int line) +{ + if (rb_multi_ractor_p()) { + rb_vm_lock_leave_body_nb(lev APPEND_LOCATION_PARAMS); + } +} + +static inline void +rb_vm_lock_leave(unsigned int *lev, const char *file, int line) +{ + if (rb_multi_ractor_p()) { + rb_vm_lock_leave_body(lev APPEND_LOCATION_PARAMS); + } +} + +static inline void +rb_vm_lock_enter_cr(struct rb_ractor_struct *cr, unsigned int *levp, const char *file, int line) +{ + RB_DEBUG_COUNTER_INC(vm_sync_lock_enter_cr); + rb_vm_lock_enter_body_cr(cr, levp APPEND_LOCATION_PARAMS); +} + +static inline void +rb_vm_lock_leave_cr(struct rb_ractor_struct *cr, unsigned int *levp, const char *file, int line) +{ + rb_vm_lock_leave_body(levp APPEND_LOCATION_PARAMS); +} + +#define RB_VM_LOCKED_P() rb_vm_locked_p() + +#define RB_VM_LOCK() rb_vm_lock(__FILE__, __LINE__) +#define RB_VM_UNLOCK() rb_vm_unlock(__FILE__, __LINE__) + +#define RB_VM_LOCK_ENTER_CR_LEV(cr, levp) rb_vm_lock_enter_cr(cr, levp, __FILE__, __LINE__) +#define RB_VM_LOCK_LEAVE_CR_LEV(cr, levp) rb_vm_lock_leave_cr(cr, levp, __FILE__, __LINE__) +#define RB_VM_LOCK_ENTER_LEV(levp) rb_vm_lock_enter(levp, __FILE__, __LINE__) +#define RB_VM_LOCK_LEAVE_LEV(levp) rb_vm_lock_leave(levp, __FILE__, __LINE__) + +#define RB_VM_LOCK_ENTER() { unsigned int _lev; RB_VM_LOCK_ENTER_LEV(&_lev); +#define RB_VM_LOCK_LEAVE() RB_VM_LOCK_LEAVE_LEV(&_lev); } +#define RB_VM_LOCKING() \ + for (unsigned int vm_locking_level, vm_locking_do = (RB_VM_LOCK_ENTER_LEV(&vm_locking_level), 1); \ + vm_locking_do; RB_VM_LOCK_LEAVE_LEV(&vm_locking_level), vm_locking_do = 0) + +#define RB_VM_LOCK_ENTER_LEV_NB(levp) rb_vm_lock_enter_nb(levp, __FILE__, __LINE__) +#define RB_VM_LOCK_LEAVE_LEV_NB(levp) rb_vm_lock_leave_nb(levp, __FILE__, __LINE__) +#define RB_VM_LOCK_ENTER_NO_BARRIER() { unsigned int _lev; RB_VM_LOCK_ENTER_LEV_NB(&_lev); +#define RB_VM_LOCK_LEAVE_NO_BARRIER() RB_VM_LOCK_LEAVE_LEV_NB(&_lev); } +#define RB_VM_LOCKING_NO_BARRIER() \ + for (unsigned int vm_locking_level, vm_locking_do = (RB_VM_LOCK_ENTER_LEV_NB(&vm_locking_level), 1); \ + vm_locking_do; RB_VM_LOCK_LEAVE_LEV_NB(&vm_locking_level), vm_locking_do = 0) + +#if RUBY_DEBUG > 0 +void RUBY_ASSERT_vm_locking(void); +void RUBY_ASSERT_vm_locking_with_barrier(void); +void RUBY_ASSERT_vm_unlocking(void); +#define ASSERT_vm_locking() RUBY_ASSERT_vm_locking() +#define ASSERT_vm_locking_with_barrier() RUBY_ASSERT_vm_locking_with_barrier() +#define ASSERT_vm_unlocking() RUBY_ASSERT_vm_unlocking() +#else +#define ASSERT_vm_locking() +#define ASSERT_vm_locking_with_barrier() +#define ASSERT_vm_unlocking() +#endif + +#endif // RUBY_VM_SYNC_H |