datadog-ruby_core_source 3.5.4 → 3.5.5

data/lib/datadog/ruby_core_source/ruby-3.1.0-p0/ractor_core.h

@@ -0,0 +1,346 @@
+#include "ruby/ruby.h"
+#include "ruby/ractor.h"
+#include "vm_core.h"
+#include "id_table.h"
+#include "vm_debug.h"
+
+#ifndef RACTOR_CHECK_MODE
+#define RACTOR_CHECK_MODE (0 || VM_CHECK_MODE || RUBY_DEBUG)
+#endif
+
+enum rb_ractor_basket_type {
+    basket_type_none,
+    basket_type_ref,
+    basket_type_copy,
+    basket_type_move,
+    basket_type_will,
+    basket_type_deleted,
+    basket_type_reserved,
+};
+
+struct rb_ractor_basket {
+    bool exception;
+    enum rb_ractor_basket_type type;
+    VALUE v;
+    VALUE sender;
+};
+
+struct rb_ractor_queue {
+    struct rb_ractor_basket *baskets;
+    int start;
+    int cnt;
+    int size;
+    unsigned int serial;
+    unsigned int reserved_cnt;
+};
+
+struct rb_ractor_waiting_list {
+    int cnt;
+    int size;
+    rb_ractor_t **ractors;
+};
+
+struct rb_ractor_sync {
+    // ractor lock
+    rb_nativethread_lock_t lock;
+#if RACTOR_CHECK_MODE > 0
+    VALUE locked_by;
+#endif
+    rb_nativethread_cond_t cond;
+
+    // communication
+    struct rb_ractor_queue  incoming_queue;
+    struct rb_ractor_waiting_list taking_ractors;
+
+    bool incoming_port_closed;
+    bool outgoing_port_closed;
+
+    struct ractor_wait {
+        enum ractor_wait_status {
+            wait_none      = 0x00,
+            wait_receiving = 0x01,
+            wait_taking    = 0x02,
+            wait_yielding  = 0x04,
+            wait_moving    = 0x08,
+        } status;
+
+        enum ractor_wakeup_status {
+            wakeup_none,
+            wakeup_by_send,
+            wakeup_by_yield,
+            wakeup_by_take,
+            wakeup_by_close,
+            wakeup_by_interrupt,
+            wakeup_by_retry,
+        } wakeup_status;
+
+        struct rb_ractor_basket yielded_basket;
+        struct rb_ractor_basket taken_basket;
+    } wait;
+};
+
+struct rb_ractor_struct {
+    struct rb_ractor_pub pub;
+
+    struct rb_ractor_sync sync;
+    VALUE receiving_mutex;
+    bool yield_atexit;
+
+    // vm wide barrier synchronization
+    rb_nativethread_cond_t barrier_wait_cond;
+
+    // thread management
+    struct {
+        struct list_head set;
+        unsigned int cnt;
+        unsigned int blocking_cnt;
+        unsigned int sleeper;
+        rb_global_vm_lock_t gvl;
+        rb_execution_context_t *running_ec;
+        rb_thread_t *main;
+    } threads;
+    VALUE thgroup_default;
+
+    VALUE name;
+    VALUE loc;
+
+    // created
+    //   | ready to run
+    // ====================== inserted to vm->ractor
+    //   v
+    // blocking <---+ all threads are blocking
+    //   |          |
+    //   v          |
+    // running -----+
+    //   | all threads are terminated.
+    // ====================== removed from vm->ractor
+    //   v
+    // terminated
+    //
+    // status is protected by VM lock (global state)
+
+    enum ractor_status {
+        ractor_created,
+        ractor_running,
+        ractor_blocking,
+        ractor_terminated,
+    } status_;
+
+    struct list_node vmlr_node;
+
+    // ractor local data
+
+    st_table *local_storage;
+    struct rb_id_table *idkey_local_storage;
+
+    VALUE r_stdin;
+    VALUE r_stdout;
+    VALUE r_stderr;
+    VALUE verbose;
+    VALUE debug;
+
+    rb_ractor_newobj_cache_t newobj_cache;
+
+    // gc.c rb_objspace_reachable_objects_from
+    struct gc_mark_func_data_struct {
+        void *data;
+        void (*mark_func)(VALUE v, void *data);
+    } *mfd;
+}; // rb_ractor_t is defined in vm_core.h
+
+
+static inline VALUE
+rb_ractor_self(const rb_ractor_t *r)
+{
+    return r->pub.self;
+}
+
+rb_ractor_t *rb_ractor_main_alloc(void);
+void rb_ractor_main_setup(rb_vm_t *vm, rb_ractor_t *main_ractor, rb_thread_t *main_thread);
+void rb_ractor_atexit(rb_execution_context_t *ec, VALUE result);
+void rb_ractor_atexit_exception(rb_execution_context_t *ec);
+void rb_ractor_teardown(rb_execution_context_t *ec);
+void rb_ractor_receive_parameters(rb_execution_context_t *ec, rb_ractor_t *g, int len, VALUE *ptr);
+void rb_ractor_send_parameters(rb_execution_context_t *ec, rb_ractor_t *g, VALUE args);
+
+VALUE rb_thread_create_ractor(rb_ractor_t *g, VALUE args, VALUE proc); // defined in thread.c
+
+rb_global_vm_lock_t *rb_ractor_gvl(rb_ractor_t *);
+int rb_ractor_living_thread_num(const rb_ractor_t *);
+VALUE rb_ractor_thread_list(rb_ractor_t *r);
+bool rb_ractor_p(VALUE rv);
+
+void rb_ractor_living_threads_init(rb_ractor_t *r);
+void rb_ractor_living_threads_insert(rb_ractor_t *r, rb_thread_t *th);
+void rb_ractor_living_threads_remove(rb_ractor_t *r, rb_thread_t *th);
+void rb_ractor_blocking_threads_inc(rb_ractor_t *r, const char *file, int line); // TODO: file, line only for RUBY_DEBUG_LOG
+void rb_ractor_blocking_threads_dec(rb_ractor_t *r, const char *file, int line); // TODO: file, line only for RUBY_DEBUG_LOG
+
+void rb_ractor_vm_barrier_interrupt_running_thread(rb_ractor_t *r);
+void rb_ractor_terminate_interrupt_main_thread(rb_ractor_t *r);
+void rb_ractor_terminate_all(void);
+bool rb_ractor_main_p_(void);
+void rb_ractor_finish_marking(void);
+void rb_ractor_atfork(rb_vm_t *vm, rb_thread_t *th);
+
+VALUE rb_ractor_ensure_shareable(VALUE obj, VALUE name);
+
+RUBY_SYMBOL_EXPORT_BEGIN
+bool rb_ractor_shareable_p_continue(VALUE obj);
+
+// THIS FUNCTION SHOULD NOT CALL WHILE INCREMENTAL MARKING!!
+// This function is for T_DATA::free_func
+void rb_ractor_local_storage_delkey(rb_ractor_local_key_t key);
+
+RUBY_SYMBOL_EXPORT_END
+
+static inline bool
+rb_ractor_main_p(void)
+{
+    if (ruby_single_main_ractor) {
+        return true;
+    }
+    else {
+        return rb_ractor_main_p_();
+    }
+}
+
+static inline bool
+rb_ractor_status_p(rb_ractor_t *r, enum ractor_status status)
+{
+    return r->status_ == status;
+}
+
+static inline void
+rb_ractor_sleeper_threads_inc(rb_ractor_t *r)
+{
+    r->threads.sleeper++;
+}
+
+static inline void
+rb_ractor_sleeper_threads_dec(rb_ractor_t *r)
+{
+    r->threads.sleeper--;
+}
+
+static inline void
+rb_ractor_sleeper_threads_clear(rb_ractor_t *r)
+{
+    r->threads.sleeper = 0;
+}
+
+static inline int
+rb_ractor_sleeper_thread_num(rb_ractor_t *r)
+{
+    return r->threads.sleeper;
+}
+
+static inline void
+rb_ractor_thread_switch(rb_ractor_t *cr, rb_thread_t *th)
+{
+    if (cr->threads.running_ec != th->ec) {
+        if (0) {
+            ruby_debug_printf("rb_ractor_thread_switch ec:%p->%p\n",
+                              (void *)cr->threads.running_ec, (void *)th->ec);
+        }
+    }
+    else {
+        return;
+    }
+
+    if (cr->threads.running_ec != th->ec) {
+        th->running_time_us = 0;
+    }
+
+    cr->threads.running_ec = th->ec;
+
+    VM_ASSERT(cr == GET_RACTOR());
+}
+
+static inline void
+rb_ractor_set_current_ec(rb_ractor_t *cr, rb_execution_context_t *ec)
+{
+#ifdef RB_THREAD_LOCAL_SPECIFIER
+  #ifdef __APPLE__
+    rb_current_ec_set(ec);
+  #else
+    ruby_current_ec = ec;
+  #endif
+#else
+    native_tls_set(ruby_current_ec_key, ec);
+#endif
+
+    if (cr->threads.running_ec != ec) {
+        if (0) {
+            ruby_debug_printf("rb_ractor_set_current_ec ec:%p->%p\n",
+                              (void *)cr->threads.running_ec, (void *)ec);
+        }
+    }
+    else {
+        VM_ASSERT(0); // should be different
+    }
+
+    cr->threads.running_ec = ec;
+}
+
+void rb_vm_ractor_blocking_cnt_inc(rb_vm_t *vm, rb_ractor_t *cr, const char *file, int line);
+void rb_vm_ractor_blocking_cnt_dec(rb_vm_t *vm, rb_ractor_t *cr, const char *file, int line);
+
+static inline uint32_t
+rb_ractor_id(const rb_ractor_t *r)
+{
+    return r->pub.id;
+}
+
+#if RACTOR_CHECK_MODE > 0
+uint32_t rb_ractor_current_id(void);
+
+static inline void
+rb_ractor_setup_belonging_to(VALUE obj, uint32_t rid)
+{
+    VALUE flags = RBASIC(obj)->flags & 0xffffffff; // 4B
+    RBASIC(obj)->flags = flags | ((VALUE)rid << 32);
+}
+
+static inline void
+rb_ractor_setup_belonging(VALUE obj)
+{
+    rb_ractor_setup_belonging_to(obj, rb_ractor_current_id());
+}
+
+static inline uint32_t
+rb_ractor_belonging(VALUE obj)
+{
+    if (SPECIAL_CONST_P(obj) || RB_OBJ_SHAREABLE_P(obj)) {
+        return 0;
+    }
+    else {
+        return RBASIC(obj)->flags >> 32;
+    }
+}
+
+static inline VALUE
+rb_ractor_confirm_belonging(VALUE obj)
+{
+    uint32_t id = rb_ractor_belonging(obj);
+
+    if (id == 0) {
+        if (UNLIKELY(!rb_ractor_shareable_p(obj))) {
+            rp(obj);
+            rb_bug("id == 0 but not shareable");
+        }
+    }
+    else if (UNLIKELY(id != rb_ractor_current_id())) {
+        if (rb_ractor_shareable_p(obj)) {
+            // ok
+        }
+        else {
+            rp(obj);
+            rb_bug("rb_ractor_confirm_belonging object-ractor id:%u, current-ractor id:%u", id, rb_ractor_current_id());
+        }
+    }
+    return obj;
+}
+#else
+#define rb_ractor_confirm_belonging(obj) obj
+#endif

