gvl-tracing 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1adc64642ec1cb371df66afa9f928cafe106349f981a3b8ec643232a0618b769
-  data.tar.gz: 9b250c7a07df1f9a1f907100554fa74eba043edb639ad1cc777b33ba705d98f3
+  metadata.gz: 1eedec6bc1503bdc8fabde77ac69167de69a9fe1cc8c211720ce7fa34d5fd66a
+  data.tar.gz: 6e504dfe9f06f97b3247e00cf5cbc0fa17ffec39136474dfc5e9ff9914a10351
 SHA512:
-  metadata.gz: 5016d9734e5eeef9578fc83211bb68cbc26f68f1b93b41c3ff0fbd9f5a3b93745cb7de23c69cc228a903b17db565ee369ec3d41f7d9575e3107a04a9bf6368a0
-  data.tar.gz: 821d89427465c6496e09a773a1277d35388d4205fd5e0e5f054fd8da8d1a46d902e4f464764a0e5891bb9ebb63451295ea2bf1986c085616b2ff60926dcbde7a
+  metadata.gz: 34fcfe11c2c1dca8307442e026420dea3a630b19c652164c9095143414226227e0198ae69b44f6e53ca3cf5325cd832e8a5450ce824ba7c5a99f37cb9e604300
+  data.tar.gz: 01dc10ae34c5398889d531313f3faceda12bbe37890193cfd64560cd99f352149e3afea3d6ebb553e0d3116aa202bb34b9c7d403cbc0c368e272ed7053e6daad

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.0

data/README.adoc

@@ -10,7 +10,7 @@ image::preview.png[]
 
 See my blog post https://ivoanjo.me/blog/2022/07/17/tracing-ruby-global-vm-lock/[tracing ruby's (global) vm lock] for more details!
 
-NOTE: This gem only works on Ruby 3.2 and above because it depends on the new https://github.com/ruby/ruby/pull/5500[GVL Instrumentation API]. See below for an easy way to run Ruby 3.2 inside docker.
+NOTE: This gem only works on Ruby 3.2 and above because it depends on the https://github.com/ruby/ruby/pull/5500[GVL Instrumentation API].
 
 == Quickest start
 
@@ -43,26 +43,6 @@ To do so:
 1. Download link:https://github.com/ivoanjo/gvl-tracing/blob/master/examples/example1.json.gz?raw=true[`examples/example1.json.gz`]
 2. Navigate to https://ui.perfetto.dev/ and use the **Open trace file** option to load the file
 
-== Quick start using docker
-
-The `gvl-tracing` gem requires Ruby 3.2, which is still under development. If you have docker installed on your machine, you can use the https://hub.docker.com/r/rubylang/ruby[ruby-lang development images] to try it out.
-
-Here's how you can use them:
-
-[source,bash]
-----
-$ cd my_ruby_app/
-$ docker run -v $(pwd):/app -it rubylang/ruby:master-focal
-root@0e0b07edf906:/# cd app/
-root@0e0b07edf906:/app# ruby -v
-ruby 3.2.0dev (2022-07-23T12:42:05Z master 721d154e2f) [x86_64-linux]
-root@0e0b07edf906:/app# gem install gvl-tracing
-Building native extensions. This could take a while...
-Successfully installed gvl-tracing-0.1.1
-1 gem installed
-root@0e0b07edf906:/app# ruby <your app>
-----
-
 == Installation
 
 Install the gem and add to the application's `Gemfile` or `gems.rb` file by executing:

data/ext/gvl_tracing_native_extension/extconf.rb

@@ -32,4 +32,10 @@ end
 
 require "mkmf"
 
+have_func("gettid", "unistd.h")
+have_header("pthread.h")
+have_func("pthread_getname_np", "pthread.h")
+have_func("pthread_threadid_np", "pthread.h")
+
+create_header
 create_makefile "gvl_tracing_native_extension"

data/ext/gvl_tracing_native_extension/gvl_tracing.c

@@ -31,6 +31,16 @@
 #include <stdbool.h>
 #include <sys/types.h>
 
+#include "extconf.h"
+
+#ifdef HAVE_PTHREAD_H
+  #include <pthread.h>
+#endif
+
+#ifdef HAVE_GETTID
+  #include <unistd.h>
+#endif
+
 static VALUE tracing_start(VALUE _self, VALUE output_path);
 static VALUE tracing_stop(VALUE _self);
 static double timestamp_microseconds(void);
@@ -59,12 +69,31 @@ void Init_gvl_tracing_native_extension(void) {
   rb_define_singleton_method(gvl_tracing_module, "stop", tracing_stop, 0);
 }
 
