gvl_timing 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6501413dc9601f05b7595fa0494ed21ef9de1638554ced822efb689f7970a51a
-  data.tar.gz: 23ed94187a9048aa54bbbb33fcd20bbfa1c1e4169c788d65bcf4c9fc078ceedb
+  metadata.gz: 11943fd2bd229bb71b905436ff49735fa683355107e773798a0c265e91dc51c9
+  data.tar.gz: 28e2c52c9d4aa6eb9d9346c4bf85398c41d70f7cd8dfd70699f3618340779979
 SHA512:
-  metadata.gz: dacfe66754ee03d97d509f8c6c30243675e0663e53616972628cd58c0b5b02d73f6943d0c3803e8879e1e9273031cb42ff9e06565d706ed21784df75ec166725
-  data.tar.gz: c4c3be6acf8a456e604ee29016f2f129621e1508955dff64671cce172ea727272f83caf90367af235f9d0535597f1b22fedfd24f26358b38183f0f310769ca94
+  metadata.gz: ca21dea3e3d9d8bc9b4c46a76c32d33aa7e501f4b56c28f4543e46374e8e5341d90950dc18381f841011fd65cfbc4a47df280e5cec6297655991300574d31ac4
+  data.tar.gz: dfa75b00eac2c2c0e23d9c4acbb816a6c3f18224405bfacf40345c6d9d59e0ab22691f3697f70934ca13387520f050aa7d8fc3d706c1d6a2a1bc52cabc34b348

data/README.md

@@ -1,24 +1,30 @@
-# GvlTiming
+# gvl\_timing
 
