ruby_memcheck 2.3.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c504d614573dbdf5af31d106bc8977c66da56202826f303a25cadbb836bcc5dd
-  data.tar.gz: c2c2a740907422ca9c6c1770c9b6541ee124c28df4851b5d997ababe9b2aaf92
+  metadata.gz: 7b355c60060a1d3a88b9bb7216eba3f2b0b286b084bcae72559447a3cd7c44cc
+  data.tar.gz: ff119d0a8850a483ad18cb7a7f05b34a0338b41782d2717e442be06ef22784b5
 SHA512:
-  metadata.gz: 0aef4eda1c4bf979ff9a5f7cc6dccaf431fc5e0c8a7f6b6fee2e9b6bc8f48c8e4d64ffb0cc4d73219e15e8949fb32b7d3c2898bdccfa09a15c0859305ce1018e
-  data.tar.gz: 523615be482fe107d2b7a46b1575d93f68d8dfc6e9f78c9107f206e466a4dfbe690be9ab479e8f07d0e260b3e5837db394c2b3e6d63c85c2130692bb0dcdd5ed
+  metadata.gz: a47edc485be9e7cfba605631576a69fc2a726be97b27b3e7aeb36ae65e18efaeba00ddc799bce147e40b20fcfa30f96cf19b595f4e6bd60265b1fe8d3eac3237
+  data.tar.gz: 3f58eee4a01327e67be1bf3d3b393841c955185cfdbf7c4da3759350c7397d0d5288988f1fc6b0724aca831315125f77da073ac4717b2ab6d6db8f08e28fc6c7

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/lint.yml

@@ -6,7 +6,5 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0'
       - run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
       - run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -10,6 +10,8 @@ jobs:
           - { ruby: '3.0', allowed-failure: false }
           - { ruby: '3.1', allowed-failure: false }
           - { ruby: '3.2', allowed-failure: false }
+          - { ruby: '3.3', allowed-failure: false }
+          - { ruby: '3.4', allowed-failure: false }
           - { ruby: ruby-head, allowed-failure: false }
     name: ruby ${{ matrix.entry.ruby }}
     steps:

data/.gitignore

@@ -1,5 +1,3 @@
-Gemfile.lock
-
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -2,7 +2,6 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
   SuggestExtensions: false
 
 Style/GlobalVars:

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    ruby_memcheck (3.0.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.8)
+    minitest (5.25.4)
+    minitest-parallel_fork (2.0.0)
+      minitest (>= 5.15.0)
+    nokogiri (1.17.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rake-compiler (1.2.8)
+      rake
+    regexp_parser (2.10.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.69.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
+    rubocop-shopify (2.15.1)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.3)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-parallel_fork (~> 2.0)
+  rake (~> 13.0)
+  rake-compiler (~> 1.1)
+  rspec-core
+  rubocop (~> 1.22)
+  rubocop-shopify (~> 2.3)
+  ruby_memcheck!
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -163,6 +163,7 @@ If you want to override any of the default configurations you can call `RubyMemc
 - `temp_dir`: Optional. The directory to store temporary files. It defaults to a temporary directory. This is present for development debugging, so you shouldn't have to use it.
 - `output_io`: Optional. The `IO` object to output Valgrind errors to. Defaults to standard error.
 - `filter_all_errors`: Optional. Whether to filter all kinds of Valgrind errors (not just memory leaks). This feature should only be used if you're encountering a large number of illegal memory accesses coming from Ruby. If you need to use this feature, you may have found a bug inside of Ruby. Consider reporting it to the [Ruby bug tracker](https://bugs.ruby-lang.org/projects/ruby-master/issues/new). Defaults to `false`.
+- `use_only_ruby_free_at_exit`: Optional. Use only the [`RUBY_FREE_AT_EXIT`](https://bugs.ruby-lang.org/issues/19993) feature introduced in Ruby 3.3 and disables most of the heuristics inside of ruby_memcheck. Disable this if you want to use the original heuristics. Defaults to `true` for Ruby 3.4 and later, `false` otherwise. Note: while `RUBY_FREE_AT_EXIT` was introduced in Ruby 3.3, there are bugs which prevents it from working well, so it is only enabled by default for Ruby 3.4 and later.
 
 ## Suppression files
 
@@ -195,6 +196,9 @@ Let's celebrate wins from this gem! If this gem was useful for you, please share
 - [`libxml2`](https://gitlab.gnome.org/GNOME/libxml2):
   - Found 1 memory leak: [memory leak from \`xmlSchemaValidateStream\` in v2.11.x (#530)](https://gitlab.gnome.org/GNOME/libxml2/-/issues/530)
   - Running in Nokogiri's CI pipeline: [#2868](https://github.com/sparklemotion/nokogiri/pull/2868)
+- [`re2`](https://github.com/mudge/re2):
+  - Found 8 memory leaks: [#105](https://github.com/mudge/re2/pull/105)
+  - Running on CI: [#149](https://github.com/mudge/re2/pull/149)
 
 ## License
 

data/lib/ruby_memcheck/configuration.rb

@@ -29,8 +29,10 @@ module RubyMemcheck
       /\Arb_rescue/,
       /\Arb_respond_to\z/,
       /\Arb_thread_create\z/, # Threads are relased to a cache, so they may be reported as a leak
+      /\Arb_vm_exec\z/,
       /\Arb_yield/,
     ].freeze
+    RUBY_FREE_AT_EXIT_SUPPORTED = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0")
 
     attr_reader :binary_name
     attr_reader :ruby
@@ -43,9 +45,11 @@ module RubyMemcheck
     attr_reader :loaded_features_file
     attr_reader :output_io
     attr_reader :filter_all_errors
+    attr_reader :use_only_ruby_free_at_exit
 
     alias_method :valgrind_generate_suppressions?, :valgrind_generate_suppressions
     alias_method :filter_all_errors?, :filter_all_errors
+    alias_method :use_only_ruby_free_at_exit?, :use_only_ruby_free_at_exit
 
     def initialize(
       binary_name: nil,
@@ -57,7 +61,8 @@ module RubyMemcheck
       skipped_ruby_functions: DEFAULT_SKIPPED_RUBY_FUNCTIONS,
       temp_dir: Dir.mktmpdir,
       output_io: $stderr,
-      filter_all_errors: false
+      filter_all_errors: false,
+      use_only_ruby_free_at_exit: RUBY_FREE_AT_EXIT_SUPPORTED
     )
       @binary_name = binary_name
       @ruby = ruby
@@ -83,6 +88,8 @@ module RubyMemcheck
       ]
 
       @loaded_features_file = Tempfile.create("", @temp_dir)
+
+      @use_only_ruby_free_at_exit = use_only_ruby_free_at_exit
     end
 
     def command(*args)
@@ -94,6 +101,15 @@ module RubyMemcheck
         #     ruby_init_stack (thread_pthread.c:871)
         #     main (main.c:48)
         "ulimit -s unlimited && ",
+        # On some distros, and in some Docker containers, the number of file descriptors is set to a
+        # very high number like 1073741816 that valgrind >= 3.21.0 will error out on:
+        #   --184100:0:libcfile Valgrind: FATAL: Private file creation failed.
+        #      The current file descriptor limit is 1073741804.
+        #      If you are running in Docker please consider
+        #      lowering this limit with the shell built-in limit command.
+        #   --184100:0:libcfile Exiting now.
+        # See https://bugs.kde.org/show_bug.cgi?id=465435 for background information.
+        "ulimit -n 8192 && ",
         valgrind,
         valgrind_options,
         valgrind_suppression_files.map { |f| "--suppressions=#{f}" },

data/lib/ruby_memcheck/stack.rb

@@ -10,6 +10,32 @@ module RubyMemcheck
     end
 
     def skip?
+      if @configuration.use_only_ruby_free_at_exit?
+        skip_using_ruby_free_at_exit?
+      else
+        skip_using_original_heuristics?
+      end
+    end
+
+    private
+
+    def skip_using_ruby_free_at_exit?
+      if configuration.binary_name.nil?
+        false
+      else
+        in_binary = false
+
+        frames.each do |frame|
+          if frame.in_binary?
+            in_binary = true
+          end
+        end
+
+        !in_binary
+      end
+    end
+
+    def skip_using_original_heuristics?
       in_binary = false
 
       frames.each do |frame|

data/lib/ruby_memcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyMemcheck
-  VERSION = "2.3.0"
+  VERSION = "3.0.1"
 end

data/ruby_memcheck.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Use Valgrind memcheck without going crazy"
   spec.homepage      = "https://github.com/Shopify/ruby_memcheck"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
 
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency("nokogiri")
 
   spec.add_development_dependency("minitest", "~> 5.0")
-  spec.add_development_dependency("minitest-parallel_fork", "~> 1.2")
+  spec.add_development_dependency("minitest-parallel_fork", "~> 2.0")
   spec.add_development_dependency("rake", "~> 13.0")
   spec.add_development_dependency("rake-compiler", "~> 1.1")
   spec.add_development_dependency("rspec-core")

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Peter Zhu
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -44,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +121,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description:
 email:
 - peter@peterzhu.ca
 executables:
@@ -130,12 +128,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/cla.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -159,7 +160,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Shopify/ruby_memcheck
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,15 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy
 test_files: []