gc_tracer 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f8ebd99820c0f4376283b1a2ef31eb4b5ca9f25
-  data.tar.gz: 87d80cbb89a799728380ff6fde872295c9daad8a
+  metadata.gz: 7e2224716adf83bacd915712295bff64908c6882
+  data.tar.gz: 35b0457e38603a400919853ceb78c5e61f2b77b7
 SHA512:
-  metadata.gz: 335152d1fc8d18e4ebd143e6f95afe398753368bae91b85cc43d9353d2f400daf566108252d40ec750b630bdaf04cdc8047791885d9898cb778f899f87cbb826
-  data.tar.gz: 3a75ee2d7c0aad3516d778cad11fa5e7a1d0be8ec94cf5c597159d9e9b94a5fe68b7283ada3d2a0192c4ec937aa956196e87925832b08839437913c4ee92f158
+  metadata.gz: 929d796e853d3d94daaa56e79883f89ddd77a976d7a937024cda3a1313b8e06059cfef1955330bc32a8b2b6ab97f11a0ed8fc9726c1b4bf918472b7c2246e99a
+  data.tar.gz: 69e5f21a252131b256069fe5b1a90c56900e58cbc469610684b26a74d8214bc559faf58f42fcf0a2a2d274fa24b2904d16aac929c75b78f9a43f87617ff0d409

data/README.md

@@ -1,7 +1,6 @@
-# GcTracer
+# GC::Tracer
 
-gc-tracer gem add GC::Tracer module which trace GC activities and output 
-all statistics information.
+Trace Garbage Collector activities and output statistics information.
 
 This gem only supports MRI 2.1.0 and later.
 
@@ -21,25 +20,32 @@ Or install it yourself as:
 
 ## Usage
 
-You can get GC statistics information like that:
+You can get GC statistics information in block form like this:
 
-    require 'gc_tracer'
-    GC::Tracer.start_logging(filename) do
-      # do something
-    end
+```ruby
+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
+```ruby
+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.
+In the stored file (filename), you can get tab separated values about
+`GC.stat()` and `GC.latest_gc_info()` at each events, there are one of:
 
+* GC starting time
+* End of marking time
+* End of sweeping time
+
+For one GC, you can get all three lines.
 
 ## Contributing
 

data/ext/gc_tracer/extconf.rb

@@ -1,20 +1,54 @@
 require 'mkmf'
 
 # auto generation script
+rusage_members = []
+
+if have_header('sys/time.h') && have_header('sys/resource.h') && have_func('getrusage')
+  %w(ru_maxrss
+     ru_ixrss
+     ru_idrss
+     ru_isrss
+     ru_minflt
+     ru_majflt
+     ru_nswap
+     ru_inblock
+     ru_oublock
+     ru_msgsnd
+     ru_msgrcv
+     ru_nsignals
+     ru_nvcsw
+     ru_nivcsw).each{|member|
+       if have_struct_member('struct rusage', member, %w(sys/time.h sys/resource.h))
+         rusage_members << member
+       end
+     }
+end
+
 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}];"
+  unless rusage_members.empty?
+    f.puts "static VALUE sym_rusage_timeval[2];"
+    f.puts "static VALUE sym_rusage[#{rusage_members.length}];" if rusage_members.length > 0
+  end
 
   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 "    sym_rusage_timeval[0] = ID2SYM(rb_intern(\"ru_utime\"));"
+    f.puts "    sym_rusage_timeval[1] = ID2SYM(rb_intern(\"ru_utime\"));"
+    rusage_members.each.with_index{|k, i|
+      f.puts "    sym_rusage[#{i}] = ID2SYM(rb_intern(\"#{k}\"));"
+    }
+    #
   f.puts "}"
 }
 

data/ext/gc_tracer/gc_tracer.c

@@ -15,9 +15,18 @@ static VALUE gc_trace_enabled;
 static FILE *gc_trace_out = NULL;
 static VALUE gc_trace_items, gc_trace_items_types;
 
+#ifdef HAVE_GETRUSAGE
+#include <sys/time.h>
+#include <sys/resource.h>
+#endif
+
 enum gc_key_type {
     GC_STAT_KEY,
-    GC_LATEST_GC_INFO_KEY
+    GC_LATEST_GC_INFO_KEY,
+#ifdef HAVE_GETRUSAGE
+    GC_RUSAGE_TIMEVAL_KEY,
+    GC_RUSAGE_KEY,
+#endif
 };
 
 /* the following code is only for internal tuning. */
@@ -129,10 +138,105 @@ out_header(void)
     out_terminate();
 }
 
