@@ -1,5 +1,5 @@ -v4.1.1. Update bundled Ruby to patchlevel 230. +v4.1.1. Update bundled Ruby to patchlevel 230. v4.1. Support calculating deltas in analyze utility. CHANGELOG @@ -1,13 +1,13 @@ BleakHouse -A library for finding memory leaks. +A library for finding memory leaks. == License -Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2006 Eric Hodel and used with permission. See the included LICENSE_BSD file. +Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2006 Eric Hodel and used with permission. See the included LICENSE_BSD file. -The public certificate for this gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem]. +The public certificate for this gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem]. If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails. @@ -43,10 +43,10 @@ First, to setup the app for profiling, add the following at the bottom of <tt>co require 'bleak_house' if ENV['BLEAK_HOUSE'] Then, to engage the logger (possibly in a live deployment situation), start a server instance as so: - RAILS_ENV=production BLEAK_HOUSE=1 ruby-bleak-house ./script/server + RAILS_ENV=production BLEAK_HOUSE=1 ruby-bleak-house ./script/server Look for the message: - ** Bleakhouse: installed + ** Bleakhouse: installed Exercise your app. After a couple hundred requests, hit CTRL-C. The server will stop and BleakHouse will produce a dumpfile in <tt>/tmp</tt>: @@ -68,10 +68,10 @@ To analyze it, just run the listed command. The top 20 leakiest lines will be li 935 /opt/local//lib/ruby/site_ruby/1.8/rubygems/specification.rb:557:String 834 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:146:Array ... - + You can pass an integer as the second parameter to <tt>bleak</tt> if you want to see more lines than the default. -The underscored types are special Ruby internal structs, but can be real leaks just as easily as fullblown classes. +The underscored types are special Ruby internal structs, but can be real leaks just as easily as fullblown classes. = Extras @@ -95,11 +95,11 @@ If BleakHouse doesn't report any heap growth but you still have memory growth, y == Methods -The easiest way to fix a leak is to make it repeatable. +The easiest way to fix a leak is to make it repeatable. First, write a script that exercises your app in a deterministic way. Run it for a small number of loops; then run <tt>bleak</tt>. Then run it for a larger number of loops, and run <tt>bleak</tt> again. The lines that grow significantly between runs are your leaks for that codepath. -Now, look at those lines in the source and try to figure out what references them. Where do the return values go? Add some breakpoints or output backtraces to <tt>STDERR</tt> as you go. Eventually you should find a point where it is relatively clear that a reference is getting maintained. +Now, look at those lines in the source and try to figure out what references them. Where do the return values go? Add some breakpoints or output backtraces to <tt>STDERR</tt> as you go. Eventually you should find a point where it is relatively clear that a reference is getting maintained. Try to remove that reference, run your script again, and see if the object counts have dropped. README @@ -2,11 +2,11 @@ require 'echoe' Echoe.new("bleak_house") do |p| - p.author = "Evan Weaver" + p.author = "Evan Weaver" p.project = "fauna" - p.summary = "A library for finding memory leaks." - p.url = "http://blog.evanweaver.com/files/doc/fauna/bleak_house/" + p.summary = "A library for finding memory leaks." + p.url = "http://blog.evanweaver.com/files/doc/fauna/bleak_house/" p.docs_host = 'blog.evanweaver.com:~/www/bax/public/files/doc/' - p.require_signed = true + p.require_signed = true p.rdoc_pattern = /^ext.*\.c|lib.*|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/ end Rakefile @@ -1,4 +1,6 @@ +* Figure out why Rubygems 1.2.0 is a hard requirement + * Override Kernel#eval to always include sourceline macros. * Mimic Valgrind's output format as much as possible * Log remaining heap reference traces TODO @@ -23,49 +23,49 @@ def which(basename) end end -if which('ruby-bleak-house') and +if which('ruby-bleak-house') and `ruby-bleak-house -e "puts RUBY_PATCHLEVEL"`.to_i >= 902 # OK else - # Build + # Build Dir.chdir(tmp) do build_dir = "bleak_house" binary_dir = File.dirname(`which ruby`) - + FileUtils.rm_rf(build_dir) rescue nil if File.exist? build_dir raise "Could not delete previous build dir #{Dir.pwd}/#{build_dir}" end - + Dir.mkdir(build_dir) - + begin Dir.chdir(build_dir) do - + # Copy Ruby source bz2 = "ruby-1.8.6-p230.tar.bz2" FileUtils.copy "#{source_dir}/#{bz2}", bz2 - + # Extract system("tar xjf #{bz2} > tar.log 2>&1") File.delete bz2 - + Dir.chdir("ruby-1.8.6-p230") do - + # Patch, configure, and build ["valgrind", "configure", "gc"].each do |patch| system("patch -p0 < \'#{source_dir}/#{patch}.patch\' > ../#{patch}_patch.log 2>&1") end - + system("./configure --prefix=#{binary_dir[0..-5]} > ../configure.log 2>&1") # --with-static-linked-ext - + # Patch the makefile for arch/sitedir makefile = File.read('Makefile') %w{arch sitearch sitedir}.each do | key | makefile.gsub!(/#{key} = .*/, "#{key} = #{Config::CONFIG[key]}") end File.open('Makefile', 'w'){|f| f.puts(makefile)} - + # Patch the config.h for constants constants = { 'RUBY_LIB' => 'rubylibdir', #define RUBY_LIB "/usr/lib/ruby/1.8" @@ -80,13 +80,13 @@ else config_h.gsub!(/#define #{const} .*/, "#define #{const} \"#{Config::CONFIG[key]}\"") end File.open('config.h', 'w'){|f| f.puts(config_h)} - + system("make > ../make.log 2>&1") - + binary = "#{binary_dir}/ruby-bleak-house" - + # Install binary - if File.exist? "ruby" + if File.exist? "ruby" # Avoid "Text file busy" error File.delete binary if File.exist? binary exec("cp ./ruby #{binary}; chmod 755 #{binary}") @@ -94,13 +94,13 @@ else raise "Binary did not build" end end - + end rescue Object => e raise "Please see the last modified log file in #{tmp}#{build_dir}, perhaps\nit will contain a clue.\n#{e.to_s}" end - + # Success - end - + end + end ext/build_ruby.rb @@ -4,7 +4,7 @@ module BleakHouse def self.write_to_log(filename, message) File.open(filename, 'a') { |fp| fp.write("#{message}\n") } end - + def self.execute(command) puts "$}- #{command}" exit -1 unless system(command) ext/extconf.rb @@ -19,8 +19,8 @@ static VALUE snapshot(VALUE self, VALUE _logfile) { Check_Type(_logfile, T_STRING); RVALUE *obj, *obj_end; - st_table_entry *sym; - + st_table_entry *sym; + struct heaps_slot * heaps = rb_gc_heap_slots(); struct st_table * sym_tbl = rb_parse_sym_tbl(); @@ -37,15 +37,15 @@ static VALUE snapshot(VALUE self, VALUE _logfile) { int filled_slots = 0; int free_slots = 0; - int i; + int i; char * chr; - + for (i = 0; i < 3; i++) { /* request GC run */ rb_funcall(rb_mGC, rb_intern("start"), 0); rb_thread_schedule(); } - + /* walk the heap */ for (i = 0; i < rb_gc_heaps_used(); i++) { obj = heaps[i].slot; @@ -53,27 +53,27 @@ static VALUE snapshot(VALUE self, VALUE _logfile) { for (; obj < obj_end; obj++) { if (obj->as.basic.flags) { /* always 0 for freed objects */ filled_slots ++; - + /* write the source file*/ if (obj->file) { - chr = obj->file; + chr = obj->file; if (*chr != '\0') { fprintf(logfile, "%s", obj->file); } else { - fprintf(logfile, "__empty__"); + fprintf(logfile, "__empty__"); } } else { fprintf(logfile, "__null__"); } - + /* write the source line */ - fprintf(logfile, ":"); + fprintf(logfile, ":"); if (obj->line) { fprintf(logfile, "%i", obj->line); } else { fprintf(logfile, "__null__"); } - + /* write the class */ fprintf(logfile, ":"); switch (TYPE(obj)) { @@ -96,7 +96,7 @@ static VALUE snapshot(VALUE self, VALUE _logfile) { fprintf(logfile, rb_obj_classname((VALUE)obj)); } } - + /* write newline */ fprintf(logfile, "\n"); } else { @@ -104,30 +104,30 @@ static VALUE snapshot(VALUE self, VALUE _logfile) { } } } - - /* walk the symbol table */ + + /* walk the symbol table */ /* hashed = lookup_builtin("Symbol"); for (i = 0; i < sym_tbl->num_bins; i++) { for (sym = sym_tbl->bins[i]; sym != 0; sym = sym->next) { fprintf(logfile, "%i,%lu\n", hashed + 1, sym->record); } } */ - + fprintf(logfile, "%i filled\n", filled_slots); fprintf(logfile, "%i free\n", free_slots); fclose(logfile); - + return Qnil; } /* -This class performs the actual object logging of BleakHouse. To use it directly, you need to make calls to BleakHouse.snapshot. +This class performs the actual object logging of BleakHouse. To use it directly, you need to make calls to BleakHouse.snapshot. -By default, BleakHouse records a snapshot on exit. You can disable this by setting the environment variable <tt>NO_EXIT_HANDLER</tt> before startup. +By default, BleakHouse records a snapshot on exit. You can disable this by setting the environment variable <tt>NO_EXIT_HANDLER</tt> before startup. -It is also possible to externally trigger the snapshot at any time by sending <tt>SIGUSR2</tt> to the process. +It is also possible to externally trigger the snapshot at any time by sending <tt>SIGUSR2</tt> to the process. == Example @@ -138,7 +138,7 @@ At the start of your app, put: Run your app. Once it exits, analyze your data: bleak /path/to/logfile - + */ void Init_snapshot() ext/snapshot.c @@ -31,7 +31,7 @@ typedef struct RVALUE { struct SCOPE scope; } as; char *file; - int line; + int line; } RVALUE; struct heaps_slot { ext/snapshot.h @@ -7,31 +7,31 @@ module BleakHouse lines = args.last[/^\d+$/] ? args.pop.to_i : 20 raise "Can't diff more than 2 files" if args.size > 2 - - outputs = args.map do |file| + + outputs = args.map do |file| filled, free = `tail -n 2 #{file}`.split("\n") unless filled =~ /filled/ and free =~ /free/ raise "#{file} is incomplete or corrupted" end - - length = `wc #{file}`.to_i - 2 - cmd = ENV['NO_TRACE'] ? "awk -F: '{print $3}' " + file : "cat #{file}" + + length = `wc #{file}`.to_i - 2 + cmd = ENV['NO_TRACE'] ? "awk -F: '{print $3}' " + file : "cat #{file}" cmd += " | sort | uniq -c | sort -nr | head -#{lines}" - + ["#{length} total objects", "#{filled} heap slots", "#{free} heap slots"] + `#{cmd}`.split("\n") end - + if outputs.size == 1 # Just output the data - puts "Displaying top #{lines} most common line/class pairs" + puts "Displaying top #{lines} most common line/class pairs" puts outputs.first else - puts "Displaying change in top #{lines} most common line/class pairs" + puts "Displaying change in top #{lines} most common line/class pairs" puts diff(outputs) end end - + def self.diff(outputs) # Calculate the diff diff = Hash.new(0) @@ -47,8 +47,8 @@ module BleakHouse -value end.map do |key, value| "#{value.to_s.rjust(6)} #{key}" - end + end end - + end end lib/bleak_house/analyzer.rb @@ -6,7 +6,7 @@ module BleakHouse filename = "/tmp/bleak.#{Process.pid}.#{@count}.dump" STDERR.puts "** BleakHouse: working..." BleakHouse.snapshot(filename) - STDERR.puts "** BleakHouse: complete\n** Bleakhouse: Run 'bleak #{filename}' to analyze." + STDERR.puts "** BleakHouse: complete\n** Bleakhouse: Run 'bleak #{filename}' to analyze." @count += 1 end end @@ -20,6 +20,4 @@ end Kernel.trap("USR2") do BleakHouse.hook -end - - +end \ No newline at end of file lib/bleak_house/hook.rb @@ -53,7 +53,7 @@ Index: configure @@ -15768,6 +15766,172 @@ fi fi - + +# Check whether --enable-valgrind was given. +if test "${enable_valgrind+set}" = set; then + enableval=$enable_valgrind; want_valgrind=$enableval @@ -221,8 +221,8 @@ Index: configure +fi + DEFAULT_KCODE="KCODE_NONE" - - + + @@ -17854,6 +18018,7 @@ ARCHFILE!$ARCHFILE$ac_delim RDOCTARGET!$RDOCTARGET$ac_delim @@ -234,7 +234,7 @@ Index: configure @@ -17887,7 +18052,7 @@ LTLIBOBJS!$LTLIBOBJS$ac_delim _ACEOF - + - if test `sed -n "s/.*$ac_delim\$/X/p" conf$$subs.sed | grep -c X` = 42; then + if test `sed -n "s/.*$ac_delim\$/X/p" conf$$subs.sed | grep -c X` = 43; then break ruby/configure.patch @@ -5,8 +5,8 @@ Index: parse.y @@ -6168,6 +6168,11 @@ * :wait2, :$>] */ - -+struct st_table * + ++struct st_table * +rb_parse_sym_tbl() { + return sym_tbl; +} @@ -21,8 +21,8 @@ Index: parse.c @@ -11157,6 +11157,11 @@ * :wait2, :$>] */ - -+struct st_table * + ++struct st_table * +rb_parse_sym_tbl() { + return sym_tbl; +} @@ -37,7 +37,7 @@ Index: gc.c @@ -260,8 +260,6 @@ } } - + -#undef GC_DEBUG - void @@ -52,12 +52,12 @@ Index: gc.c int line; -#endif } RVALUE; - + #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__CYGWIN__) @@ -318,6 +314,22 @@ static int heaps_length = 0; static int heaps_used = 0; - + +struct heaps_slot * +rb_gc_heap_slots() +{ @@ -76,15 +76,15 @@ Index: gc.c + #define HEAP_MIN_SLOTS 10000 static int heap_slots = HEAP_MIN_SLOTS; - + @@ -386,16 +398,19 @@ rb_newobj() { VALUE obj; - -+ ++ if (!freelist) garbage_collect(); - + obj = (VALUE)freelist; freelist = freelist->as.free.next; - MEMZERO((void*)obj, RVALUE, 1); @@ -93,16 +93,16 @@ Index: gc.c - RANY(obj)->line = ruby_sourceline; -#endif + -+ MEMZERO((void*)obj, RVALUE, 1); ++ MEMZERO((void*)obj, RVALUE, 1); + + if (ruby_current_node && ruby_current_node->nd_file) { + RANY(obj)->file = ruby_current_node->nd_file; + RANY(obj)->line = nd_line(ruby_current_node); -+ } -+ ++ } ++ return obj; } - + @@ -732,7 +747,10 @@ if (rb_special_const_p(ptr)) return; /* special const not marked */ if (obj->as.basic.flags == 0) return; /* free cell */ @@ -111,7 +111,7 @@ Index: gc.c obj->as.basic.flags |= FL_MARK; + /* mark our new reference point for sourcefile objects */ + mark_source_filename(RANY(obj)->file); - + if (lev > GC_LEVEL_MAX || (lev == 0 && ruby_stack_check())) { if (!mark_stack_overflow) { Index: version.h @@ -124,6 +124,6 @@ Index: version.h #define RUBY_RELEASE_CODE 20080620 -#define RUBY_PATCHLEVEL 230 +#define RUBY_PATCHLEVEL 902 - + #define RUBY_VERSION_MAJOR 1 #define RUBY_VERSION_MINOR 8 ruby/gc.patch @@ -3,14 +3,14 @@ Index: Makefile.in --- Makefile.in (revision 6439) +++ Makefile.in (working copy) @@ -34,7 +34,7 @@ - + empty = OUTFLAG = @OUTFLAG@$(empty) -CFLAGS = @CFLAGS@ @XCFLAGS@ @ARCH_FLAG@ +CFLAGS = @CFLAGS@ @XCFLAGS@ @ARCH_FLAG@ @VALGRIND_CFLAGS@ CPPFLAGS = -I. -I$(srcdir) @CPPFLAGS@ LDFLAGS = @STATIC@ $(CFLAGS) @LDFLAGS@ - EXTLDFLAGS = + EXTLDFLAGS = Index: configure.in =================================================================== --- configure.in (revision 6439) @@ -18,7 +18,7 @@ Index: configure.in @@ -895,6 +895,22 @@ fi fi - + +AC_ARG_ENABLE(valgrind, + [ --enable-valgrind use valgrind support], + [want_valgrind=$enableval], [want_valgrind=auto]) @@ -37,10 +37,10 @@ Index: configure.in + dnl default value for $KANJI DEFAULT_KCODE="KCODE_NONE" - + @@ -1504,6 +1520,7 @@ esac - + AC_SUBST(XCFLAGS)dnl +AC_SUBST(VALGRIND_CFLAGS)dnl AC_SUBST(XLDFLAGS)dnl @@ -53,7 +53,7 @@ Index: eval.c @@ -28,6 +28,12 @@ #define EXIT_FAILURE 1 #endif - + +#ifdef HAVE_VALGRIND +#include <valgrind/memcheck.h> +#else @@ -61,7 +61,7 @@ Index: eval.c +#endif + #include <stdio.h> - + #include "st.h" @@ -5225,6 +5231,9 @@ int pcall; @@ -80,7 +80,7 @@ Index: gc.c @@ -30,6 +30,12 @@ #include <sys/resource.h> #endif - + +#ifdef HAVE_VALGRIND +#include <valgrind/memcheck.h> +#else @@ -93,7 +93,7 @@ Index: gc.c @@ -93,6 +99,9 @@ { void *mem; - + + VALGRIND_MAKE_MEM_DEFINED(&malloc_increase, sizeof(malloc_increase)); + VALGRIND_MAKE_MEM_DEFINED(&malloc_limit, sizeof(malloc_limit)); + @@ -113,7 +113,7 @@ Index: gc.c @@ -713,7 +725,10 @@ { register RVALUE *obj; - + + VALGRIND_MAKE_MEM_DEFINED(&ptr, sizeof(ptr)); obj = RANY(ptr); + VALGRIND_MAKE_MEM_DEFINED(obj, sizeof(*obj)); ruby/valgrind.patch @@ -6,7 +6,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../../lib") require 'bleak_house' Dike.logfactory("/tmp") -if ARGV[0] +if ARGV[0] Dike.finger exec('cat /tmp/0') else test/benchmark/bench.rb @@ -7,11 +7,11 @@ require 'rubygems' require 'echoe' require 'test/unit' require 'bleak_house' - + class BleakHouseTest < Test::Unit::TestCase # Match the default hook filename, for convenience - FILE = "/tmp/bleak.#{Process.pid}.0.dump" + FILE = "/tmp/bleak.#{Process.pid}.0.dump" def setup File.delete FILE rescue nil @@ -22,15 +22,15 @@ class BleakHouseTest < Test::Unit::TestCase BleakHouse.snapshot(FILE) assert File.exist?(FILE) assert BleakHouse.heaps_used > 0 - assert BleakHouse.heaps_length > 0 + assert BleakHouse.heaps_length > 0 end - + def test_exception assert_raises(RuntimeError) do BleakHouse.snapshot("/") - end + end end - + def test_analyze BleakHouse.snapshot(FILE) Dir.chdir(File.dirname(__FILE__) + "/../../bin") do @@ -41,7 +41,7 @@ class BleakHouseTest < Test::Unit::TestCase assert_match(/\d+ __null__:__null__:__node__/, output[4]) end end - + def test_signal Echoe.silence do system("kill -s SIGUSR2 #{Process.pid}") test/unit/test_bleak_house.rb 4cf0bff0c477851eb9de97059f40a26d4b648a4a Manfred Stienstra manfred@fngtps.com http://github.com/fauna/bleak_house/commit/c05a425b2f09a5d07c4e4f8c3e41333191c7b53b c05a425b2f09a5d07c4e4f8c3e41333191c7b53b 2009-02-02T01:01:20-08:00 2008-11-21T13:10:39-08:00 Add TODO and fix whitespace. Signed-off-by: Snax Fauna <evan+fauna@cloudbur.st> a6e29791ef13bd6fd6626cd0f2574114371e1689 Snax Fauna evan+fauna@cloudbur.st