gc_tracer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bc50631646c163085a2c1122538138baf772b6a
+  data.tar.gz: f5f45aca16dc2820814c8b80bc13538ca8636291
+SHA512:
+  metadata.gz: 090166b2f6544f9d7f72bc89d23cab974232faec13c50b7d70b9728e49bb857b6b50546c19269c9767c431f0100551fb06b78ac645b35ed2f0ebe9be7841857d
+  data.tar.gz: 4e6fe7b6c353439b664692f290f67e14fc0e0ad3190c5a9699292ff23afc82c904132dd2380726cb6683dd6c560faf5b1c2db7e7720fb9a7cbdb3b3d95860b44

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gc_tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Koichi Sasada
+
+MIT License
+
+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,56 @@
+# GcTracer
+
+gc-tracer gem add GC::Tracer module which trace GC activities and output 
+all statistics information.
+
+This gem only supports MRI 2.1.0 and later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gc_tracer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gc_tracer
+
+## Usage
+
+You can get GC statistics information like that:
+
+    require 'gc_tracer'
+    GC::Tracer.start_logging(filename) do
+      # do something
+    end
+
+This code is equivalent to the following code.
+
+    require 'gc_tracer'
+    GC::Tracer.start_logging(filename)
+    # do something
+    GC::Tracer.stop_logging
+
+In the stored file, you can get tab separated values about GC.stat() and 
+GC.latest_gc_info() at each events.  Events are "GC starting time", "end 
+of marking time" and "end of sweeping time".  For one GC, three lines 
+you can get.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/ko1/gc_tracer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Credit
+
+Originally created by Koichi Sasada.
+Thank you Yuki Torii who helps me to make gem package.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require 'rspec/core/rake_task'
+
+spec = Gem::Specification.load('gc_tracer.gemspec')
+
+Rake::ExtensionTask.new("gc_tracer", spec){|ext|
+  ext.lib_dir = "lib/gc_tracer"
+}
+
+RSpec::Core::RakeTask.new('spec' => 'compile')
+
+task default: :spec

data/ext/gc_tracer/extconf.rb

@@ -0,0 +1,21 @@
+require 'mkmf'
+
+# auto generation script
+open("gc_tracer.h", 'w'){|f|
+  f.puts '#include "ruby/ruby.h"'
+  f.puts "static VALUE sym_gc_stat[#{GC.stat.keys.size}];"
+  f.puts "static VALUE sym_latest_gc_info[#{GC.latest_gc_info.keys.size}];"
+
+  f.puts "static void"
+  f.puts "setup_gc_trace_symbols(void)"
+  f.puts "{"
+    GC.stat.keys.each.with_index{|k, i|
+      f.puts "    sym_gc_stat[#{i}] = ID2SYM(rb_intern(\"#{k}\"));"
+    }
+    GC.latest_gc_info.keys.each.with_index{|k, i|
+      f.puts "    sym_latest_gc_info[#{i}] = ID2SYM(rb_intern(\"#{k}\"));"
+    }
+  f.puts "}"
+}
+
+create_makefile('gc_tracer/gc_tracer')

data/ext/gc_tracer/gc_tracer.c

