memory 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc40099542a524f07fbf5b7366935ea4ec2f9b935df2f6f8016067c1d210794f
+  data.tar.gz: 6d5a19607b091081788dbf26bab000a7b1f221befb5c7f9aece9d80f4583fa44
+SHA512:
+  metadata.gz: 8e546c7a3d224c4349152630e37c0c00446aff9184395dbdb9699eec0eacfdd9724e313a33c7442b99c6fdcc6a684a75d28d54f99c78122260bda499503f1682
+  data.tar.gz: a4760e52fc70250c44faf2685dac5101fe726ef719578cb37dbabe00db4eeebb9cfe46cad41f7238e45d5bd6eb5a591f8f96d7d61766e385567739aad4a49cfa

data/bake/memory/profiler.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+def check
+	require 'console'
+	
+	paths = Dir["../../*.mprof"]
+	
+	total_size = paths.sum{|path| File.size(path)}
+	
+	require_relative 'lib/memory_profiler'
+	
+	report = Memory::Report.general
+	
+	cache = Memory::Cache.new
+	wrapper = Memory::Wrapper.new(cache)
+	
+	measure = Console.logger.measure(report, total_size)
+	
+	paths.each do |path|
+		Console.logger.info(report, "Loading #{path}, #{Memory.formatted_bytes File.size(path)}")
+		
+		File.open(path) do |io|
+			unpacker = wrapper.unpacker(io)
+			count = unpacker.read_array_header
+			
+			report.concat(unpacker)
+			
+			measure.increment(io.size)
+		end
+		
+		Console.logger.info(report, "Loaded allocations, #{report.total_allocated}")
+	end
+	
+	report.print($stdout)
+	
+	binding.irb
+end

data/lib/memory.rb

@@ -1,3 +1,35 @@
+# frozen_string_literal: true
 
-require 'memory/usage'
-# require 'memory/profile'
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative "memory/version"
+require_relative "memory/cache"
+require_relative "memory/report"
+require_relative "memory/sampler"
+
+module Memory
+	def self.report(&block)
+		sampler = Sampler.new
+		sampler.run(&block)
+		
+		return sampler.report
+	end
+end

data/lib/memory/aggregate.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Memory
+	UNITS = {
+		0 => 'B',
+		3 => 'KiB',
+		6 => 'MiB',
+		9 => 'GiB',
+		12 => 'TiB',
+		15 => 'PiB',
+		18 => 'EiB',
+		21 => 'ZiB',
+		24 => 'YiB'
+	}.freeze
+	
+	def self.formatted_bytes(bytes)
+		return "0 B" if bytes.zero?
+		
+		scale = Math.log2(bytes).div(10) * 3
+		scale = 24 if scale > 24
+		"%.2f #{UNITS[scale]}" % (bytes / 10.0**scale)
+	end
+	
+	class Aggregate
+		Total = Struct.new(:memory, :count) do
+			def initialize
+				super(0, 0)
+			end
+			
+			def << allocation
+				self.memory += allocation.size
+				self.count += 1
+			end
+			
+			def formatted_memory
+				self.memory
+			end
+			
+			def to_s
+				"(#{Memory.formatted_bytes memory} in #{count} allocations)"
+			end
+		end
+		
+		def initialize(title, &block)
+			@title = title
+			@metric = block
+			
+			@total = Total.new
+			@totals = Hash.new{|h,k| h[k] = Total.new}
+		end
+		
+		attr :total
+		
+		def << allocation
+			metric = @metric.call(allocation)
+			total = @totals[metric]
+			
+			total.memory += allocation.memsize
+			total.count += 1
+			
+			@total.memory += allocation.memsize
+			@total.count += 1
+		end
+		
+		def totals_by(key)
+			@totals.sort_by{|metric, total| [total[key], metric]}
+		end
+		
+		def print(io = $stderr, limit: 10, title: @title, level: 2)
+			io.puts "#{'#' * level} #{title} #{@total}", nil
+			
+			totals_by(:memory).last(limit).reverse_each do |metric, total|
+				io.puts "- #{total}\t#{metric}"
+			end
+			
+			io.puts nil
+		end
+	end
+	
+	class ValueAggregate
+		def initialize(title, &block)
+			@title = title
+			@metric = block
+			
+			@aggregates = Hash.new{|h,k| h[k] = Aggregate.new(k.inspect, &@metric)}
+		end
+		
+		def << allocation
+			if value = allocation.value
+				aggregate = @aggregates[value]
+				
+				aggregate << allocation
+			end
+		end
+		
+		def aggregates_by(key)
+			@aggregates.sort_by{|value, aggregate| [aggregate.total[key], value]}
+		end
+		
+		def print(io = $stderr, limit: 10, level: 2)
+			io.puts "#{'#' * level} #{@title}", nil
+			
+			aggregates_by(:count).last(limit).reverse_each do |value, aggregate|
+				aggregate.print(io, level: level+1)
+			end
+		end
+	end
+end