+#ifdef HAVE_GETRUSAGE
+struct rusage_cache {
+    int cached;
+    struct rusage usage;
+};
+
+static void
+getursage_fill(struct rusage_cache *rusage_cache)
+{
+    if (!rusage_cache->cached) {
+	rusage_cache->cached = 1;
+	getrusage(RUSAGE_SELF, &rusage_cache->usage);
+    }
+}
+
+static double
+timeval2double(struct timeval *tv)
+{
+    return tv->tv_sec * 1000000 + tv->tv_usec;
+}
+
+static double
+getrusage_timeval(VALUE sym, struct rusage_cache *rusage_cache)
+{
+    getursage_fill(rusage_cache);
+
+    if (sym == sym_rusage_timeval[0]) {
+	return timeval2double(&rusage_cache->usage.ru_utime);
+    }
+    if (sym == sym_rusage_timeval[1]) {
+	return timeval2double(&rusage_cache->usage.ru_stime);
+    }
+
+    rb_raise(rb_eRuntimeError, "getrusage_timeval: unknown symbol");
+    return 0;
+}
+
+static size_t
+getrusage_sizet(VALUE sym, struct rusage_cache *rusage_cache)
+{
+    int i = 0;
+
+    getursage_fill(rusage_cache);
+
+#if HAVE_ST_RU_MAXRSS
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_maxrss;
+#endif
+#if HAVE_ST_RU_IXRSS
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_ixrss;
+#endif
+#if HAVE_ST_RU_IDRSS
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_idrss;
+#endif
+#if HAVE_ST_RU_ISRSS
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_isrss;
+#endif
+#if HAVE_ST_RU_MINFLT
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_minflt;
+#endif
+#if HAVE_ST_RU_MAJFLT
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_majflt;
+#endif
+#if HAVE_ST_RU_NSWAP
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_nswap;
+#endif
+#if HAVE_ST_RU_INBLOCK
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_inblock;
+#endif
+#if HAVE_ST_RU_OUBLOCK
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_oublock;
+#endif
+#if HAVE_ST_RU_MSGSND
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_msgsnd;
+#endif
+#if HAVE_ST_RU_MSGRCV
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_msgrcv;
+#endif
+#if HAVE_ST_RU_NSIGNALS
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_nsignals;
+#endif
+#if HAVE_ST_RU_NVCSW
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_nvcsw;
+#endif
+#if HAVE_ST_RU_NIVCSW
+    if (sym == sym_rusage[i++]) return rusage_cache->usage.ru_nivcsw;
+#endif
+
+    rb_raise(rb_eRuntimeError, "getrusage_sizet: unknown symbol");
+    return 0;
+}
+#endif
+
 static void
 trace(const char *type)
 {
     int i;
+#ifdef HAVE_GETRUSAGE
+    struct rusage_cache rusage_cache = {0};
+#endif
 
     out_tick();
     out_str(type);
@@ -148,6 +252,14 @@ trace(const char *type)
 	  case GC_LATEST_GC_INFO_KEY:
 	    out_obj(rb_gc_latest_gc_info(sym));
 	    break;
+#ifdef HAVE_GETRUSAGE
+	  case GC_RUSAGE_TIMEVAL_KEY:
+	    out_sizet((size_t)getrusage_timeval(sym, &rusage_cache));
+	    break;
+	  case GC_RUSAGE_KEY:
+	    out_sizet(getrusage_sizet(sym, &rusage_cache));
+	    break;
+#endif
 	  default:
 	    rb_bug("xyzzy");
 	}
@@ -244,12 +356,20 @@ 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_gc_stat)/sizeof(VALUE)); i++) {
+	if (sym_gc_stat[i] == sym) return GC_STAT_KEY;
+    }
+    for (i=0; i<(int)(sizeof(sym_latest_gc_info)/sizeof(VALUE)); i++) {
+	if (sym_latest_gc_info[i] == sym) return GC_LATEST_GC_INFO_KEY;
     }
-    for (i=0; i<(int)(sizeof(sym_latest_gc_info)/sizeof(VALUE));i++) {
-	return GC_LATEST_GC_INFO_KEY;
+#ifdef HAVE_GETRUSAGE
+    for (i=0; i<(int)(sizeof(sym_rusage_timeval)/sizeof(VALUE)); i++) {
+	if (sym_rusage_timeval[i] == sym) return GC_RUSAGE_TIMEVAL_KEY;
     }
+    for (i=0; i<(int)(sizeof(sym_rusage)/sizeof(VALUE)); i++) {
+	if (sym_rusage[i] == sym) return GC_RUSAGE_KEY;
+    }
+#endif
     rb_raise(rb_eArgError, "Unknown key type");
     return 0; /* unreachable */
 }
@@ -260,19 +380,35 @@ 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");
+    if (NIL_P(ary)) { /* revert all settings */
+	int i;
 
-    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));
+#define ADD(syms) for (i=0; i<(int)(sizeof(syms)/sizeof(VALUE));i++) { \
+    rb_ary_push(gc_trace_items, syms[i]); \
+    rb_ary_push(gc_trace_items_types, INT2FIX(item_type(syms[i]))); \
+}
+	ADD(sym_gc_stat);
+	ADD(sym_latest_gc_info);
+#ifdef HAVE_GETRUSAGE
+	ADD(sym_rusage_timeval);
+	ADD(sym_rusage);
+#endif
     }
+    else {
+	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);
+	rb_ary_replace(gc_trace_items, keys);
+	rb_ary_replace(gc_trace_items_types, types);
+    }
     return Qnil;
 }
 
@@ -296,15 +432,5 @@ Init_gc_tracer(void)
     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));
-	}
-    }
+    gc_tracer_setup_logging(Qnil, Qnil);
 }

data/lib/gc_tracer/version.rb

@@ -1,3 +1,3 @@
 module GcTracer
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gc_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler