gc_tracer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02c2e3a73f9c81c909ea34661ee28e724e46ae6a
-  data.tar.gz: f9ecb1757af0bf11518f6a4bf0065568fc1f6d78
+  metadata.gz: 7ad7a07f89e6474de38728bba4e183173133c727
+  data.tar.gz: 1be0ad94f2746c7fee8880725827a386cde7ef75
 SHA512:
-  metadata.gz: c442b07afc88814c7dd2687872ba1a260bd6cfd26951596b488291fb31e06787265c1c9c2d1db353be6c712cfa209bfb91dc900a73e747d946d8ea4d7ab30b1d
-  data.tar.gz: ccb123ceff8944ef0405c37793d192eabbc8d515c364da02aaf5ca1b3ec4872c82487467a946a96264f18d3237fb1168b2f03318f89b6e1fc35aeb9905517676
+  metadata.gz: b3410157161b046b7870da5caae27c0be60968c825f38908a18907e7ee8941effa28240e32f05ce769a5ad459064ec9784b0ec42746c989d486b2b2a65805c45
+  data.tar.gz: a168bf9cd168fbc5d4c80eacfb44d4b7dcc52053f5ba89bf821bb7a372dd874e9b06ed65073c21a02eda04b34321d6ee484a06513d5d42dac8b4cb95b053200c

data/README.md

@@ -72,10 +72,36 @@ If you have netpbm package and pnmtopng command,
 bin/objspace_recorder_convert.rb converts all ppm images into png files. 
 Converted png images stored into dirname/png/.
 
-You can view all converted png images with public/viewer.html.
+To view converted images, "dirname/viewer.html" is created.
+You can view all converted png images with "dirname/viewer.html" file in animation.
 
 This feature is supported only latest Ruby versions (2.2, and later).
 
