* [PATCH] mwrap 2.0.0 mwrap - LD_PRELOAD malloc wrapper for Ruby
@ 2018-07-20 9:25 6% Eric Wong
0 siblings, 0 replies; 3+ results
From: Eric Wong @ 2018-07-20 9:25 UTC (permalink / raw)
To: ruby-talk, mwrap-public
mwrap is designed to answer the question:
Which lines of Ruby are hitting malloc the most?
mwrap wraps all malloc-family calls to trace the Ruby source
location of such calls and bytes allocated at each callsite.
As of mwrap 2.0.0, it can also function as a leak detector
and show live allocations at every call site. Depending on
your application and workload, the overhead is roughly a 50%
increase memory and runtime.
It works best for allocations under GVL, but tries to track
numeric caller addresses for allocations made without GVL so you
can get an idea of how much memory usage certain extensions and
native libraries use.
It requires the concurrent lock-free hash table from the
Userspace RCU project: https://liburcu.org/
It does not require recompiling or rebuilding Ruby, but only
supports Ruby trunk (2.6.0dev+) on a few platforms:
* GNU/Linux
* FreeBSD (tested 11.1)
It may work on NetBSD, OpenBSD and DragonFly BSD.
Changes in 2.0.0:
This release includes significant changes to track live
allocations and frees. It can find memory leaks from malloc
with less overhead than valgrind's leakchecker and there is a
new Rack endpoint (MwrapRack) which can display live allocation
stats.
API additions:
* Mwrap#[] - https://80x24.org/mwrap/Mwrap.html#method-c-5B-5D
* Mwrap::SourceLocation - https://80x24.org/mwrap/Mwrap/SourceLocation.html
* MwrapRack - https://80x24.org/mwrap/MwrapRack.html
Incompatible changes:
* Mwrap.clear now an alias to Mwrap.reset; as it's unsafe
to implement the new Mwrap#[] API otherwise:
https://80x24.org/mwrap-public/20180716211933.5835-12-e@80x24.org/
26 changes since v1.0.0:
README: improve usage example
MANIFEST: add .document
add benchmark
use __attribute__((weak)) instead of dlsym
Mwrap.dump: do not segfault on invalid IO arg
bin/mwrap: support LISTEN_FDS env from systemd
support per-allocation headers for per-alloc tracking
mwrap: use malloc to do our own memalign
hold RCU read lock to insert each allocation
realloc: do not copy if allocation failed
internal_memalign: do not assume real_malloc succeeds
ensure ENOMEM is preserved in errno when appropriate
memalign: check alignment on all public functions
reduce stack usage from file names
resolve real_malloc earlier for C++ programs
allow analyzing live allocations via Mwrap[location]
alias Mwrap.clear to Mwrap.reset
implement accessors for SourceLocation
mwrap_aref: quiet -Wshorten-64-to-32 warning
fixes for FreeBSD 11.1...
use memrchr to extract address under glibc
do not track allocations for constructor and Init_
disable memalign tracking by default
support Mwrap.quiet to temporarily disable allocation tracking
mwrap_rack: Rack app to track live allocations
documentation updates for 2.0.0 release
^ permalink raw reply [relevance 6%]
* [PATCH 18/19] support Mwrap.quiet to temporarily disable allocation tracking
2018-07-16 21:19 7% [PATCH 0/19] the heavy version of mwrap Eric Wong
@ 2018-07-16 21:19 6% ` Eric Wong
0 siblings, 0 replies; 3+ results
From: Eric Wong @ 2018-07-16 21:19 UTC (permalink / raw)
To: mwrap-public
Tracking memory used for monitoring code itself is noise,
so give users the power to omit it.
---
ext/mwrap/mwrap.c | 22 ++++++++++++++++++++++
test/test_mwrap.rb | 20 ++++++++++++++++++++
2 files changed, 42 insertions(+)
diff --git a/ext/mwrap/mwrap.c b/ext/mwrap/mwrap.c
index 2752598..c1a59e7 100644
--- a/ext/mwrap/mwrap.c
+++ b/ext/mwrap/mwrap.c
@@ -30,6 +30,7 @@ extern void * __attribute__((weak)) ruby_current_execution_context_ptr;
extern void * __attribute__((weak)) ruby_current_vm_ptr; /* for rb_gc_count */
extern size_t __attribute__((weak)) rb_gc_count(void);
extern VALUE __attribute__((weak)) rb_cObject;
+extern VALUE __attribute__((weak)) rb_yield(VALUE);
/* true for glibc/dlmalloc/ptmalloc, not sure about jemalloc */
#define ASSUMED_MALLOC_ALIGNMENT (sizeof(void *) * 2)
@@ -997,6 +998,26 @@ static VALUE src_loc_name(VALUE self)
return ret;
}
+static VALUE reset_locating(VALUE ign) { --locating; return Qfalse; }
+
+/*
+ * call-seq:
+ *
+ * Mwrap.quiet do |depth|
+ * # expensive sort/calculate/emitting results of Mwrap.each
+ * # affecting statistics of the rest of the app
+ * end
+ *
+ * Stops allocation tracking inside the block. This is useful for
+ * monitoring code which calls other Mwrap (or ObjectSpace/GC)
+ * functions which unavoidably allocate memory.
+ */
+static VALUE mwrap_quiet(VALUE mod)
+{
+ size_t cur = ++locating;
+ return rb_ensure(rb_yield, SIZET2NUM(cur), reset_locating, 0);
+}
+
/*
* Document-module: Mwrap
*
@@ -1040,6 +1061,7 @@ void Init_mwrap(void)
rb_define_singleton_method(mod, "clear", mwrap_clear, 0);
rb_define_singleton_method(mod, "each", mwrap_each, -1);
rb_define_singleton_method(mod, "[]", mwrap_aref, 1);
+ rb_define_singleton_method(mod, "quiet", mwrap_quiet, 0);
rb_define_method(cSrcLoc, "each", src_loc_each, 0);
rb_define_method(cSrcLoc, "frees", src_loc_frees, 0);
rb_define_method(cSrcLoc, "allocations", src_loc_allocations, 0);
diff --git a/test/test_mwrap.rb b/test/test_mwrap.rb
index bc8694e..8425c35 100644
--- a/test/test_mwrap.rb
+++ b/test/test_mwrap.rb
@@ -252,4 +252,24 @@ class TestMwrap < Test::Unit::TestCase
loc.name.frozen? or abort 'SourceLocation#name not frozen'
end;
end
+
+ def test_quiet
+ assert_separately(+"#{<<~"begin;"}\n#{<<~'end;'}")
+ begin;
+ require 'mwrap'
+ before = __LINE__
+ res = Mwrap.quiet do |depth|
+ depth == 1 or abort 'depth is not 1'
+ ('a' * 10000).clear
+ Mwrap.quiet { |d| d == 2 or abort 'depth is not 2' }
+ :foo
+ end
+ after = __LINE__ - 1
+ (before..after).each do |lineno|
+ Mwrap["#{__FILE__}:#{lineno}"] and
+ abort "unexpectedly tracked allocation at line #{lineno}"
+ end
+ res == :foo or abort 'Mwrap.quiet did not return block result'
+ end;
+ end
end
--
EW
^ permalink raw reply related [relevance 6%]
* [PATCH 0/19] the heavy version of mwrap
@ 2018-07-16 21:19 7% Eric Wong
2018-07-16 21:19 6% ` [PATCH 18/19] support Mwrap.quiet to temporarily disable allocation tracking Eric Wong
0 siblings, 1 reply; 3+ results
From: Eric Wong @ 2018-07-16 21:19 UTC (permalink / raw)
To: mwrap-public
TL;DR: live demo of the new features running inside a Rack app:
https://80x24.org/MWRAP/each/2000
The following changes since commit 834de3bc0da4af53535d5c9d4975e546df9fb186:
bin/mwrap: support LISTEN_FDS env from systemd (2018-07-16 19:33:12 +0000)
are available in the Git repository at:
https://80x24.org/mwrap.git heavy
for you to fetch changes up to c432e3ad30aa247dbac8575af87b0c594365d3fd:
mwrap_rack: Rack app to track live allocations (2018-07-16 21:14:13 +0000)
----------------------------------------------------------------
Eric Wong (19):
support per-allocation headers for per-alloc tracking
mwrap: use malloc to do our own memalign
hold RCU read lock to insert each allocation
realloc: do not copy if allocation failed
internal_memalign: do not assume real_malloc succeeds
ensure ENOMEM is preserved in errno when appropriate
memalign: check alignment on all public functions
reduce stack usage from file names
resolve real_malloc earlier for C++ programs
allow analyzing live allocations via Mwrap[location]
alias Mwrap.clear to Mwrap.reset
implement accessors for SourceLocation
mwrap_aref: quiet -Wshorten-64-to-32 warning
fixes for FreeBSD 11.1...
use memrchr to extract address under glibc
do not track allocations for constructor and Init_
disable memalign tracking by default
support Mwrap.quiet to temporarily disable allocation tracking
mwrap_rack: Rack app to track live allocations
ext/mwrap/extconf.rb | 15 +
ext/mwrap/mwrap.c | 792 +++++++++++++++++++++++++++++++++++++++++++--------
lib/mwrap_rack.rb | 105 +++++++
test/test_mwrap.rb | 113 ++++++++
4 files changed, 901 insertions(+), 124 deletions(-)
create mode 100644 lib/mwrap_rack.rb
^ permalink raw reply [relevance 7%]
Results 1-3 of 3 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2018-07-16 21:19 7% [PATCH 0/19] the heavy version of mwrap Eric Wong
2018-07-16 21:19 6% ` [PATCH 18/19] support Mwrap.quiet to temporarily disable allocation tracking Eric Wong
2018-07-20 9:25 6% [PATCH] mwrap 2.0.0 mwrap - LD_PRELOAD malloc wrapper for Ruby Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/mwrap.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).