ruby_memcheck 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fda45a20aaf7c0365ca7605bf5a74ca03d6f7fdf69b962c0c69695319b722739
-  data.tar.gz: b6ab56e5aa970a8d8c38a5e91b4ed92d93a7f0d1e286f97f749a08f9f44d05a9
+  metadata.gz: fca269c41420864e19c468ac6d8c0101624f7c8638b603f2cf6975acbcc9f6b6
+  data.tar.gz: ea928aef070c76ab183cc80592e0ad8ecf3cbb2c5550f4dacd4ea143c0096d5a
 SHA512:
-  metadata.gz: 5e66f20481d0b3d8a129dc38c7e0b667d0ac9c418b34b433532c4f739349f8809680d1129f3dc1549dc73b2220f657a399ce9ee7328d23030c138508f5680b90
-  data.tar.gz: 1d55a41057a27ab8de092717dbbd90174fe6bfbf59f36f0fb120f1a6534c467e63daa8505551b840cdc715c7dd5ce4f258188523f567aaa9fce9560fcbca2dc1
+  metadata.gz: e7049b31e3177ab265ae4f67318cb3c95ef9332091eea013af93a636662e4350190d02a0f6a8d571755e0df9031ba20a59624c133b07dbf57a3af04929da374e
+  data.tar.gz: 8e210f743656f5c604103f113574f2957f37666b2ba52ba350ee94680a34fbb61ade1ccd535b6145f268c280c29082b50c2133b3d1b4c32a9ba19c83c9b1af65

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.
@@ -121,18 +140,6 @@ The easiest way to use this gem is to use it on your test suite (minitest or RSp
       end
       ```
 
-1. Add the following line to your `test_helper.rb` or `spec_helper.rb`:
-
-    ```ruby
-    at_exit { GC.start }
-    ```
-
-    This will run a major garbage collection cycle before the Ruby process shuts down. This will ensure that any remaining Ruby objects are collected which will prevent Valgrind from reporting false positives.
-
-    It is safest to add the line above at the very first line of `test_helper.rb` or `spec_helper.rb`.
-
-    - **For minitest:** It is important that the line above is added BEFORE the `require "minitest/autorun"` line.
-
 1. You're ready to run your test suite with Valgrind using `rake test:valgrind` or `rake spec:valgrind`! Note that this will take a while to run because Valgrind will make Ruby significantly slower.
 1. (Optional) If you find false positives in the output, you can create Valgrind suppression files. See the [`Suppression files`](#suppression-files) section for more details.
 
@@ -151,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
 

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/rspec/rake_task.rb

@@ -40,6 +40,7 @@ module RubyMemcheck
       def spec_command
         # First part of command is Ruby
         args = super.split(" ")[1..]
+        args.unshift("-r" + File.expand_path(File.join(__dir__, "../test_helper.rb")))
 
         configuration.command(args)
       end

data/lib/ruby_memcheck/test_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+at_exit { GC.start }

data/lib/ruby_memcheck/test_task.rb

@@ -18,6 +18,7 @@ module RubyMemcheck
     end
 
     def ruby(*args, **options, &block)
+      args.unshift("-r" + File.expand_path(File.join(__dir__, "test_helper.rb")))
       command = configuration.command(args)
       sh(command, **options) do |ok, res|
         report_valgrind_errors

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.1.2"
+  VERSION = "1.3.0"
 end

data/suppressions/ruby.supp

@@ -28,3 +28,9 @@
   fun:exec_recursive
   ...
 }
+{
+  "Invalid read of size 8" when marking the stack of fibers
+  Memcheck:Addr8
+  fun:each_location*
+  ...
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Peter Zhu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -143,6 +143,7 @@ files:
 - lib/ruby_memcheck/rspec/rake_task.rb
 - lib/ruby_memcheck/stack.rb
 - lib/ruby_memcheck/suppression.rb
+- lib/ruby_memcheck/test_helper.rb
 - lib/ruby_memcheck/test_task.rb
 - lib/ruby_memcheck/test_task_reporter.rb
 - lib/ruby_memcheck/valgrind_error.rb
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy