leak_profiler 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c65071dbbe8a5516095022d27fc86043512d1f2a1c12c8fcf24d9c3aea7e0a71
-  data.tar.gz: e2ba069b4a7b4ed7c369b72756ec8f97f2f32736ea212ae7092802d0e4aecf94
+  metadata.gz: 3e7942b0713d364d60dcfbeb171894c69aa63028adc6795d4b48e85d6019152d
+  data.tar.gz: '05967d0eefaf0301b380620c23b5eb925ac62a26ad45c1504a7ff2e6690f537a'
 SHA512:
-  metadata.gz: e3b875bd325d8ab5c36004b0c413ff7eeb742211e058669a5fd328dfe1ff654672b69a84cb4d627663085e37c0a540a881d36e40eb65c9a48e2b85fb23a99304
-  data.tar.gz: 6f26582f06e662a12ed60282fc41b78303de00ccd1350469e99565ec54ba142f1c68b966fea60e5294927aa724132165f9d49cdcdadba7ed2d30d478501c915f
+  metadata.gz: b430a5fe0d7ad6fc90d1dd1f949aeb0b2948487a6f651b4c52975774b4e5cb21ab98a9f7219e8c665f90daa3c70f6aa3d3c803ffdc9aa48acddd0e0e95d8bf15
+  data.tar.gz: 175e865aa10c22816d9b86c04301a0c574af0260becbe3fdf76b78d8f338b466fdc2170431a4244e0296ed47b27223879e52c60060363654f1adc8da7cd49638

data/.rubocop.yml

@@ -14,6 +14,9 @@ Metrics:
 Style/Copyright:
   Enabled: false
 
+Style/GlobalVars:
+  Enabled: false
+
 Style/ImplicitRuntimeError:
   Enabled: false
 

data/Rakefile

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'rake/extensiontask'
 require 'rake/testtask'
 
-task default: :test
+task default: %i[compile test]
+
+Rake::ExtensionTask.new('leak_profiler_ext') do |ext|
+  ext.ext_dir = 'ext/leak_profiler'
+end
 
 Rake::TestTask.new do |task|
   task.pattern = 'test/test_*.rb'
 end
+
+# Update RBS signature
+task :'rbs:update' do
+  sh 'bundle exec rbs-inline --output lib'
+end

data/ext/leak_profiler/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+$LDFLAGS += ' -lpsapi' if RUBY_PLATFORM.include?('mingw')
+
+create_makefile('leak_profiler_ext')

data/ext/leak_profiler/leak_profiler.c

@@ -0,0 +1,37 @@
+#include "ruby.h"
+
+#if defined(_WIN32)
+#include <psapi.h>
+
+static VALUE leak_profiler_max_rss(VALUE self)
+{
+        PROCESS_MEMORY_COUNTERS pmc;
+    if (!GetProcessMemoryInfo(GetCurrentProcess(), &pmc, sizeof(pmc))) {
+        rb_sys_fail("GetProcessMemoryInfo");
+    }
+    return LONG2NUM(pmc.PeakWorkingSetSize);
+}
+
+#else
+#include <sys/resource.h>
+
+static VALUE leak_profiler_max_rss(VALUE self)
+{
+    struct rusage usage;
+    if (getrusage(RUSAGE_SELF, &usage) == -1) {
+        rb_sys_fail("getrusage");
+    }
+
+    return LONG2NUM(usage.ru_maxrss);
+}
+
+#endif
+
+void Init_leak_profiler_ext(void)
+{
+    VALUE cLeakProfiler = rb_define_class("LeakProfiler", rb_cObject);
+    VALUE cMemoryUsage = rb_define_class_under(cLeakProfiler, "MemoryUsage", rb_cObject);
+
+
+    rb_define_singleton_method(cMemoryUsage, "max_rss", leak_profiler_max_rss, 0);
+}

data/lib/leak_profiler/allocations.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require 'objspace'
 
 class LeakProfiler
   class Allocations
     attr_reader :thread
 
+    # @rbs logger: untyped
+    # @rbs interval: Integer
+    # @rbs max_allocations: Integer
+    # @rbs max_referrers: Integer
     def initialize(logger:, interval:, max_allocations:, max_referrers:)
       @logger = logger
       @interval = interval