@@ -0,0 +1,310 @@
+/*
+ * gc_tracer adds GC::Tracer module.
+ *
+ * By Koichi Sasada
+ * created at Wed Feb 26 10:52:59 2014.
+ */
+
+#include "ruby/ruby.h"
+#include "ruby/debug.h"
+#include "gc_tracer.h"
+#include "stdio.h"
+
+static VALUE gc_start, gc_end_mark, gc_end_sweep;
+static VALUE gc_trace_enabled;
+static FILE *gc_trace_out = NULL;
+static VALUE gc_trace_items, gc_trace_items_types;
+
+enum gc_key_type {
+    GC_STAT_KEY,
+    GC_LATEST_GC_INFO_KEY
+};
+
+/* the following code is only for internal tuning. */
+
+/* Source code to use RDTSC is quoted and modified from
+ * http://www.mcs.anl.gov/~kazutomo/rdtsc.html
+ * written by Kazutomo Yoshii <kazutomo@mcs.anl.gov>
+ */
+
+#if defined(__GNUC__) && defined(__i386__)
+typedef unsigned long long tick_t;
+
+static inline tick_t
+tick(void)
+{
+    unsigned long long int x;
+    __asm__ __volatile__ ("rdtsc" : "=A" (x));
+    return x;
+}
+
+#elif defined(__GNUC__) && defined(__x86_64__)
+typedef unsigned long long tick_t;
+
+static __inline__ tick_t
+tick(void)
+{
+    unsigned long hi, lo;
+    __asm__ __volatile__ ("rdtsc" : "=a"(lo), "=d"(hi));
+    return ((unsigned long long)lo)|( ((unsigned long long)hi)<<32);
+}
+
+#elif defined(_WIN32) && defined(_MSC_VER)
+#include <intrin.h>
+typedef unsigned __int64 tick_t;
+
+static inline tick_t
+tick(void)
+{
+    return __rdtsc();
+}
+
+#else /* use clock */
+typedef clock_t tick_t;
+static inline tick_t
+tick(void)
+{
+    return clock();
+}
+#endif
+
+static tick_t start_tick;
+
+static void
+out_str(const char *str)
+{
+    fprintf(gc_trace_out, "%s\t", str);
+}
+
+static void
+out_terminate(void)
+{
+    fprintf(gc_trace_out, "\n");
+}
+
+static void
+out_sizet(size_t size)
+{
+    fprintf(gc_trace_out, "%lu\t", (unsigned long)size);
+}
+
+static void
+out_tick(void)
+{
+    out_sizet(tick() - start_tick);
+}
+
+static void
+out_obj(VALUE obj)
+{
+    if (NIL_P(obj) || obj == Qfalse) {
+	out_sizet(0);
+    }
+    else if (obj == Qtrue) {
+	out_sizet(1);
+    }
+    else if (SYMBOL_P(obj)) {
+	out_str(rb_id2name(SYM2ID(obj)));
+    }
+    else if (FIXNUM_P(obj)) {
+	out_sizet(FIX2INT(obj));
+    }
+    else {
+	rb_bug("out_obj: unknown object to output");
+    }
+}
+
+static void
+out_header(void)
+{
+    int i;
+
+    out_str("tick");
+    out_str("type");
+
+    for (i=0; i<RARRAY_LEN(gc_trace_items); i++) {
+	out_str(rb_id2name(SYM2ID(RARRAY_AREF(gc_trace_items, i))));
+    }
+
+    out_terminate();
+}
+
+static void
+trace(const char *type)
+{
+    int i;
+
+    out_tick();
+    out_str(type);
+
+    for (i=0; i<RARRAY_LEN(gc_trace_items); i++) {
+	enum gc_key_type type = FIX2INT(RARRAY_AREF(gc_trace_items_types, i));
+	VALUE sym = RARRAY_AREF(gc_trace_items, i);
+
+	switch (type) {
+	  case GC_STAT_KEY:
+	    out_sizet(rb_gc_stat(sym));
+	    break;
+	  case GC_LATEST_GC_INFO_KEY:
+	    out_obj(rb_gc_latest_gc_info(sym));
+	    break;
+	  default:
+	    rb_bug("xyzzy");
+	}
+    }
+
+    out_terminate();
+}
+
+static void
+gc_start_i(VALUE tpval, void *data)
+{
+    trace("gc_start");
+}
+
+static void
+gc_end_mark_i(VALUE tpval, void *data)
+{
+    trace("gc_end_m");
+}
+
+static void
+gc_end_sweep_i(VALUE tpval, void *data)
+{
+    trace("gc_end_s");
+}
+
+static VALUE
+gc_tracer_stop_logging(VALUE self)
+{
+    if (gc_start != 0 && gc_trace_enabled != Qfalse) {
+	gc_trace_enabled = Qfalse;
+
+	fflush(gc_trace_out);
+	if (gc_trace_out != stderr) {
+	    fclose(gc_trace_out);
+	}
+	gc_trace_out = NULL;
+
+	rb_tracepoint_disable(gc_start);
+	rb_tracepoint_disable(gc_end_mark);
+	rb_tracepoint_disable(gc_end_sweep);
+    }
+
+    return Qnil;
+}
+
+static VALUE
+gc_tracer_start_logging(int argc, VALUE *argv, VALUE self)
+{
+    if (gc_start == 0) {
+	gc_start = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_GC_START, gc_start_i, 0);
+	gc_end_mark = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_GC_END_MARK, gc_end_mark_i, 0);
+	gc_end_sweep = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_GC_END_SWEEP, gc_end_sweep_i, 0);
+
+	/* mark for GC */
+	rb_gc_register_mark_object(gc_start);
+	rb_gc_register_mark_object(gc_end_mark);
+	rb_gc_register_mark_object(gc_end_sweep);
+    }
+
+    if (gc_trace_enabled == Qfalse) {
+	gc_trace_enabled = Qtrue;
+
+	if (argc == 0) {
+	    gc_trace_out = stderr;
+	}
+	else if (argc == 1) {
+	    if (RB_TYPE_P(argv[0], T_STRING)) {
+		const char *filename = StringValueCStr(argv[0]);
+		if ((gc_trace_out = fopen(filename, "w")) == NULL) {
+		    rb_raise(rb_eRuntimeError, "can not open file: %s\n", filename);
+		}
+	    }
+	}
+	else {
+	    rb_raise(rb_eArgError, "too many arguments");
+	}
+
+	rb_tracepoint_enable(gc_start);
+	rb_tracepoint_enable(gc_end_mark);
+	rb_tracepoint_enable(gc_end_sweep);
+
+	out_header();
+
+	if (rb_block_given_p()) {
+	    rb_ensure(rb_yield, Qnil, gc_tracer_stop_logging, Qnil);
+	}
+    }
+
+    return Qnil;
+}
+
+static enum gc_key_type
+item_type(VALUE sym)
+{
+    int i;
+    for (i=0; i<(int)(sizeof(sym_gc_stat)/sizeof(VALUE));i++) {
+	return GC_STAT_KEY;
+    }
+    for (i=0; i<(int)(sizeof(sym_latest_gc_info)/sizeof(VALUE));i++) {
+	return GC_LATEST_GC_INFO_KEY;
+    }
+    rb_raise(rb_eArgError, "Unknown key type");
+    return 0; /* unreachable */
+}
+
+static VALUE
+gc_tracer_setup_logging(VALUE self, VALUE ary)
+{
+    int i;
+    VALUE keys = rb_ary_new(), types = rb_ary_new();
+
+    if (!RB_TYPE_P(ary, T_ARRAY)) rb_raise(rb_eArgError, "unsupported argument");
+
+    for (i=0; i<RARRAY_LEN(ary); i++) {
+	VALUE sym = RARRAY_AREF(ary, i);
+	enum gc_key_type type;
+	if (!SYMBOL_P(sym)) rb_raise(rb_eArgError, "unsupported type");
+	type = item_type(sym);
+	rb_ary_push(keys, sym);
+	rb_ary_push(types, INT2FIX(type));
+    }
+
+    rb_ary_replace(gc_trace_items, keys);
+    rb_ary_replace(gc_trace_items_types, types);
+    return Qnil;
+}
+
+void
+Init_gc_tracer(void)
+{
+    VALUE mod = rb_define_module_under(rb_mGC, "Tracer");
+
+    /* logging methods */
+    rb_define_module_function(mod, "start_logging", gc_tracer_start_logging, -1);
+    rb_define_module_function(mod, "stop_logging", gc_tracer_stop_logging, 0);
+    rb_define_module_function(mod, "setup_logging", gc_tracer_setup_logging, 1);
+
+    /* setup default banners */
+    setup_gc_trace_symbols();
+    start_tick = tick();
+    rb_gc_latest_gc_info(ID2SYM(rb_intern("gc_by"))); /* warm up */
+
+    gc_trace_items = rb_ary_new();
+    gc_trace_items_types = rb_ary_new();
+    rb_gc_register_mark_object(gc_trace_items);
+    rb_gc_register_mark_object(gc_trace_items_types);
+
+    {
+	int i;
+	for (i=0; i<(int)(sizeof(sym_gc_stat)/sizeof(VALUE));i++) {
+	    rb_ary_push(gc_trace_items, sym_gc_stat[i]);
+	    rb_ary_push(gc_trace_items_types, INT2FIX(GC_STAT_KEY));
+	}
+	for (i=0; i<(int)(sizeof(sym_latest_gc_info)/sizeof(VALUE));i++) {
+	    rb_ary_push(gc_trace_items, sym_latest_gc_info[i]);
+	    rb_ary_push(gc_trace_items_types, INT2FIX(GC_LATEST_GC_INFO_KEY));
+	}
+    }
+}

