mwrap 1.0.0

data/mwrap.gemspec

@@ -0,0 +1,30 @@
+git_manifest = `git ls-files 2>/dev/null`.split("\n")
+manifest = File.exist?('MANIFEST') ?
+  File.readlines('MANIFEST').map!(&:chomp).delete_if(&:empty?) : git_manifest
+if git_manifest[0] && manifest != git_manifest
+  tmp = "MANIFEST.#$$.tmp"
+  File.open(tmp, 'w') { |fp| fp.puts(git_manifest.join("\n")) }
+  File.rename(tmp, 'MANIFEST')
+  system('git add MANIFEST')
+end
+
+Gem::Specification.new do |s|
+  s.name = 'mwrap'
+  s.version = '1.0.0'
+  s.homepage = 'https://80x24.org/mwrap/'
+  s.authors = ["Ruby hackers"]
+  s.summary = 'LD_PRELOAD malloc wrapper for Ruby'
+  s.executables = %w(mwrap)
+  s.files = manifest
+  s.description = <<~EOF
+mwrap wraps all malloc, calloc, and realloc calls to trace the Ruby
+source location of such calls and bytes allocated at each callsite.
+  EOF
+  s.email = %q{e@80x24.org}
+  s.test_files = Dir['test/test_*.rb']
+  s.extensions = %w(ext/mwrap/extconf.rb)
+
+  s.add_development_dependency('test-unit', '~> 3.0')
+  s.add_development_dependency('rake-compiler', '~> 1.0')
+  s.licenses = %w(GPL-2.0+)
+end

