gvl_timing 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6501413dc9601f05b7595fa0494ed21ef9de1638554ced822efb689f7970a51a
-  data.tar.gz: 23ed94187a9048aa54bbbb33fcd20bbfa1c1e4169c788d65bcf4c9fc078ceedb
+  metadata.gz: db733cb6bbf991888c58e4d4aede834efaaec117a02c7ca2822f19ef1c842eec
+  data.tar.gz: a86891666732c57f85b46e9eaf8fb88cc5f265449a282f6d1bc1e444b4dd6ac4
 SHA512:
-  metadata.gz: dacfe66754ee03d97d509f8c6c30243675e0663e53616972628cd58c0b5b02d73f6943d0c3803e8879e1e9273031cb42ff9e06565d706ed21784df75ec166725
-  data.tar.gz: c4c3be6acf8a456e604ee29016f2f129621e1508955dff64671cce172ea727272f83caf90367af235f9d0535597f1b22fedfd24f26358b38183f0f310769ca94
+  metadata.gz: 89b22673ab84fba5fb065f34180fbe8bd83b23b77432f60e0736bd7f5a137fc0c285aff73f8527207ffd6ec3593301e434047a7dbd70f3b80c19bf265f2b6dd5
+  data.tar.gz: '09fcfe0991aa902049de16ac2b3e9d8cfe5f9142641258cddcb6b60d8159b00636579231a70a7ccb09544977e415dadc5bc9334b0513db4e9b4eac06316028ad'

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/gvl_timing.c

@@ -159,12 +159,12 @@ 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, "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, "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);
 }

data/lib/gvl_timing/version.rb

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

data/lib/gvl_timing.rb

@@ -20,21 +20,58 @@ 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_start,
+      :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
+
+
     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
+        duration,
+        running_duration,
+        idle_duration,
+        stalled_duration,
       ]
     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,16 @@
 --- !ruby/object:Gem::Specification
 name: gvl_timing
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-06-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:
@@ -54,5 +54,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Report time spent in different GVL states
+summary: Measure time spent in different GVL states
 test_files: []