data/lib/leak_profiler/leak_profiler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require_relative 'allocations'
 require_relative 'memory_memsize'
 require_relative 'memory_usage'
@@ -7,6 +9,8 @@ require 'fileutils'
 require 'logger'
 
 class LeakProfiler
+  # @rbs output_dir: String
+  # @rbs return: void
   def initialize(output_dir: './leak_profiler')
     @output_dir = output_dir
     @threads = []
@@ -14,6 +18,12 @@ class LeakProfiler
     FileUtils.mkdir_p(@output_dir)
   end
 
+  # @rbs interval: Integer
+  # @rbs max_allocations: Integer
+  # @rbs max_referrers: Integer
+  # @rbs logger: untyped
+  # @rbs filename: String
+  # @rbs return: self
   def report(interval: 30, max_allocations: 10, max_referrers: 3, logger: nil, filename: nil)
     filename ||= "leak_profiler-#{Process.pid}.log"
     logger ||= Logger.new(File.join(@output_dir, filename))
@@ -24,6 +34,9 @@ class LeakProfiler
     self
   end
 
+  # @rbs interval: Integer
+  # @rbs filename: String
+  # @rbs return: self
   def report_rss(interval: 1, filename: nil)
     profiler = LeakProfiler::MemoryUsage.new(output_dir: @output_dir, interval: interval, filename: filename)
     profiler.report
@@ -32,6 +45,9 @@ class LeakProfiler
     self
   end
 
+  # @rbs interval: Integer
+  # @rbs filename: String
+  # @rbs return: self
   def report_memsize(interval: 1, filename: nil)
     profiler = LeakProfiler::MemoryMemsize.new(output_dir: @output_dir, interval: interval, filename: filename)
     profiler.report

data/lib/leak_profiler/memory_memsize.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require 'objspace'
 
 class LeakProfiler
   class MemoryMemsize
     attr_reader :thread
 
+    # @rbs output_dir: String
+    # @rbs interval: Integer
+    # @rbs filename: String
     def initialize(output_dir:, interval:, filename: nil)
       @output_dir = output_dir
       @interval = interval

data/lib/leak_profiler/memory_usage.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 class LeakProfiler
   class MemoryUsage
     attr_reader :thread
 
+    # @rbs output_dir: String
+    # @rbs interval: Integer
+    # @rbs filename: String
     def initialize(output_dir:, interval:, filename: nil)
       @output_dir = output_dir
       @interval = interval
@@ -11,17 +16,13 @@ class LeakProfiler
     end
 
     def report
-      raise('Not supported Windows platform because this uses `ps` command for measurement.') if /mingw/.match?(RUBY_PLATFORM)
-
-      pid = Process.pid
-
       @thread = Thread.start do
         i = 0
         File.open(File.expand_path(File.join(@output_dir, @filename)), 'w') do |f|
           f.puts('elapsed [sec],memory usage (rss) [MB]')
 
           loop do
-            rss = Integer(`ps -o rss= -p #{pid}`) / 1024.0
+            rss = LeakProfiler::MemoryUsage.max_rss / 1024.0
             f.puts("#{i},#{rss}")
             f.fsync
             i += @interval

data/lib/leak_profiler.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require 'leak_profiler/leak_profiler'
+require_relative 'leak_profiler_ext.so'

data/sig/generated/leak_profiler/allocations.rbs

@@ -0,0 +1,27 @@
+# Generated from lib/leak_profiler/allocations.rb with RBS::Inline
+
+class LeakProfiler
+  class Allocations
+    attr_reader thread: untyped
+
+    # @rbs logger: untyped
+    # @rbs interval: Integer
+    # @rbs max_allocations: Integer
+    # @rbs max_referrers: Integer
+    def initialize: (logger: untyped, interval: Integer, max_allocations: Integer, max_referrers: Integer) -> untyped
+
+    def report: () -> untyped
+
+    private
+
+    def report_allocations: (untyped allocations) -> untyped
+
+    def report_referrer_objects: (untyped allocations) -> untyped
+
+    def detect_referrer_objects: (untyped object) -> untyped
+
+    def allocated_location: (untyped obj) -> untyped
+
+    def sort: (untyped allocations) -> untyped
+  end
+end

