memory 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007d5f4bf3d0a25dc887eefc4c7467f44a021e0658a4ac6acfe186da4c72c435
-  data.tar.gz: dcc7e341db91dccf9f3928d3eb7901606e31fc3df9bb7701c1ad3c1253e7d2c6
+  metadata.gz: 116b9be7bb4a7d1c7b906923132406708953a8e3e7d43687d82f7920192ad74f
+  data.tar.gz: bf093a25998cefbf01f8fbc79d92d23bc972c016596acb3678cd6303eb09e034
 SHA512:
-  metadata.gz: 0f5831fce8f53208b08a5c2fab8f0d4286077fbe69a9d1fe227888695be775259743f098fb8ef1a2dce9843e478ddcc7f66e37142567f79df9bbfe20f694ffbc
-  data.tar.gz: fac10ba0b56492a1d870217d31c92fb20e35c9cdb65dfb44d5b7bec41d673b0ccb2631f4d913575fa40474c5eaddece64e821c63cbd2f86819fb9f6b5b305a3c
+  metadata.gz: 403676e22f95cd9239f3da72898a9be935c100e236bd51a6fca58d2ebf472a33609efb373dff628cf5f6f1e7ed9ace28dc3abc45adbbdc9975d489539b2f853d
+  data.tar.gz: be14f62bb150ab3daec0c9743800e887e606b0ba1545725143484362278779451f9a98dab2a35126d4396d6a57e08c1ccdce28b1a21fe5e894516b16e235b79c

data/lib/memory/aggregate.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 module Memory
 	UNITS = {
@@ -31,7 +31,7 @@ module Memory
 			end
 			
 			def << allocation
-				self.memory += allocation.size
+				self.memory += allocation.memsize
 				self.count += 1
 			end
 			

data/lib/memory/report.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require_relative 'aggregate'
 
 module Memory
 	class Report
-		def self.general
+		def self.general(**options)
 			Report.new([
 				Aggregate.new("By Gem", &:gem),
 				Aggregate.new("By File", &:file),
@@ -15,10 +15,12 @@ module Memory
 				Aggregate.new("By Class", &:class_name),
 				ValueAggregate.new("Strings By Gem", &:gem),
 				ValueAggregate.new("Strings By Location", &:location),
-			])
+			], **options)
 		end
 		
-		def initialize(aggregates)
+		def initialize(aggregates, retained_only: true)
+			@retained_only = retained_only
+			
 			@total_allocated = Aggregate::Total.new
 			@total_retained = Aggregate::Total.new
 			
@@ -38,16 +40,25 @@ module Memory
 		def concat(allocations)
 			allocations.each do |allocation|
 				@total_allocated << allocation
-				@total_retained << allocation if allocation.retained
 				
-				@aggregates.each do |aggregate|
-					aggregate << allocation
+				if allocation.retained
+					@total_retained << allocation
+				end
+				
+				if !@retained_only || allocation.retained
+					@aggregates.each do |aggregate|
+						aggregate << allocation
+					end
 				end
 			end
 		end
 		
 		def print(io = $stderr)
-			io.puts "\# Memory Profile", nil
+			if @retained_only
+				io.puts "\# Retained Memory Profile", nil
+			else
+				io.puts "\# Memory Profile", nil
+			end
 			
 			io.puts "- Total Allocated: #{@total_allocated}"
 			io.puts "- Total Retained: #{@total_retained}"

data/lib/memory/sampler.rb

@@ -17,6 +17,8 @@ require 'objspace'
 require 'msgpack'
 require 'console'
 
+require_relative 'cache'
+
 module Memory
 	class Wrapper < MessagePack::Factory
 		def initialize(cache)
@@ -94,6 +96,9 @@ module Memory
 			
 			# **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.
 			
+			# Overwrite any immediate values on the C stack to avoid retaining them.
+			ObjectSpace.dump(Object.new)
+			
 			GC.enable
 			3.times{GC.start}
 			
@@ -131,8 +136,8 @@ module Memory
 			@allocated.concat(allocations)
 		end
 		
-		def report
-			report = Report.general
+		def report(**options)
+			report = Report.general(**options)
 			
 			report.concat(@allocated)
 			
@@ -158,7 +163,7 @@ module Memory
 		def track_allocations(generation)
 			rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
 			
-			allocated = Hash.new.compare_by_identity
+			allocated = Hash.new
 			
 			ObjectSpace.each_object do |object|
 				next unless ObjectSpace.allocation_generation(object) == generation

data/lib/memory/version.rb

@@ -7,5 +7,5 @@
 # Copyright, 2020-2024, by Samuel Williams.
 
 module Memory
-	VERSION = "0.4.2"
+	VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -61,7 +61,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -125,7 +125,9 @@ files:
 homepage: https://github.com/socketry/memory
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/memory/
+  source_code_uri: https://github.com/socketry/memory.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -134,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.3+