gctime 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415713b61297b0808196eb07372db20deda2723a58c449ad2b9b9f5692a619c2
-  data.tar.gz: 7f0ffe0e2cc8f5472a5ddc4239bf5fb2eceb6d1a81a14088a00fc5b4546052b2
+  metadata.gz: 0b594dd96d438936c08955b149f5a0a6d9abb4a044cbbaddd8ac1befe80bece4
+  data.tar.gz: 806439090aac36803dd00a6823aa87ab4896d8300e546bee00a225a256af8f84
 SHA512:
-  metadata.gz: b92fba315640ddfdb3a3edded95fdf52886e0d546c32d8e985b1c8653fd598382eded803094271e7af3509a33e647c89ed36bf364bbfcd642e3317a7969eef75
-  data.tar.gz: 83521f8200beea897272f42b622dff0f54e335364ed9452aad3661ce2ed5640f2a551f76e92b222570e07aa06f266e3919a1e676c4865d1406c59422940e5d76
+  metadata.gz: fb9114576a8739d06b8eac360a44419db09555a9fa2f7f59c2b783f54390893b1088a4f4aaa126501a5dfebf230e00f8cc16860294956ffbd69b3c260a83bc09
+  data.tar.gz: 2bc82c46d079c05098fe9b51c0bf19a834401259d4dece2bab58c265a32cade1853bcac4c66d731cbdf76bfb6eb2c25826b6d711ce1a313930e25646344e9abd

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    gctime (0.2.0)
+    gctime (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     minitest (5.14.4)
     rake (13.0.6)
+    rake-compiler (1.1.1)
+      rake
 
 PLATFORMS
   ruby
@@ -17,6 +19,7 @@ DEPENDENCIES
   gctime!
   minitest (~> 5.0)
   rake (~> 13.0)
+  rake-compiler (~> 1.0)
 
 BUNDLED WITH
    2.2.25

data/README.md

@@ -1,6 +1,6 @@
 # GCTime
 
-Exposes a monotonically increasing GC total_time metric.
+Backport Ruby 3.1's `GC.stat(:time)` and `GC.total_time`. This gem is a noop on Ruby 3.1+.
 
 ## Installation
 
@@ -21,38 +21,23 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require 'gctime'
->> GCTime.total_time
-=> 0.0
->> GCTime.enable
-=> nil
+>> GC.measure_total_time
+=> true
 >> 4.times { GC.start }
 => 4
->> GCTime.total_time
-=> 127.42100000000012 # ms
->> GCTime.disable
-=> nil
+>> GC.stat(:time)
+=> 123 # milliseconds (returns a Float on JRuby and TruffleRuby)
+>> GC.stat[:time]
+=> 123 # milliseconds (returns a Float on JRuby and TruffleRuby)
+>> GC.total_time
+=> 123909999 # nanoseconds
+>> GC.measure_total_time = false # Disable instrumentation
+=> false
 ```
 
-`GCTime.total_time` returns a `Float` representing the total number of milliseconds spent in GC.
+`GC.stat(:time)` and `GC.stat[:time]` returns the total number of milliseconds spent in GC as Integer on MRI and as Float on JRuby and TruffleRuby.
 
-## Incompatibilities
-
-`CGTime` relies on the built-in [`GC::Profiler`](https://ruby-doc.org/core-3.0.0/GC/Profiler.html) which is a stateful datastructure. Which mean any other gem or application code using it
-is likely incompatoble with `GCTime` and will likely lead to incorrect timings.
-
-Known incompatible gems are:
-
-  - [`newrelic_rpm`](https://github.com/newrelic/newrelic-ruby-agent/blob/4baffe79b87e6ec725dfae9f5e76113a1f1d01ba/lib/new_relic/agent/vm/monotonic_gc_profiler.rb#L22-L38)
-
-If you suspect that one of your gem might be using `GC::Profiler.clear`, you can check with `grep -R 'GC::Profiler.clear' $(bundle show --paths)`.
-
-## Memory Leak
-
-It is important to note that the underlying `GC::Profiler` keeps internal records of all GC triggers. Every time `GCTime.total_time` is called the datastructure is reset,
-but if it isn't called on a regular basis, it might lead to a memory leak.
-
-Make sure to either call it on a regular basis, or to disable it when it's no longer needed.
+`GC.total_time` returns the total number of nanoseconds spent in GC as Integer.
 
 ## Development
 

data/Rakefile

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
+require "rake/extensiontask"
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+gemspec = Gem::Specification.load("gctime.gemspec")
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'gctime'
+  ext.ext_dir = 'ext/gctime'
+  ext.lib_dir = 'lib/gctime'
+  ext.gem_spec = gemspec
+end
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+task default: %i(compile test)

data/ext/gctime/extconf.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+if GC.respond_to?(:total_time)
+  File.write("Makefile", dummy_makefile($srcdir).join(""))
+else
+  $CFLAGS << ' -O3 '
+  $CFLAGS << ' -std=c99'
+
+  create_makefile("gctime/gctime")
+end

data/ext/gctime/gctime.c

@@ -0,0 +1,91 @@
+#include <ruby.h>
+#include <ruby/debug.h>
+#include <stdbool.h>
+#include <errno.h>
+#include <time.h>
+#include <stdlib.h>
+
+static uint64_t total_time_ns = 0;
+static VALUE tracepoint = Qnil;
+static struct timespec gc_entered_at;
+
+inline void
+gctime_get(struct timespec *time)
+{
+    if (clock_gettime(CLOCK_MONOTONIC, time) == -1) {
+        rb_sys_fail("clock_gettime");
+    }
+}
+
+static void
+gctime_hook(VALUE tpval, void *data)
+{
+    switch (rb_tracearg_event_flag(rb_tracearg_from_tracepoint(tpval))) {
+        case RUBY_INTERNAL_EVENT_GC_ENTER: {
+            gctime_get(&gc_entered_at);
+        }
+        break;
+
+        case RUBY_INTERNAL_EVENT_GC_EXIT: {
+            struct timespec gc_exited_at;
+            gctime_get(&gc_exited_at);
+            total_time_ns += (gc_exited_at.tv_nsec - gc_entered_at.tv_nsec);
+            total_time_ns += (gc_exited_at.tv_sec - gc_entered_at.tv_sec) * 1000000000;
+        }
+        break;
+    }
+}
+
+static VALUE
+gctime_rb_gc_total_time(VALUE klass)
+{
+    return ULL2NUM(total_time_ns);
+}
+
+static VALUE
+gctime_rb_time_ms(VALUE klass)
+{
+    return ULL2NUM(total_time_ns / 1000000);
+}
+
+static VALUE
+gctime_rb_measure_total_time(VALUE klass)
+{
+    if (NIL_P(tracepoint)) return Qfalse;
+    return rb_tracepoint_enabled_p(tracepoint);
+}
+
+static VALUE
+gctime_rb_measure_total_time_set(VALUE klass, VALUE enabled)
+{
+    if (RTEST(enabled)) {
+        if (NIL_P(tracepoint)) {
+            tracepoint = rb_tracepoint_new(
+                0,
+                RUBY_INTERNAL_EVENT_GC_ENTER | RUBY_INTERNAL_EVENT_GC_EXIT,
+                gctime_hook,
+                (void *) NULL
+            );
+        }
+        rb_tracepoint_enable(tracepoint);
+    } else {
+        if (!NIL_P(tracepoint)) {
+            rb_tracepoint_disable(tracepoint);
+        }
+    }
+    return enabled;
+}
+
+void
+Init_gctime()
+{
+    rb_global_variable(&tracepoint);
+
+    VALUE mGC = rb_const_get(rb_cObject, rb_intern("GC"));
+    rb_define_module_function(mGC, "total_time", gctime_rb_gc_total_time, 0);
+    rb_define_module_function(mGC, "measure_total_time", gctime_rb_measure_total_time, 0);
+    rb_define_module_function(mGC, "measure_total_time=", gctime_rb_measure_total_time_set, 1);
+
+    VALUE mGCTime = rb_const_get(rb_cObject, rb_intern("GCTime"));
+    rb_define_module_function(mGCTime, "_time_ms", gctime_rb_time_ms, 0);
+}

data/gctime.gemspec

@@ -24,4 +24,8 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
   spec.require_paths = ["lib"]
+
+  spec.extensions = ['ext/gctime/extconf.rb']
+
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
 end

data/lib/gctime/version.rb

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

data/lib/gctime.rb

@@ -1,44 +1,53 @@
 # frozen_string_literal: true
-
 require_relative "gctime/version"
 
 module GCTime
-  @mutex = Mutex.new
-  @total_time = 0.0
-
-  begin
-    GC.stat(:time) # Implemented on JRuby and TruffleRuby
-    class << self
-      def enable
-      end
+  if GC.respond_to?(:total_time)
+    # We're on Ruby 3.1+, nothing to backport.
+  elsif GC.stat.key?(:time)
+    # We're likely on JRuby or TruffleRuby
+    module Backport
+      def measure_total_time
+        true
+      end unless GC.respond_to?(:measure_total_time)
 
-      def disable
-      end
+      def measure_total_time=(enabled)
+        # noop
+      end unless GC.respond_to?(:measure_total_time=)
 
       def total_time
-        GC.stat(:time).to_f
-      end
+        (stat(:time) * 1_000_000.0).to_i # nanoseconds integer
+      end unless GC.respond_to?(:total_time)
     end
-  rescue ArgumentError
-    # MRI Implementation
-    class << self
-      def enable
-        GC::Profiler.enable
-      end
 
-      def disable
-        GC::Profiler.disable
-      end
+    unless Backport.instance_methods(:false).empty?
+      GC.singleton_class.prepend(Backport)
+    end
+  else
+    # We're on MRI 3.0 or older.
+    require "gctime/gctime"
+    GC.measure_total_time = true
 
-      def total_time
-        if GC::Profiler.total_time > 0.0
-          @mutex.synchronize do
-            @total_time += GC::Profiler.total_time * 1_000.0
-            GC::Profiler.clear
-          end
+    module Backport
+      UNDEF = BasicObject.new
+
+      def stat(key = UNDEF)
+        if UNDEF.equal?(key)
+          stats = super()
+          stats[:time] = ::GCTime._time_ms # milliseconds integer
+          stats
+        elsif key == :time
+          ::GCTime._time_ms # milliseconds integer
+        elsif Hash === key
+          stats = super
+          stats[:time] = ::GCTime._time_ms # milliseconds integer
+          stats
+        else
+          super
         end
-        @total_time
       end
     end
+
+    GC.singleton_class.prepend(Backport)
   end
 end

metadata

@@ -1,20 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: gctime
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
-dependencies: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description:
 email:
 - jean.boussier@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/gctime/extconf.rb
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
@@ -26,8 +41,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- ext/gctime/extconf.rb
+- ext/gctime/gctime.c
 - gctime.gemspec
 - lib/gctime.rb
+- lib/gctime/gctime.bundle
 - lib/gctime/version.rb
 homepage: https://github.com/Shopify/gctime
 licenses: