ruby_memcheck 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e474f34ff993ba99b7c554d54bf850c49b8fc8f73fdec8702639373673a088
-  data.tar.gz: a1413639549cc0493adf456b8f38e6dc6463975dab3ef508459809f3b8307031
+  metadata.gz: d7a2965241d52c1a38ece5788f2e029a6424fbd34f0b18ffc3dcc35253a45377
+  data.tar.gz: 4949a4a3357647895f61bc85353342a6257b329d970f854ca7105fd85843b4b8
 SHA512:
-  metadata.gz: ade6759ab00942eb4dc1ebd5f5e3578d316c49cdf69e979e42ec5d37a8215d139d9765bca26f519158764613d51ed58f01bed055ba70b17860e0d15d7b1c9a89
-  data.tar.gz: 46b92557fbf9dca12a6b3a9f5196d95d54d44b886f06d46beb7b6afe7768476decc921c0f893864e9417328453f45346a4bf91159df8fe3bd529091b19637b90
+  metadata.gz: bdc2918a24c74f5b238bc67a86d071006abc24df8a8ac613c5d555ad8de8c27a147c63bb85f42cfa6c13f1a14c3599c61329e93d324da741f5373d562d602a3a
+  data.tar.gz: b2f8a27e88f0ab7347429eda0fc484ffba7eecf01b29e7411a6d1cdafb7fac31dfed10d826ae5259b089102cd984c93f94196e346851b8b0aab2842dc02b7821

data/.github/workflows/test.yml

@@ -4,11 +4,13 @@ jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         entry:
           - { ruby: '2.7', allowed-failure: false }
           - { ruby: '3.0', allowed-failure: false }
           - { ruby: '3.1', allowed-failure: false }
+          - { ruby: '3.2', allowed-failure: false }
           - { ruby: ruby-head, allowed-failure: false }
     name: ruby ${{ matrix.entry.ruby }}
     steps:
@@ -16,7 +18,18 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.entry.ruby }}
-      - run: sudo apt-get install -y valgrind
+      # - run: sudo apt-get install -y valgrind
+      # We cannot use Valgrind from apt because we need at least Valgrind 3.20.0
+      # to support DWARF 5
+      - run: sudo apt-get install -y libc6-dbg
+      - name: Install Valgrind from source
+        run: |
+          wget https://sourceware.org/pub/valgrind/valgrind-3.20.0.tar.bz2
+          tar xvf valgrind-3.20.0.tar.bz2
+          cd valgrind-3.20.0
+          ./configure
+          make
+          sudo make install
       - run: bundle install --jobs=3 --retry=3
       - run: bundle exec rake
         continue-on-error: ${{ matrix.entry.allowed-failure }}

data/README.md

@@ -50,6 +50,25 @@ gem install ruby_memcheck
 
 ## Setup
 
+> **Note**
+> If you encounter errors from Valgrind that looks like this:
+> ```
+> ### unhandled dwarf2 abbrev form code 0x25
+> ```
+> Then you need a newer version of Valgrind (>= 3.20.0) with DWARF5 support.
+> The current versions of Valgrind in Ubuntu Packages is not new enough.
+>
+> You can install Valgrind from source using the following commands:
+> ```
+> sudo apt-get install -y libc6-dbg
+> wget https://sourceware.org/pub/valgrind/valgrind-3.20.0.tar.bz2
+> tar xvf valgrind-3.20.0.tar.bz2
+> cd valgrind-3.20.0
+> ./configure
+> make
+> sudo make install
+> ```
+
 The easiest way to use this gem is to use it on your test suite (minitest or RSpec) using rake.
 
 0. Install Valgrind.
