gvltools 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b6af92049391130d2248c5d14ec3c93e859f4ab92d6af9842e2a88c289b3e50
-  data.tar.gz: 4681a32780409d180b6727a791cdc122a9a03d21eba7f28f2070c8de6e52ddb1
+  metadata.gz: 93f82e0950c9e2c02690e92984d20654d36dd91b3dffee80d0e85965a0bbc0b3
+  data.tar.gz: c6db2e33663b3c3fe290889eb91a71ac336d75a1005e90903b5c54e663446f70
 SHA512:
-  metadata.gz: 005a90c02765c716c97f9165f777dd6b26b3853037e6c64f13e3255278db5a7c5d378855850758a7e391d9957389d18db7edb24a3658a46a5ec6105668238fa7
-  data.tar.gz: e16793a8f452f958cd0dde468c5aff337a78719485c8657bc9f5e1e91bd393b0bc1a523e56b5a1e06246c963e8661ed34707ef49e05cb15d6e94e57865c9932c
+  metadata.gz: fcb609efc5575f85fd66fd57e223204a3206905b724940bf59dfc75e7421dab91faf0b9c7ed6e10083be728c17e5b083445ac59196fdfaa9ff629f4b05f53523
+  data.tar.gz: f71c390eaa0d6d72f8b06d58a70802f18ce7ec8347b84e42b4e5abcea5ec0c4a7bf598790080abd3b847e99537692caba4923651a2822d8cf1865a3588c5e962

data/.rubocop.yml

@@ -1,5 +1,4 @@
 AllCops:
-  TargetRubyVersion: 3.0
   NewCops: enable
   SuggestExtensions: false
 
@@ -25,6 +24,9 @@ Style/GlobalVars:
 Style/EmptyMethod:
   Enabled: false
 