-static inline unsigned int current_thread_id(void) {
-    if (!current_thread_serial_set) {
-        current_thread_serial_set = true;
-        current_thread_serial = RUBY_ATOMIC_FETCH_ADD(thread_serial, 1);
-    }
-    return (unsigned int)current_thread_serial;
+static inline void initialize_thread_id(void) {
+  current_thread_serial_set = true;
+  current_thread_serial = RUBY_ATOMIC_FETCH_ADD(thread_serial, 1);
+}
+
+static inline void render_thread_metadata(void) {
+  uint64_t native_thread_id = 0;
+  #ifdef HAVE_GETTID
+    native_thread_id = gettid();
+  #elif HAVE_PTHREAD_THREADID_NP
+    pthread_threadid_np(pthread_self(), &native_thread_id);
+  #else
+    native_thread_id = current_thread_serial; // TODO: Better fallback for Windows?
+  #endif
+
+  char native_thread_name_buffer[64] = "(unnamed)";
+
+  #ifdef HAVE_PTHREAD_GETNAME_NP
+    pthread_getname_np(pthread_self(), native_thread_name_buffer, sizeof(native_thread_name_buffer));
+  #endif
+
+  fprintf(output_file,
+    "  {\"ph\": \"M\", \"pid\": %u, \"tid\": %u, \"name\": \"thread_name\", \"args\": {\"name\": \"%lu %s\"}},\n",
+    process_id, current_thread_serial, native_thread_id, native_thread_name_buffer
+  );
 }
 
 static VALUE tracing_start(VALUE _self, VALUE output_path) {
@@ -134,7 +163,13 @@ static double timestamp_microseconds(void) {
 static void render_event(const char *event_name) {
   // Event data
   double now_microseconds = timestamp_microseconds() - started_tracing_at_microseconds;
-  unsigned int thread_id = current_thread_id();
+
+  if (!current_thread_serial_set) {
+    initialize_thread_id();
+    render_thread_metadata();
+  }
+
+  unsigned int thread_id = current_thread_serial;
 
   // Each event is converted into two events in the output: one that signals the end of the previous event
   // (whatever it was), and one that signals the start of the actual event we're processing.
@@ -158,11 +193,11 @@ static void render_event(const char *event_name) {
 static void on_thread_event(rb_event_flag_t event_id, const rb_internal_thread_event_data_t *_unused1, void *_unused2) {
   const char* event_name = "bug_unknown_event";
   switch (event_id) {
-    case RUBY_INTERNAL_THREAD_EVENT_READY:     event_name = "ready";     break;
+    case RUBY_INTERNAL_THREAD_EVENT_READY:     event_name = "wants_gvl"; break;
     case RUBY_INTERNAL_THREAD_EVENT_RESUMED:   event_name = "running";   break;
     case RUBY_INTERNAL_THREAD_EVENT_SUSPENDED: event_name = "waiting";   break;
     case RUBY_INTERNAL_THREAD_EVENT_STARTED:   event_name = "started";   break;
-    case RUBY_INTERNAL_THREAD_EVENT_EXITED:    event_name = "exited";    break;
+    case RUBY_INTERNAL_THREAD_EVENT_EXITED:    event_name = "died";      break;
   };
   render_event(event_name);
 }

data/gvl-tracing.gemspec

@@ -36,13 +36,13 @@ Gem::Specification.new do |spec|
   spec.summary = "Get a timeline view of Global VM Lock usage in your Ruby app"
   spec.homepage = "https://github.com/ivoanjo/gvl-tracing"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0.dev"
+  spec.required_ruby_version = ">= 3.2.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|examples)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
   spec.require_paths = ["lib", "ext"]

data/lib/gvl_tracing/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gvl-tracing
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ivo Anjo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,19 +19,12 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".ruby-version"
 - ".standard.yml"
 - CODE_OF_CONDUCT.adoc
 - LICENSE
 - README.adoc
 - Rakefile
-- examples/example1.json.gz
-- examples/example1.rb
-- examples/example2.json.gz
-- examples/example2.rb
-- examples/example3.json.gz
-- examples/example3.rb
-- examples/gc.json.gz
-- examples/gc.rb
 - ext/gvl_tracing_native_extension/extconf.rb
 - ext/gvl_tracing_native_extension/gvl_tracing.c
 - gems.rb
@@ -52,14 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0.dev
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Get a timeline view of Global VM Lock usage in your Ruby app

data/examples/example1.rb

@@ -1,18 +0,0 @@
-require "gvl-tracing"
-
-def fib(n)
-  return n if n <= 1
-  fib(n - 1) + fib(n - 2)
-end
-
-GvlTracing.start("example1.json")
-
-Thread.new { sleep(0.05) while true }
-
-sleep(0.05)
-
-3.times.map { Thread.new { fib(37) } }.map(&:join)
-
-sleep(0.05)
-
-GvlTracing.stop

data/examples/example2.rb

@@ -1,14 +0,0 @@
-require "gvl-tracing"
-
-def fib(n)
-  return n if n <= 1
-  fib(n - 1) + fib(n - 2)
-end
-
-GvlTracing.start("example2.json")
-
-other_thread = Thread.new { fib(37) } # runs in other thread
-fib(37) # runs in main thread
-
-other_thread.join
-GvlTracing.stop

data/examples/example3.rb

@@ -1,14 +0,0 @@
-require "gvl-tracing"
-
-def fib(n)
-  return n if n <= 1
-  fib(n - 1) + fib(n - 2)
-end
-
-GvlTracing.start("example3.json")
-
-other_ractor = Ractor.new { fib(37) } # runs in other ractor
-fib(37) # runs in main thread
-
-other_ractor.take
-GvlTracing.stop

data/examples/gc.rb

@@ -1,13 +0,0 @@
-require "gvl-tracing"
-
-def alloc(n)
-  n.times { Object.new }
-end
-
-GvlTracing.start("gc.json")
-
-3.times.map { Thread.new { alloc(100_000) } }.map(&:join)
-
-sleep(0.05)
-
-GvlTracing.stop