gvltools 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d6e3f8ea2cc420e17a413a62fba51ccb6c2b90dac11138186e9f4d203bed51
-  data.tar.gz: 97576f44774bb991699152d36140714b792e17ced8a7ea48d1210f0c8d94b1df
+  metadata.gz: 5ffb320bec5fdc8a0d4940d8b370af1607a20383e1a9a8f939cc759588ca6627
+  data.tar.gz: 223bee0c124c17296b8386bbdda94406f91b84ad0adcf3acd09921424bb8eaf8
 SHA512:
-  metadata.gz: ae23c00ab1f94c2af17753f5ba847690ebea31cb0d3f23134080ad34a475686ac0d9872fa56025a1fab8135c5ee57c58e19675bbc08160c9444a8d30edb847db
-  data.tar.gz: 54e1694fd5d16935c98a6b838fdf188427cf645f0fe00ac08a7323609c70f01721d9836b80c6bdf2096ee7341d4d39a44f713b20a770470072c72c48887564c3
+  metadata.gz: 1c988c2e9d2c17925b178e4201f99530e75328cda648b3e3b50664e1d751ff5ad086139293a22dab5a54ae18e86bdd7d6e14064f4a4833eae18d3d948f134f20
+  data.tar.gz: 3b56ad91bf7784d0c61e4d321964eeaaae8ca97ec6c6c86c1934e8e95ad9d720b00933a7b0f7e91ec45e7ffd2a07665800c6f616250b7251318dc889a5ba94ca

data/.rubocop.yml

@@ -22,6 +22,15 @@ Style/GlobalVars:
   Exclude:
     - ext/**/extconf.rb
 
