bleak_house 5.3 → 6

data/CHANGELOG

@@ -1,6 +1,7 @@
 
 BleakHouse Changelog
 
+6. log heap usage, remove pure-ruby profiler
 5.3. subtract rails core counts from action counts and convolve
 5.2. change smoothing algorithm to be more intuitive and so mem usage is correct
 5.1. close file properly

data/Manifest

@@ -12,9 +12,7 @@
 ./lib/bleak_house/c.rb
 ./lib/bleak_house/dispatcher.rb
 ./lib/bleak_house/gruff_hacks.rb
-./lib/bleak_house/mem_logger.rb
 ./lib/bleak_house/rake_task_redefine_task.rb
-./lib/bleak_house/ruby.rb
 ./lib/bleak_house/support_methods.rb
 ./lib/bleak_house.rb
 ./patches/gc.c.patch

data/README

@@ -7,8 +7,8 @@ A *nix operating system. Windows is not supported.
 
 Gems: 'gruff', 'rmagick', 'active_support', 'RubyInline'
 
-It is highly recommended that you compile the bleak_house patched 
-Ruby build. In the plugin directory: 
+You need to compile the bleak_house patched Ruby build. In the 
+plugin directory: 
   rake ruby:build
 
 USAGE
@@ -35,6 +35,10 @@ alongside a different verson of Ruby. You could try to patch your local
 version of Ruby instead, or you could just upgrade to 1.8.6, which has
 a good trackrecord of stability anyway.
 
+FURTHER READING
+
+Please visit: http://blog.evanweaver.com/pages/code#bleak_house
+
 COPYRIGHT AND LICENSING
 
 Copyright (c) 2007 Cloudburst, LLC. See the included LICENSE_AFL 

data/lib/bleak_house.rb

@@ -1,10 +1,14 @@
 
 if ENV['BLEAK_HOUSE']
 
-  require 'dispatcher' # rails  
+  # rails  
+  require 'dispatcher'
   
+  # logger
+  require 'bleak_house/c'
   require 'bleak_house/bleak_house'
-  require 'bleak_house/mem_logger'
+
+  # overrides
   require 'bleak_house/dispatcher'
   require 'bleak_house/action_controller'
 

data/lib/bleak_house/analyze.rb

@@ -20,6 +20,7 @@ class BleakHouse
   
     SMOOTHNESS = ENV['SMOOTHNESS'].to_i.zero? ? 1 : ENV['SMOOTHNESS'].to_i
     MEM_KEY = "memory usage"
+    HEAP_KEY = "heap usage"
     DIR = "#{RAILS_ROOT}/log/bleak_house/"
     
     def initialize(data, increments, name)
@@ -41,7 +42,12 @@ class BleakHouse
       g.marker_font_size = 14
             
       @data.map do |key, values|        
-        ["#{(key.to_s.empty? ? '[Unknown]' : key).gsub(/.*::/, '')} (#{key == MEM_KEY ? "relative" : values.to_i.max})", values] # hax
+        ["#{(key.to_s.empty? ? '[Unknown]' : key).gsub(/.*::/, '')} (#{ if 
+          [MEM_KEY, HEAP_KEY].include?(key) 
+            'relative'
+          else
+            values.to_i.max
+          end })", values] # hax
       end.sort_by do |key, values|
         0 - key[/.*?([\d]+)\)$/, 1].to_i
       end.each do |key, values|
@@ -120,22 +126,30 @@ class BleakHouse
         
         # generate initial controller graph
         puts "entire app"