-TODO: Delete this and the text below, and describe your gem
+Measures timings for the current thread's GVL state for CRuby.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gvl_timing`. To experiment with that code, run `bin/console` for an interactive prompt.
+This will add some (small) overhead to all GVL activity, so may be better to
+development/test or sampled use rather than continuous timing.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add gvl_timing
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+>> timer = GVLTiming.measure { sleep 0.1 }
+=> #<GVLTiming::Timer total=0.10s running=0.00s idle=0.10s stalled=0.00s>
+>> timer.duration
+=> 0.101082
+>> timer.cpu_duration
+=> 7.4667e-05
+>> timer.idle_duration
+=> 0.101048
+>> timer.stalled_duration
+=> 1.0e-06
+```
 
 ## Development
 

data/ext/gvl_timing/extconf.rb

@@ -7,4 +7,7 @@ require "mkmf"
 # selectively, or entirely remove this flag.
 append_cflags("-fvisibility=hidden")
 
+have_header("ruby/thread.h")
+have_struct_member("rb_internal_thread_event_data_t", "thread", ["ruby/thread.h"])
+
 create_makefile("gvl_timing/gvl_timing")

data/ext/gvl_timing/gvl_timing.c

@@ -26,6 +26,8 @@ struct gvl_timer {
     uint64_t cputime_start;
     uint64_t cputime_stop;
 
+    uint64_t yields_count;
+
     uint64_t prev_timestamp;
     enum ruby_gvl_state prev_state;
     VALUE thread;
@@ -40,16 +42,23 @@ void record_timing(struct gvl_timer *timer, enum ruby_gvl_state new_state) {
     timer->timings[timer->prev_state] += (timestamp - timer->prev_timestamp);
     timer->prev_timestamp = timestamp;
     timer->prev_state = new_state;
+
+    if (new_state == GVL_STATE_IDLE) {
+        timer->yields_count++;
+    }
+
 }
 
 void internal_thread_event_cb(rb_event_flag_t event, const rb_internal_thread_event_data_t *event_data, void *data) {
     struct gvl_timer *timer = data;
 
+    VALUE thread;
+#if HAVE_RB_INTERNAL_THREAD_EVENT_DATA_T_THREAD
+    thread = event_data->thread;
+#else
     if (!ruby_native_thread_p()) return;
-    VALUE thread = rb_thread_current();
-//#if HAVE_RB_INTERNAL_THREAD_EVENT_DATA_T_THREAD
-//#else
-//#endif
+    thread = rb_thread_current();
+#endif
     if (thread != timer->thread) {
         return;
     }
@@ -150,6 +159,10 @@ VALUE gvl_timer_idle_duration(VALUE obj) {
     return ULL2NUM(get_timer(obj)->timings[GVL_STATE_IDLE]);
 }
 
+VALUE gvl_timer_yields_count(VALUE obj) {
+    return ULL2NUM(get_timer(obj)->yields_count);
+}
+
 RUBY_FUNC_EXPORTED void
 Init_gvl_timing(void)
 {
@@ -159,12 +172,14 @@ Init_gvl_timing(void)
     rb_define_method(rb_cTimer, "start", gvl_timer_start, 0);
     rb_define_method(rb_cTimer, "stop", gvl_timer_stop, 0);
 
-    rb_define_method(rb_cTimer, "monotonic_start", gvl_timer_monotonic_start, 0);
-    rb_define_method(rb_cTimer, "monotonic_stop", gvl_timer_monotonic_stop, 0);
-    rb_define_method(rb_cTimer, "cputime_start", gvl_timer_cputime_start, 0);
-    rb_define_method(rb_cTimer, "cputime_stop", gvl_timer_cputime_stop, 0);
+    rb_define_method(rb_cTimer, "monotonic_start_ns", gvl_timer_monotonic_start, 0);
+    rb_define_method(rb_cTimer, "monotonic_stop_ns", gvl_timer_monotonic_stop, 0);
+    rb_define_method(rb_cTimer, "cputime_start_ns", gvl_timer_cputime_start, 0);
+    rb_define_method(rb_cTimer, "cputime_stop_ns", gvl_timer_cputime_stop, 0);
+
+    rb_define_method(rb_cTimer, "running_duration_ns", gvl_timer_running_duration, 0);
+    rb_define_method(rb_cTimer, "stalled_duration_ns", gvl_timer_stalled_duration, 0);
+    rb_define_method(rb_cTimer, "idle_duration_ns", gvl_timer_idle_duration, 0);
 
-    rb_define_method(rb_cTimer, "running_duration", gvl_timer_running_duration, 0);
-    rb_define_method(rb_cTimer, "stalled_duration", gvl_timer_stalled_duration, 0);
-    rb_define_method(rb_cTimer, "idle_duration", gvl_timer_idle_duration, 0);
+    rb_define_method(rb_cTimer, "yields_count", gvl_timer_yields_count, 0);
 }

data/lib/gvl_timing/version.rb

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

data/lib/gvl_timing.rb

@@ -20,21 +20,60 @@ module GVLTiming
   class Timer
     NANOSECONDS_PER_SECOND_F = 1000000000.0
 
-    def duration
-      monotonic_stop - monotonic_start
+    def duration_ns
+      monotonic_stop_ns - monotonic_start_ns
     end
 
-    def cpu_duration
-      cputime_stop - cputime_start
+    def cpu_duration_ns
+      cputime_stop_ns - cputime_start_ns
     end
 
+    [
+      :duration, :cpu_duration,
+      :monotonic_start, :monotonic_stop,
+      :cputime_start, :cputime_stop,
+      :running_duration, :stalled_duration, :idle_duration
+    ].each do |name|
+      class_eval <<~RUBY
+        def #{name}(unit = :float_second)
+          scale_ns(#{name}_ns, unit)
+        end
+      RUBY
+    end
+
+    alias releases_count yields_count
+
     def inspect
-      "#<#{self.class} total=%.2fs running=%.2fs idle=%.2fs stalled=%.2fs>" % [
-        duration / NANOSECONDS_PER_SECOND_F,
-        running_duration / NANOSECONDS_PER_SECOND_F,
-        idle_duration / NANOSECONDS_PER_SECOND_F,
-        stalled_duration / NANOSECONDS_PER_SECOND_F
+      "#<#{self.class} total=%.2fs running=%.2fs idle=%.2fs stalled=%.2fs yields=%d>" % [
+        duration,
+        running_duration,
+        idle_duration,
+        stalled_duration,
+        yields_count,
       ]
     end
+
+    private
+
+    def scale_ns(value_ns, unit)
+      case unit
+      when :float_second
+        value_ns / 1_000_000_000.0
+      when :float_millisecond
+        value_ns / 1_000_000.0
+      when :float_microsecond
+        value_ns / 1000.0
+      when :second
+        value_ns / 1_000_000_000
+      when :millisecond
+        value_ns / 1_000_000
+      when :microsecond
+        value_ns / 1000
+      when :nanosecond
+        value_ns
+      else
+        raise ArgumentError, "unexpected unit: #{unit.inspect}"
+      end
+    end
   end
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gvl_timing
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - John Hawthorn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies: []
-description: Report time spent in different GVL states
+description: Measure time spent in different GVL states
 email:
 - john@hawthorn.email
 executables:
@@ -36,7 +35,6 @@ metadata:
   homepage_uri: https://github.com/jhawthorn/gvl_timing
   source_code_uri: https://github.com/jhawthorn/gvl_timing
   changelog_uri: https://github.com/jhawthorn/gvl_timing
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Report time spent in different GVL states
+summary: Measure time spent in different GVL states
 test_files: []