data/test/test_mwrap.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+# Copyright (C) 2018 mwrap hackers <mwrap-public@80x24.org>
+# License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+require 'test/unit'
+require 'mwrap'
+require 'rbconfig'
+require 'tempfile'
+
+class TestMwrap < Test::Unit::TestCase
+  RB = "#{RbConfig::CONFIG['bindir']}/#{RbConfig::CONFIG['RUBY_INSTALL_NAME']}"
+
+  mwrap_so = $".grep(%r{/mwrap\.so\z})[0]
+  env = ENV.to_hash
+  cur = env['LD_PRELOAD']
+  env['LD_PRELOAD'] = cur ? "#{mwrap_so}:#{cur}".freeze : mwrap_so
+  @@env = env.freeze
+  inc = File.dirname(mwrap_so)
+  @@cmd = %W(#{RB} -w --disable=gems -I#{inc} -rmwrap).freeze
+
+  def test_mwrap_preload
+    cmd = @@cmd + %w(
+      -e ("helloworld"*1000).clear
+      -e Mwrap.dump
+    )
+    Tempfile.create('junk') do |tmp|
+      tmp.sync = true
+      res = system(@@env, *cmd, err: tmp)
+      assert res, $?.inspect
+      tmp.rewind
+      lines = tmp.readlines
+      line_1 = lines.grep(/\s-e:1\b/)[0].strip
+      assert_equal '10001', line_1.split(/\s+/)[0]
+    end
+  end
+
+  def test_dump_via_destructor
+    env = @@env.dup
+    env['MWRAP'] = 'dump_fd:5'
+    cmd = @@cmd + %w(-e ("0"*10000).clear)
+    Tempfile.create('junk') do |tmp|
+      tmp.sync = true
+      res = system(env, *cmd, { 5 => tmp })
+      assert res, $?.inspect
+      tmp.rewind
+      assert_match(/\b10001\s+1\s+-e:1$/, tmp.read)
+
+      env['MWRAP'] = 'dump_fd:1,dump_min:10000'
+      tmp.rewind
+      tmp.truncate(0)
+      res = system(env, *cmd, { 1 => tmp })
+      assert res, $?.inspect
+      tmp.rewind
+      assert_match(/\b10001\s+1\s+-e:1$/, tmp.read)
+
+      tmp.rewind
+      tmp.truncate(0)
+      env['MWRAP'] = "dump_path:#{tmp.path},dump_min:10000"
+      res = system(env, *cmd)
+      assert res, $?.inspect
+      assert_match(/\b10001\s+1\s+-e:1$/, tmp.read)
+    end
+  end
+
+  def test_clear
+    cmd = @@cmd + %w(
+      -e ("0"*10000).clear
+      -e Mwrap.clear
+      -e ("0"*20000).clear
+      -e Mwrap.dump($stdout,9999)
+    )
+    Tempfile.create('junk') do |tmp|
+      tmp.sync = true
+      res = system(@@env, *cmd, { 1 => tmp })
+      assert res, $?.inspect
+      tmp.rewind
+      buf = tmp.read
+      assert_not_match(/\s+-e:1$/, buf)
+      assert_match(/\b20001\s+1\s+-e:3$/, buf)
+    end
+  end
+
+  # make sure we don't break commands spawned by an mwrap-ed Ruby process:
+  def test_non_ruby_exec
+    IO.pipe do |r, w|
+      th = Thread.new { r.read }
+      Tempfile.create('junk') do |tmp|
+        tmp.sync = true
+        env = @@env.merge('MWRAP' => "dump_path:#{tmp.path}")
+        cmd = %w(perl -e print("HELLO_WORLD"))
+        res = system(env, *cmd, out: w)
+        w.close
+        assert res, $?.inspect
+        assert_match(/0x[a-f0-9]+\b/, tmp.read)
+      end
+      assert_equal "HELLO_WORLD", th.value
+    end
+  end
+
+  # some URCU flavors use USR1, ensure the one we choose does not
+  def test_sigusr1_works
+    cmd = @@cmd + %w(
+      -e STDOUT.sync=true
+      -e trap(:USR1){p("HELLO_WORLD")}
+      -e END{Mwrap.dump}
+      -e puts -e STDIN.read)
+    IO.pipe do |r, w|
+      IO.pipe do |r2, w2|
+        pid = spawn(@@env, *cmd, in: r2, out: w, err: '/dev/null')
+        r2.close
+        w.close
+        assert_equal "\n", r.gets
+        buf = +''
+        10.times { Process.kill(:USR1, pid) }
+        while IO.select([r], nil, nil, 0.1)
+          case tmp = r.read_nonblock(1000, exception: false)
+          when String
+            buf << tmp
+          end
+        end
+        w2.close
+        Process.wait(pid)
+        assert_predicate $?, :success?, $?.inspect
+        assert_equal(["\"HELLO_WORLD\"\n"], buf.split(/^/).uniq)
+      end
+    end
+  end
+
+  def test_reset
+    assert_nil Mwrap.reset
+  end
+
+  def test_each
+    cmd = @@cmd + %w(
+      -e ("0"*10000).clear
+      -e h={}
+      -e Mwrap.each(1000){|a,b,c|h[a]=[b,c]}
+      -e puts(Marshal.dump(h))
+    )
+    r = IO.popen(@@env, cmd, 'r')
+    h = Marshal.load(r.read)
+    assert_not_predicate h, :empty?
+    h.each_key { |k| assert_kind_of String, k }
+    h.each_value do |total,calls|
+      assert_operator total, :>, 0
+      assert_operator calls, :>, 0
+      assert_operator total, :>=, calls
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: mwrap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ruby hackers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  mwrap wraps all malloc, calloc, and realloc calls to trace the Ruby
+  source location of such calls and bytes allocated at each callsite.
+email: e@80x24.org
+executables:
+- mwrap
+extensions:
+- ext/mwrap/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- COPYING
+- MANIFEST
+- README
+- Rakefile
+- bin/mwrap
+- ext/mwrap/extconf.rb
+- ext/mwrap/jhash.h
+- ext/mwrap/mwrap.c
+- mwrap.gemspec
+- test/test_mwrap.rb
+homepage: https://80x24.org/mwrap/
+licenses:
+- GPL-2.0+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 3.0.0.beta1
+signing_key: 
+specification_version: 4
+summary: LD_PRELOAD malloc wrapper for Ruby
+test_files:
+- test/test_mwrap.rb