gvltools 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed2a6e0154120c8b048e3b92db8e6f6c4a87d2b653b105b90a06a171ca61895b
-  data.tar.gz: a976aab0ebf0da04af47d53587c144b7e89eeeef8f078c5b115d037db0fe3f6b
+  metadata.gz: 5ffb320bec5fdc8a0d4940d8b370af1607a20383e1a9a8f939cc759588ca6627
+  data.tar.gz: 223bee0c124c17296b8386bbdda94406f91b84ad0adcf3acd09921424bb8eaf8
 SHA512:
-  metadata.gz: baca86f153a68a90ca36213775bd22d5263325e98fdf3cd3332c4b3db953014c7c9a8e14c9ddee27ad0b19de5300065fd77d79d795d7ad8f931d45838f797921
-  data.tar.gz: be738a183964c4b6e0ef4f9ff5b9aac5e1a9b983d3fffe38034a338416260dc8be5fd95fcc23fe35697c2cc9d79ab8b1e8689deb3907e07468fe8e9985247911
+  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,10 @@
 ## [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`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gvltools (0.2.0)
+    gvltools (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/ext/gvltools/instrumentation.c

@@ -93,12 +93,15 @@ static VALUE local_timer_reset(VALUE module) {
 
 // Thread counts
 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 ULL2NUM(waiting_threads_total);
 }
 
 static VALUE waiting_threads_reset(VALUE module) {
+    waiting_threads_current_generation++;
     waiting_threads_total = 0;
     return Qtrue;
 }
@@ -122,6 +125,7 @@ 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)) {
+                waiting_threads_ready_generation = waiting_threads_current_generation;
                 waiting_threads_total++;
             }
 
@@ -134,7 +138,9 @@ 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)) {
-                waiting_threads_total--;
+                if (waiting_threads_ready_generation == waiting_threads_current_generation) {
+                    waiting_threads_total--;
+                }
             }
 
             if (ENABLED(TIMER_GLOBAL | TIMER_LOCAL)) {
@@ -172,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.2.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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-28 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.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Set of GVL instrumentation tools