+Naming/PredicateMethod:
+  Enabled: false
+
 Style/IfUnlessModifier:
   Enabled: false
 

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.5.0] - 2026-06-15
+
+- Fixed a `LocalTimer` deadlock with fiber schedulers by not allocating (and potentially triggering GC) during the `RESUMED` event (#34).
+- Store the `LocalTimer` counter in a thread instance variable instead of fiber-local storage, so it is shared across fibers of the same thread (#37).
+
+## [0.4.0] - 2024-01-19
+
 - Fixed compatibility with Ruby 3.3.0.
 - Added `GVLTools::LocalTimer.for(thread)` to access another thread counter (Ruby 3.3+ only).
 

data/Gemfile.lock

@@ -1,41 +1,45 @@
 PATH
   remote: .
   specs:
-    gvltools (0.4.0)
+    gvltools (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    minitest (5.21.2)
-    parallel (1.24.0)
-    parser (3.3.0.2)
+    ast (2.4.3)
+    json (2.19.8)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.27.0)
+    parallel (2.1.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    prism (1.9.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rake-compiler (1.2.0)
+    rake (13.4.2)
+    rake-compiler (1.3.1)
       rake
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.59.0)
+    regexp_parser (2.12.0)
+    rubocop (1.87.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   aarch64-linux
@@ -50,4 +54,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.3.14
+   2.5.3

data/README.md

@@ -44,6 +44,8 @@ It is particularly useful to detect wether an application use too many threads,
 For instance as a Rack middleware:
 
 ```ruby
+# lib/gvl_instrumentation_middleware.rb
+
 class GVLInstrumentationMiddleware
   def initialize(app)
     @app = app
@@ -59,6 +61,15 @@ class GVLInstrumentationMiddleware
 end
 ```
 
+```ruby
+# config/initializers/gvl_instrumentation.rb
+
+GVLTools::LocalTimer.enable
+
+require "gvl_instrumentation_middleware"
+config.middleware.use GVLInstrumentationMiddleware
+```
+
 Starting from Ruby 3.3, a thread local timer can be accessed from another thread:
 
 ```ruby

data/ext/gvltools/instrumentation.c

@@ -26,6 +26,7 @@ typedef struct {
 
 #ifdef HAVE_RB_INTERNAL_THREAD_SPECIFIC_GET // 3.3+
 static int thread_storage_key = 0;
+static ID id_local_state;
 
 static size_t thread_local_state_memsize(const void *data) {
     return sizeof(thread_local_state);
@@ -45,7 +46,8 @@ static inline thread_local_state *GT_LOCAL_STATE(VALUE thread, bool allocate) {
     thread_local_state *state = rb_internal_thread_specific_get(thread, thread_storage_key);
     if (!state && allocate) {
         VALUE wrapper = TypedData_Make_Struct(rb_cLocalTimer, thread_local_state, &thread_local_state_type, state);
-        rb_thread_local_aset(thread, rb_intern("__gvltools_local_state"), wrapper);
+        // Anchor to the thread object, not fiber-local storage, so it outlives the allocating fiber.
+        rb_ivar_set(thread, id_local_state, wrapper);
         RB_GC_GUARD(wrapper);
         rb_internal_thread_specific_set(thread, thread_storage_key, state);
     }
@@ -99,6 +101,20 @@ static VALUE gt_enable_metric(VALUE module, VALUE metric) {
             RUBY_INTERNAL_THREAD_EVENT_STARTED | RUBY_INTERNAL_THREAD_EVENT_EXITED | RUBY_INTERNAL_THREAD_EVENT_READY | RUBY_INTERNAL_THREAD_EVENT_RESUMED,
             NULL
         );
+
+#ifdef HAVE_RB_INTERNAL_THREAD_SPECIFIC_GET
+        // Eagerly allocate the per-thread state for every thread that already
+        // exists at enable time. Threads created later get their state allocated from the
+        // STARTED event (also GVL-held). This guarantees the RESUMED event always finds an
+        // existing state and never has to allocate. Allocating from RESUMED is
+        // illegal because it doesn't necessarily run with the GVL.
+        VALUE threads = rb_funcall(rb_const_get(rb_cObject, rb_intern("Thread")), rb_intern("list"), 0);
+        long count = RARRAY_LEN(threads);
+        for (long i = 0; i < count; i++) {
+            GT_LOCAL_STATE(RARRAY_AREF(threads, i), true);
+        }
+        RB_GC_GUARD(threads);
+#endif
     }
     return Qtrue;
 }
@@ -138,7 +154,7 @@ static VALUE local_timer_m_reset(VALUE module) {
 #ifdef HAVE_RB_INTERNAL_THREAD_SPECIFIC_GET
 static VALUE local_timer_for(VALUE module, VALUE thread) {
     GT_LOCAL_STATE(thread, true);
-    return rb_thread_local_aref(thread, rb_intern("__gvltools_local_state"));
+    return rb_ivar_get(thread, id_local_state);
 }
 
 static VALUE local_timer_monotonic_time(VALUE timer) {
@@ -207,9 +223,9 @@ static void gt_thread_callback(rb_event_flag_t event, const rb_internal_thread_e
             }
         }
         break;
-        case RUBY_INTERNAL_THREAD_EVENT_RESUMED: {
-            thread_local_state *state = GT_EVENT_LOCAL_STATE(event_data, true);
-            if (!state->was_ready)  {
+        case RUBY_INTERNAL_THREAD_EVENT_RESUMED: { // Must not allocate
+            thread_local_state *state = GT_EVENT_LOCAL_STATE(event_data, false);
+            if (!state || !state->was_ready)  {
                 break; // In case we registered the hook while some threads were already waiting on the GVL
             }
 
@@ -240,6 +256,7 @@ static void gt_thread_callback(rb_event_flag_t event, const rb_internal_thread_e
 void Init_instrumentation(void) {
 #ifdef HAVE_RB_INTERNAL_THREAD_SPECIFIC_GET // 3.3+
     thread_storage_key = rb_internal_thread_specific_key_create();
+    id_local_state = rb_intern("__gvltools_local_state");
 #endif
 
     VALUE rb_mGVLTools = rb_const_get(rb_cObject, rb_intern("GVLTools"));

data/lib/gvltools/version.rb

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

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gvltools
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean Boussier
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - jean.boussier@gmail.com
 executables: []
@@ -19,6 +17,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -38,7 +37,6 @@ metadata:
   homepage_uri: https://github.com/Shopify/gvltools
   source_code_uri: https://github.com/Shopify/gvltools
   changelog_uri: https://github.com/Shopify/gvltools/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,8 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Set of GVL instrumentation tools
 test_files: []