gvl-tracing 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 643b4b237db640d34ecf842459246640517ca9d58118ca891c76a629f1c6ab73
-  data.tar.gz: 10c2613b6b66681b46f7d32a143e5742ed98b969d9aca00e3ceb6b22c5579f4b
+  metadata.gz: d4945e5419655b2e69f310845e6214ff0bd6eb66ae820383f9cbe97855f15cdb
+  data.tar.gz: dd95a9431c53c3904b054227a305da7433a789d8828b0340abc2b48864361735
 SHA512:
-  metadata.gz: f3265c1719bd2dd7859f4df78a4b9096277b45f26b9a6bd515c5a3222f3bdb98e56461eef274f5987a61cfb7ec331ac44dac58a94fd8dadf7474a51b9033f3d6
-  data.tar.gz: 40a336509af944962fc2c48ae2f40c2ae40ff133b53b7e006f63f1a453e4106d68f6283e008462088f39afd3c5653556ef064fb6bf312aeffc09cd282ba90ba9
+  metadata.gz: eca1b710f5918e887f06c44dfa970100e77c99bbc63318321a72e76dfffc4b44022b055dae4de05992494fc40910a467f4aa3ed045ab891018303a15fe8169e1
+  data.tar.gz: 59deb53b041211513979526345af62c3e94495e73deae38d1f1e7272a11469695ae5c2435331bcf811f1c943c18f9602c4e3199c97fef9963cb3e3e4cd25f5cd

data/README.adoc

@@ -25,17 +25,15 @@ def fib(n)
   fib(n - 1) + fib(n - 2)
 end
 
-GvlTracing.start("example1.json")
+GvlTracing.start("example1.json") do
+  Thread.new { sleep(0.05) while true }
 
-Thread.new { sleep(0.05) while true }
+  sleep(0.05)
 
-sleep(0.05)
+  3.times.map { Thread.new { fib(37) } }.map(&:join)
 
-3.times.map { Thread.new { fib(37) } }.map(&:join)
-
-sleep(0.05)
-
-GvlTracing.stop
+  sleep(0.05)
+end
 ----
 
 To do so:
@@ -65,7 +63,7 @@ Use `require "gvl-tracing"` to load the gem.
 
 This gem only provides a single module (`GvlTracing`) with methods:
 
-* `start(filename)`: Starts tracing, writing the results to the provided filename
+* `start(filename, &block)`: Starts tracing, writing the results to the provided filename. When a block is passed, yields the block and calls stop.
 * `stop`: Stops tracing
 
 The resulting traces can be analyzed by going to https://ui.perfetto.dev/[Perfetto UI].

data/ext/gvl_tracing_native_extension/gvl_tracing.c

@@ -56,11 +56,14 @@ static void set_native_thread_id(void);
 static void render_event(const char *event_name);
 static void on_thread_event(rb_event_flag_t event, const rb_internal_thread_event_data_t *_unused1, void *_unused2);
 static void on_gc_event(VALUE tpval, void *_unused1);
+static VALUE mark_sleeping(VALUE _self);
 
 // Thread-local state
 static _Thread_local bool current_thread_seen = false;
 static _Thread_local unsigned int current_thread_serial = 0;
 static _Thread_local uint64_t thread_id = 0;
+static _Thread_local rb_event_flag_t previous_state = 0; // Used to coalesce similar events
+static _Thread_local bool sleeping = false; // Used to track when a thread is sleeping
 
 // Global mutable state
 static rb_atomic_t thread_serial = 0;
@@ -77,6 +80,7 @@ void Init_gvl_tracing_native_extension(void) {
 
   rb_define_singleton_method(gvl_tracing_module, "_start", tracing_start, 1);
   rb_define_singleton_method(gvl_tracing_module, "_stop", tracing_stop, 0);
+  rb_define_singleton_method(gvl_tracing_module, "mark_sleeping", mark_sleeping, 0);
 }
 
 static inline void initialize_thread_id(void) {
@@ -204,6 +208,23 @@ static void render_event(const char *event_name) {
 }
 
 static void on_thread_event(rb_event_flag_t event_id, UNUSED_ARG const rb_internal_thread_event_data_t *_unused1, UNUSED_ARG void *_unused2) {
+  // In some cases, Ruby seems to even multiple suspended events for the same thread in a row (e.g. when multiple threads)
+  // are waiting on a Thread::ConditionVariable.new that gets signaled. We coalesce these events to make the resulting
+  // timeline easier to see.
+  //
+  // I haven't observed other situations where we'd want to coalesce events, but we may apply this to all events in the
+  // future. One annoying thing to remember when generalizing this is how to reset the `previous_state` across multiple
+  // start/stop calls to GvlTracing.
+  if (event_id == RUBY_INTERNAL_THREAD_EVENT_SUSPENDED && event_id == previous_state) return;
+  previous_state = event_id;
+
+  if (event_id == RUBY_INTERNAL_THREAD_EVENT_SUSPENDED && sleeping) {
+    render_event("sleeping");
+    return;
+  } else {
+    sleeping = false;
+  }
+
   const char* event_name = "bug_unknown_event";
   switch (event_id) {
     case RUBY_INTERNAL_THREAD_EVENT_READY:     event_name = "wants_gvl"; break;
@@ -224,3 +245,8 @@ static void on_gc_event(VALUE tpval, UNUSED_ARG void *_unused1) {
   }
   render_event(event_name);
 }
+
+static VALUE mark_sleeping(VALUE _self) {
+  sleeping = true;
+  return Qnil;
+}

data/lib/gvl-tracing.rb

@@ -37,6 +37,14 @@ module GvlTracing
     def start(file)
       _start(file)
       @path = file
+
+      return unless block_given?
+
+      begin
+        yield
+      ensure
+        _stop
+      end
     end
 
     def stop

data/lib/gvl_tracing/sleep_tracking.rb

@@ -0,0 +1,12 @@
+# Experimental: This monkey patch when loaded introduces a new state -- "sleeping" -- which is more specific than the
+# regular "waiting". This can be useful to distinguish when waiting is happening based on time, vs for some event to
+# happen.
+
+module GvlTracing::SleepTracking
+  def sleep(...)
+    GvlTracing.mark_sleeping
+    super(...)
+  end
+end
+
+include GvlTracing::SleepTracking

data/lib/gvl_tracing/version.rb

@@ -26,5 +26,5 @@
 # frozen_string_literal: true
 
 module GvlTracing
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gvl-tracing
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ivo Anjo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-09-05 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -30,6 +30,7 @@ files:
 - gems.rb
 - gvl-tracing.gemspec
 - lib/gvl-tracing.rb
+- lib/gvl_tracing/sleep_tracking.rb
 - lib/gvl_tracing/version.rb
 - preview.png
 homepage: https://github.com/ivoanjo/gvl-tracing
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Get a timeline view of Global VM Lock usage in your Ruby app