dike 0.0.1

data/README

@@ -0,0 +1,175 @@
+NAME
+
+  dike
+
+SYNOPSIS
+
+  a simple memory leak detector for ruby with preconfigured rails' hooks.
+
+INSTALL
+
+  gem install dike
+
+URIS
+
+  http://www.codeforpeople.com/lib/ruby/
+  http://rubyforge.org/projects/codeforpeople/
+
+DESCRIPTION
+
+  the concept behind is simple: Object is extended in order that the location
+  of each objects' creation is tracked.  a summarizer command is given to walk
+  ObjectSpace using each objects class and the location if it's creation to
+  detect memory leaks.  not all leaks can be detected and some that are may
+  not really be leaks, but dike provided a simple way to see the hotspots in
+  your code that may potentially be leaking.
+
+EXAMPLES
+
+  PURE RUBY
+
+    require 'dike'
+
+    Dike.log STDERR # the default
+
+    Thread.new do
+      sleep 4.2 and Dike.finger
+    end
+
+    Main.start
+
+
+  RAILS
+
+    file:RAILS_ROOT/config/environment.rb
+      ...
+      require 'dike'
+
+    shell: ./script/server
+
+    shell: curl --silent http://localhost:3000
+
+    shell: cat ./log/dike/0
+    ---
+    - class: String
+      count: 90769
+      trace: []
+    - class: Array
+      count: 18931
+      trace: []
+    - class: Class
+      count: 2
+      trace:
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `each'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets/page/base.rb:1
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `require'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `load'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
+      - /Users/ahoward/site/votelink.com/public/../config/../app/controllers/application.rb:150
+    ...
+
+    shell: curl --silent http://localhost:3000
+
+    shell: cat ./log/dike/1
+    ---
+    - class: String
+      count: 100769
+      trace: []
+    - class: Array
+      count: 19931
+      trace: []
+    - class: Class
+      count: 5
+      trace:
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `each'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets/page/base.rb:1
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `require'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `load'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
+      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
+      - /Users/ahoward/site/votelink.com/public/../config/../app/controllers/application.rb:150
+    ...
+
+    shell: dike ./log/dike
+    --- 
+    - class: Proc
+      count: 65
+      trace: 
+      - /opt/local/lib/ruby/1.8/cgi/session.rb:165:in `new'
+      - /opt/local/lib/ruby/1.8/cgi/session.rb:165:in `callback'
+      - /opt/local/lib/ruby/1.8/cgi/session.rb:299:in `initialize'
+      - /Users/ahoward/src/ruby/dike/dike-0.0.1/lib/dike.rb:233:in `new'
+      - /Users/ahoward/src/ruby/dike/dike-0.0.1/lib/dike.rb:233:in `call'
+      - /Users/ahoward/src/ruby/dike/dike-0.0.1/lib/dike.rb:233:in `new'
+      - /Users/ahoward/site/votelink.com/public/../config/../vendor/rails/actionpack/lib/action_contr oller/cgi_process.rb:123:in `session'
+    ...
+
+SUMMARY
+
+  * the 'Dike.finger' method dumps it's log in a format showing
+
+    class : the class of object being leaked/allocated
+    count : the number instances leaked from the trace location
+    trace : the trace location of object birth
+
+  * loading into a rails environment causes snapshots of the above format to
+    be dumped into RAILS_ROOT/log/dike/ after each request.  each snapshot is
+    incrementally numbered 0, 1, ...
+
+  * the 'dike' command line tool can be used in two ways
+
+      dike directory/with/logs/dike/
+
+      dike old_dump new_dump
+
+    if given a directory 'old_dump' and 'new_dump' are auto-calculated by
+    scanning the directory.  in either case the tool dups a delta running old
+    -->> new.  the delta shows only changes from old to new, so a line like
+
+      - class: Proc
+        count: 3 
+        ...
+
+    means that 3 Proc objects were created between the two dumps.  note that,
+    when given a directory, the default old and new dumps are the oldest and
+    newest dumps respectively, to get fine grained information sumarizing the
+    changes between two requests give the files manually, for example
+  
+      dike ./log/dike/41 ./log/dike/42
+
+  * options that affect logging
+
+    - Dike.filter pattern
+
+        pattern must respond to '===' and each object in ObjectSpace will be
+        compared against it.  for example
+
+          Dile.filter Array
+
+        would cause logging to restrict itself to Array, or sublcasses of
+        Array, only
+
+    - Dike.log io
+
+      set the dike logging object.  the object should respond to 'puts'.
+
+    - Dike.logfactory directory
+
+        cause logging to occur into a new log for each call the 'Dike.finger'.
+        the logs will be auto numbered 0, 1, ...
+
+LIMITATIONS
+
+  not all object creation can be tracked and not all leaks are reported.
+
+AUTHOR
+
+  ara [dot] t [dot] howard [at] gmail [dot] com
+

data/bin/dike

@@ -0,0 +1,66 @@
+#! /usr/bin/env ruby
+require "yaml"
+require "orderedhash"
+
+### TODO objectify - this is crap
+
+### parse argv
+  help = ARGV.delete("-h") || ARGV.delete("--help") || ARGV.delete("help")
+
+  a, b, *ignored = ARGV
+
+  if help or a.nil?
+    puts "dike (directory || old_dump new_dump)"
+    exit 42
+  end
+
+### load/determine files
+  if b
+    old_dump = a
+    new_dump = b
+  else
+    directory = a
+    Dir.chdir directory do
+      list = Dir.glob "*"
+      list = list.grep(%r/^[0-9]+$/).map{|entry| entry.to_i}
+      a, b = list.min, list.max
+      abort "not enough dumps" unless((a and b) and (a != b))
+      old_dump = File.join directory, a.to_s
+      new_dump = File.join directory, b.to_s
+    end
+  end
+
+### compute stats
+  a = open(old_dump){|fd| YAML.load fd}
+  a_index = {}
+  a.each{|record| a_index[record["trace"]] = record}
+
+  b = open(new_dump){|fd| YAML.load fd}
+  b_index = {}
+  b.each{|record| b_index[record["trace"]] = record}
+
+### generate report
+  report = []
+
+  (a_index.keys + b_index.keys).uniq.each do |trace|
+    record = OrderedHash.new
+
+    a_record = a_index[trace] || {}
+    b_record = b_index[trace] || {}
+
+    klass = a_record["class"] || b_record["class"]
+    count = b_record["count"].to_i - a_record["count"].to_i
+
+    next unless count > 0 
+
+    record["class"] = klass 
+    record["count"] = count 
+    record["trace"] = trace.clone
+
+    report << record
+  end
+
+  report =
+    report.sort_by{|record| [-record["count"], record["class"]]}
+
+  y report

data/gemspec.rb

@@ -0,0 +1,28 @@
+
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  $VERBOSE = nil
+  spec.name = lib 
+  spec.version = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = lib 
+
+  spec.files = Dir::glob "**/**"
+  spec.executables = Dir::glob("bin/*").map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+  spec.autorequire = lib
+
+  spec.has_rdoc = File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+  #spec.add_dependency 'lib', '>= version'
+
+  spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/install.rb

@@ -0,0 +1,210 @@
+#!/usr/bin/env ruby
+require 'rbconfig'
+require 'find'
+require 'ftools'
+require 'tempfile'
+include Config
+
+LIBDIR      = "lib"
+LIBDIR_MODE = 0644
+
+BINDIR      = "bin"
+BINDIR_MODE = 0755
+
+
+$srcdir            = CONFIG["srcdir"]
+$version           = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+$libdir            = File.join(CONFIG["libdir"], "ruby", $version)
+$archdir           = File.join($libdir, CONFIG["arch"])
+$site_libdir       = $:.find {|x| x =~ /site_ruby$/}
+$bindir            = CONFIG["bindir"] || CONFIG['BINDIR']
+$ruby_install_name = CONFIG['ruby_install_name'] || CONFIG['RUBY_INSTALL_NAME'] || 'ruby'
+$ruby_ext          = CONFIG['EXEEXT'] || ''
+$ruby              = File.join($bindir, ($ruby_install_name + $ruby_ext))
+
+if !$site_libdir
+  $site_libdir = File.join($libdir, "site_ruby")
+elsif $site_libdir !~ %r/#{Regexp.quote($version)}/
+  $site_libdir = File.join($site_libdir, $version)
+end
+
+def install_rb(srcdir=nil, destdir=nil, mode=nil, bin=nil)
+#{{{
+  path   = []
+  dir    = []
+  Find.find(srcdir) do |f|
+    next unless FileTest.file?(f)
+    next if (f = f[srcdir.length+1..-1]) == nil
+    next if (/CVS$/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    path.push f
+    dir |= [File.dirname(f)]
+  end
+  for f in dir
+    next if f == "."
+    next if f == "CVS"
+    File::makedirs(File.join(destdir, f))
+  end
+  for f in path
+    next if (/\~$/ =~ f)
+    next if (/^\./ =~ File.basename(f))
+    unless bin
+      File::install(File.join(srcdir, f), File.join(destdir, f), mode, true)
+    else
+      from = File.join(srcdir, f)
+      to = File.join(destdir, f)
+      shebangify(from) do |sf|
+        $deferr.print from, " -> ", File::catname(from, to), "\n"
+        $deferr.printf "chmod %04o %s\n", mode, to 
+        File::install(sf, to, mode, false)
+      end
+    end
+  end
+#}}}
+end
+def shebangify f
+#{{{
+  open(f) do |fd|
+    buf = fd.read 42 
+    if buf =~ %r/^\s*#\s*!.*ruby/o
+      ftmp = Tempfile::new("#{ $$ }_#{ File::basename(f) }")
+      begin
+        fd.rewind
+        ftmp.puts "#!#{ $ruby  }"
+        while((buf = fd.read(8192)))
+          ftmp.write buf
+        end
+        ftmp.close
+        yield ftmp.path
+      ensure
+        ftmp.close!
+      end
+    else
+      yield f
+    end
+  end
+#}}}
+end
+def ARGV.switch
+#{{{
+  return nil if self.empty?
+  arg = self.shift
+  return nil if arg == '--'
+  if arg =~ /^-(.)(.*)/
+    return arg if $1 == '-'
+    raise 'unknown switch "-"' if $2.index('-')
+    self.unshift "-#{$2}" if $2.size > 0
+    "-#{$1}"
+  else
+    self.unshift arg
+    nil
+  end
+#}}}
+end
+def ARGV.req_arg
+#{{{
+  self.shift || raise('missing argument')
+#}}}
+end
+def linkify d, linked = []
+#--{{{
+  if test ?d, d
+    versioned = Dir[ File::join(d, "*-[0-9].[0-9].[0-9].rb") ]
+    versioned.each do |v| 
+      src, dst = v, v.gsub(%r/\-[\d\.]+\.rb$/, '.rb')
+      lnk = nil
+      begin
+        if test ?l, dst
+          lnk = "#{ dst }.lnk"
+          puts "#{ dst } -> #{ lnk }"
+          File::rename dst, lnk
+        end
+        unless test ?e, dst
+          puts "#{ src } -> #{ dst }"
+          File::copy src, dst 
+          linked << dst
+        end
+      ensure
+        if lnk
+          at_exit do
+            puts "#{ lnk } -> #{ dst }"
+            File::rename lnk, dst
+          end
+        end
+      end
+    end
+  end
+  linked
+#--}}}
+end
+
+
+#
+# main program
+#
+
+libdir = $site_libdir
+bindir = $bindir
+no_linkify = false
+linked = nil
+help = false
+
+usage = <<-usage
+  #{ File::basename $0 }
+    -d, --destdir    <destdir>
+    -l, --libdir     <libdir>
+    -b, --bindir     <bindir>
+    -r, --ruby       <ruby>
+    -n, --no_linkify
+    -s, --sudo
+    -h, --help
+usage
+
+begin
+  while switch = ARGV.switch
+    case switch
+    when '-d', '--destdir'
+      libdir = ARGV.req_arg
+    when '-l', '--libdir'
+      libdir = ARGV.req_arg
+    when '-b', '--bindir'
+      bindir = ARGV.req_arg
+    when '-r', '--ruby'
+      $ruby = ARGV.req_arg
+    when '-n', '--no_linkify'
+      no_linkify = true
+    when '-s', '--sudo'
+      sudo = 'sudo' 
+    when '-h', '--help'
+      help = true
+    else
+      raise "unknown switch #{switch.dump}"
+    end
+  end
+rescue
+  STDERR.puts $!.to_s
+  STDERR.puts usage
+  exit 1
+end    
+
+if help
+  STDOUT.puts usage
+  exit
+end
+
+system "#{ sudo } #{ $ruby } pre-install.rb" if test(?s, 'pre-install.rb')
+
+unless no_linkify
+  linked = linkify('lib') + linkify('bin')
+end
+
+system "#{ $ruby } extconf.rb && make && #{ sudo } make install" if test(?s, 'extconf.rb')
+
+install_rb(LIBDIR, libdir, LIBDIR_MODE)
+install_rb(BINDIR, bindir, BINDIR_MODE, bin=true)
+
+if linked
+  linked.each{|path| File::rm_f path}
+end
+
+system "#{ sudo } #{ $ruby } post-install.rb" if test(?s, 'post-install.rb')

data/lib/dike.rb

@@ -0,0 +1,264 @@
+require "yaml"
+require "attributes"
+require "orderedhash"
+
+module Dike
+  class LogFactory
+    attribute "directory"
+    attribute "current"
+
+    def initialize directory = "dike"
+      require "fileutils"
+      FileUtils.mkdir_p directory
+      @directory = directory
+      list = Dir.glob(File.join(@directory, "*"))
+      list = list.grep(%r/^[0-9]+$/).map{|entry| entry.to_i}
+      @current = list.max || -1 
+    end
+
+    def next &block
+      if block
+        open File.join(@directory, self.next.to_s), "w", &block 
+      else
+        @current += 1
+      end
+    end
+  end
+
+  class << self
+    Objects = Hash.new
+
+    def mark_birth object, stacktrace
+      return if Objects[object_id]
+      object_id = Object::Methods["object_id"].bind(object).call
+      Objects[object_id] = stacktrace
+      ObjectSpace.define_finalizer object, &mark_birth_finalizer(object_id)
+    end
+
+    def mark_birth_finalizer object_id
+      lambda{ Objects.delete object_id }
+    end
+
+    Ignore = Hash.new
+
+    Ignore[Ignore.object_id] = true
+
+    class << Ignore
+      def transaction
+        state = clone
+        Ignore[state.object_id] = true
+        yield
+      ensure
+        clear
+        update state
+        Ignore.delete state.object_id
+        state = nil
+      end
+    end
+
+    def ignore *list
+      list.flatten.each do |object|
+        object_id = ::Object::Methods["object_id"].bind(object).call
+        Ignore[object_id] = true
+        #ObjectSpace.define_finalizer object, &ignore_finalizer(object_id)
+      end
+    end
+
+    def ignored &block
+      object = block.call
+      ignore object
+      object
+    end
+
+    def ignore_finalizer object_id
+      lambda{ Ignore.delete object_id }
+    end
+
+    attribute("filter"){ Object }
+    attribute("threshold"){ Struct.new(:class, :code, :object)[42, 42, 1] }
+    attribute("log"){ STDERR }
+    attribute("logfactory"){ nil }
+
+    def finger options = {} 
+      Thread.critical = true
+
+      begin
+        GC.start
+
+        count, code = :remembered 
+
+        Ignore.transaction do
+          count = Hash.new 0
+          ignore count
+
+          code = Hash.new do |h,k|
+            sh = Hash.new 0
+            ignore sh
+            h[k] = sh 
+          end
+          ignore code
+    
+          ObjectSpace.each_object(filter) do |object|
+            m = Object::Methods["object_id"].bind object
+            ignore m
+            object_id = m.call
+
+            next if Ignore[object_id]
+
+            m = Object::Methods["class"].bind object
+            ignore m
+            klass = m.call 
+
+            defined_at = Objects[object_id]
+            count[klass] += 1 
+            code[klass][defined_at] += 1 
+          end
+        end
+
+        GC.start
+
+        worst_klasses =
+          count.to_a.sort_by{|pair| pair.last}.last(threshold.class).reverse
+
+        count.clear
+        count = nil
+
+=begin
+        report = []
+=end
+        total = 0
+
+        logging do |log|
+          log.puts "---"
+
+          worst_klasses.each do |klass, count|
+            worst_code = code[klass].to_a.sort_by{|pair| pair.last}.last(threshold.code).reverse
+
+            name = Class::Methods["name"].bind(klass).call.to_s
+            name = Class::Methods["inspect"].bind(klass).call.to_s if name.empty?
+            name = 'UNKNOWN' if name.empty?
+
+            worst_code.each do |stacktrace, count|
+              next unless count > threshold.object
+=begin
+
+  TODO - figure out why the hell yaml leaks so bad!
+
+              report << OrderedHash[
+                'class', name,
+                'count', count,
+                'stacktrace', (stacktrace ? stacktrace.clone : []),
+              ]
+=end
+              trace = stacktrace ? stacktrace.clone : []
+
+            ### roll our own because yaml leaks!
+              log.puts "- class: #{ name }"
+              log.puts "  count: #{ count }"
+              if trace.empty?
+                log.puts "  trace: []"
+              else
+                log.puts "  trace:"
+                trace.each do |line|
+                  log.puts "  - #{ line }"
+                end
+              end
+            end
+
+            worst_code.clear
+            worst_code = nil
+
+            total += count
+          end
+        end
+
+=begin
+        logging do |log|
+          log.puts report.to_yaml
+          log.flush
+        end
+
+        report.clear
+        report = nil
+        GC.start
+=end
+
+        worst_klasses.clear
+        worst_klasses = nil
+
+        code.clear
+        code = nil
+
+        GC.start
+
+        total
+      ensure
+        Thread.critical = false 
+      end
+    end
+
+    def logging &block
+      logfactory ? logfactory.next(&block) : block.call(log)
+    end
+  end
+
+  class ::Object
+    Methods = instance_methods.inject(Hash.new){|h, m| h.update m => instance_method(m)}
+    Methods["initialize"] = instance_method "initialize"
+    Dike.ignore Methods
+    Methods.each{|k,v| Dike.ignore k, v}
+
+    verbose = $VERBOSE
+    begin
+      $VERBOSE = nil
+      def initialize *a, &b
+        Methods["initialize"].bind(self).call *a, &b
+      ensure
+        Dike.mark_birth self, caller rescue nil
+      end
+    ensure
+      $VERBOSE = verbose 
+    end
+  end
+
+  class ::Class
+    Methods = instance_methods.inject(Hash.new){|h, m| h.update m => instance_method(m)}
+    Dike.ignore Methods
+    Methods.each{|k,v| Dike.ignore k, v}
+
+    verbose = $VERBOSE
+    begin
+      $VERBOSE = nil
+      def new *a, &b
+        object = Methods["new"].bind(self).call *a, &b
+      ensure
+        Dike.mark_birth object, caller rescue nil
+      end
+      def allocate *a, &b
+        object = Methods["allocate"].bind(self).call *a, &b
+      ensure
+        Dike.mark_birth object, caller rescue nil
+      end
+    ensure
+      $VERBOSE = verbose 
+    end
+  end
+
+  class ::Module
+    Methods = instance_methods.inject(Hash.new){|h, m| h.update m => instance_method(m)}
+    Dike.ignore Methods
+    Methods.each{|k,v| Dike.ignore k, v}
+  end
+end
+
+
+if defined? Rails 
+  Dike.logfactory Dike::LogFactory.new(File.join(RAILS_ROOT, "log", "dike"))
+
+  ActionController::Base.module_eval do
+    after_filter do |controller|
+      Dike.finger
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: dike
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-09-27 00:00:00 -06:00
+summary: dike
+require_paths: 
+- lib
+email: ara.t.howard@gmail.com
+homepage: http://codeforpeople.com/lib/ruby/dike/
+rubyforge_project: 
+description: 
+autorequire: dike
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Ara T. Howard
+files: 
+- bin
+- bin/dike
+- dike-0.0.1.gem
+- gemspec.rb
+- install.rb
+- lib
+- lib/dike.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- dike
+extensions: []
+
+requirements: []
+
+dependencies: []
+