memory_profiler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e06600592ba32b7ac0b1184619e2c5f5f121af8
+  data.tar.gz: 15408fc5c3da8f1d71c5e156f41d84d34e269fb2
+SHA512:
+  metadata.gz: cb7fd523c0abf056c31fdfaae902a35ebf04122fd422fb21d339afe3a7513fb34f712e8ed7c4422ffa00313aeb037656adde9f62885cfb8574367ea949ad2cc8
+  data.tar.gz: c592a9668fbd024dd176fcebab3938b031efdd09ee42c6840ce61f1a0a5fd0dd0e0f60c3cdaeff4f9119121594ad95daa5eb821f4eb0a7eeeeba09d7e0b51ee6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in memory_profiler.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# MemoryProfiler
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'memory_profiler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memory_profiler
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+

data/lib/memory_profiler/helpers.rb

@@ -0,0 +1,37 @@
+module MemoryProfiler
+  module Helpers
+    def self.guess_gem(path)
+      if /(\/gems\/.*)*\/gems\/(?<gem>[^\/]+)/ =~ path
+        gem
+      elsif /\/rubygems\// =~ path
+        "rubygems"
+      elsif /(?<app>[^\/]+\/(bin|app|lib))/ =~ path
+        app
+      else
+        "other"
+      end
+    end
+
+    # helper to work around GC.start not freeing everything
+    def self.full_gc
+      # attempt to work around lazy sweep, need a cleaner way
+      GC.start while new_count = decreased_count(new_count)
+    end
+
+    def self.decreased_count(old)
+      count = count_objects
+      if !old || count < old
+        count
+      else
+        nil
+      end
+    end
+
+    def self.count_objects
+      i = 0
+      ObjectSpace.each_object do |obj|
+        i += 1
+      end
+    end
+  end
+end

data/lib/memory_profiler/reporter.rb

@@ -0,0 +1,82 @@
+require 'objspace'
+module MemoryProfiler
+  class Reporter
+
+    def self.report(top=50, &block)
+      report = self.new
+      report.run(top,&block)
+    end
+
+    def run(top=50,&block)
+      allocated, rvalue_size = nil
+
+      # calcualte RVALUE
+      GC::Profiler.enable
+      Helpers.full_gc
+      begin
+        data = GC::Profiler.raw_data[0]
+        # so hacky, but no other way
+        rvalue_size = data[:HEAP_TOTAL_SIZE] / data[:HEAP_TOTAL_OBJECTS]
+        GC::Profiler.disable
+      end
+      GC.disable
+
+      ObjectSpace.trace_object_allocations do
+        generation = GC.count
+        block.call
+        allocated = object_list(generation, rvalue_size)
+      end
+
+      GC.enable
+
+      Helpers.full_gc
+
+      retained = StatHash.new
+      ObjectSpace.each_object do |obj|
+        begin
+          found = allocated[obj.__id__]
+          retained[obj.__id__] = found if found
+        rescue
+          # __id__ is not defined, skip it
+        end
+      end
+
+      Results.from_raw(allocated,retained,top)
+
+    end
+
+    def object_list(generation, rvalue_size)
+      results = StatHash.new
+      objs = []
+
+      ObjectSpace.each_object do |obj|
+        objs << obj
+      end
+
+      objs.each do |obj|
+        if generation == ObjectSpace.allocation_generation(obj)
+          file = ObjectSpace.allocation_sourcefile(obj)
+          unless file == __FILE__
+            line = ObjectSpace.allocation_sourceline(obj)
+            class_path = ObjectSpace.allocation_class_path(obj)
+            method_id = ObjectSpace.allocation_method_id(obj)
+
+            class_name = obj.class.name rescue "BasicObject"
+            begin
+              object_id = obj.__id__
+
+              memsize = ObjectSpace.memsize_of(obj) + rvalue_size
+              # compensate for API bug
+              memsize = rvalue_size if memsize > 100_000_000_000
+              results[object_id] = Stat.new(class_name, file, line, class_path, method_id, memsize)
+            rescue
+              # __id__ is not defined, give up
+            end
+          end
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/memory_profiler/results.rb

