memory-profiler 1.1.14 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c26d5bc8b4215de3776e42ec9cd8daaf54a3cba9d55449f6b570ba7ee5ef9c91
-  data.tar.gz: 6668320402b35e3633eff016bd79b34c6b69952cb03120fc7f04886782bacfe3
+  metadata.gz: 44131407c83cd30a000572173db2bd27a1b2cc226090fe5b2ab5b9452671676a
+  data.tar.gz: 76c488be0ca9902ac543a21941b3ebd4d5fd5ea807e958289452044021ba8f0c
 SHA512:
-  metadata.gz: 68404ae44a442584084727cc854ed81abc36964c5621b93361cde70c6ae80f71ad21c7a45caf049c5906846cec8dff23ccbddb2e021eedf137e8ba7d57c78363
-  data.tar.gz: 406d8caac175e30907d752cec211d066a8c7ed5bf260c4e4eba6304f73b60d7c47be6d68d8b6cc4e738cb8fe19ebadeea0f251c7b2df888923b86abdaae2867e
+  metadata.gz: 98eba2b7e667ad5d9e9ea01a528de98a4525074580e66178b91f246932183557d0a826a8693e773147977e694f7ef9a15af47d0d8f954c4352bb77ada9d5e558
+  data.tar.gz: 71424607c4a188ef16da5436c4bd7b0ebc6640b3bbc1b182f0a9cc64c15b940bb4cf81a3f1cc47f00cfb5b7dc596565a3f22df88cd6c9ccb80b7866122c6bb53

data/ext/memory/profiler/capture.c