data/gc_tracer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gc_tracer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gc_tracer"
+  spec.version       = GcTracer::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+  spec.summary       = %q{gc_tracer gem adds GC::Tracer module.}
+  spec.description   = %q{gc_tracer gem adds GC::Tracer module.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.extensions    = %w[ext/gc_tracer/extconf.rb]
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec"
+end

data/lib/gc_tracer/version.rb

@@ -0,0 +1,3 @@
+module GcTracer
+  VERSION = "0.0.2"
+end

data/lib/gc_tracer.rb

@@ -0,0 +1,3 @@
+require "gc_tracer/version"
+require 'gc_tracer/gc_tracer'
+

data/spec/gc_tracer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'tmpdir'
+
+describe GC::Tracer do
+  shared_examples "logging_test" do
+    it do
+      Dir.mktmpdir('gc_tracer'){|dir|
+        logfile = "#{dir}/logging"
+        GC::Tracer.start_logging(logfile){
+          count.times{
+            GC.start
+          }
+        }
+        expect(File.exist?(logfile)).to be_true
+        expect(File.read(logfile).split(/\n/).length).to be >= count * 3 + 1
+      }
+    end
+  end
+
+  context "1 GC.start" do
+    let(:count){1}
+    it_behaves_like "logging_test"
+  end
+
+  context "2 GC.start" do
+    let(:count){2}
+    it_behaves_like "logging_test"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'gc_tracer'
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: gc_tracer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Koichi Sasada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: gc_tracer gem adds GC::Tracer module.
+email:
+- ko1@atdot.net
+executables: []
+extensions:
+- ext/gc_tracer/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/gc_tracer/extconf.rb
+- ext/gc_tracer/gc_tracer.c
+- gc_tracer.gemspec
+- lib/gc_tracer.rb
+- lib/gc_tracer/version.rb
+- spec/gc_tracer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: gc_tracer gem adds GC::Tracer module.
+test_files:
+- spec/gc_tracer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: