From: Nicholas Nethercote Date: Fri, 2 Jun 2006 22:32:02 +0000 (+0000) Subject: Add a helpful comment. X-Git-Tag: svn/VALGRIND_3_2_0~10 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=74ef44f79a80860b4efcd8319e57f9abf8abc5c4;p=thirdparty%2Fvalgrind.git Add a helpful comment. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5949 --- diff --git a/include/valgrind.h b/include/valgrind.h index b5c8222b4a..82d9a78a01 100644 --- a/include/valgrind.h +++ b/include/valgrind.h @@ -2442,6 +2442,11 @@ VALGRIND_PRINTF_BACKTRACE(const char *format, ...) you could miss an error this way). See memcheck/tests/custom_alloc.c for an example. + WARNING: if your allocator uses malloc() or 'new' to allocate + superblocks, rather than mmap() or brk(), this will not work properly -- + you'll likely get assertion failures during leak detection. This is + because Valgrind doesn't like seeing overlapping heap blocks. Sorry. + Nb: block must be freed via a free()-like function specified with VALGRIND_FREELIKE_BLOCK or mismatch errors will occur. */ #define VALGRIND_MALLOCLIKE_BLOCK(addr, sizeB, rzB, is_zeroed) \