gctrack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92838d06f2819fc114876a76cb748508d1d1468d
+  data.tar.gz: 403295552c868ce6284861af1071cb14350f6bd8
+SHA512:
+  metadata.gz: 5942ef39807b64f69e448325265f9bb2b6a7575de22534073c11d58f19525bc6641beb10b0996a66d758c62e60becfcfa191bddd0a6527c706b640aee3b7ff5e
+  data.tar.gz: 9f9e5f8c6bb6b976b15d9e09f85e34492245bc7d040b0a6bbe1b167d3854d53d15af4a472d7e4a97631e27a59516980657535b0a7ba3ed7b838f853ed806e7a7

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/lib/gctrack/*.so
+/lib/gctrack/*.bundle
+/tmp/*
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+rvm:
+  - '2.3.3'
+  - '2.4.1'

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+gemspec
+
+group :deployment do 
+  gem 'package_cloud'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    gctrack (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    highline (1.6.20)
+    json_pure (1.8.1)
+    mime-types (1.25.1)
+    package_cloud (0.2.44)
+      highline (= 1.6.20)
+      json_pure (= 1.8.1)
+      rainbow (= 2.1.0)
+      rest-client (~> 1.6.7)
+      thor (~> 0.18)
+    power_assert (1.0.2)
+    rainbow (2.1.0)
+    rake (12.0.0)
+    rake-compiler (1.0.4)
+      rake
+    rest-client (1.6.9)
+      mime-types (~> 1.16)
+    test-unit (3.2.5)
+      power_assert
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gctrack!
+  package_cloud
+  rake
+  rake-compiler (~> 1.0)
+  test-unit
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Scott Francis <scott.francis@shopify.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+## GCTrack
+

data/Rakefile

@@ -0,0 +1,34 @@
+task :default => :test
+
+# ==========================================================
+# Packaging
+# ==========================================================
+
+GEMSPEC = eval(File.read('gctrack.gemspec'))
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+end
+
+# ==========================================================
+# Ruby Extension
+# ==========================================================
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('gctrack', GEMSPEC) do |ext|
+  ext.ext_dir = 'ext/gctrack'
+  ext.lib_dir = 'lib/gctrack'
+end
+task :build => :compile
+
+# ==========================================================
+# Testing
+# ==========================================================
+
+require 'rake/testtask'
+Rake::TestTask.new 'test' do |t|
+  t.test_files = FileList['test/test_*.rb']
+end
+task :test => :build
+
+require "bundler/gem_tasks"

data/ext/gctrack/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+$CFLAGS = "-O3 -Wall"
+
+create_makefile('gctrack/gctrack')

data/ext/gctrack/gctrack.c

@@ -0,0 +1,170 @@
+#include <ruby.h>
+#include <ruby/debug.h>
+#include <ruby/intern.h>
+#include <stdbool.h>
+#include <errno.h>
+#include <time.h>
+#include <stdlib.h>
+
+typedef struct record_t record_t;
+
+struct record_t {
+  uint32_t cycles;
+  uint64_t duration;
+  record_t *parent;
+};
+
+static VALUE tracepoint = Qnil;
+
+static record_t *last_record = NULL;
+static uint64_t last_enter = 0;
+
+static uint64_t 
+nanotime()
+{
+  struct timespec ts;
+  if (clock_gettime(CLOCK_MONOTONIC, &ts) == -1) {
+    rb_sys_fail("clock_gettime");
+  }
+  return ts.tv_sec * (uint64_t) 1000000000 + ts.tv_nsec;
+}
+
+static inline void 
+add_gc_cycle(uint64_t duration)
+{
+  record_t *record = last_record;
+  while (record) {
+    record->cycles = record->cycles + 1;
+    record->duration = record->duration + duration;
+    record = record->parent;
+  }
+}
+
+static inline bool 
+gctracker_enabled() 
+{
+  return !NIL_P(tracepoint) && rb_tracepoint_enabled_p(tracepoint);
+}
+
+static void 
+gctracker_hook(VALUE tpval, void *data)
+{
+  if (!gctracker_enabled()) {
+    return;
+  }
+  rb_trace_arg_t *tparg = rb_tracearg_from_tracepoint(tpval);
+  switch (rb_tracearg_event_flag(tparg)) {
+    case RUBY_INTERNAL_EVENT_GC_ENTER: {
+      last_enter = nanotime();
+    }
+      break;
+    case RUBY_INTERNAL_EVENT_GC_EXIT: {
+      if (last_enter) {
+        add_gc_cycle(nanotime() - last_enter);
+      }
+      last_enter = 0;
+    }
+      break;
+  }
+}
+
+static void
+create_tracepoint() 
+{
+  rb_event_flag_t events;
+  events = RUBY_INTERNAL_EVENT_GC_ENTER | RUBY_INTERNAL_EVENT_GC_EXIT;
+  tracepoint = rb_tracepoint_new(0, events, gctracker_hook, (void *) NULL);
+  if (NIL_P(tracepoint)) {
+    rb_raise(rb_eRuntimeError, "GCTracker: Couldn't create tracepoint!");
+  }
+  rb_global_variable(&tracepoint);
+}
+
+static VALUE
+gctracker_start_record(int argc, VALUE *argv, VALUE klass)
+{
+  if(!gctracker_enabled()) {
+    return Qfalse;
+  }
+
+  record_t *record = (record_t *) calloc(1, sizeof(record_t));
+  if (!record) {
+    return Qfalse;
+  }
+  
+  record->parent = last_record;
+  last_record = record;
+  return Qtrue;
+}
+
+static VALUE
+gctracker_end_record(int argc, VALUE *argv, VALUE klass)
+{
+  if (!last_record) {
+    return Qnil;
+  } 
+  record_t *record = last_record;
+  last_record = record->parent;
+  
+  VALUE stats = rb_ary_new2(2);
+  rb_ary_store(stats, 0, ULONG2NUM(record->cycles));
+  rb_ary_store(stats, 1, ULONG2NUM(record->duration));
+
+  free(record);  
+
+  return stats;
+}
+
+static VALUE
+gctracker_enable(int argc, VALUE *argv, VALUE klass)
+{
+  if (NIL_P(tracepoint)) {
+    create_tracepoint();
+  }
+
+  if (gctracker_enabled()) {
+    return Qtrue;
+  }
+
+  rb_tracepoint_enable(tracepoint);
+  if (!gctracker_enabled()) {
+    rb_raise(rb_eRuntimeError, "GCTracker: Couldn't enable tracepoint!");
+  }
+
+  return Qtrue;
+}
+
+static VALUE
+gctracker_disable(VALUE self)
+{
+  if (!gctracker_enabled()) {
+    return Qfalse;
+  }
+
+  rb_tracepoint_disable(tracepoint);
+  if (gctracker_enabled()) {
+    rb_raise(rb_eRuntimeError, "GCTracker: Couldn't disable tracepoint!");
+  } 
+
+  while (last_record) {
+    record_t *record = last_record;
+    last_record = record->parent;
+    free(record);
+  }
+  last_record = NULL;
+  
+  return Qtrue;
+}
+
+void
+Init_gctrack()
+{
+  VALUE mGC = rb_define_module("GC");
+  VALUE cTracker = rb_define_module_under(mGC, "Tracker");
+
+  rb_define_module_function(cTracker, "enable", gctracker_enable, 0);
+  rb_define_module_function(cTracker, "disable", gctracker_disable, 0);
+
+  rb_define_module_function(cTracker, "start_record", gctracker_start_record, 0);
+  rb_define_module_function(cTracker, "end_record", gctracker_end_record, 0);
+}

data/gctrack.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = 'gctrack'
+  s.version = '0.0.1'
+  s.summary = 'Track Ruby GC events'
+  s.description = <<-DOC
+    This gem can be used to track Ruby GC tracepoints that are normally only visible through GC extensions.
+  DOC
+  s.homepage = 'https://github.com/Shopify/gctrack'
+  s.authors = ['Scott Francis', 'Alex Snaps']
+  s.email   = ['scott.francis@shopify.com', 'alex.snaps@shopify.com']
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.extensions = ['ext/gctrack/extconf.rb']
+  s.add_development_dependency 'rake-compiler', '~> 1.0'
+  s.add_development_dependency 'test-unit'
+end

data/test/test_gctrack.rb

@@ -0,0 +1,63 @@
+require 'test/unit'
+require 'gctrack/gctrack'
+
+class TestGctrack < Test::Unit::TestCase
+  def test_enable
+    assert GC::Tracker.enable
+  ensure
+    GC::Tracker.disable
+  end
+
+  def test_disable
+    assert !GC::Tracker.disable
+    assert GC::Tracker.enable
+    assert GC::Tracker.disable
+  end
+
+  def test_returns_false_when_not_enabled
+    assert_equal false, GC::Tracker.disable
+  end
+
+  def test_enabled_generates_events
+    assert GC::Tracker.enable
+    assert GC::Tracker.start_record
+    GC.start
+    cycles, duration = GC::Tracker.end_record
+    assert cycles > 0
+    assert duration > 0
+  ensure
+    GC::Tracker.disable
+  end
+
+  def test_recurses
+    assert GC::Tracker.enable
+    assert GC::Tracker.start_record
+    a = "a"
+    10.times { |i| a += a * i }
+    GC.start
+    assert GC::Tracker.start_record
+    a = "a"
+    10.times { |i| a += a * i }
+    cycles_c, duration_c = GC::Tracker.end_record
+    cycles_p, duration_p = GC::Tracker.end_record
+    assert cycles_p > cycles_c
+    assert duration_p > duration_c
+  ensure
+    GC::Tracker.disable
+  end
+
+  def test_no_data_when_disabled
+    assert !GC::Tracker.start_record
+    assert GC::Tracker.end_record.nil?
+  end
+
+  def test_no_data_for_started_records_on_disable
+    assert GC::Tracker.enable
+    assert GC::Tracker.start_record
+    assert GC::Tracker.disable
+    assert GC::Tracker.end_record.nil?
+  ensure
+    GC::Tracker.disable
+  end
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: gctrack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Francis
+- Alex Snaps
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-07 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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    This gem can be used to track Ruby GC tracepoints that are normally
+  only visible through GC extensions.\n"
+email:
+- scott.francis@shopify.com
+- alex.snaps@shopify.com
+executables: []
+extensions:
+- ext/gctrack/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- ext/gctrack/extconf.rb
+- ext/gctrack/gctrack.c
+- gctrack.gemspec
+- test/test_gctrack.rb
+homepage: https://github.com/Shopify/gctrack
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Track Ruby GC events
+test_files: []