@@ -298,21 +298,6 @@ static void Memory_Profiler_Capture_event_callback(VALUE data, void *ptr) {
 	VALUE klass = rb_class_of(object);
 	if (!klass) return;
 	
-	// Check if class is already freed (T_NONE). This can happen when:
-	// 1. Object was allocated before capture started (no NEWOBJ event queued).
-	// 2. Anonymous class (Class.new) was freed before its instances.
-	//
-	// If the class is T_NONE, it means:
-	// - It's NOT in tracked_classes (would retain it via GC mark callback).
-	// - It's NOT in any pending NEWOBJ event (would retain it via event queue marking).
-	//
-	// Therefore process_freeobj() would skip this event anyway (class lookup fails at line 200).
-	// We must skip enqueueing to avoid attempting to mark a T_NONE object during GC,
-	// which can cause: [BUG] try to mark T_NONE object.
-	if (rb_type(klass) == T_NONE) {
-		return;
-	}
-	
 	if (DEBUG) {
 		const char *klass_name = "(ignored)";
 		if (event_flag == RUBY_INTERNAL_EVENT_NEWOBJ) {
@@ -325,6 +310,7 @@ static void Memory_Profiler_Capture_event_callback(VALUE data, void *ptr) {
 		// Skip NEWOBJ if disabled (during callback) to prevent infinite recursion
 		if (capture->paused) return;
 		
+		// Check if class is already freed (T_NONE). This can happen when:
 		// It's safe to unconditionally call here:
 		object = rb_obj_id(object);
 
@@ -332,6 +318,10 @@ static void Memory_Profiler_Capture_event_callback(VALUE data, void *ptr) {
 	} else if (event_flag == RUBY_INTERNAL_EVENT_FREEOBJ) {
 		// We only care about objects that have been seen before (i.e. have an object ID):
 		if (RB_FL_TEST(object, FL_SEEN_OBJ_ID)) {
+			// For freeobj, we only care about klasses that we are tracking.
+			// This prevents us from enqueuing klass objects that might be freed.
+			if (!st_lookup(capture->tracked_classes, (st_data_t)klass, NULL)) return;
+			
 			// It's only safe to call here if the object already has an object ID.
 			object = rb_obj_id(object);
 			

data/lib/memory/profiler/sampler.rb

@@ -93,12 +93,15 @@ module Memory
 			# @parameter increases_threshold [Integer] Number of increases before enabling detailed tracking.
 			# @parameter prune_limit [Integer] Keep only top N children per node during pruning (default: 5).
 			# @parameter prune_threshold [Integer] Number of insertions before auto-pruning (nil = no auto-pruning).
-			def initialize(depth: 4, filter: nil, increases_threshold: 10, prune_limit: 5, prune_threshold: nil)
+			# @parameter gc [Hash | Nil] Run GC with these options before each sample (nil = don't run GC).
+			def initialize(depth: 4, filter: nil, increases_threshold: 10, prune_limit: 5, prune_threshold: nil, gc: nil)
 				@depth = depth
 				@filter = filter || default_filter
 				@increases_threshold = increases_threshold
 				@prune_limit = prune_limit
 				@prune_threshold = prune_threshold
+				@gc = gc
+				
 				@capture = Capture.new
 				@call_trees = {}
 				@samples = {}
@@ -150,6 +153,9 @@ module Memory
 				while true
 					start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 					
+					# Optional garbage collection before sampling can help reduce noise:
+					GC.start(**@gc) if @gc
+					
 					sample!(&block)
 					
 					# Log capture statistics to detect issues like missing FREEOBJ events:
@@ -169,15 +175,22 @@ module Memory
 				@capture.each do |klass, allocations|
 					count = allocations.retained_count
 					sample = @samples[klass] ||= Sample.new(klass, count)
+					increased = false
 					
 					if sample.sample!(count)
+						increased = true
+						
 						# Check if we should enable detailed tracking
-						if sample.increases >= @increases_threshold && !@call_trees.key?(klass)
-							track(klass, allocations)
+						if sample.increases >= @increases_threshold
+							# Start tracking with call path analysis if not already doing so:
+							unless tracking?(klass)
+								track(klass, allocations)
+							end
 						end
-						
-						# Notify about growth if block given
-						yield sample if block_given?
+					end
+					
+					if block_given?
+						yield sample, increased
 					end
 				end
 				
@@ -188,14 +201,12 @@ module Memory
 			# Start tracking with call path analysis.
 			#
 			# @parameter klass [Class] The class to track with detailed analysis.
-			def track(klass, allocations = nil)
+			def track(klass, allocations = nil, filter: @filter, depth: @depth)
 				# Track the class and get the allocations object
 				allocations ||= @capture.track(klass)
 				
 				# Set up call tree for this class
 				tree = @call_trees[klass] = CallTree.new
-				depth = @depth
-				filter = @filter
 				
 				# Register callback on allocations object:
 				# - On :newobj - returns state (leaf node) which C extension stores
@@ -293,8 +304,9 @@ module Memory
 			
 		private
 			
+			# Default filter to include all locations.
 			def default_filter
-				->(location) {!location.path.match?(%r{/(gems|ruby)/|\A\(eval\)})}
+				->(location) {true}
 			end
 			
 			def prune_call_trees!

data/lib/memory/profiler/version.rb

@@ -7,7 +7,7 @@
 module Memory
 	# @namespace
 	module Profiler
-		VERSION = "1.1.14"
+		VERSION = "1.2.0"
 	end
 end
 

data/readme.md

@@ -22,6 +22,17 @@ Please see the [project documentation](https://socketry.github.io/memory-profile
 
 Please see the [project releases](https://socketry.github.io/memory-profiler/releases/index) for all releases.
 
+### v1.2.0
+
+  - Enable custom `depth:` and `filter:` options to `Sampler#track`.
+  - Change default filter to no-op.
+  - Add option to run GC with custom options before each sample to reduce noise.
+  - Always report sampler statistics after each sample.
+
+### v1.1.15
+
+  - Ignore `freeobj` for classes that are not being tracked.
+
 ### v1.1.14
 
   - Ignore `freeobj` events for objects with anonymous classes that are not tracked (and thus become `T_NONE`).
@@ -60,16 +71,6 @@ Please see the [project releases](https://socketry.github.io/memory-profiler/rel
 
   - Expose `Capture#statistics` for debugging internal memory tracking state.
 
-### v1.1.6
-
-  - Write barriers all the things.
-  - Better state handling and object increment/decrement counting.
-  - Better call tree handling - including support for `prune!`.
-
-### v1.1.5
-
-  - Use queue for `newobj` too to avoid invoking user code during object allocation.
-
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -1,5 +1,16 @@
 # Releases
 
+## v1.2.0
+
+  - Enable custom `depth:` and `filter:` options to `Sampler#track`.
+  - Change default filter to no-op.
+  - Add option to run GC with custom options before each sample to reduce noise.
+  - Always report sampler statistics after each sample.
+
+## v1.1.15
+
+  - Ignore `freeobj` for classes that are not being tracked.
+
 ## v1.1.14
 
   - Ignore `freeobj` events for objects with anonymous classes that are not tracked (and thus become `T_NONE`).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory-profiler
 version: !ruby/object:Gem::Version
-  version: 1.1.14
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams