objspace-age 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9aec62c2286763310ddf21e6c01b5d80139e4abf
+  data.tar.gz: 4ed882bc9f19a4d9a16b31ab93350ffef263aeee
+SHA512:
+  metadata.gz: 5d8c99f697121384817637fd074c1031383388b2cfeec60730fee09ca4cfbba2cb89c71b6129daea8db0836aace23be4b80fa394ae4672738e46b77f2271ff8c
+  data.tar.gz: 57609b00df37902ffc6aa19a368a3266145fa70a0e0c5b8b46fe5fcc9c56ff8fbc1c4e4c61f1a669dd72b3ac017ff18187577532a1c0dd353e12076814be4623

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/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - head
+
+script: rake test
+
+gemfile:
+  - Gemfile
+
+notifications:
+  email: authornari+travis@gmail.com

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in objspace_age.gemspec
+gemspec
+
+group :test do
+  gem 'test-unit', '~> 2.5.2'
+end

data/README.rdoc

@@ -0,0 +1,59 @@
+= ObjectSpace::Age
+
+* https://github.com/authorNari/objspace-age
+
+== DESCRIPTION:
+
+Show stats on object's age.
+An age is how many time an object survive from GarbageCollect.
+
+== INSTALL:
+
+  gem install objspace-age
+
+== FEATURES/PROBLEMS:
+
+* Support Ruby *2.1.0* or later
+
+== USAGE:
+
+  # /tmp/a.rb
+  require 'objspace/age'
+  
+  ObjectSpace::Age.enable
+  a = []
+  1_000_000.times{ a << 'b' }
+  ObjectSpace::Age.stats_on(:class)  # an array index indicates an age
+  # => [nil, nil, nil, nil, {String=>30309} ...
+  ObjectSpace::Age.stats_on(:line)
+  # => [nil, nil, ... , nil, {"/tmp/a.rb:6"=>617}, ... {"/tmp/a.rb:6"=>278271}, 
+  ObjectSpace::Age.how_old(a)
+  # => 58
+  ObjectSpace::Age.where(a)
+  # => '/tmp/a.rb:5'
+  ObjectSpace::Age.disable
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2013 Narihiro Nakamura
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+task :compile do
+  sh "cd ext/objspace_age/ && ruby extconf.rb && make"
+end
+
+task :clean do
+  sh "cd ext/objspace_age/ && rm -f *.o *.so"
+end
+
+task :test => [:clean, :compile] do
+  sh "/usr/bin/env ruby test/run-test.rb"
+end

data/ext/objspace_age/extconf.rb

@@ -0,0 +1,10 @@
+require 'mkmf'
+
+if with_config("test")
+  $defs << "-DOBJSPACE_HISTGRAM_TEST"
+  $CFLAGS << " -O0"
+end
+
+dir_config("objspace_age_ext")
+create_header
+create_makefile("objspace_age_ext")

data/ext/objspace_age/objspace_age.h

@@ -0,0 +1,10 @@
+#ifndef OBJSPACE_AGE_H
+
+#include "ruby.h"
+#include "ruby/re.h"
+#include "extconf.h"
+#include <assert.h>
+
+void Init_objspace_age_ext(void);
+
+#endif

data/ext/objspace_age/objspace_age_ext.c