+Style/EmptyMethod:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-04-11
+
+- Automatically reset the `WaitingThreads` counter when enabling it (#7).
+- Disallow resetting the `WaitingThreads` counter when it is active (#7).
+
+## [0.2.0] - 2023-03-28
+
+- Use C11 atomics instead of MRI's `rb_atomic_t`.
+
 ## [0.1.0] - 2022-06-14
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gvltools (0.1.0)
+    gvltools (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,6 +32,7 @@ GEM
     unicode-display_width (2.1.0)
 
 PLATFORMS
+  aarch64-linux
   arm64-darwin-21
   arm64-darwin-22
   x86_64-linux

data/ext/gvltools/extconf.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require "mkmf"
-if RUBY_ENGINE == "ruby" && have_func("rb_internal_thread_add_event_hook", ["ruby/thread.h"])
+if RUBY_ENGINE == "ruby" &&
+   have_header("stdatomic.h") &&
+   have_func("rb_internal_thread_add_event_hook", ["ruby/thread.h"])
+
   $CFLAGS << " -O3 -Wall "
   create_makefile("gvltools/instrumentation")
 else

data/ext/gvltools/instrumentation.c

@@ -1,7 +1,9 @@
 #include <time.h>
 #include <ruby.h>
 #include <ruby/thread.h>
-#include <ruby/atomic.h>
+#include <stdatomic.h>
+
+typedef unsigned long long counter_t;
 
 // Metrics
 static rb_internal_thread_event_hook_t *gt_hook = NULL;
@@ -31,8 +33,8 @@ static inline void gt_gettime(struct timespec *time) {
     }
 }
 
-static inline rb_atomic_t gt_time_diff_ns(struct timespec before, struct timespec after) {
-    rb_atomic_t total = 0;
+static inline counter_t gt_time_diff_ns(struct timespec before, struct timespec after) {
+    counter_t total = 0;
     total += (after.tv_nsec - before.tv_nsec);
     total += (after.tv_sec - before.tv_sec) * SECONDS_TO_NANOSECONDS;
     return total;
@@ -67,16 +69,16 @@ static VALUE gt_disable_metric(VALUE module, VALUE metric) {
 }
 
 // GVLTools::LocalTimer and GVLTools::GlobalTimer
-static rb_atomic_t global_timer_total = 0;
-static THREAD_LOCAL_SPECIFIER uint64_t local_timer_total = 0;
+static _Atomic counter_t global_timer_total = 0;
+static THREAD_LOCAL_SPECIFIER counter_t local_timer_total = 0;
 static THREAD_LOCAL_SPECIFIER struct timespec timer_ready_at = {0};
 
 static VALUE global_timer_monotonic_time(VALUE module) {
-    return UINT2NUM(global_timer_total);
+    return ULL2NUM(global_timer_total);
 }
 
 static VALUE global_timer_reset(VALUE module) {
-    RUBY_ATOMIC_SET(global_timer_total, 0);
+    global_timer_total = 0;
     return Qtrue;
 }
 
@@ -90,14 +92,17 @@ static VALUE local_timer_reset(VALUE module) {
 }
 
 // Thread counts
-static rb_atomic_t waiting_threads_total = 0;
+static _Atomic counter_t waiting_threads_total = 0;
+static _Atomic counter_t waiting_threads_current_generation = 1;
+static THREAD_LOCAL_SPECIFIER counter_t waiting_threads_ready_generation = 0;
 
 static VALUE waiting_threads_count(VALUE module) {
-    return UINT2NUM(waiting_threads_total);
+    return ULL2NUM(waiting_threads_total);
 }
 
 static VALUE waiting_threads_reset(VALUE module) {
-    RUBY_ATOMIC_SET(waiting_threads_total, 0);
+    waiting_threads_current_generation++;
+    waiting_threads_total = 0;
     return Qtrue;
 }
 
@@ -120,7 +125,8 @@ static void gt_thread_callback(rb_event_flag_t event, const rb_internal_thread_e
             if (!was_ready) was_ready = true;
 
             if (ENABLED(WAITING_THREADS)) {
-                RUBY_ATOMIC_INC(waiting_threads_total);
+                waiting_threads_ready_generation = waiting_threads_current_generation;
+                waiting_threads_total++;
             }
 
             if (ENABLED(TIMER_GLOBAL | TIMER_LOCAL)) {
@@ -132,20 +138,22 @@ static void gt_thread_callback(rb_event_flag_t event, const rb_internal_thread_e
             if (!was_ready) break; // In case we registered the hook while some threads were already waiting on the GVL
 
             if (ENABLED(WAITING_THREADS)) {
-                RUBY_ATOMIC_DEC(waiting_threads_total);
+                if (waiting_threads_ready_generation == waiting_threads_current_generation) {
+                    waiting_threads_total--;
+                }
             }
 
             if (ENABLED(TIMER_GLOBAL | TIMER_LOCAL)) {
                 struct timespec current_time;
                 gt_gettime(&current_time);
-                rb_atomic_t diff = gt_time_diff_ns(timer_ready_at, current_time);
+                counter_t diff = gt_time_diff_ns(timer_ready_at, current_time);
 
                 if (ENABLED(TIMER_LOCAL)) {
                     local_timer_total += diff;
                 }
 
                 if (ENABLED(TIMER_GLOBAL)) {
-                    RUBY_ATOMIC_ADD(global_timer_total, diff);
+                    global_timer_total += diff;
                 }
             }
         }
@@ -170,6 +178,6 @@ void Init_instrumentation(void) {
     rb_define_singleton_method(rb_mLocalTimer, "monotonic_time", local_timer_monotonic_time, 0);
 
     VALUE rb_mWaitingThreads = rb_const_get(rb_mGVLTools, rb_intern("WaitingThreads"));
-    rb_define_singleton_method(rb_mWaitingThreads, "reset", waiting_threads_reset, 0);
+    rb_define_singleton_method(rb_mWaitingThreads, "_reset", waiting_threads_reset, 0);
     rb_define_singleton_method(rb_mWaitingThreads, "count", waiting_threads_count, 0);
 }

data/lib/gvltools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GVLTools
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/gvltools.rb

@@ -96,8 +96,27 @@ module GVLTools
       end
       alias_method :count, :count
 
+      def enable
+        unless enabled?
+          reset
+        end
+        super
+      end
+
+      def reset
+        if enabled?
+          raise Error, "can't reset WaitingThreads counter while it is active"
+        else
+          _reset
+        end
+      end
+
       private
 
+      def _reset
+      end
+      alias_method :_reset, :_reset # to be redefined from C.
+
       def metric
         WAITING_THREADS
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gvltools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Set of GVL instrumentation tools