data/lib/datadog/ruby_core_source/ruby-3.1.0-p0/ruby_assert.h

@@ -0,0 +1,14 @@
+#ifndef RUBY_TOPLEVEL_ASSERT_H                           /*-*-C-*-vi:se ft=c:*/
+#define RUBY_TOPLEVEL_ASSERT_H
+/**
+ * @author     Ruby developers <ruby-core@ruby-lang.org>
+ * @copyright  This  file  is   a  part  of  the   programming  language  Ruby.
+ *             Permission  is hereby  granted,  to  either redistribute  and/or
+ *             modify this file, provided that  the conditions mentioned in the
+ *             file COPYING are met.  Consult the file for details.
+ */
+#include "ruby/assert.h"
+#undef assert
+#define assert RUBY_ASSERT_NDEBUG
+
+#endif /* RUBY_TOPLEVEL_ASSERT_H */

data/lib/datadog/ruby_core_source/ruby-3.1.0-p0/ruby_atomic.h

@@ -0,0 +1,23 @@
+#include "ruby/atomic.h"
+
+/* shim macros only */
+#define ATOMIC_ADD(var, val) RUBY_ATOMIC_ADD(var, val)
+#define ATOMIC_CAS(var, oldval, newval) RUBY_ATOMIC_CAS(var, oldval, newval)
+#define ATOMIC_DEC(var) RUBY_ATOMIC_DEC(var)
+#define ATOMIC_EXCHANGE(var, val) RUBY_ATOMIC_EXCHANGE(var, val)
+#define ATOMIC_FETCH_ADD(var, val) RUBY_ATOMIC_FETCH_ADD(var, val)
+#define ATOMIC_FETCH_SUB(var, val) RUBY_ATOMIC_FETCH_SUB(var, val)
+#define ATOMIC_INC(var) RUBY_ATOMIC_INC(var)
+#define ATOMIC_OR(var, val) RUBY_ATOMIC_OR(var, val)
+#define ATOMIC_PTR_CAS(var, oldval, newval) RUBY_ATOMIC_PTR_CAS(var, oldval, newval)
+#define ATOMIC_PTR_EXCHANGE(var, val) RUBY_ATOMIC_PTR_EXCHANGE(var, val)
+#define ATOMIC_SET(var, val) RUBY_ATOMIC_SET(var, val)
+#define ATOMIC_SIZE_ADD(var, val) RUBY_ATOMIC_SIZE_ADD(var, val)
+#define ATOMIC_SIZE_CAS(var, oldval, newval) RUBY_ATOMIC_SIZE_CAS(var, oldval, newval)
+#define ATOMIC_SIZE_DEC(var) RUBY_ATOMIC_SIZE_DEC(var)
+#define ATOMIC_SIZE_EXCHANGE(var, val) RUBY_ATOMIC_SIZE_EXCHANGE(var, val)
+#define ATOMIC_SIZE_INC(var) RUBY_ATOMIC_SIZE_INC(var)
+#define ATOMIC_SIZE_SUB(var, val) RUBY_ATOMIC_SIZE_SUB(var, val)
+#define ATOMIC_SUB(var, val) RUBY_ATOMIC_SUB(var, val)
+#define ATOMIC_VALUE_CAS(var, oldval, val) RUBY_ATOMIC_VALUE_CAS(var, oldval, val)
+#define ATOMIC_VALUE_EXCHANGE(var, val) RUBY_ATOMIC_VALUE_EXCHANGE(var, val)