data/sig/generated/leak_profiler/leak_profiler.rbs

@@ -0,0 +1,27 @@
+# Generated from lib/leak_profiler/leak_profiler.rb with RBS::Inline
+
+class LeakProfiler
+  # @rbs output_dir: String
+  # @rbs return: void
+  def initialize: (?output_dir: String) -> void
+
+  # @rbs interval: Integer
+  # @rbs max_allocations: Integer
+  # @rbs max_referrers: Integer
+  # @rbs logger: untyped
+  # @rbs filename: String
+  # @rbs return: self
+  def report: (?interval: Integer, ?max_allocations: Integer, ?max_referrers: Integer, ?logger: untyped, ?filename: String) -> self
+
+  # @rbs interval: Integer
+  # @rbs filename: String
+  # @rbs return: self
+  def report_rss: (?interval: Integer, ?filename: String) -> self
+
+  # @rbs interval: Integer
+  # @rbs filename: String
+  # @rbs return: self
+  def report_memsize: (?interval: Integer, ?filename: String) -> self
+
+  def shutdown: () -> untyped
+end

data/sig/generated/leak_profiler/memory_memsize.rbs

@@ -0,0 +1,14 @@
+# Generated from lib/leak_profiler/memory_memsize.rb with RBS::Inline
+
+class LeakProfiler
+  class MemoryMemsize
+    attr_reader thread: untyped
+
+    # @rbs output_dir: String
+    # @rbs interval: Integer
+    # @rbs filename: String
+    def initialize: (output_dir: String, interval: Integer, ?filename: String) -> untyped
+
+    def report: () -> untyped
+  end
+end

data/sig/generated/leak_profiler/memory_usage.rbs

@@ -0,0 +1,14 @@
+# Generated from lib/leak_profiler/memory_usage.rb with RBS::Inline
+
+class LeakProfiler
+  class MemoryUsage
+    attr_reader thread: untyped
+
+    # @rbs output_dir: String
+    # @rbs interval: Integer
+    # @rbs filename: String
+    def initialize: (output_dir: String, interval: Integer, ?filename: String) -> untyped
+
+    def report: () -> untyped
+  end
+end

data/sig/leak_profiler.rbs

@@ -1,10 +1,5 @@
 class LeakProfiler
-  def initialize: (?output_dir: String) -> void
-
-  # TODO: Use valid type for logger
-  def report: (?interval: Integer, ?max_allocations: Integer, ?max_referrers: Integer, ?logger: Object, ?filename: String) -> self
-
-  def report_rss: (?interval: Integer, ?filename: String) -> self
-
-  def report_memsize: (?interval: Integer, ?filename: String) -> self
+  class MemoryUsage
+    def self.max_rss: () -> Integer
+  end
 end

data/test/test_memory_usage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'leak_profiler'
+require 'minitest/autorun'
+
+class MemoryUsageTest < Minitest::Test
+  def test_report_rss
+    assert_equal(true, LeakProfiler::MemoryUsage.max_rss.positive?)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Watson
@@ -27,7 +27,8 @@ description: A simple profiler for Ruby to detect memory leak.
 email:
 - watson1978@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/leak_profiler/extconf.rb
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
@@ -35,13 +36,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- ext/leak_profiler/extconf.rb
+- ext/leak_profiler/leak_profiler.c
 - lib/leak_profiler.rb
 - lib/leak_profiler/allocations.rb
 - lib/leak_profiler/leak_profiler.rb
 - lib/leak_profiler/memory_memsize.rb
 - lib/leak_profiler/memory_usage.rb
+- sig/generated/leak_profiler/allocations.rbs
+- sig/generated/leak_profiler/leak_profiler.rbs
+- sig/generated/leak_profiler/memory_memsize.rbs
+- sig/generated/leak_profiler/memory_usage.rbs
 - sig/leak_profiler.rbs
 - test/test_leak_profiler.rb
+- test/test_memory_usage.rb
 homepage: https://github.com/Watson1978/leak_profiler
 licenses:
 - MIT
@@ -63,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A simple profiler for Ruby to detect memory leak.
 test_files: []