summaryrefslogtreecommitdiff
path: root/include/my_valgrind.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/my_valgrind.h')
-rw-r--r--include/my_valgrind.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/include/my_valgrind.h b/include/my_valgrind.h
index 7c2bc8aa3d4..04116e556ce 100644
--- a/include/my_valgrind.h
+++ b/include/my_valgrind.h
@@ -55,12 +55,19 @@ https://github.com/google/sanitizers/wiki/AddressSanitizerManualPoisoning */
#endif /* HAVE_VALGRIND_MEMCHECK_H */
#ifndef DBUG_OFF
+/* NOTE: Do not invoke TRASH_FILL directly! Use TRASH_ALLOC or TRASH_FREE.
+
+The MEM_UNDEFINED() call before memset() is for canceling the effect
+of any previous MEM_NOACCESS(). We must invoke MEM_UNDEFINED() after
+writing the dummy pattern, unless MEM_NOACCESS() is going to be invoked.
+On AddressSanitizer, the MEM_UNDEFINED() in TRASH_ALLOC() has no effect. */
#define TRASH_FILL(A,B,C) do { const size_t trash_tmp= (B); MEM_UNDEFINED(A, trash_tmp); memset(A, C, trash_tmp); } while (0)
#else
#define TRASH_FILL(A,B,C) do { MEM_UNDEFINED((A), (B)); } while (0)
#endif
-
+/** Note that some memory became allocated or uninitialized. */
#define TRASH_ALLOC(A,B) do { TRASH_FILL(A,B,0xA5); MEM_UNDEFINED(A,B); } while(0)
+/** Note that some memory became freed. (Prohibit further access to it.) */
#define TRASH_FREE(A,B) do { TRASH_FILL(A,B,0x8F); MEM_NOACCESS(A,B); } while(0)
#endif /* MY_VALGRIND_INCLUDED */