@@ -0,0 +1,88 @@
+module MemoryProfiler
+  class Results
+
+    def self.register_type(name, lookup)
+      ["allocated","retained"].product(["objects","memory"]).each do |type, metric|
+        full_name = "#{type}_#{metric}_by_#{name}"
+        attr_accessor full_name
+
+        @@lookups ||= []
+        mapped = lookup
+
+        if metric == "memory"
+          mapped = lambda{|stat|
+            [lookup.call(stat), stat.memsize]
+          }
+        end
+
+        @@lookups << [full_name, mapped]
+
+      end
+    end
+
+    register_type :gem, lambda{|stat|
+      Helpers.guess_gem("#{stat.file}")
+    }
+
+    register_type :file, lambda{|stat|
+      stat.file
+    }
+
+    register_type :location, lambda{|stat|
+      "#{stat.file}:#{stat.line}"
+    }
+
+    attr_accessor :total_allocated
+    attr_accessor :total_retained
+
+    def self.from_raw(allocated, retained, top)
+      self.new.register_results(allocated,retained,top)
+    end
+
+    def register_results(allocated, retained, top)
+      @@lookups.each do |name, lookup|
+        mapped = lambda{|tuple|
+            lookup.call(tuple[1])
+        }
+
+        result =
+          if name =~ /^allocated/
+            allocated.top_n(top, &mapped)
+          else
+            retained.top_n(top, &mapped)
+          end
+
+        self.send "#{name}=", result
+        self.total_allocated = allocated.count
+        self.total_retained = retained.count
+      end
+
+      self
+    end
+
+    def pretty_print
+      puts "Total allocated #{total_allocated}"
+      puts "Total retained #{total_retained}"
+      puts
+      ["allocated","retained"]
+        .product(["memory", "objects"])
+        .product(["gem", "file", "location"])
+        .each do |(type, metric), name|
+        dump "#{type} #{metric} by #{name}", self.send("#{type}_#{metric}_by_#{name}")
+      end
+    end
+
+    def dump(description, data)
+      puts description
+      puts "-----------------------------------"
+      if data
+        data.each do |item|
+          puts "#{item[:data]} x #{item[:count]}"
+        end
+      else
+        puts "NO DATA"
+      end
+      puts
+    end
+  end
+end

data/lib/memory_profiler/stat.rb

@@ -0,0 +1,3 @@
+module MemoryProfiler
+  Stat = Struct.new(:class_name, :file, :line, :class_path, :method_id, :memsize)
+end

data/lib/memory_profiler/stat_hash.rb

@@ -0,0 +1,5 @@
+module MemoryProfiler
+  class StatHash < Hash
+    include TopN
+  end
+end

data/lib/memory_profiler/top_n.rb

@@ -0,0 +1,51 @@
+module MemoryProfiler
+  module TopN
+    # Efficient mechanism for finding top_n entries in a list
+    # optional block can specify custom element and weight
+    def top_n(max = 10)
+
+      sorted =
+        if block_given?
+          self.map { |row|
+            yield(row)
+          }
+        else
+          self.dup
+        end
+
+      sorted.sort!
+
+      found = []
+
+      last = sorted[0]
+      count = 0
+      lowest_count = 0
+
+      sorted << nil
+
+      sorted.each do |row|
+
+        current_item, current_count = row
+
+        unless current_item == last
+          if count > lowest_count
+            found << {data: last, count: count}
+          end
+
+          if found.length > max
+            found.sort!{|x,y| x[:count] <=> y[:count] }
+            found.delete_at(0)
+            lowest_count = found[0][:count]
+          end
+
+          count = 0
+          last = current_item
+        end
+
+        count += (current_count || 1) unless row.nil?
+      end
+
+      found.reverse
+    end
+  end
+end

data/lib/memory_profiler/version.rb

@@ -0,0 +1,3 @@
+module MemoryProfiler
+  VERSION = "0.0.1"
+end

data/lib/memory_profiler.rb

@@ -0,0 +1,15 @@
+require "memory_profiler/version"
+require "memory_profiler/helpers"
+require "memory_profiler/top_n"
+require "memory_profiler/stat"
+require "memory_profiler/stat_hash"
+require "memory_profiler/results"
+require "memory_profiler/reporter"
+
+module MemoryProfiler
+  def self.report(top=50,&block)
+    Reporter.report(top,&block)
+  end
+end
+
+