data/lib/datadog/ruby_core_source/ruby-3.1.0-p0/thread_pthread.h

@@ -0,0 +1,115 @@
+#ifndef RUBY_THREAD_PTHREAD_H
+#define RUBY_THREAD_PTHREAD_H
+/**********************************************************************
+
+  thread_pthread.h -
+
+  $Author$
+
+  Copyright (C) 2004-2007 Koichi Sasada
+
+**********************************************************************/
+
+#ifdef HAVE_PTHREAD_NP_H
+#include <pthread_np.h>
+#endif
+
+#define RB_NATIVETHREAD_LOCK_INIT PTHREAD_MUTEX_INITIALIZER
+#define RB_NATIVETHREAD_COND_INIT PTHREAD_COND_INITIALIZER
+
+typedef struct native_thread_data_struct {
+    union {
+        struct list_node ubf;
+        struct list_node gvl;
+    } node;
+#if defined(__GLIBC__) || defined(__FreeBSD__)
+    union
+#else
+    /*
+     * assume the platform condvars are badly implemented and have a
+     * "memory" of which mutex they're associated with
+     */
+    struct
+#endif
+    {
+        rb_nativethread_cond_t intr; /* th->interrupt_lock */
+        rb_nativethread_cond_t gvlq; /* vm->gvl.lock */
+    } cond;
+} native_thread_data_t;
+
+#undef except
+#undef try
+#undef leave
+#undef finally
+
+typedef struct rb_global_vm_lock_struct {
+    /* fast path */
+    const struct rb_thread_struct *owner;
+    rb_nativethread_lock_t lock; /* AKA vm->gvl.lock */
+
+    /*
+     * slow path, protected by vm->gvl.lock
+     * - @waitq - FIFO queue of threads waiting for GVL
+     * - @timer - it handles timeslices for @owner.  It is any one thread
+     *   in @waitq, there is no @timer if @waitq is empty, but always
+     *   a @timer if @waitq has entries
+     * - @timer_err tracks timeslice limit, the timeslice only resets
+     *   when pthread_cond_timedwait returns ETIMEDOUT, so frequent
+     *   switching between contended/uncontended GVL won't reset the
+     *   timer.
+     */
+    struct list_head waitq; /* <=> native_thread_data_t.node.ubf */
+    const struct rb_thread_struct *timer;
+    int timer_err;
+
+    /* yield */
+    rb_nativethread_cond_t switch_cond;
+    rb_nativethread_cond_t switch_wait_cond;
+    int need_yield;
+    int wait_yield;
+} rb_global_vm_lock_t;
+
+
+#if __STDC_VERSION__ >= 201112
+  #define RB_THREAD_LOCAL_SPECIFIER _Thread_local
+#elif defined(__GNUC__)
+  /* note that ICC (linux) and Clang are covered by __GNUC__ */
+  #define RB_THREAD_LOCAL_SPECIFIER __thread
+#else
+
+typedef pthread_key_t native_tls_key_t;
+
+static inline void *
+native_tls_get(native_tls_key_t key)
+{
+    void *ptr = pthread_getspecific(key);
+    if (UNLIKELY(ptr == NULL)) {
+        rb_bug("pthread_getspecific returns NULL");
+    }
+    return ptr;
+}
+
+static inline void
+native_tls_set(native_tls_key_t key, void *ptr)
+{
+    if (UNLIKELY(pthread_setspecific(key, ptr) != 0)) {
+        rb_bug("pthread_setspecific error");
+    }
+}
+#endif
+
+RUBY_SYMBOL_EXPORT_BEGIN
+#ifdef RB_THREAD_LOCAL_SPECIFIER
+  #ifdef __APPLE__
+    // on Darwin, TLS can not be accessed across .so
+    struct rb_execution_context_struct *rb_current_ec(void);
+    void rb_current_ec_set(struct rb_execution_context_struct *);
+  #else
+    RUBY_EXTERN RB_THREAD_LOCAL_SPECIFIER struct rb_execution_context_struct *ruby_current_ec;
+  #endif
+#else
+  RUBY_EXTERN native_tls_key_t ruby_current_ec_key;
+#endif
+RUBY_SYMBOL_EXPORT_END
+
+#endif /* RUBY_THREAD_PTHREAD_H */