@@ -0,0 +1,277 @@
+/**********************************************************************
+
+  object_age_ext.c
+
+  This file is covered under the Ruby's license.
+  Original file is ruby/ext/objspace/object_tracing.c
+  Some parts in this file are modified by Narihiro Nakamura.
+
+**********************************************************************/
+
+#include "ruby/ruby.h"
+#include "ruby/debug.h"
+
+size_t rb_gc_count(void); /* from gc.c */
+
+struct traceobj_age_arg {
+    VALUE newobj_trace;
+    VALUE freeobj_trace;
+    st_table *object_table;
+    st_table *str_table;
+};
+
+/* TODO: do not use GLOBAL VARIABLE!!! */
+struct traceobj_age_arg traceobj_age_arg;
+
+struct allocation_info {
+    const char *path;
+    unsigned long line;
+    size_t generation;
+};
+
+static const char *
+make_unique_str(st_table *tbl, const char *str, long len)
+{
+    if (!str) {
+	return NULL;
+    }
+    else {
+	st_data_t n;
+	char *result;
+
+	if (st_lookup(tbl, (st_data_t)str, &n)) {
+	    st_insert(tbl, (st_data_t)str, n+1);
+	    st_get_key(tbl, (st_data_t)str, (st_data_t *)&result);
+	}
+	else {
+	    result = (char *)ruby_xmalloc(len+1);
+	    strncpy(result, str, len);
+	    result[len] = 0;
+	    st_add_direct(tbl, (st_data_t)result, 1);
+	}
+	return result;
+    }
+}
+
+static void
+delete_unique_str(st_table *tbl, const char *str)
+{
+    if (str) {
+	st_data_t n;
+
+	st_lookup(tbl, (st_data_t)str, &n);
+	if (n == 1) {
+	    st_delete(tbl, (st_data_t *)&str, 0);
+	    ruby_xfree((char *)str);
+	}
+	else {
+	    st_insert(tbl, (st_data_t)str, n-1);
+	}
+    }
+}
+
+static void
+newobj_i(VALUE tpval, void *data)
+{
+    struct traceobj_age_arg *arg = (struct traceobj_age_arg *)data;
+    rb_trace_arg_t *tparg = rb_tracearg_from_tracepoint(tpval);
+    VALUE obj = rb_tracearg_object(tparg);
+    VALUE path = rb_tracearg_path(tparg);
+    VALUE line = rb_tracearg_lineno(tparg);
+    struct allocation_info *info = (struct allocation_info *)ruby_xmalloc(sizeof(struct allocation_info));
+    const char *path_cstr = RTEST(path) ? make_unique_str(arg->str_table, RSTRING_PTR(path), RSTRING_LEN(path)) : 0;
+
+    info->path = path_cstr;
+    info->line = NUM2INT(line);
+    info->generation = rb_gc_count();
+    st_insert(arg->object_table, (st_data_t)obj, (st_data_t)info);
+}
+
+static void
+freeobj_i(VALUE tpval, void *data)
+{
+    struct traceobj_age_arg *arg = (struct traceobj_age_arg *)data;
+    rb_trace_arg_t *tparg = rb_tracearg_from_tracepoint(tpval);
+    VALUE obj = rb_tracearg_object(tparg);
+    struct allocation_info *info;
+
+    if (st_delete(arg->object_table, (st_data_t *)&obj, (st_data_t *)&info)) {
+	delete_unique_str(arg->str_table, info->path);
+	ruby_xfree(info);
+    }
+}
+
+static int
+free_keys_i(st_data_t key, st_data_t value, void *data)
+{
+    ruby_xfree((void *)key);
+    return ST_CONTINUE;
+}
+
+static int
+free_values_i(st_data_t key, st_data_t value, void *data)
+{
+    ruby_xfree((void *)value);
+    return ST_CONTINUE;
+}
+
+static VALUE
+stop_age_trace_object_allocations(VALUE objspace)
+{
+    struct traceobj_age_arg *arg = (struct traceobj_age_arg *)&traceobj_age_arg;
+    rb_tracepoint_disable(arg->newobj_trace);
+    rb_tracepoint_disable(arg->freeobj_trace);
+    st_foreach(arg->object_table, free_values_i, 0);
+    st_foreach(arg->str_table, free_keys_i, 0);
+    st_free_table(arg->object_table);
+    st_free_table(arg->str_table);
+
+    arg->newobj_trace = NULL;
+
+    return Qnil;
+}
+
+static VALUE
+start_age_trace_object_allocations(VALUE objspace)
+{
+    traceobj_age_arg.newobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_NEWOBJ, newobj_i, &traceobj_age_arg);
+    traceobj_age_arg.freeobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_FREEOBJ, freeobj_i, &traceobj_age_arg);
+    traceobj_age_arg.object_table = st_init_numtable();
+    traceobj_age_arg.str_table = st_init_strtable();
+
+    rb_tracepoint_enable(traceobj_age_arg.newobj_trace);
+    rb_tracepoint_enable(traceobj_age_arg.freeobj_trace);
+
+    return Qnil;
+}
+
+struct allocation_info *
+allocation_info(VALUE obj)
+{
+    if (traceobj_age_arg.newobj_trace) {
+	struct allocation_info *info;
+	if (st_lookup(traceobj_age_arg.object_table, obj, (st_data_t *)&info)) {
+	    return info;
+	}
+    }
+    return NULL;
+}
+
+static VALUE
+allocation_sourceline(VALUE objspace, VALUE obj)
+{
+    struct allocation_info *info = allocation_info(obj);
+    if (info) {
+	return INT2FIX(info->line);
+    }
+    else {
+	return Qnil;
+    }
+}
+
+static VALUE
+allocation_sourcefile_and_line(VALUE objspace, VALUE obj)
+{
+    struct allocation_info *info = allocation_info(obj);
+    if (info) {
+        if (info->path) {
+            return rb_str_plus(rb_str_new2(info->path),
+			       rb_str_plus(rb_str_new_cstr(":"),
+					   rb_fix2str(allocation_sourceline(objspace, obj), 10)));
+        }
+	return Qnil;
+    }
+    else {
+	return Qnil;
+    }
+}
+
+static VALUE
+allocation_old(VALUE objspace, VALUE obj)
+{
+    struct allocation_info *info = allocation_info(obj);
+    if (info) {
+	return SIZET2NUM(rb_gc_count() - info->generation);
+    }
+    else {
+	return Qnil;
+    }
+}
+
+struct arg_stat_data {
+    VALUE result;
+};
+
+static int
+age_stat_line_i(VALUE obj, struct allocation_info *info, st_data_t data)
+{
+    struct arg_stat_data *arg = (void*)data;
+    long age = rb_gc_count() - info->generation;
+    VALUE hash, cnt, path;
+
+    hash = rb_ary_entry(arg->result, age);
+    if (hash == Qnil) {
+    	hash = rb_hash_new();
+    	rb_ary_store(arg->result, age, hash);
+    }
+    path = allocation_sourcefile_and_line(Qnil, obj);
+    cnt = rb_hash_aref(hash, path);
+    if (cnt == Qnil) {
+    	cnt = INT2NUM(0);
+    }
+    rb_hash_aset(hash, path, LONG2NUM(NUM2LONG(cnt)+1));
+    return ST_CONTINUE;
+}
+
+static int
+age_stat_class_i(VALUE obj, struct allocation_info *info, st_data_t data)
+{
+    struct arg_stat_data *arg = (void*)data;
+    long age = rb_gc_count() - info->generation;
+    VALUE hash, cnt, klass;
+
+    hash = rb_ary_entry(arg->result, age);
+    if (hash == Qnil) {
+	hash = rb_hash_new();
+	rb_ary_store(arg->result, age, hash);
+    }
+    klass = rb_obj_class(obj);
+    cnt = rb_hash_aref(hash, klass);
+    if (cnt == Qnil) {
+	cnt = INT2NUM(0);
+    }
+    rb_hash_aset(hash, rb_obj_class(obj), LONG2NUM(NUM2LONG(cnt)+1));
+    return ST_CONTINUE;
+}
+
+static VALUE
+age_stats(VALUE objspace, VALUE type)
+{
+    struct arg_stat_data data;
+    st_table *table = st_copy(traceobj_age_arg.object_table);
+    VALUE result = rb_ary_new();
+
+    data.result = result;
+    if (type == ID2SYM(rb_intern("class"))) {
+	st_foreach(table, age_stat_class_i, (st_data_t)&data);
+    }
+    else if (type == ID2SYM(rb_intern("line"))) {
+	st_foreach(table, age_stat_line_i, (st_data_t)&data);
+    }
+
+    st_free_table(table);
+    return result;
+}
+
+void
+Init_objspace_age_ext(void)
+{
+    VALUE rb_mObjSpace = rb_const_get(rb_cObject, rb_intern("ObjectSpace"));
+    VALUE rb_mObjSpaceAge = rb_const_get(rb_mObjSpace, rb_intern("Age"));
+
+    rb_define_module_function(rb_mObjSpaceAge, "enable", start_age_trace_object_allocations, 0);
+    rb_define_module_function(rb_mObjSpaceAge, "disable", stop_age_trace_object_allocations, 0);
+    rb_define_module_function(rb_mObjSpaceAge, "where", allocation_sourcefile_and_line, 1);
+    rb_define_module_function(rb_mObjSpaceAge, "how_old", allocation_old, 1);
+    rb_define_module_function(rb_mObjSpaceAge, "stats_on", age_stats, 1);
+}

