leak_profiler 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9eee59048d470d4ea437d6eabf4295b4b9fe98b547ed90f43675f56d31b30f4
-  data.tar.gz: 3f85e846b9cb4e9e6232b69c2025e32223a410af5f8c1edf5a8903ebe24d97fd
+  metadata.gz: '0893023e2e636f17ea493dbb9e48a3663efdec4839aa0f8f92575fbf679d619f'
+  data.tar.gz: 5274e289f44e7d0157c337f44b02d8e7628b482d1c3033e22eee8d5a0b3addac
 SHA512:
-  metadata.gz: e070418ef607471a5364579825addfcde2b1d4f13b882546f88cf24ceaea72754439f770d5c44a5c5e2500520ef579285ac9fa252271176295ab56a6074ec434
-  data.tar.gz: 0be27cc605be614704a20976ec107f9dc56c63235cad4086123365c4f5b2b6ee74ad6cb55320f7cc868cd7661328348ec7797117afd8e018cc3c8a97cf45922f
+  metadata.gz: 565d9b09913c43416dce885ce9345e2d2d41a383c35d3238ff3d06609809da29b5e534ffaf6485069c850a9c7f9780f5a6b0221ec81345eb3d88724327bc0134
+  data.tar.gz: 762cc7effc4e9d7f0780fa193a60f6f977de4169d7a709d42cb5191e5fe88cc2be78b09603c0815a11774ff07b6888f8a5e75543f719a472cc3929f6ef7cfca7

data/README.md

@@ -86,11 +86,6 @@ elapsed [sec],memory usage (rss) [MB]
   * `interval` (default `1`): The interval in seconds for report.
   * `filename` (defalut `nil`): Specify the filename if you want to use custom filename.
 
-> [!WARNING]
-> This uses this uses `ps` command for measurement.
-> So, this is not supported Windows platform.
-
-
 ### `LeakProfiler#report_memsize`
 This method outputs `ObjectSpace.memsize_of_all` values with CSV format, like:
 

data/ext/leak_profiler/leak_profiler.c

@@ -1,38 +1,52 @@
 #include "ruby.h"
-
+#include <stdio.h>
+#include <unistd.h>
 
 // get the maximum resident set size (RSS) of the current process
 // return the value in kilobytes
 #if defined(_WIN32)
 #include <psapi.h>
 
-static VALUE leak_profiler_max_rss(VALUE self)
+static VALUE leak_profiler_rss(VALUE self)
 {
-        PROCESS_MEMORY_COUNTERS pmc;
+    PROCESS_MEMORY_COUNTERS pmc;
     if (!GetProcessMemoryInfo(GetCurrentProcess(), &pmc, sizeof(pmc))) {
         rb_sys_fail("GetProcessMemoryInfo");
     }
     return LONG2NUM(pmc.PeakWorkingSetSize / 1024);
 }
 
-#else
-#include <sys/resource.h>
+#elif defined(__APPLE__)
 