@@ -73,7 +92,7 @@ The easiest way to use this gem is to use it on your test suite (minitest or RSp
 
 1. Setup the test task for your test framework.
     - **minitest**
-    
+
       Locate your test task(s) in your Rakefile. You can identify it with a call to `Rake::TestTask.new`.
 
       Create a namespace under the test task and create a `RubyMemcheck::TestTask` with the same configuration.
@@ -139,6 +158,7 @@ When you run `RubyMemcheck.config`, you are creating a default `RubyMemcheck::Co
 - `skipped_ruby_functions`: Optional. Ruby functions that are ignored because they are considered a call back into Ruby. This is only present as an escape hatch, so avoid using it. If you find another Ruby function that is a false positive because it calls back into Ruby, please send a patch into this repo. Otherwise, use a Valgrind suppression file.
 - `valgrind_xml_dir`: Optional. The directory to store temporary XML files for Valgrind. 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`.
 
 ## Suppression files
 
@@ -155,7 +175,7 @@ Let's celebrate wins from this gem! If this gem was useful for you, please share
   - Running on CI: [#162](https://github.com/Shopify/liquid-c/pull/162)
 - [`nokogiri`](https://github.com/sparklemotion/nokogiri):
   - Found 5 memory leaks: [4 in #2345](https://github.com/sparklemotion/nokogiri/pull/2345), [#2347](https://github.com/sparklemotion/nokogiri/pull/2347)
-  - CI is WIP: [#2344](https://github.com/sparklemotion/nokogiri/pull/2344)
+  - Running on CI: [#2344](https://github.com/sparklemotion/nokogiri/pull/2344)
 - [`rotoscope`](https://github.com/Shopify/rotoscope):
   - Found a [memory leak in Ruby TracePoint](https://bugs.ruby-lang.org/issues/18264)
   - Running on CI: [#89](https://github.com/Shopify/rotoscope/pull/89)
@@ -163,6 +183,11 @@ Let's celebrate wins from this gem! If this gem was useful for you, please share
   - Found 1 memory leak: [#9150](https://github.com/protocolbuffers/protobuf/pull/9150)
 - [`gRPC`](https://github.com/grpc/grpc):
   - Found 1 memory leak: [#27900](https://github.com/grpc/grpc/pull/27900)
+- [`wasmtime-rb`](https://github.com/bytecodealliance/wasmtime-rb):
+  - Found 1 memory leak: [#26](https://github.com/bytecodealliance/wasmtime-rb/pull/26)
+- [`yarp`](https://github.com/shopify/yarp):
+  - Found 6 memory leaks and 1 memory error: [#292](https://github.com/Shopify/yarp/pull/304), [#292](https://github.com/Shopify/yarp/pull/292)
+  - Running on CI: [#293](https://github.com/Shopify/yarp/pull/293)
 
 ## License
 

data/lib/ruby_memcheck/configuration.rb

@@ -31,9 +31,19 @@ module RubyMemcheck
       /\Arb_yield/,
     ].freeze
 
-    attr_reader :binary_name, :ruby, :valgrind, :valgrind_options, :valgrind_suppression_files,
-      :valgrind_generate_suppressions, :skipped_ruby_functions, :valgrind_xml_dir, :output_io
+    attr_reader :binary_name
+    attr_reader :ruby
+    attr_reader :valgrind
+    attr_reader :valgrind_options
+    attr_reader :valgrind_suppression_files
+    attr_reader :valgrind_generate_suppressions
+    attr_reader :skipped_ruby_functions
+    attr_reader :valgrind_xml_dir
+    attr_reader :output_io
+    attr_reader :filter_all_errors
+
     alias_method :valgrind_generate_suppressions?, :valgrind_generate_suppressions
+    alias_method :filter_all_errors?, :filter_all_errors
 
     def initialize(
       binary_name:,
@@ -44,7 +54,8 @@ module RubyMemcheck
       valgrind_generate_suppressions: false,
       skipped_ruby_functions: DEFAULT_SKIPPED_RUBY_FUNCTIONS,
       valgrind_xml_dir: Dir.mktmpdir,
-      output_io: $stderr
+      output_io: $stderr,
+      filter_all_errors: false
     )
       @binary_name = binary_name
       @ruby = ruby
@@ -56,6 +67,7 @@ module RubyMemcheck
       @valgrind_generate_suppressions = valgrind_generate_suppressions
       @skipped_ruby_functions = skipped_ruby_functions
       @output_io = output_io
+      @filter_all_errors = filter_all_errors
 
       if valgrind_xml_dir
         valgrind_xml_dir = File.expand_path(valgrind_xml_dir)

data/lib/ruby_memcheck/frame.rb

@@ -14,17 +14,18 @@ module RubyMemcheck
     end
 
     def in_ruby?
+      return false unless obj
+
       obj == configuration.ruby ||
         # Hack to fix Ruby built with --enabled-shared
         File.basename(obj) == "libruby.so.#{RUBY_VERSION}"
     end
 
     def in_binary?
-      if obj
-        File.basename(obj, ".*") == configuration.binary_name
-      else
-        false
-      end
+      return false unless obj
+
+      binary_name_without_ext = File.join(File.dirname(obj), File.basename(obj, ".*"))
+      binary_name_without_ext.end_with?(File.join("", configuration.binary_name))
     end
 
     def to_s

data/lib/ruby_memcheck/valgrind_error.rb

@@ -47,7 +47,7 @@ module RubyMemcheck
     private
 
     def should_filter?
-      kind_leak?
+      @configuration.filter_all_errors? || kind_leak?
     end
 
     def kind_leak?

data/lib/ruby_memcheck/version.rb

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

data/suppressions/ruby.supp

@@ -28,3 +28,25 @@
   fun:exec_recursive
   ...
 }
+{
+  "Invalid read of size 8" when marking the stack of fibers
+  Memcheck:Addr8
+  fun:each_location*
+  ...
+}
+{
+  Rust probes for statx(buf), will be fixed in Valgrind >= 3.1.6.0
+  Memcheck:Param
+  statx(buf)
+  ...
+  fun:*try_statx*
+  ...
+}
+{
+  Rust probes for statx(file_name), will be fixed in Valgrind >= 3.1.6.0
+  Memcheck:Param
+  statx(file_name)
+  ...
+  fun:*try_statx*
+  ...
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Peter Zhu
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: 
+description:
 email:
 - peter@peterzhu.ca
 executables: []
@@ -155,7 +155,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/peterzhu2118/ruby_memcheck
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy
 test_files: []