+        
         controller_data, increments = aggregate(data, //, /^(.*?)($|\/|::::)/)
-        if controller_data.has_key? MEM_KEY
-          controller_data_without_memory = controller_data.dup
-          controller_data_without_memory.delete(MEM_KEY)
-          scale_factor = controller_data_without_memory.values.flatten.to_i.max / controller_data[MEM_KEY].max.to_f * 0.8 rescue 1
-          controller_data[MEM_KEY] = controller_data[MEM_KEY].map{|x| (x * scale_factor).to_i }
+        controller_data_without_specials = controller_data.dup
+        controller_data_without_specials.delete(MEM_KEY)
+        controller_data_without_specials.delete(HEAP_KEY)
+        [HEAP_KEY, MEM_KEY].each do |key|
+#          next unless controller_data[key]
+          scale_factor = controller_data_without_specials.values.flatten.to_i.max / controller_data[key].max.to_f * 0.8 rescue 1
+          controller_data[key] = controller_data[key].map{|x| (x * scale_factor).to_i }
         end
         Analyze.new(controller_data, increments, "objects by controller").draw
-                
+
         # in each controller, by action
         controller_data.keys.each do |controller|
-          @mem = (controller == MEM_KEY)
-          puts(@mem ? "  #{controller}" : "  action for #{controller} controller")
+#          next unless controller == HEAP_KEY
+          @special = [MEM_KEY, HEAP_KEY].include? controller
+          puts(@special ? "  #{controller}" : "  action for #{controller} controller")
           Dir.descend(controller) do             
             action_data, increments = aggregate(data, /^#{controller}($|\/|::::)/, /\/(.*?)($|\/|::::)/)
-            Analyze.new(action_data, increments, @mem ?  "#{controller} in kilobytes" : "objects by action in /#{controller}_controller").draw          
+            Analyze.new(action_data, increments, case controller
+              when MEM_KEY then "#{controller} in kilobytes" 
+              when HEAP_KEY then "#{controller} in slots"
+              else "objects by action in /#{controller}_controller"
+            end).draw          
           
             # in each action, by object class
             action_data.keys.each do |action|
@@ -146,7 +160,7 @@ class BleakHouse
                   /::::(.*)/)
                 Analyze.new(class_data, increments, "objects by class in /#{controller}/#{action}").draw
               end
-            end unless @mem
+            end unless @special
           
           end          
         end

data/lib/bleak_house/bleak_house.rb

@@ -29,16 +29,6 @@ class BleakHouse
   WITH_SPECIALS = false
   GC = true
 
-  MEMLOGGER = if ENV['MEMLOGGER'] !~ /ruby/i and (ENV['MEMLOGGER'] =~ /c/i or 
-    `which ruby-bleak-house` !~ /no ruby_bleak_house/)    
-    require 'bleak_house/c'
-    warn "using C instrumentation"
-    CLogger.new
-  else
-    require 'bleak_house/ruby'
-    warn "using pure Ruby instrumentation"
-    warn "(build the patched binary for speed and accuracy improvements)"
-    RubyLogger.new
-  end
-
+  MEMLOGGER = CLogger.new
+    
 end

data/lib/bleak_house/c.rb

@@ -3,11 +3,16 @@ require 'rubygems'
 require 'inline'
 
 class BleakHouse
-  class CLogger < MemLogger
+  class CLogger
 
     MAX_UNIQ_TAGS = 1536 # per frame
     MAX_TAG_LENGTH = 192 # tag plus fully namespaced classname
 
+    def mem_usage
+      a = `ps -o vsz,rss -p #{Process.pid}`.split(/\s+/)[-2..-1].map{|el| el.to_i}
+      [a.first - a.last, a.last]
+    end
+
     inline do |builder|
       builder.include '"node.h"' # struct RNode
       builder.include '"st.h"'  # struct st_table
@@ -97,8 +102,8 @@ class BleakHouse
       # writes a frame to a file
       builder.c <<-EOC
         static void
-        VALUE snapshot(VALUE path, VALUE tag, VALUE _specials) {
-          Check_Type(path, T_STRING);
+        VALUE snapshot(VALUE logfile, VALUE tag, VALUE _specials) {
+          Check_Type(logfile, T_STRING);
           Check_Type(tag, T_STRING);
 
           RVALUE *p, *pend;
@@ -106,12 +111,12 @@ class BleakHouse
 
           int specials = RTEST(_specials);
 
-          FILE *obj_log = fopen(StringValueCStr(path), "r");
+          FILE *obj_log = fopen(StringValueCStr(logfile), "r");
           int is_new;
           if (!(is_new = (obj_log == NULL)))
             fclose(obj_log);
 
-          if ((obj_log = fopen(StringValueCStr(path), "a+")) == NULL)
+          if ((obj_log = fopen(StringValueCStr(logfile), "a+")) == NULL)
             rb_raise(rb_eRuntimeError, "couldn't open snapshot file");
 
           if (is_new) 
@@ -126,6 +131,9 @@ class BleakHouse
           char current_tag[2048];
           int counts[#{MAX_UNIQ_TAGS}];
           int current_pos = 0;
+          
+          int filled_slots = 0;
+          int free_slots = 0;
 
           int i, j;
           for (i = 0; i < rb_gc_heaps_used(); i++) {
@@ -133,6 +141,7 @@ class BleakHouse
             pend = p + heaps[i].limit;
             for (; p < pend; p++) {
               if (p->as.basic.flags) { /* always 0 for freed objects */
+                filled_slots ++;
                 sprintf(current_tag, "");
                 switch (TYPE(p)) {
                   #{RAW_TYPES.map do |type|
@@ -167,10 +176,14 @@ class BleakHouse
                     current_pos ++;
                   }
                 }
+              } else {
+                free_slots ++;
               }
             }
           }
-          
+/*          fprintf(obj_log, \"    :\\"heap usage/ruby heaps\\": %i\\n", rb_gc_heaps_used()); */
+          fprintf(obj_log, \"    :\\"heap usage/filled slots\\": %i\\n", filled_slots);
+          fprintf(obj_log, \"    :\\"heap usage/free slots\\": %i\\n", free_slots);
           for (j = 0; j < current_pos; j++) {
             fprintf(obj_log, "    :\\"%s\\": %i\\n", tags[j], counts[j]);
           }

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: bleak_house
 version: !ruby/object:Gem::Version 
-  version: "5.3"
-date: 2007-05-08 00:00:00 -04:00
+  version: "6"
+date: 2007-05-12 00:00:00 -04:00
 summary: BleakHouse is a Rails plugin for finding memory leaks. It tracks ObjectSpace for your entire app, and produces charts of references by controller, by action, and by object class.
 require_paths: 
 - lib
@@ -27,7 +27,7 @@ signing_key:
 cert_chain: 
 post_install_message: |+
   
-  Thanks for installing Bleak House 5.3. 
+  Thanks for installing Bleak House 6. 
   
   For each Rails app you want to profile, you will need to add the following 
   rake task in RAILS_ROOT/lib/tasks/bleak_house_tasks.rake to be able to run 
@@ -60,9 +60,7 @@ files:
 - ./lib/bleak_house/c.rb
 - ./lib/bleak_house/dispatcher.rb
 - ./lib/bleak_house/gruff_hacks.rb
-- ./lib/bleak_house/mem_logger.rb
 - ./lib/bleak_house/rake_task_redefine_task.rb
-- ./lib/bleak_house/ruby.rb
 - ./lib/bleak_house/support_methods.rb
 - ./lib/bleak_house.rb
 - ./patches/gc.c.patch

data/lib/bleak_house/mem_logger.rb

@@ -1,15 +0,0 @@
-
-class BleakHouse
-  class MemLogger
-    def snapshot
-      raise "abstract method; please require 'ruby' or 'c'"
-    end
-    
-    def mem_usage
-      a = `ps -o vsz,rss -p #{Process.pid}`.split(/\s+/)[-2..-1].map{|el| el.to_i}
-      [a.first - a.last, a.last]
-    end
-
-  end
-end
-

data/lib/bleak_house/ruby.rb

@@ -1,46 +0,0 @@
-
-require 'yaml'
-
-class BleakHouse
-  class RubyLogger < MemLogger
-    SWAP = :"memory usage/swap"
-    RSS = :"memory usage/real"  
-    SEEN = {}
-    CURRENT = {}
-    TAGS = Hash.new(0)
-    
-    def snapshot(path, tag, _specials)
-      CURRENT.clear
-      ObjectSpace.each_object do |obj|
-        CURRENT[obj_id = obj._bleak_house_object_id] = true
-        unless SEEN[obj_id]
-          # symbols will rapidly stabilize
-          SEEN[obj_id] = "#{tag}::::#{obj._bleak_house_class}".to_sym 
-          TAGS[SEEN[obj_id]] += 1
-        end
-      end
-      SEEN.keys.each do |obj_id|
-        TAGS[SEEN.delete(obj_id)] -= 1 unless CURRENT[obj_id]          
-      end
-      CURRENT.clear
-
-      TAGS[SWAP], TAGS[RSS] = mem_usage
-                      
-      write(path)  
-    end        
-    
-    def write(path)
-      exists = File.exist? path
-      File.open(path, 'a+') do |log|
-        dump = YAML.dump([[Time.now.to_i, TAGS]])
-        log.write(exists ? dump[5..-1] : dump)
-      end      
-    end
-    
-  end
-end
-
-class Object
-  alias :_bleak_house_object_id :object_id
-  alias :_bleak_house_class  :class
-end