-static VALUE leak_profiler_max_rss(VALUE self)
-{
-    struct rusage usage;
-    long max_rss;
+#include <mach/mach.h>
 
-    if (getrusage(RUSAGE_SELF, &usage) == -1) {
-        rb_sys_fail("getrusage");
+static VALUE leak_profiler_rss(VALUE self)
+{
+    struct mach_task_basic_info info;
+    mach_msg_type_number_t count = MACH_TASK_BASIC_INFO_COUNT;
+    kern_return_t kr = task_info(mach_task_self(), MACH_TASK_BASIC_INFO, (task_info_t)&info, &count);
+    if (kr != KERN_SUCCESS) {
+        rb_sys_fail("task_info");
     }
-    max_rss = usage.ru_maxrss;
+    return LONG2NUM(info.resident_size / 1024);
+}
 
-#if defined(__APPLE__)
-    max_rss = max_rss / 1024;
-#endif
+#else // linux
 
-    return LONG2NUM(max_rss);
+static VALUE leak_profiler_rss(VALUE self)
+{
+    long rss = 0;
+
+    FILE *file = fopen("/proc/self/statm", "r");
+    if (!file) {
+        rb_sys_fail("/proc/self/statm");
+    }
+    if (fscanf(file, "%*s%ld", &rss) != 1) {
+        fclose(file);
+        rb_sys_fail("fscanf");
+    }
+    fclose(file);
+    return LONG2NUM(rss * sysconf(_SC_PAGESIZE) / 1024);
 }
 
 #endif
@@ -43,5 +57,5 @@ void Init_leak_profiler_ext(void)
     VALUE cMemoryUsage = rb_define_class_under(cLeakProfiler, "MemoryUsage", rb_cObject);
 
 
-    rb_define_singleton_method(cMemoryUsage, "max_rss", leak_profiler_max_rss, 0);
+    rb_define_singleton_method(cMemoryUsage, "rss", leak_profiler_rss, 0);
 }

data/lib/leak_profiler/allocations.rb

@@ -22,13 +22,16 @@ class LeakProfiler
     def report
       @thread = Thread.start do
         loop do
-          allocations = {}
-
           ObjectSpace.trace_object_allocations_start
           sleep(@interval)
           ObjectSpace.trace_object_allocations_stop
 
+          allocations = {}
+          allocations_by_class = Hash.new { |h, k| h[k] = 0 }
+
           ObjectSpace.each_object.each do |obj|
+            allocations_by_class[obj.class] += ObjectSpace.memsize_of(obj)
+
             key = allocated_location(obj)
             next unless key
 
@@ -40,6 +43,7 @@ class LeakProfiler
             allocations[key][:sample_object] = obj
           end
 
+          report_allocations_class(allocations_by_class)
           report_allocations(allocations)
           report_referrer_objects(allocations)
         end
@@ -48,6 +52,16 @@ class LeakProfiler
 
     private
 
+    def report_allocations_class(allocations_by_class)
+      return if @max_allocations <= 0
+
+      @logger.add(Logger::Severity::INFO, "Allocations by class #{"~" * 80}")
+      allocations_by_class.sort_by { |_, v| -v }
+                          .take(@max_allocations).each do |klass, value|
+        @logger.add(Logger::Severity::INFO, "#{klass} retains #{value} bytes")
+      end
+    end
+
     def report_allocations(allocations)
       return if @max_allocations <= 0
 

data/lib/leak_profiler/memory_usage.rb

@@ -22,7 +22,7 @@ class LeakProfiler
           f.puts('elapsed [sec],memory usage (rss) [MB]')
 
           loop do
-            rss = LeakProfiler::MemoryUsage.max_rss / 1024.0
+            rss = LeakProfiler::MemoryUsage.rss / 1024.0
             f.puts("#{i},#{rss}")
             f.fsync
             i += @interval

data/sig/generated/leak_profiler/allocations.rbs

@@ -14,6 +14,8 @@ class LeakProfiler
 
     private
 
+    def report_allocations_class: (untyped allocations_by_class) -> untyped
+
     def report_allocations: (untyped allocations) -> untyped
 
     def report_referrer_objects: (untyped allocations) -> untyped

data/sig/leak_profiler.rbs

@@ -1,5 +1,5 @@
 class LeakProfiler
   class MemoryUsage
-    def self.max_rss: () -> Integer
+    def self.rss: () -> Integer
   end
 end

data/test/test_memory_usage.rb

@@ -5,6 +5,6 @@ require 'minitest/autorun'
 
 class MemoryUsageTest < Minitest::Test
   def test_report_rss
-    assert_equal(true, LeakProfiler::MemoryUsage.max_rss.positive?)
+    assert_equal(true, LeakProfiler::MemoryUsage.rss.positive?)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Watson
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple profiler for Ruby to detect memory leak.
 test_files: []