heap_dump 0.0.6 → 0.0.8

data/.gitignore

@@ -17,4 +17,5 @@ test/version_tmp
 tmp
 *.bundle
 *.so
-*.dll
+*.dll
+dump.json

data/README.md

@@ -1,6 +1,9 @@
 # HeapDump
 
-TODO: Write a gem description
+Low-level ruby heap memory dump - including data and code references.
+Written across ruby 1.9.2-p290 data structures. Other rubies support may come later (or may not).
+
+Currently is under development and output format may differ.
 
 ## Installation
 
@@ -18,7 +21,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your code call:
+
+```ruby
+
+HeapDump.dump
+```
+
+this will run GC and then create a dump.json with live heap contents.
+Json contains one object per line, thus can be easily grepped.
+
+### Injecting into live process via GDB
+
+run gdb
+
+```bash
+
+gdb `which ruby` $YOUR_PID
+```
+
+And then run commands like:
+
+```
+call rb_require("/Users/vasfed/work/heap_dump/lib/heap_dump.bundle")
+call heapdump_dump("mydump.json")
+```
+
+or `call heapdump_dump(0)`, filename defaults to dump.json.
+
+Note that ruby-internal and yajl-ruby gems should be available to process this being injected into.
+
+### Importing dump in MongoDB
+
+Dump can be imported in mongo for some map-reduce, easy script access etc.
+
+```bash
+
+cat dump.json | sed 's/^[,\[]//;s/\]$//;s/^{"id"/{"_id"/' | mongoimport -d database_name -c collection_name --drop --type json
+```
+
+Note that even small dumps usually contain a few hundred thousands objects, so do not forget to add some indexes.
+
 
 ## Contributing
 

data/Rakefile

@@ -3,4 +3,13 @@ require "bundler/gem_tasks"
 
 
 require 'rake/extensiontask'
-Rake::ExtensionTask.new('heap_dump')
+Rake::ExtensionTask.new('heap_dump')
+
+desc "Simple dump test,just to check if extension compiles and does not segfault on simple dump"
+task :test => :compile do
+  require 'heap_dump'
+  puts "Dumping..."
+  HeapDump.dump
+end
+
+task :default => :test

data/ext/heap_dump/extconf.rb

@@ -3,6 +3,7 @@ require 'mkmf'
 spec = Gem::Specification.find_by_name('ruby-internal', '~>0.8.5') #FIXME: DRY (see gemfile)
 find_header('version.h', File.join(spec.gem_dir, 'ext', 'internal', 'yarv-headers'))
 find_header('yarv-headers/node.h', File.join(spec.gem_dir, 'ext', 'internal'))
+find_header('internal/method/internal_method.h', File.join(spec.gem_dir, 'ext'))
 
 yajl = Gem::Specification.find_by_name('yajl-ruby', '~>1.1')
 find_header('api/yajl_gen.h', File.join(yajl.gem_dir, 'ext', 'yajl'))

data/ext/heap_dump/heap_dump.c

@@ -15,6 +15,7 @@
 
 
 #include "yarv-headers/method.h"
+#include "method/internal_method.h"
 
 #include "ruby_io.h" // need rb_io_t
 
@@ -476,7 +477,7 @@ static int dump_const_entry_i(ID key, const rb_const_entry_t *ce, walk_ctx_t *ct
   return ST_CONTINUE;
 }
 
-const char* iseq_type(VALUE type){
+static const char* iseq_type(VALUE type){
   switch(type){
     case ISEQ_TYPE_TOP:    return "top";
     case ISEQ_TYPE_METHOD: return "method";
@@ -492,7 +493,7 @@ const char* iseq_type(VALUE type){
   return "unknown";
 }
 
-void dump_iseq(const rb_iseq_t* iseq, walk_ctx_t *ctx){
+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);
@@ -520,15 +521,8 @@ void dump_iseq(const rb_iseq_t* iseq, walk_ctx_t *ctx){
   }
 }
 
-//!!! from 1.9.2-p290
-struct METHOD {
-    VALUE recv;
-    VALUE rclass;
-    ID id;
-    rb_method_entry_t me;
-};
 
-void dump_data_if_known(VALUE obj, walk_ctx_t *ctx){
+static void dump_data_if_known(VALUE obj, walk_ctx_t *ctx){
 
   // VM
   // VM/env
@@ -842,11 +836,11 @@ static int objspace_walker(void *vstart, void *vend, int stride, walk_ctx_t *ctx
 // #elif defined(__i386) && defined(__GNUC__) && !defined(__native_client__)
 // #define SET_MACHINE_STACK_END(p) __asm__("movl\t%%esp, %0" : "=r" (*(p)))
 // #else
-NOINLINE(void rb_gc_set_stack_end(VALUE **stack_end_p));
+NOINLINE(static void rb_gc_set_stack_end(VALUE **stack_end_p));
 #define SET_MACHINE_STACK_END(p) rb_gc_set_stack_end(p)
 #define USE_CONSERVATIVE_STACK_END
 // #endif
-void
+static void
 rb_gc_set_stack_end(VALUE **stack_end_p)
 {
     VALUE stack_end;
@@ -922,6 +916,7 @@ extern st_table *rb_class_tbl;
 #endif
 
 //FIXME: this should be autoextracted from ruby
+// see how this is done in ruby-internal gem
 typedef struct RVALUE {
     union {
   struct {
@@ -1241,16 +1236,17 @@ static int dump_iv_entry1(ID key, rb_const_entry_t* ce/*st_data_t val*/, walk_ct
   return ST_CONTINUE;
 }
 
-static VALUE
-rb_heapdump_dump(VALUE self, VALUE filename)
-{
+
+//public symbol, can be used from GDB
+void heapdump_dump(const char* filename){
   struct walk_ctx ctx_o, *ctx = &ctx_o;
   memset(ctx, 0, sizeof(*ctx));
 
-  Check_Type(filename, T_STRING);
-
-  printf("Dump should go to %s\n", RSTRING_PTR(filename));
-  ctx->file = fopen(RSTRING_PTR(filename), "wt");
+  if(!filename){
+    filename = "dump.json";
+  }
+  printf("Dump should go to %s\n", filename);
+  ctx->file = fopen(filename, "wt");
   ctx->yajl = yajl_gen_alloc(NULL,NULL);
   yajl_gen_array_open(ctx->yajl);
 
@@ -1295,18 +1291,30 @@ rb_heapdump_dump(VALUE self, VALUE filename)
   fclose(ctx->file);
 
   printf("Walker called %d times, seen %d live objects.\n", ctx->walker_called, ctx->live_objects);
+}
 
+static VALUE
+rb_heapdump_dump(VALUE self, VALUE filename)
+{
+  Check_Type(filename, T_STRING);
+  heapdump_dump(RSTRING_PTR(filename));
   return Qnil;
 }
 
-
 void Init_heap_dump(){
   //ruby-internal need to be required before linking us, but just in case..
+  ID require, gem;
+  CONST_ID(require, "require");
+  CONST_ID(gem, "gem");
+  CONST_ID(classid, "__classid__");
+
+  rb_require("rubygems");
+  rb_funcall(rb_mKernel, gem, 1, rb_str_new2("yajl-ruby"));
+  rb_funcall(rb_mKernel, gem, 1, rb_str_new2("ruby-internal")); //TODO: version requirements
   rb_require("internal/node");
   rb_require("yajl");
-  init_node_type_descrips();
 
-  CONST_ID(classid, "__classid__");
+  init_node_type_descrips();
 
   rb_mHeapDumpModule = rb_define_module("HeapDump");
   rb_define_singleton_method(rb_mHeapDumpModule, "dump_ext", rb_heapdump_dump, 1);

data/lib/heap_dump/version.rb

@@ -1,3 +1,3 @@
 module HeapDump
-  VERSION = "0.0.6"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heap_dump
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-internal
-  requirement: &70171206252720 !ruby/object:Gem::Requirement
+  requirement: &70110343222520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.5
   type: :runtime
   prerelease: false
-  version_requirements: *70171206252720
+  version_requirements: *70110343222520
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70171206251900 !ruby/object:Gem::Requirement
+  requirement: &70110343221760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70171206251900
+  version_requirements: *70110343221760
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &70171206251120 !ruby/object:Gem::Requirement
+  requirement: &70110343221160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70171206251120
+  version_requirements: *70110343221160
 description: dump ruby 1.9 heap contents
 email:
 - vasilyfedoseyev@gmail.com