data/lib/memory/cache.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Memory
+	class Cache
+		def initialize
+			@gem_guess_cache = Hash.new
+			@location_cache = Hash.new { |h, k| h[k] = Hash.new.compare_by_identity }
+			@class_name_cache = Hash.new.compare_by_identity
+			@string_cache = Hash.new
+		end
+
+		def guess_gem(path)
+			@gem_guess_cache[path] ||=
+				if /(\/gems\/.*)*\/gems\/(?<gemname>[^\/]+)/ =~ path
+					gemname
+				elsif /\/rubygems[\.\/]/ =~ path
+					"rubygems"
+				elsif /ruby\/2\.[^\/]+\/(?<stdlib>[^\/\.]+)/ =~ path
+					stdlib
+				elsif /(?<app>[^\/]+\/(bin|app|lib))/ =~ path
+					app
+				else
+					"other"
+				end
+		end
+
+		def lookup_location(file, line)
+			@location_cache[file][line] ||= "#{file}:#{line}"
+		end
+
+		def lookup_class_name(klass)
+			@class_name_cache[klass] ||= ((klass.is_a?(Class) && klass.name) || '<<Unknown>>').to_s
+		end
+
+		def lookup_string(obj)
+			# This string is shortened to 200 characters which is what the string report shows
+			# The string report can still list unique strings longer than 200 characters
+			#   separately because the object_id of the shortened string will be different
+			@string_cache[obj] ||= String.new << obj[0, 64]
+		end
+	end
+end

data/lib/memory/deque.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'objspace'
+require 'msgpack'
+
+module Memory
+	class Deque
+		def initialize
+			@segments = []
+			@last = nil
+		end
+		
+		def freeze
+			return self if frozen?
+			
+			@segments.each(&:freeze)
+			@last = nil
+			
+			super
+		end
+		
+		include Enumerable
+		
+		def concat(segment)
+			@segments << segment
+			@last = nil
+			
+			return self
+		end
+		
+		def << item
+			unless @last
+				@last = []
+				@segments << @last
+			end
+			
+			@last << item
+			
+			return self
+		end
+		
+		def each(&block)
+			@segments.each do |segment|
+				segment.each(&block)
+			end
+		end
+		
+		def size
+			@segments.sum(&:size)
+		end
+	end
+end

data/lib/memory/report.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'aggregate'
+
+module Memory
+	class Report
+		def self.general
+			Report.new([
+				Aggregate.new("By Gem", &:gem),
+				Aggregate.new("By File", &:file),
+				Aggregate.new("By Location", &:location),
+				Aggregate.new("By Class", &:class_name),
+				ValueAggregate.new("Strings By Gem", &:gem),
+				ValueAggregate.new("Strings By Location", &:location),
+			])
+		end
+		
+		def initialize(aggregates)
+			@total_allocated = Aggregate::Total.new
+			@total_retained = Aggregate::Total.new
+			
+			@aggregates = aggregates
+		end
+		
+		attr :total_allocated
+		
+		def concat(allocations)
+			allocations.each do |allocation|
+				@total_allocated << allocation
+				@total_retained << allocation if allocation.retained
+				
+				@aggregates.each do |aggregate|
+					aggregate << allocation
+				end
+			end
+		end
+
+		def print(io = $stderr)
+			io.puts "\# Memory Profile", nil
+			
+			io.puts "- Total Allocated: #{@total_allocated}"
+			io.puts "- Total Retained: #{@total_retained}"
+			io.puts
+			
+			@aggregates.each do |aggregate|
+				aggregate.print(io)
+			end
+		end
+	end
+end

