gc_tracer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9ce36d7506d6380617767354fcf92f131fb8eb2
-  data.tar.gz: cd6eeb8447b71f3e4ceafd623af6bf0e793c45a7
+  metadata.gz: 08efc028ba431a430f1e0d1ac444b74884e575b4
+  data.tar.gz: 04aa0ea80b8ce757cd32bce97a84644740c6a53c
 SHA512:
-  metadata.gz: 28c17973fe087d97552e5b12d0e8e0a3b43e0910e2591ae9144d3e6225bdd008da490777939b7d2cd97582a2fbc7e907b18b4c2517869fa65cad7ffb36fc1b66
-  data.tar.gz: b27a89753bf65de227143b1e5966e131e5c47cc595cd90332f0265fa6c6bd28a35febfc5306fa7b0615dd93ae6c8aeeaa9c61db034eadcdb85beeaa867c64808
+  metadata.gz: 299a15128bd5794000a3d631e5ca21132dbe954192f19c71c5b5a18f3332271646375d108be07b516ef7f803dab65fcd932e862e435e9a3ba7ddd3c0329e95af
+  data.tar.gz: b6132a320def13c6161a4dcc7e105c21f167c82e6ad03af303dd4f9f2f9a00b874c8e253bf3f864a0978737d2673e588f946087faae8307e368eca702208e3e6

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0

data/README.md

@@ -4,6 +4,8 @@ Trace Garbage Collector activities and output statistics information.
 
 This gem only supports MRI 2.1.0 and later.
 
