Changeset 72625 in vbox for trunk

Timestamp:

Jun 20, 2018 12:21:30 PM (7 years ago)

Author:

vboxsync

Message:

iprt/mem.h: Added RTMEM_WILL_LEAK and RTMEM_MAY_LEAK macros for marking memory as leaked on higher levels. Made VBOX_GCC_SANITIZER_FLAGS define an IPRT friendly indicator, is VBOX_XXXX is still stricly forbidden in Runtime/.

Location:

trunk

Files:

• Config.kmk (modified) (1 diff)
• include/iprt/mem.h (modified) (1 diff)
• src/VBox/Runtime/r3/alloc.cpp (modified) (4 diffs)

trunk/Config.kmk

@@ -2930 +2930 @@
 ifdef VBOX_WITH_GCC_SANITIZER
  VBOX_GCC_SANITIZER_FLAGS := \
-        -fsanitize=undefined \
-        -fsanitize=address \
-        -fsanitize=return \
-        -fsanitize=bounds \
-        -fsanitize=object-size \
-        -fno-sanitize=alignment \
-        -fno-sanitize=vptr \
-        -fno-common \
-        -include sanitizer/lsan_interface.h \
-        -DVBOX_WITH_GCC_SANITIZER
+        -fsanitize=undefined \
+        -fsanitize=address \
+        -fsanitize=return \
+        -fsanitize=bounds \
+        -fsanitize=object-size \
+        -fno-sanitize=alignment \
+        -fno-sanitize=vptr \
+        -fno-common \
+        -include sanitizer/lsan_interface.h \
+        -DIPRT_WITH_GCC_SANITIZER \
+        -DVBOX_WITH_GCC_SANITIZER
 else
  VBOX_GCC_SANITIZER_FLAGS =

trunk/include/iprt/mem.h

@@ -499 +499 @@
  */
 RTDECL(void) RTMemWipeThoroughly(void *pv, size_t cb, size_t cMinPasses) RT_NO_THROW_PROTO;
+
+
+/** @def RTMEM_WILL_LEAK
+ * Macro for hinting that a memory allocation @a a_pv will leak.
+ *
+ * @note This shall only be used in code that doesn't allocate the object.
+ *       Code allocating memory knowing it will leak shall start the allocation
+ *       tag string with 'will-leak:'.
+ */
+/** @def RTMEM_MAY_LEAK
+ * Macro for hinting that a memory allocation @a a_pv may leak.
+ *
+ * @note This shall only be used in code that doesn't allocate the object.
+ *       Code allocating memory knowing it may leak shall start the allocation
+ *       tag string with 'may-leak:'.
+ */
+#ifdef IPRT_WITH_GCC_SANITIZER
+# define RTMEM_WILL_LEAK(a_pv)   __lsan_ignore_object(a_pv)
+# define RTMEM_MAY_LEAK(a_pv)    __lsan_ignore_object(a_pv)
+#else
+# define RTMEM_WILL_LEAK(a_pv)   do { } while (0)
+# define RTMEM_MAY_LEAK(a_pv)    do { } while (0)
+#endif
+
 
 #ifdef IN_RING0

trunk/src/VBox/Runtime/r3/alloc.cpp

@@ -86 +86 @@
 
 
-#ifdef VBOX_WITH_GCC_SANITIZER
+#ifdef IPRT_WITH_GCC_SANITIZER
 /**
  * Checks if @a pszTag is a leak tag.
@@ -118 +118 @@
         && pszTag[8] == 'k';
 }
-#endif /* VBOX_WITH_GCC_SANITIZER */
+#endif /* IPRT_WITH_GCC_SANITIZER */
 
 
@@ -158 +158 @@
               , ("pv=%p RTMEM_ALIGNMENT=%#x\n", pv, RTMEM_ALIGNMENT));
 #endif /* !RTALLOC_USE_EFENCE */
-#ifdef VBOX_WITH_GCC_SANITIZER
+#ifdef IPRT_WITH_GCC_SANITIZER
     if (rtMemIsLeakTag(pszTag))
         __lsan_ignore_object(pv);
@@ -186 +186 @@
               , ("pv=%p RTMEM_ALIGNMENT=%#x\n", pv, RTMEM_ALIGNMENT));
 #endif /* !RTALLOC_USE_EFENCE */
-#ifdef VBOX_WITH_GCC_SANITIZER
+#ifdef IPRT_WITH_GCC_SANITIZER
     if (rtMemIsLeakTag(pszTag))
         __lsan_ignore_object(pv);