heap_dump 0.0.9 → 0.0.10

data/README.md

@@ -89,6 +89,33 @@ bt field is ruby builtin type name.
 Where available - val/refs/ivs/etc. field present with hash/array of references.
 Long numbers usually are object ids.
 
+## What may leak
+
+### Brief Ruby GC decription
+(brief) Ruby has mark-and-sweep GC, this means that it does not leak in traditional way when you lose some pointer and do not free memory.
+Ruby leaks references. But also it is different from reference counting GC, like one in python.
+
+For example, 3 objects:
+
+```
+A -> B -> C
+```
+let's assume that A is a global variable or is referenced in stack. In this chain C does not get freed bacause it has a reference path from global/stack.
+
+If reference to B gets deleted (for example A.b = nil):
+
+```
+A  B -> C
+```
+C still is referenced by something, but both B and C will be freed, as there's no path.
+
+### Examples of references
+
+Obvious references: from variables, instance variables (including class), arrays, hashes, etc.
+
+Less obvious: method closures. These are stored in T_DATAs with 'VM/env' type.
+Latest version of heap_dump allows to trace such references: search for a env, by it's id you can find it's owner iseq, which usually has file and line number where block/lambda/proc was created.
+
 ## Contributing
 
 1. Fork it

data/ext/heap_dump/heap_dump.c

@@ -118,7 +118,7 @@ static void yg_id1(VALUE obj, walk_ctx_t* ctx){
     }
     if (obj == Qundef) { yg_cstring("(undef)"); return; }
 
-    printf("immediate p %p?\n", obj);
+    printf("immediate p %p?\n", (void*)obj);
     yg_cstring("(unknown)");
     return;
   } else /*non-immediate*/ {
@@ -346,15 +346,14 @@ static void dump_node_refs(NODE* obj, walk_ctx_t* ctx){
 
     //iteration func - blocks,procs,lambdas etc:
     case NODE_IFUNC: //NEN_CFNC, NEN_TVAL, NEN_STATE? / u2 seems to be data for func(context?)
-      printf("IFUNC NODE: %p %p %p\n", obj->nd_cfnc, obj->u2.node, (void*)obj->nd_aid /*u3 - aid id- - aka frame_this_func?*/);
-      //FIXME: closures may leak references?
+      //printf("IFUNC NODE: %p %p %p\n", obj->nd_cfnc, obj->u2.node, (void*)obj->nd_aid /*u3 - aid id- - aka frame_this_func?*/);
       if(is_pointer_to_heap(obj->u2.node, 0)){
-        printf("in heap: %p\n", obj->u2.node);
+        //printf("in heap: %p\n", obj->u2.node);
         //TODO: do we need to dump it inline?
-        yg_id(obj->u2.node);
+        yg_id((VALUE)obj->u2.node);
       }
       if(is_pointer_to_heap( (void*)obj->nd_aid, 0)){
-        printf("in heap: %p\n", (void*)obj->nd_aid);
+        //printf("in heap: %p\n", (void*)obj->nd_aid);
         yg_id(obj->nd_aid);
       }
       break;
@@ -489,14 +488,14 @@ static const char* iseq_type(VALUE type){
     case ISEQ_TYPE_MAIN:   return "main";
     case ISEQ_TYPE_DEFINED_GUARD: return "defined_guard";
   }
-  printf("unknown iseq type %d!\n", type);
+  printf("unknown iseq type %p!\n", (void*)type);
   return "unknown";
 }
 
 static void dump_iseq(const rb_iseq_t* iseq, walk_ctx_t *ctx){
   if(iseq->name) ygh_rstring("name", iseq->name);
   if(iseq->filename) ygh_rstring("filename", iseq->filename);
-  ygh_int("line", iseq->line_no);
+  ygh_int("line", FIX2INT(iseq->line_no));
 
   //if(iseq->type != 25116) //also 28 in mark_ary
   ygh_cstring("type", iseq_type(iseq->type));
@@ -556,6 +555,7 @@ static void dump_data_if_known(VALUE obj, walk_ctx_t *ctx){
     if(proc->block.iseq && !RUBY_VM_IFUNC_P(proc->block.iseq)) {
       yg_cstring("iseq");
       yajl_gen_map_open(ctx->yajl);
+      //FIXME: id may be different (due to RBasic fields)!!!
       ygh_id("id", proc->block.iseq);
       dump_iseq(proc->block.iseq, ctx);
       yajl_gen_map_close(ctx->yajl);

data/lib/heap_dump/version.rb

@@ -1,3 +1,3 @@
 module HeapDump
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heap_dump
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-internal
-  requirement: &70250067931780 !ruby/object:Gem::Requirement
+  requirement: &70141930337500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.5
   type: :runtime
   prerelease: false
-  version_requirements: *70250067931780
+  version_requirements: *70141930337500
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70250067931200 !ruby/object:Gem::Requirement
+  requirement: &70141930336660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70250067931200
+  version_requirements: *70141930336660
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &70250067930760 !ruby/object:Gem::Requirement
+  requirement: &70141930335600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70250067930760
+  version_requirements: *70141930335600
 description: dump ruby 1.9 heap contents
 email:
 - vasilyfedoseyev@gmail.com