data/lib/objspace/age.rb

@@ -0,0 +1,7 @@
+require "objspace/age/version"
+
+module ObjectSpace::Age
+  # Your code goes here...
+end
+
+require "objspace_age/objspace_age_ext"

data/lib/objspace/age/version.rb

@@ -0,0 +1,3 @@
+module ObjectSpace::Age
+  VERSION = "0.0.1"
+end

data/objspace-age.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'objspace/age/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "objspace-age"
+  gem.version       = ObjectSpace::Age::VERSION
+  gem.authors       = ["Narihiro Nakamura"]
+  gem.email         = ["authornari@gmail.com"]
+  gem.description   = %q{Show stats on object's age}
+  gem.summary       = %q{Show stats on object's age}
+  gem.homepage      = "https://github.com/authorNari/objspace-age"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib", "ext"]
+end

data/test/run-test.rb

@@ -0,0 +1,55 @@
+require 'minitest/unit'
+$: << File.join(__dir__, '../lib')
+$: << File.join(__dir__, '../ext')
+$: << __dir__
+
+require 'objspace/age'
+
+MiniTest::Unit.autorun
+
+class TestObjectSpaceAge < MiniTest::Unit::TestCase
+  def test_enable
+    assert_equal nil, ObjectSpace::Age.enable
+  ensure
+    ObjectSpace::Age.disable
+  end
+
+  def test_where
+    ObjectSpace::Age.enable
+    a = ''
+    assert_equal 'test/run-test.rb:19', ObjectSpace::Age.where(a)
+  ensure
+    ObjectSpace::Age.disable
+  end
+
+  def test_how_old
+    ObjectSpace::Age.enable
+    a = ''
+    GC.start
+    assert_equal 1, ObjectSpace::Age.how_old(a)
+  ensure
+    ObjectSpace::Age.disable
+  end
+
+  def test_stats_on_class
+    expect = [nil, nil, {Array=>1, String=>10}]
+    ObjectSpace::Age.enable
+    a = []
+    10.times{ a << '' }
+    2.times{ GC.start }
+    assert_equal expect, ObjectSpace::Age.stats_on(:class)
+  ensure
+    ObjectSpace::Age.disable
+  end
+
+  def test_stats_on_line
+    expect = [nil, nil, {"test/run-test.rb:48"=>1, "test/run-test.rb:49"=>10}]
+    ObjectSpace::Age.enable
+    a = []
+    10.times{ a << '' }
+    2.times{ GC.start }
+    assert_equal expect, ObjectSpace::Age.stats_on(:line)
+  ensure
+    ObjectSpace::Age.disable
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: objspace-age
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Narihiro Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-06 00:00:00.000000000 Z
+dependencies: []
+description: Show stats on object's age
+email:
+- authornari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.rdoc
+- Rakefile
+- ext/objspace_age/extconf.rb
+- ext/objspace_age/objspace_age.h
+- ext/objspace_age/objspace_age_ext.c
+- lib/objspace/age.rb
+- lib/objspace/age/version.rb
+- objspace-age.gemspec
+- test/run-test.rb
+homepage: https://github.com/authorNari/objspace-age
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Show stats on object's age
+test_files:
+- test/run-test.rb