+[![Build Status](https://travis-ci.org/ko1/gc_tracer.svg)](https://travis-ci.org/ko1/gc_tracer)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -80,7 +82,7 @@ ensure
 end
 ```
 
-Default events are "start", "end_mark" and "end_sweep". You can specify 
+Default events are "start", "end_mark" and "end_sweep". You can specify
 what kind of information you want to collect.
 
 ```ruby
@@ -93,22 +95,48 @@ ensure
 end
 ```
 
-Above example means that no details information are not needed. Default 
+Above example means that no details information are not needed. Default
 setting is "gc_stat: true, gc_latest_gc_info: true, rusage: false".
 
-You can specify tick (time stamp) type with keyword parameter 
-"tick_type". You can choose one of the tick type in :hw_counter, :time 
+You can specify tick (time stamp) type with keyword parameter
+"tick_type". You can choose one of the tick type in :hw_counter, :time
 and :nano_time (if platform supports clock_gettime()).
 
 See lib/gc_tracer.rb for more details.
 
+### Custom fields
+
+You can add custom fields.
+
+```ruby
+GC::Tracer.start_logging(custom_fields: [:name1, :name2, ...]) do
+  # All fields are cleared by zero.
+
+  # You can increment values of each field.
+  GC::Tracer.custom_field_increment(:name1)
+  # It is equivalent to
+  #   GC::Tracer.custom_field_set(:name1, GC::Tracer.custom_field_get(:name1))
+
+  # You can also decrement values
+  GC::Tracer.custom_field_decrement(:name1)
+
+  # Now, you can specify only Fixnum as field value.
+  GC::Tracer.custom_field_set(:name2, 123)
+
+  # You can specify an index instead of field name (faster than actual name)
+  GC::Tracer.custom_field_increment(0) # :name1
+end
+```
+
+Custom fields are printed as last columns.
+
 ### Custom events
 
-You can add custom events by your own. Calling 
-`GC::Tracer.custom_event_logging(event_name)` in your program will puts 
+You can add custom events by your own. Calling
+`GC::Tracer.custom_event_logging(event_name)` in your program will puts
 new statistics line into the logging file.
 
-For example, the following program insert 1000 custom event lines into 
+For example, the following program insert 1000 custom event lines into
 logging file (stderr for this type).
 
 ```ruby
@@ -120,7 +148,7 @@ GC::Tracer.start_logging(events: %i(start), gc_stat: false) do
 end
 ```
 
-This method is useful to trace where the GC events occur in your 
+This method is useful to trace where the GC events occur in your
 application.
 
 

data/ext/gc_tracer/gc_logging.c

@@ -66,6 +66,8 @@ tick(void)
 #define MAX_HOOKS 5
 #endif
 
+#define MAX_CUSTOM_FIELDS 128
+
 static VALUE tracer_hooks[MAX_HOOKS];
 static VALUE tracer_acceptable_events[MAX_HOOKS];
 
@@ -77,12 +79,16 @@ struct gc_logging {
 	int log_gc_stat;
 	int log_gc_latest_gc_info;
 	int log_rusage;
+	int log_custom_fields_count;
     } config;
 
     int enabled;
     VALUE enable_hooks[MAX_HOOKS]; /* Symbols */
     int enable_hooks_num; /* 0 to MAX_HOOKS */
 
+    ID custom_field_names[MAX_CUSTOM_FIELDS];
+    long  custom_field_values[MAX_CUSTOM_FIELDS];
+
     FILE *out;
     const char *event;
 
@@ -138,6 +144,12 @@ out_sizet(FILE *out, size_t size)
     fprintf(out, "%lu\t", (unsigned long)size);
 }
 
+static void
+out_long(FILE *out, long l)
+{
+    fprintf(out, "%ld\t", l);
+}
+
 static double
 timeval2double(struct timeval *tv)
 {
@@ -303,6 +315,13 @@ out_stat(struct gc_logging *logging, const char *event)
 #if HAVE_GETRUSAGE
     if (logging->config.log_rusage) out_rusage(logging);
 #endif
+    if (logging->config.log_custom_fields_count > 0) {
+	int i;
+	for (i=0; i<logging->config.log_custom_fields_count; i++) {
+	    out_long(logging->out, logging->custom_field_values[i]);
+	}
+    }
+
     out_terminate(logging->out);
 }
 
@@ -335,6 +354,12 @@ out_header(struct gc_logging *logging)
 	out_header_each(logging, sym_rusage, sizeof(sym_rusage)/sizeof(VALUE));
     }
 #endif
+    if (logging->config.log_custom_fields_count > 0) {
+	int i;
+	for (i=0; i<logging->config.log_custom_fields_count; i++) {
+	    out_str(logging->out, rb_id2name(logging->custom_field_names[i]));
+	}
+    }
     out_terminate(logging->out);
 }
 
@@ -540,6 +565,96 @@ gc_tracer_setup_logging_rusage(VALUE self, VALUE b)
     return self;
 }
 
+static VALUE
+gc_tracer_setup_logging_custom_fields(VALUE self, VALUE b)
+{
+    struct gc_logging *logging = &trace_logging;
+
+    if (RTEST(b)) {
+	VALUE ary = rb_check_array_type(b);
+	int i;
+
+	logging->config.log_custom_fields_count = RARRAY_LEN(ary);
+
+	for (i=0; i<RARRAY_LEN(ary); i++) {
+	    VALUE name = RARRAY_AREF(ary, i);
+	    ID field_id = rb_to_id(name);
+
+	    if (i >= MAX_CUSTOM_FIELDS) {
+		rb_raise(rb_eRuntimeError, "Number of custome fields exceeds %d", MAX_CUSTOM_FIELDS);
+	    }
+
+	    logging->custom_field_names[i] = field_id;
+	    logging->custom_field_values[i] = 0;
+	}
+    }
+    else {
+	logging->config.log_custom_fields_count = 0;
+    }
+
+    return self;
+}
+
+static long *
+custom_field_value_place(VALUE name)
+{
+    struct gc_logging *logging = &trace_logging;
+    int index;
+
+    if (FIXNUM_P(name)) {
+	index = FIX2INT(name);
+	if (index >= logging->config.log_custom_fields_count) {
+	    rb_raise(rb_eRuntimeError, "Only %d custom fields are available, but %d was specified",
+		     logging->config.log_custom_fields_count, index);
+	}
+    }
+    else {
+	int i;
+	ID nid = rb_to_id(name);
+	for (i=0; i<logging->config.log_custom_fields_count; i++) {
+	    if (nid == logging->custom_field_names[i]) {
+		index = i;
+		goto found;
+	    }
+	}
+	rb_raise(rb_eRuntimeError, "Unkown custom fileds is specified.");
+    }
+  found:
+    return &logging->custom_field_values[index];
+}
+
+static VALUE
+gc_tracer_custom_field_increment(VALUE self, VALUE name)
+{
+    long *valp = custom_field_value_place(name);
+    (*valp)++;
+    return self;
+}
+
+static VALUE
+gc_tracer_custom_field_decrement(VALUE self, VALUE name)
+{
+    long *valp = custom_field_value_place(name);
+    (*valp)--;
+    return self;
+}
+
+static VALUE
+gc_tracer_custom_field_get(VALUE self, VALUE name)
+{
+    long *valp = custom_field_value_place(name);
+    return LONG2NUM(*valp);
+}
+
+static VALUE
+gc_tracer_custom_field_set(VALUE self, VALUE name, VALUE val)
+{
+    long *valp = custom_field_value_place(name);
+    long lval = NUM2LONG(val);
+    *valp = lval;
+    return val;
+}
+
 static VALUE
 gc_tracer_start_logging(int argc, VALUE *argv, VALUE self)
 {
@@ -597,6 +712,13 @@ Init_gc_tracer_logging(VALUE mod)
     rb_define_module_function(mod, "setup_logging_gc_latest_gc_info=", gc_tracer_setup_logging_gc_latest_gc_info, 1);
     rb_define_module_function(mod, "setup_logging_rusage=", gc_tracer_setup_logging_rusage, 1);
 
+    /* custom fields */
+    rb_define_module_function(mod, "setup_looging_custom_fields=", gc_tracer_setup_logging_custom_fields, 1);
+    rb_define_module_function(mod, "custom_field_increment", gc_tracer_custom_field_increment, 1);
+    rb_define_module_function(mod, "custom_field_decrement", gc_tracer_custom_field_decrement, 1);
+    rb_define_module_function(mod, "custom_field_set", gc_tracer_custom_field_set, 2);
+    rb_define_module_function(mod, "custom_field_get", gc_tracer_custom_field_get, 1);
+
     /* custom event */
     rb_define_module_function(mod, "custom_event_logging", gc_tracer_custom_event_logging, 1);
 

data/lib/gc_tracer.rb

@@ -12,7 +12,9 @@ module GC
                            # collect information
                            gc_stat: true,
                            gc_latest_gc_info: true,
-                           rusage: false)
+                           rusage: false,
+                           custom_fields: nil
+                         )
       # setup
       raise "do not specify two fienames" if filename && filename_opt
       setup_logging_out(filename_opt || filename)
@@ -22,6 +24,7 @@ module GC
       self.setup_logging_gc_latest_gc_info = gc_latest_gc_info
       self.setup_logging_rusage = rusage
       self.setup_logging_tick_type = tick_type
+      self.setup_looging_custom_fields = custom_fields
 
       if block_given?
         begin

data/lib/gc_tracer/version.rb

@@ -1,3 +1,3 @@
 module GC::Tracer
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/gc_tracer_spec.rb

@@ -28,6 +28,78 @@ describe GC::Tracer do
     it_behaves_like "logging_test"
   end
 
+  describe 'custom fields' do
+    describe 'manipulate values' do
+      around 'open' do |example|
+        Dir.mktmpdir('gc_tracer'){|dir|
+          logfile = "#{dir}/logging"
+          GC::Tracer.start_logging(logfile, custom_fields: %i(a b c)) do
+            example.run
+          end
+        }
+      end
+
+      it 'should raise error for unknown name or index' do
+        expect{GC::Tracer.custom_field_increment(:xyzzy)}.to raise_error RuntimeError
+        expect{GC::Tracer.custom_field_increment(42)}.to raise_error RuntimeError
+      end
+
+      it 'should count increments' do
+        GC::Tracer.custom_field_increment(:a)
+        GC::Tracer.custom_field_increment(:a)
+        GC::Tracer.custom_field_increment(:a)
+        GC::Tracer.custom_field_increment(0)
+        GC::Tracer.custom_field_increment(0)
+        GC::Tracer.custom_field_increment(0)
+
+        expect(GC::Tracer.custom_field_get(:a)).to be 6
+        expect(GC::Tracer.custom_field_get(0)).to be 6
+      end
+
+      it 'should count decments' do
+        GC::Tracer.custom_field_decrement(:b)
+        GC::Tracer.custom_field_decrement(:b)
+        GC::Tracer.custom_field_decrement(:b)
+        GC::Tracer.custom_field_decrement(1)
+        GC::Tracer.custom_field_decrement(1)
+        GC::Tracer.custom_field_decrement(1)
+
+        expect(GC::Tracer.custom_field_get(:b)).to be -6
+        expect(GC::Tracer.custom_field_get(1)).to be -6
+      end
+
+      it 'should set values' do
+        GC::Tracer.custom_field_set(:c, 42)
+        expect(GC::Tracer.custom_field_get(:c)).to be 42
+        GC::Tracer.custom_field_set(2, 43)
+        expect(GC::Tracer.custom_field_get(:c)).to be 43
+      end
+    end
+
+    describe 'output custome fields' do
+      it 'should output custome fields' do
+        Dir.mktmpdir('gc_tracer'){|dir|
+          logfile = "#{dir}/logging"
+          GC::Tracer.start_logging(logfile, custom_fields: %i(a b c)) do
+            GC::Tracer.custom_field_increment(:a)
+            GC::Tracer.custom_field_decrement(:b)
+            GC::Tracer.custom_event_logging("out")
+          end
+
+          expect(File.exist?(logfile)).to be_true
+          log = File.read(logfile)
+          expect(log.lines[0]).to match /a\tb\tc/
+          log.each_line{|line|
+            if /out/ =~ line
+              expect(line).to match /1\t-1\t0/
+            end
+          }
+        }
+      end
+    end
+  end
+  
+
 =begin not supported now.
   shared_examples "objspace_recorder_test" do
     dirname = "gc_tracer_objspace_recorder_spec.#{$$}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gc_tracer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -119,4 +120,3 @@ summary: gc_tracer gem adds GC::Tracer module.
 test_files:
 - spec/gc_tracer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: