memprof 0.1.0 → 0.1.1

data/README

@@ -5,6 +5,14 @@ What is memprof?
 Memprof is a memory profiler for Ruby that requires no patches to the Ruby VM.
 It can help you find Ruby level memory leaks in your application.
 
+Required to install
+===================
+If you are using the Linux version, you need to install libelf:
+
+apt-get install libelfg0-dev
+
+The experimental OSX version needs no additional libraries.
+
 How to use
 ==========
 
@@ -13,16 +21,23 @@ Memprof.start
 
 # ruby code
 
+Memprof.stats
+
+# more ruby code
+
+Memprof.stats
 Memprof.stop
-Memprof.dump
 
-That will monitor allocations and frees that happen between "start" and "stop"
-and will output information to standard error.
 
-Memprof.dump also takes an (optional) file name to write the output to a file.
+The above code will output 2 summaries, allowing you to compare which objects were
+destroyed and which are still around.
+
+Memprof.stats also takes an (optional) file name to write the output to a file.
 
 Supported systems
 =================
+This only works on unstripped binaries.
+
 Currently supporting:
 
   Linux:
@@ -33,6 +48,7 @@ Experimental support:
 
   Snow Leopard:
     x86_64 builds of MRI (both enable-shared and disable-shared)
+    OSX system Ruby, distributed with Snow Leopard
 
 Coming soon:
 

data/ext/mach.c

@@ -12,9 +12,9 @@
 #include <mach-o/ldsyms.h>
 
 static void
-set_text_segment(struct mach_header *header, const char *sectname)
+set_text_segment(const struct mach_header *header, const char *sectname)
 {
-  text_segment = getsectdatafromheader_64((struct mach_header_64*)header, "__TEXT", sectname, (uint64_t*)&text_segment_len);
+  text_segment = getsectdatafromheader_64((const struct mach_header_64*)header, "__TEXT", sectname, (uint64_t*)&text_segment_len);
   if (!text_segment)
     errx(EX_UNAVAILABLE, "Failed to locate the %s section", sectname);
 }
@@ -28,8 +28,8 @@ update_dyld_stubs(int entry, void *trampee_addr)
   for(; count < text_segment_len; count++) {
     if (*byte == '\xff') {
       int off = *(int *)(byte+2);
-      if (trampee_addr == (void*)(*(long long*)(byte + 6 + off))) {
-        *(long long*)(byte + 6 + off) = tramp_table[entry].addr;
+      if (trampee_addr == *((void**)(byte + 6 + off))) {
+        *((void**)(byte + 6 + off)) = tramp_table[entry].addr;
       }
     }
     byte++;
@@ -55,17 +55,18 @@ bin_allocate_page()
 void
 bin_update_image(int entry, void *trampee_addr)
 {
-  // Modify any callsites residing inside the text segment of the executable itself
-  set_text_segment((struct mach_header*)&_mh_execute_header, "__text");
-  update_callqs(entry, trampee_addr);
-
-  // Modify all dyld stubs in shared libraries that have been loaded
   int i, j, k;
   int header_count = _dyld_image_count();
 
   // Go through all the mach objects that are loaded into this process
   for (i=0; i < header_count; i++) {
     const struct mach_header *current_hdr = _dyld_get_image_header(i);
+
+    // Modify any callsites residing inside the text segment
+    set_text_segment(current_hdr, "__text");
+    text_segment += _dyld_get_image_vmaddr_slide(i);
+    update_callqs(entry, trampee_addr);
+
     int lc_count = current_hdr->ncmds;
 
     // this as a char* because we need to step it forward by an arbitrary number of bytes

data/ext/memprof.c

@@ -98,7 +98,15 @@ freelist_tramp(unsigned long rval)
 }
 
 static int
-memprof_tabulate(st_data_t key, st_data_t record, st_data_t arg)
+objs_free(st_data_t key, st_data_t record, st_data_t arg)
+{
+  struct obj_track *tracker = (struct obj_track *)record;
+  free(tracker->source);
+  return ST_DELETE;
+}
+
+static int
+objs_tabulate(st_data_t key, st_data_t record, st_data_t arg)
 {
   st_table *table = (st_table *)arg;
   struct obj_track *tracker = (struct obj_track *)record;
@@ -121,7 +129,7 @@ memprof_tabulate(st_data_t key, st_data_t record, st_data_t arg)
       type = "__node__"; break;
     default:
       if (RBASIC(tracker->obj)->klass) {
-        type = rb_obj_classname(tracker->obj);
+        type = (char*) rb_obj_classname(tracker->obj);
       } else {
         type = "__unknown__";
       }
@@ -133,8 +141,7 @@ memprof_tabulate(st_data_t key, st_data_t record, st_data_t arg)
     free(source_key);
   }
 
-  free(tracker->source);
-  return ST_DELETE;
+  return ST_CONTINUE;
 }
 
 struct results {
@@ -172,6 +179,7 @@ memprof_stop(VALUE self)
     return Qfalse;
 
   track_objs = 0;
+  st_foreach(objs, objs_free, (st_data_t)0);
   return Qtrue;
 }
 
@@ -184,7 +192,7 @@ memprof_strcmp(const void *obj1, const void *obj2)
 }
 
 static VALUE
-memprof_dump(int argc, VALUE *argv, VALUE self)
+memprof_stats(int argc, VALUE *argv, VALUE self)
 {
   st_table *tmp_table;
   struct results res;
@@ -203,7 +211,7 @@ memprof_dump(int argc, VALUE *argv, VALUE self)
   track_objs = 0;
 
   tmp_table = st_init_strtable();
-  st_foreach(objs, memprof_tabulate, (st_data_t)tmp_table);
+  st_foreach(objs, objs_tabulate, (st_data_t)tmp_table);
 
   res.num_entries = 0;
   res.entries = malloc(sizeof(char*) * tmp_table->num_entries);
@@ -222,6 +230,27 @@ memprof_dump(int argc, VALUE *argv, VALUE self)
   return Qnil;
 }
 
+static VALUE
+memprof_stats_bang(int argc, VALUE *argv, VALUE self)
+{
+  memprof_stats(argc, argv, self);
+  st_foreach(objs, objs_free, (st_data_t)0);
+  return Qnil;
+}
+
+static VALUE
+memprof_track(int argc, VALUE *argv, VALUE self)
+{
+  if (!rb_block_given_p())
+    rb_raise(rb_eArgError, "block required");
+
+  memprof_start(self);
+  rb_yield(Qnil);
+  memprof_stats(argc, argv, self);
+  memprof_stop(self);
+  return Qnil;
+}
+
 static void
 create_tramp_table()
 {
@@ -458,7 +487,9 @@ Init_memprof()
   VALUE memprof = rb_define_module("Memprof");
   rb_define_singleton_method(memprof, "start", memprof_start, 0);
   rb_define_singleton_method(memprof, "stop", memprof_stop, 0);
-  rb_define_singleton_method(memprof, "dump", memprof_dump, -1);
+  rb_define_singleton_method(memprof, "stats", memprof_stats, -1);
+  rb_define_singleton_method(memprof, "stats!", memprof_stats_bang, -1);
+  rb_define_singleton_method(memprof, "track", memprof_track, -1);
 
   pagesize = getpagesize();
   objs = st_init_numtable();

data/memprof.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'memprof'
-  s.version = '0.1.0'
+  s.version = '0.1.1'
   s.date = '2009-12-10'
   s.summary = 'Ruby Memory Profiler'
   s.description = "Ruby memory profiler similar to bleak_house, but without patches to the Ruby VM"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: memprof
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joe Damato