data/memory_profiler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memory_profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memory_profiler"
+  spec.version       = MemoryProfiler::VERSION
+  spec.authors       = ["Sam Saffron"]
+  spec.email         = ["sam.saffron@gmail.com"]
+  spec.description   = %q{Memory profiling routines for Ruby Head}
+  spec.summary       = %q{Memory profiling routines for Ruby Head}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'memory_profiler'
+require 'minitest/pride'

data/test/test_helpers.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module MemoryProfiler
+
+  class TestHelpers < Minitest::Test
+    def assert_gem_parse(expected, path)
+      assert_equal(expected, Helpers.guess_gem(path))
+    end
+
+    def test_rubygems_parse
+      assert_gem_parse( "rubygems",
+                        "/home/sam/.rbenv/versions/ruby-head/lib/ruby/2.1.0/rubygems/version.rb")
+    end
+
+    def test_standard_parse
+      assert_gem_parse( "rails_multisite",
+                        "/home/sam/Source/discourse/vendor/gems/rails_multisite/lib")
+    end
+
+    def test_another_standard_parse
+      assert_gem_parse( "activesupport-3.2.12",
+                        "/home/sam/.rbenv/versions/ruby-head/lib/ruby/gems/2.1.0/gems/activesupport-3.2.12/lib/active_support/dependencies.rb")
+    end
+
+    def test_app_path_parse
+      assert_gem_parse( "discourse/app",
+                        "/home/sam/Source/discourse/app/assets")
+    end
+
+  end
+
+end

data/test/test_reporter.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class TestReporter < Minitest::Test
+  def allocate_strings(n)
+    n.times do
+      ""
+    end
+  end
+
+  def test_counts
+    a = nil
+    result = MemoryProfiler::Reporter.report do
+      allocate_strings(10)
+      a = "hello"
+    end
+    assert_equal(11, result.total_allocated)
+    assert_equal(1, result.total_retained)
+    assert_equal(1, result.retained_objects_by_location.length)
+  end
+
+end

data/test/test_results.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TestResults < Minitest::Test
+  def test_pretty_print_works
+    MemoryProfiler::Results.new.pretty_print
+  end
+end

data/test/test_stat_hash.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+class TestStatHash < Minitest::Test
+
+
+end

data/test/test_top_n.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class ArrayWithTopN < Array
+  include MemoryProfiler::TopN
+end
+
+class TestTopN < Minitest::Test
+
+  def tn(*vals)
+    ArrayWithTopN.new.concat(vals)
+  end
+
+  def test_top_n
+    data = tn( 7,1,2,2,3,3,99,3 )
+    results = data.top_n(2)
+
+    assert_equal([{data: 3, count: 3}, {data: 2, count: 2}], results)
+  end
+
+  def test_top_n_with_block
+    data = tn( 0,3,6,1,4,2 )
+
+    results = data.top_n(2) do |r|
+      r%3
+    end
+
+    assert_equal([{data: 0, count: 3}, {data: 1, count: 2}], results)
+  end
+  def test_top_n_with_block_and_size
+    data = tn( [1,100], [1,10], [2,1], [2,1], [2,1],[3,100] )
+
+    results = data.top_n(2) do |r|
+      r
+    end
+
+    assert_equal([{data: 1, count: 110}, {data: 3, count: 100}], results)
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: memory_profiler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam Saffron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Memory profiling routines for Ruby Head
+email:
+- sam.saffron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/memory_profiler.rb
+- lib/memory_profiler/helpers.rb
+- lib/memory_profiler/reporter.rb
+- lib/memory_profiler/results.rb
+- lib/memory_profiler/stat.rb
+- lib/memory_profiler/stat_hash.rb
+- lib/memory_profiler/top_n.rb
+- lib/memory_profiler/version.rb
+- memory_profiler.gemspec
+- test/test_helper.rb
+- test/test_helpers.rb
+- test/test_reporter.rb
+- test/test_results.rb
+- test/test_stat_hash.rb
+- test/test_top_n.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Memory profiling routines for Ruby Head
+test_files:
+- test/test_helper.rb
+- test/test_helpers.rb
+- test/test_reporter.rb
+- test/test_results.rb
+- test/test_stat_hash.rb
+- test/test_top_n.rb