data/lib/memory/sampler.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'objspace'
+require 'msgpack'
+require 'console'
+
+module Memory
+	class Wrapper < MessagePack::Factory
+		def initialize(cache)
+			super()
+			
+			@cache = cache
+			
+			self.register_type(0x01, Allocation,
+				packer: ->(instance){self.pack(instance.pack)},
+				unpacker: ->(data){Allocation.unpack(@cache, self.unpack(data))},
+			)
+			
+			self.register_type(0x02, Symbol)
+		end
+	end
+	
+	Allocation = Struct.new(:cache, :class_name, :file, :line, :memsize, :value, :retained) do
+		def location
+			cache.lookup_location(file, line)
+		end
+		
+		def gem
+			cache.guess_gem(file)
+		end
+		
+		def pack
+			[class_name, file, line, memsize, value, retained]
+		end
+		
+		def self.unpack(cache, fields)
+			self.new(cache, *fields)
+		end
+	end
+	
+	# Sample memory allocations.
+	#
+	# ~~~ ruby
+	# sampler = Sampler.capture do
+	# 	5.times { "foo" }
+	# end
+	# ~~~
+	class Sampler
+		def initialize(&filter)
+			@filter = filter
+			
+			@cache = Cache.new
+			@wrapper = Wrapper.new(@cache)
+			@allocated = Array.new
+		end
+		
+		attr :filter
+		
+		attr :cache
+		attr :wrapper
+		attr :allocated
+		
+		def start
+			GC.disable
+			GC.start
+			
+			@generation = GC.count
+			ObjectSpace.trace_object_allocations_start
+		end
+		
+		def stop
+			ObjectSpace.trace_object_allocations_stop
+			allocated = track_allocations(@generation)
+			
+			# **WARNING** Do not allocate any new Objects between the call to GC.start and the completion of the retained lookups. It is likely that a new Object would reuse an object_id from a GC'd object.
+			
+			GC.enable
+			3.times{GC.start}
+			
+			ObjectSpace.each_object do |object|
+				next unless ObjectSpace.allocation_generation(object) == @generation
+				
+				if found = allocated[object.__id__]
+					found.retained = true
+				end
+			end
+			
+			ObjectSpace.trace_object_allocations_clear
+		end
+		
+		def dump(io = nil)
+			Console.logger.debug(self, "Dumping allocations: #{@allocated.size}")
+			
+			if io
+				packer = @wrapper.packer(io)
+				packer.pack(@allocated)
+				packer.flush
+			else
+				@wrapper.dump(@allocated)
+			end
+		end
+		
+		def load(data)
+			allocations = @wrapper.load(data)
+			
+			Console.logger.debug(self, "Loading allocations: #{allocations.size}")
+			
+			@allocated.concat(allocations)
+		end
+		
+		def report
+			report = Report.general
+			
+			report.concat(@allocated)
+			
+			return report
+		end
+		
+		# Collects object allocation and memory of ruby code inside of passed block.
+		def run(&block)
+			start
+			
+			begin
+				# We do this to avoid retaining the result of the block.
+				yield && false
+			ensure
+				stop
+			end
+		end
+		
+		private
+		
+		# Iterates through objects in memory of a given generation.
+		# Stores results along with meta data of objects collected.
+		def track_allocations(generation)
+			rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
+			
+			allocated = Hash.new.compare_by_identity
+			
+			ObjectSpace.each_object do |object|
+				next unless ObjectSpace.allocation_generation(object) == generation
+				
+				file = ObjectSpace.allocation_sourcefile(object) || "(no name)"
+				
+				klass = object.class rescue nil
+				
+				unless Class === klass
+					# attempt to determine the true Class when .class returns something other than a Class
+					klass = Kernel.instance_method(:class).bind(object).call
+				end
+				
+				next if @filter && !@filter.call(klass, file)
+				
+				line = ObjectSpace.allocation_sourceline(object)
+				
+				# we do memsize first to avoid freezing as a side effect and shifting
+				# storage to the new frozen string, this happens on @hash[s] in lookup_string
+				memsize = ObjectSpace.memsize_of(object)
+				class_name = @cache.lookup_class_name(klass)
+				value = (klass == String) ? @cache.lookup_string(object) : nil
+				
+				# compensate for API bug
+				memsize = rvalue_size if memsize > 100_000_000_000
+				
+				allocation = Allocation.new(@cache, class_name, file, line, memsize, value, false)
+				
+				@allocated << allocation
+				allocated[object.__id__] = allocation
+			end
+			
+			return allocated
+		end
+	end
+end