komamitsu-gc_monitor 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-08-09
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/gc_monitor.rb
+script/console
+script/destroy
+script/generate
+test/test_gc_monitor.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on gc_monitor, see http://gc_monitor.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,72 @@
+= GcMonitor
+GcMonitor is a Ruby module for monitoring GC.
+
+== Examples
+If you want to monitor the specific class, you may include GcMonitor into the class.
+  
+  require 'gc_monitor'
+
+  class Foo
+    attr_accessor :dummy
+    include GcMonitor
+  end
+
+  Foo.release_hook('puts "i am released."')  # This is option hook, for debug.
+
+  15.times do
+    o = Foo.new
+    o.dummy = 'x' * 100 * 1024 * 1024  # For GC.
+    sleep 0.5
+  end
+
+  GcMonitor.list.each{|rec| p rec}  # Array of the objects not garbage collected.
+
+  # You can filter the objects with using :time keyword.
+  GcMonitor.list(:time => 8).each{|rec| p rec}  # Only older than 8 sec.
+
+Then "i am released." will be printed when some Foo instancees are collected. At the last codes, array of the remaining objects will be dumped.
+
+  i am released.
+     :
+  i am released.
+  ["Foo__fdbef6946", {:time=>Sun Aug 09 00:11:49 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8f52", {:time=>Sun Aug 09 00:11:50 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8dfe", {:time=>Sun Aug 09 00:11:55 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8c28", {:time=>Sun Aug 09 00:11:57 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8912", {:time=>Sun Aug 09 00:11:59 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef87c8", {:time=>Sun Aug 09 00:12:00 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef84ee", {:time=>Sun Aug 09 00:12:02 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8386", {:time=>Sun Aug 09 00:12:04 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8110", {:time=>Sun Aug 09 00:12:05 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef7ea4", {:time=>Sun Aug 09 00:12:07 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8f3e", {:time=>Sun Aug 09 00:12:09 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8f34", {:time=>Sun Aug 09 00:12:10 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  ["Foo__fdbef8e76", {:time=>Sun Aug 09 00:12:12 +0900 2009, :caller=>["gc_monitor.rb:136:in `new'", "gc_monitor.rb:136", "gc_monitor.rb:135:in `times'", "gc_monitor.rb:135"]}]
+  i am released.
+     :
+  i am released.
+
+You can monitor almost all of classes. Instead of "include GcMonitor" in the class definition, call GcMonitor.include_in_subclasses. But some classes are not supported, Time (sorry...) and implemented classes in ruby such as String and so on.
+
+  GcMonitor.include_in_subclasses(Object)  # If you monitor IO and the sub classes, set the argument IO.
+
+Finally, there is TCP/IP interface.
+
+  GcMonitor.tcp_server('0.0.0.0', 4321)
+
+And using TCP/IP client, you can monitor the realtime information by 'list' command.
+
+  $ telnet localhost 4321
+  Trying ::1...
+  Trying 127.0.0.1...
+  Connected to localhost.
+  Escape character is '^]'.
+  list
+  now: Sun Aug 09 00:48:59 +0900 2009
+  ["Rational__fdbe7752e", {:time=>Sun Aug 09 00:48:56 +0900 2009, :caller=>["/usr/lib/ruby/1.8/rational.rb:94:in `new'", "/usr/lib/ruby/1.8/rational.rb:94:in `new!'", "/usr/lib/ruby/1.8/rational.rb:337:in `coerce'", "/usr/lib/ruby/1.8/date.rb:503:in `-'", "/usr/lib/ruby/1.8/date.rb:503:in `jd_to_ajd'", "/usr/lib/ruby/1.8/date.rb:754:in `new'", "gc_monitor.rb:155", "gc_monitor.rb:154:in `times'", "gc_monitor.rb:154"]}]
+    :
+  list 8   <== Only the remaining objects older than 8 sec ago.
+    :
+  quit     <== Command for quit TCP/IP interface.
+
+

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/gc_monitor'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'gc_monitor' do
+  self.developer 'FIXME full name', 'FIXME email'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/gc_monitor.rb

@@ -0,0 +1,143 @@
+require 'thread'
+
+module GcMonitor
+  VERSION = '0.0.1'
+
+  class << self
+    def remaining_objects
+      @remaining_objects ||= {}
+      @remaining_objects
+    end
+
+    def mutex
+      @mutex ||= Mutex.new
+      @mutex
+    end
+
+    def include_in_subclasses(klass = Object)
+      ObjectSpace.each_object(class << klass; self; end) do |cls|
+        next if cls.ancestors.include?(Exception)
+        next if [GcMonitor, Time].include?(cls)
+        cls.__send__(:include, GcMonitor)
+      end
+    end
+
+    def key(obj)
+      sprintf("%s__%0x", obj.class, obj.object_id)
+    end
+
+    def regist(obj, caller)
+      mutex.synchronize do
+        remaining_objects[GcMonitor.key(obj)] = {:time => Time.now, :caller => caller}
+      end
+    end
+
+    def release(obj, caller)
+      mutex.synchronize do
+        remaining_objects.delete(GcMonitor.key(obj))
+      end
+    end
+
+    def list(cond = {})
+      mutex.synchronize do
+        cond.keys.inject(remaining_objects) {|objs, cond_key|
+          new_objs = nil
+
+          case cond_key
+          when :time
+            now = Time.now
+            new_objs = objs.select do |obj_k, obj_v|
+              obj_v[:time] < now - cond[cond_key]
+            end
+          else
+            raise "Invalid list option [#{cond_key}]"
+          end
+
+          new_objs
+        }.sort_by{|k, v| v[:time]}
+      end
+    end
+
+    def release_proc(proc_str)
+      lambda {
+        instance_eval(proc_str)
+        GcMonitor.release(self)
+      }
+    end
+
+    def included(base)
+      class << base
+        return if @gc_monitor_included
+        @gc_monitor_included = true
+      end
+      return unless base.private_methods.include?("initialize")
+      begin
+        base.__send__(:alias_method, :initialize_without_gc_monitor_pre, :initialize)
+      rescue NameError
+        return
+      end
+      base.__send__(:alias_method, :initialize, :initialize_with_gc_monitor_pre)
+
+      def base.method_added(name)
+        return unless name == :initialize
+        return if @made_initialize_with_gc_monitor_post
+        @made_initialize_with_gc_monitor_post = true
+        alias_method :initialize_without_gc_monitor_post, :initialize
+        alias_method :initialize, :initialize_with_gc_monitor_post
+      end
+
+      def base.release_hook(proc_str)
+        @@gc_monitor_release_hook = proc_str
+      end
+    end
+
+    def tcp_server(host, port)
+      require 'socket'
+
+      Thread.new do
+        s = TCPServer.new(host, port)
+        loop do
+          Thread.new(s.accept) do |c|
+            while command_line = c.gets.strip
+              next if command_line.empty?
+
+              command, *args = command_line.split(/\s+/)
+
+              case command
+              when 'list'
+                cond = args.empty? ? {} : {:time => Integer(args[0])}
+                c.puts "now: #{Time.now}"
+                GcMonitor.list(cond).each do |obj|
+                  c.puts(obj.inspect)
+                end
+              when 'quit'
+                c.close
+                Thread.exit
+              else
+                c.puts 'unknown command'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  private
+  def regist_gc_monitor(caller)
+    GcMonitor.regist(self, caller)
+    @@gc_monitor_release_hook ||= nil
+    ObjectSpace.define_finalizer(self, GcMonitor.release_proc(@@gc_monitor_release_hook))
+  end
+
+  def initialize_with_gc_monitor_pre(*args, &blk)
+    initialize_without_gc_monitor_pre(*args, &blk)
+    regist_gc_monitor(caller)
+  end
+  
+  def initialize_with_gc_monitor_post(*args, &blk)
+    initialize_without_gc_monitor_post(*args, &blk)
+    regist_gc_monitor(caller)
+  end
+end
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/gc_monitor.rb'}"
+puts "Loading gc_monitor gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_gc_monitor.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGcMonitor < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/gc_monitor'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: komamitsu-gc_monitor
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- komamitsu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby module for monitoring GC
+email: komamitsu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/gc_monitor.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_gc_monitor.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/komamitsu/gc_monitor
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Ruby module for monitoring GC
+test_files: []
+