+#### Examaple
+
+```ruby
+require 'gc_tracer'
+GC::Tracer.start_objspace_recording("objspace_recorded_type_example", :type){
+  n =  1_000
+  m = 10_000
+
+  n.times{
+    ary = []
+    m.times{
+      ary << ''
+    }
+  }
+}
+```
+
+This program takes all snapshot of type information at each GC events.
+
+- :age (default) - take snapshots of age information (empty/young/old/shady)
+- :type - take snapshots of type information (T_???)
+
+You can see an [age example] (http://www.atdot.net/~ko1/gc_tracer/objspace_recorded_age_example/viewer.html) and
+a [type example] (http://www.atdot.net/~ko1/gc_tracer/objspace_recorded_type_example/viewer.html).
+
 ## Contributing
 
 1. Fork it ( http://github.com/ko1/gc_tracer/fork )

data/bin/objspace_recorder_convert.rb

@@ -1,7 +1,40 @@
-dir = ARGV.shift || 'records'
+require 'erb'
+require 'fileutils'
+
+dir = ARGV.shift || 'objspace_records'
 Dir.mkdir("#{dir}/png") unless File.directory?("#{dir}/png")
+first_gc_count = nil
+last_gc_count = 0
 
 Dir.glob("#{dir}/ppm/*"){|file|
   cmd = "pnmtopng #{file} > #{dir}/png/#{File.basename(file)}.png"
   system(cmd)
+  if /(\d{8})\.\d/ =~ file
+    c = $1.to_i
+    first_gc_count = c if first_gc_count == nil || first_gc_count > c
+    last_gc_count = c if last_gc_count < c
+  end
+}
+
+color_description = {}
+File.read("#{dir}/color_description.txt").each_line{|line|
+  desc, color = *line.chomp.split(/\t/)
+  color_description[desc] = color
+}
+
+color_description_js = color_description.map{|(k, v)|
+  "    {desc: \"#{k}\", \t\"color\": \"#{v}\"}"
+}.join(",\n")
+
+html_file = "#{dir}/viewer.html"
+
+open(html_file, 'w'){|f|
+  f.puts ERB.new(File.read(File.join(__dir__, "../lib/gc_tracer/viewer.html.erb"))).result(binding)
 }
+
+unless File.exist?("#{dir}/jquery-2.1.0.min.js")
+  FileUtils.cp(File.join(__dir__, "../public/jquery-2.1.0.min.js"), "#{dir}/jquery-2.1.0.min.js")
+end
+
+puts "Success: see #{html_file}"
+

data/ext/gc_tracer/gc_tracer.c

@@ -478,84 +478,127 @@ struct objspace_recording_data {
     int width, height;
 };
 
+struct picker_description {
+    const char *name;
+    const int color;
+};
+
 static void
 set_color(unsigned char *buff, int color)
 {
-    buff[0] = (color >>  0) & 0xff;
+    buff[2] = (color >>  0) & 0xff;
     buff[1] = (color >>  8) & 0xff;
-    buff[2] = (color >> 16) & 0xff;
-}
+    buff[0] = (color >> 16) & 0xff;
+}
+
+const int categorical_color10_colors[] = {
+    0x1f77b4,
+    0xff7f0e,
+    0x2ca02c,
+    0xd62728,
+    0x9467bd,
+    0x8c564b,
+    0xe377c2,
+    0x7f7f7f,
+    0xbcbd22,
+    0x17becf
+};
 
 static int
 categorical_color10(int n)
 {
-    const int colors[] = {
-	0x1f77b4,
-	0xff7f0e,
-	0x2ca02c,
-	0xd62728,
-	0x9467bd,
-	0x8c564b,
-	0xe377c2,
-	0x7f7f7f,
-	0xbcbd22,
-	0x17becf};
     assert(n < 10);
-    return colors[n];
-}
+    return categorical_color10_colors[n];
+}
+
+const int categorical_color20_colors[] = {
+    0x1f77b4,
+    0xaec7e8,
+    0xff7f0e,
+    0xffbb78,
+    0x2ca02c,
+    0x98df8a,
+    0xd62728,
+    0xff9896,
+    0x9467bd,
+    0xc5b0d5,
+    0x8c564b,
+    0xc49c94,
+    0xe377c2,
+    0xf7b6d2,
+    0x7f7f7f,
+    0xc7c7c7,
+    0xbcbd22,
+    0xdbdb8d,
+    0x17becf,
+    0x9edae5,
+};
 
 static int
 categorical_color20(int n)
 {
-    const int colors[] = {
-	0x1f77b4,
-	0xaec7e8,
-	0xff7f0e,
-	0xffbb78,
-	0x2ca02c,
-	0x98df8a,
-	0xd62728,
-	0xff9896,
-	0x9467bd,
-	0xc5b0d5,
-	0x8c564b,
-	0xc49c94,
-	0xe377c2,
-	0xf7b6d2,
-	0x7f7f7f,
-	0xc7c7c7,
-	0xbcbd22,
-	0xdbdb8d,
-	0x17becf,
-	0x9edae5,
-    };
     assert(n < 20);
-    return colors[n];
+    return categorical_color20_colors[n];
 }
 
+static struct picker_description object_age_picker_description[] = {
+    {"empty slot",   0},
+    {"old slot",     0x1f77b4},
+    {"young slot",   0xff7f0e},
+    {"shady slot",   0x2ca02c}
+};
+
 static int
 object_age_picker(VALUE v) {
     if (RB_TYPE_P(v, T_NONE)) {
-	return categorical_color10(0);
+	return 0;
     }
     else {
 	if (OBJ_PROMOTED(v)) {
 	    /* old */
-	    return categorical_color10(1);
+	    return categorical_color10(0);
 	}
 	else {
-	    /* young */
-	    return categorical_color10(2);
+	    if (OBJ_WB_PROTECTED(v)) {
+		/* young */
+		return categorical_color10(1);
+	    }
+	    else {
+		return categorical_color10(2);
+	    }
 	}
     }
 }
 
+static struct picker_description object_type_picker_description[] = {
+    {"RUBY_T_NONE", 0},
+    {"RUBY_T_OBJECT", 0x1f77b4},
+    {"RUBY_T_CLASS", 0xaec7e8},
+    {"RUBY_T_MODULE", 0xff7f0e},
+    {"RUBY_T_FLOAT", 0xffbb78},
+    {"RUBY_T_STRING", 0x2ca02c},
+    {"RUBY_T_REGEXP", 0x98df8a},
+    {"RUBY_T_ARRAY", 0xd62728},
+    {"RUBY_T_HASH", 0xff9896},
+    {"RUBY_T_STRUCT", 0x9467bd},
+    {"RUBY_T_BIGNUM", 0xc5b0d5},
+    {"RUBY_T_FILE", 0x8c564b},
+    {"RUBY_T_DATA", 0xc49c94},
+    {"RUBY_T_MATCH", 0xe377c2},
+    {"RUBY_T_COMPLEX", 0xf7b6d2},
+    {"RUBY_T_RATIONAL", 0x7f7f7f},
+    {"RUBY_T_NODE", 0xc7c7c7},
+    {"RUBY_T_ICLASS", 0xbcbd22},
+    {"RUBY_T_ZOMBIE", 0xdbdb8d},
+};
+
 static int
 object_type_picker(VALUE v) {
     int type = BUILTIN_TYPE(v);
     int color = 0;
     switch (type) {
       case RUBY_T_NONE:
+	return 0;
       case RUBY_T_OBJECT:
       case RUBY_T_CLASS:
       case RUBY_T_MODULE:
@@ -571,12 +614,12 @@ object_type_picker(VALUE v) {
       case RUBY_T_MATCH:
       case RUBY_T_COMPLEX:
       case RUBY_T_RATIONAL: /* 0x0f */
-	color = type;
+	color = type - 1;
 	break;
       case RUBY_T_NODE:
       case RUBY_T_ICLASS:
       case RUBY_T_ZOMBIE:
-	color = type - 11;
+	color = type - 12;
 	break;
       default:
 	rb_bug("object_type_picker: unreachable (type: %d)", type);
@@ -650,6 +693,27 @@ gc_tracer_stop_objspace_recording(VALUE self)
     return Qnil;
 }
 
+static void
+puts_color_description(VALUE dirname, struct picker_description desc[], int n)
+{
+    char buff[0x200];
+    FILE *fp;
+    int i;
+
+    snprintf(buff, 0x200, "%s/color_description.txt", RSTRING_PTR(dirname));
+
+    if ((fp = fopen(buff, "w")) == NULL) {
+	rb_raise(rb_eRuntimeError, "puts_color_description: failed to open file");
+    }
+
+    for (i=0; i<n; i++) {
+	fprintf(fp, "%s\t#%06x\n", desc[i].name, desc[i].color);
+    }
+
+    fclose(fp);
+}
+
+
 static VALUE
 gc_tracer_start_objspace_recording(int argc, VALUE *argv, VALUE self)
 {
@@ -679,9 +743,11 @@ gc_tracer_start_objspace_recording(int argc, VALUE *argv, VALUE self)
 
 	if (picker_type == ID2SYM(rb_intern("age"))) {
 	    objspace_recorder_color_picker = object_age_picker;
+	    puts_color_description(dirname, &object_age_picker_description[0], sizeof(object_age_picker_description) / sizeof(struct picker_description));
 	}
 	else if (picker_type == ID2SYM(rb_intern("type"))) {
 	    objspace_recorder_color_picker = object_type_picker;
+	    puts_color_description(dirname, &object_type_picker_description[0], sizeof(object_type_picker_description) / sizeof(struct picker_description));
 	}
 	else {
 	    rb_raise(rb_eArgError, "unsupported picker type: %s", rb_id2name(SYM2ID(picker_type)));

data/gc_tracer.gemspec

@@ -5,7 +5,7 @@ require 'gc_tracer/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "gc_tracer"
-  spec.version       = GcTracer::VERSION
+  spec.version       = GC::Tracer::VERSION
   spec.authors       = ["Koichi Sasada"]
   spec.email         = ["ko1@atdot.net"]
   spec.summary       = %q{gc_tracer gem adds GC::Tracer module.}

data/lib/gc_tracer/version.rb

@@ -1,3 +1,3 @@
-module GcTracer
-  VERSION = "0.1.1"
+module GC::Tracer
+  VERSION = "0.1.2"
 end

data/lib/gc_tracer/viewer.html.erb

@@ -0,0 +1,80 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <script src="./jquery-2.1.0.min.js"></script>
+
+<script>
+
+function startAnimation(){
+    var start = Number($("#start").val());
+    var end = Number($("#end").val());
+    var sleep_time = Number($("#wait").val());
+    var i = start, j = 0;
+
+    var timer_func = function(){
+        image_path = "./png/" +  ("00000000"+i).slice(-8) + "." + j + ".ppm.png";
+        $("#view").attr({
+          src: image_path
+        });
+        $("#status").text(image_path);
+
+        if (j < 2) {
+            j += 1;
+        }
+        else {
+            if (i < end) {
+                i += 1;
+                j = 0;
+            }
+            else{
+                return false;
+            }
+        }
+        setTimeout(timer_func, sleep_time);
+    }
+
+    timer_func();
+}
+
+var color_description = [
+<%= color_description_js %>
+];
+
+function reloadConfig() {
+    $("#color_desc_table").remove();
+    $("#config").after("<table id='color_desc_table'></table>");
+
+    for (var i = 0; i < color_description.length; i++) {
+        $("#color_desc_table").before(
+            "<tr>" + 
+            "<td style='background-color: " + color_description[i].color + "' hspace='1em' width='100px'>" +
+            "<td> " + color_description[i].desc + "</td>" + 
+            "</tr>");
+    }
+}
+
+$(function(){
+    reloadConfig();
+    $("#submit").click(
+        function(){
+            startAnimation();
+        });
+});
+
+</script>
+  </head>
+  <body>
+    <div>
+      <div id='config'>
+	start: <input type='text' id='start' value='<%= first_gc_count %>' readonly>,
+	end: <input type='text' id='end' value='<%= last_gc_count %>' readonly>
+      </div>
+    </div>
+    <p>
+      <input type='submit' id='submit' value='start!'>
+      wait: <input type='text' id='wait' value='100'>
+      <span id='status'></span>
+    </p>
+    <img id='view'>
+  </body>
+</html>

data/spec/gc_tracer_spec.rb

@@ -39,6 +39,8 @@ describe GC::Tracer do
           }
         }
         expect(Dir.glob("#{DIRNAME}/ppm/*.ppm").size).to be >= count * 3
+      rescue NoMethodError
+        pending "start_objspace_recording requires MRI >= 2.2"
       ensure
         FileUtils.rm_rf(DIRNAME) if File.directory?(DIRNAME)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gc_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,8 +86,8 @@ files:
 - gc_tracer.gemspec
 - lib/gc_tracer.rb
 - lib/gc_tracer/version.rb
+- lib/gc_tracer/viewer.html.erb
 - public/jquery-2.1.0.min.js
-- public/viewer.html
 - spec/gc_tracer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ko1/gc_tracer

data/public/viewer.html

@@ -1,61 +0,0 @@
-<html>
-  <head>
-    <meta charset="utf-8">
-    <script src="./jquery-2.1.0.min.js"></script>
-
-<script>
-
-function startAnimation(){
-    var dir = $("#dir").val();
-    var start = Number($("#start").val());
-    var end = Number($("#end").val());
-    var sleep_time = Number($("#wait").val());
-    var i = start, j = 0;
-
-    var timer_func = function(){
-        image_path = dir + "/png/" +  ("00000000"+i).slice(-8) + "." + j + ".ppm.png";
-        $("#view").attr({
-          src: image_path
-        });
-        $("#status").text(image_path);
-
-        if (j < 2) {
-            j += 1;
-        }
-        else {
-            if (i < end) {
-                i += 1;
-                j = 0;
-            }
-            else{
-                return false;
-            }
-        }
-        setTimeout(timer_func, sleep_time);
-    }
-
-    timer_func();
-}
-
-$(function(){
-    $("#submit").click(
-        function(){
-            startAnimation();
-        });
-});
-
-</script>
-  </head>
-  <body>
-    <p>
-      dir: <input type='text' id='dir' value='test'>,
-      start: <input type='text' id='start' value='5'>,
-      end: <input type='text' id='end' value='100'>
-      wait: <input type='text' id='wait' value='300'>,
-    </p>
-    <p>
-      <input type='submit' id='submit' value='start!'><span id='status'></span>
-    </p>
-    <img id='view'>
-  </body>
-</html>