bmalloc should implement malloc introspection (to stop false-positive leaks when...
authorggaren@apple.com <ggaren@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 19 Feb 2015 20:42:52 +0000 (20:42 +0000)
committerggaren@apple.com <ggaren@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 19 Feb 2015 20:42:52 +0000 (20:42 +0000)
https://bugs.webkit.org/show_bug.cgi?id=141802

Reviewed by Andreas Kling.

This patch does the bare minimum to stop false positive leaks from
being reported by the Darwin leaks tool. We register each super chunk
as a single object, and then request that the leaks tool scan it.

* bmalloc.xcodeproj/project.pbxproj: Added an abstraction for the malloc
zone introspection API.

* bmalloc/Algorithm.h: Missing #include.

* bmalloc/VMHeap.cpp:
(bmalloc::VMHeap::grow):
* bmalloc/VMHeap.h: Adopt the new abstraction.

* bmalloc/Zone.cpp: Added.
(bmalloc::remoteRead): Helper for reading an object out of another process.
(bmalloc::Zone::enumerator):
(bmalloc::Zone::Zone): Register a malloc zone so that we will participate
in introspection.

* bmalloc/Zone.h: Added.
(bmalloc::Zone::superChunks):
(bmalloc::Zone::addSuperChunk): Use a non-dynamically-allocated vector
since our dynamic allocations will not be scanned by leaks since they
will have the malloc VM tag.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@180359 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/bmalloc/ChangeLog
Source/bmalloc/bmalloc.xcodeproj/project.pbxproj
Source/bmalloc/bmalloc/Algorithm.h
Source/bmalloc/bmalloc/VMHeap.cpp
Source/bmalloc/bmalloc/VMHeap.h
Source/bmalloc/bmalloc/Zone.cpp [new file with mode: 0644]
Source/bmalloc/bmalloc/Zone.h [new file with mode: 0644]

index 66ff2b2..41e8c5d 100644 (file)
@@ -1,3 +1,35 @@
+2015-02-19  Geoffrey Garen  <ggaren@apple.com>
+
+        bmalloc should implement malloc introspection (to stop false-positive leaks when MallocStackLogging is off)
+        https://bugs.webkit.org/show_bug.cgi?id=141802
+
+        Reviewed by Andreas Kling.
+
+        This patch does the bare minimum to stop false positive leaks from
+        being reported by the Darwin leaks tool. We register each super chunk
+        as a single object, and then request that the leaks tool scan it.
+
+        * bmalloc.xcodeproj/project.pbxproj: Added an abstraction for the malloc
+        zone introspection API.
+
+        * bmalloc/Algorithm.h: Missing #include.
+
+        * bmalloc/VMHeap.cpp:
+        (bmalloc::VMHeap::grow):
+        * bmalloc/VMHeap.h: Adopt the new abstraction.
+
+        * bmalloc/Zone.cpp: Added.
+        (bmalloc::remoteRead): Helper for reading an object out of another process.
+        (bmalloc::Zone::enumerator):
+        (bmalloc::Zone::Zone): Register a malloc zone so that we will participate
+        in introspection.
+
+        * bmalloc/Zone.h: Added.
+        (bmalloc::Zone::superChunks):
+        (bmalloc::Zone::addSuperChunk): Use a non-dynamically-allocated vector
+        since our dynamic allocations will not be scanned by leaks since they
+        will have the malloc VM tag.
+
 2015-02-18  Geoffrey Garen  <ggaren@apple.com>
 
         bmalloc: VMHeap should keep a record of all of its VM ranges (for malloc introspection)
index 72606b7..21d7d5a 100644 (file)
@@ -16,6 +16,8 @@
                143CB81C19022BC900B16A45 /* StaticMutex.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 143CB81A19022BC900B16A45 /* StaticMutex.cpp */; };
                143CB81D19022BC900B16A45 /* StaticMutex.h in Headers */ = {isa = PBXBuildFile; fileRef = 143CB81B19022BC900B16A45 /* StaticMutex.h */; settings = {ATTRIBUTES = (Private, ); }; };
                1440AFC91A95142400837FAA /* SuperChunk.h in Headers */ = {isa = PBXBuildFile; fileRef = 1440AFC81A95142400837FAA /* SuperChunk.h */; settings = {ATTRIBUTES = (Private, ); }; };
+               1440AFCB1A95261100837FAA /* Zone.h in Headers */ = {isa = PBXBuildFile; fileRef = 1440AFCA1A95261100837FAA /* Zone.h */; settings = {ATTRIBUTES = (Private, ); }; };
+               1440AFCD1A9527AF00837FAA /* Zone.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1440AFCC1A9527AF00837FAA /* Zone.cpp */; };
                1448C30018F3754600502839 /* mbmalloc.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1448C2FF18F3754300502839 /* mbmalloc.cpp */; };
                1448C30118F3754C00502839 /* bmalloc.h in Headers */ = {isa = PBXBuildFile; fileRef = 1448C2FE18F3754300502839 /* bmalloc.h */; settings = {ATTRIBUTES = (Private, ); }; };
                14895D911A3A319C0006235D /* Environment.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 14895D8F1A3A319C0006235D /* Environment.cpp */; };
@@ -92,6 +94,8 @@
                143E29E918CAE8BE00FE8A0F /* MediumPage.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = MediumPage.h; path = bmalloc/MediumPage.h; sourceTree = "<group>"; };
                143E29ED18CAE90500FE8A0F /* SmallPage.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SmallPage.h; path = bmalloc/SmallPage.h; sourceTree = "<group>"; };
                1440AFC81A95142400837FAA /* SuperChunk.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SuperChunk.h; path = bmalloc/SuperChunk.h; sourceTree = "<group>"; };
+               1440AFCA1A95261100837FAA /* Zone.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = Zone.h; path = bmalloc/Zone.h; sourceTree = "<group>"; };
+               1440AFCC1A9527AF00837FAA /* Zone.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = Zone.cpp; path = bmalloc/Zone.cpp; sourceTree = "<group>"; };
                144469E417A46BFE00F9EA1D /* Cache.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; lineEnding = 0; name = Cache.cpp; path = bmalloc/Cache.cpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
                144469E517A46BFE00F9EA1D /* Cache.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; name = Cache.h; path = bmalloc/Cache.h; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.objcpp; };
                144469FD17A61F1F00F9EA1D /* PerThread.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; name = PerThread.h; path = bmalloc/PerThread.h; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.objcpp; };
                                1440AFC81A95142400837FAA /* SuperChunk.h */,
                                144F7BFB18BFC517003537F3 /* VMHeap.cpp */,
                                144F7BFC18BFC517003537F3 /* VMHeap.h */,
+                               1440AFCA1A95261100837FAA /* Zone.h */,
+                               1440AFCC1A9527AF00837FAA /* Zone.cpp */,
                        );
                        name = heap;
                        sourceTree = "<group>";
                                14C919C918FCC59F0028DB43 /* BPlatform.h in Headers */,
                                14DD788C18F48CAE00950702 /* LargeChunk.h in Headers */,
                                14DD789218F48CFC00950702 /* EndTag.h in Headers */,
+                               1440AFCB1A95261100837FAA /* Zone.h in Headers */,
                                140FA00519CE4B6800FFD3C8 /* LineMetadata.h in Headers */,
                                14DD78CC18F48D7500950702 /* PerThread.h in Headers */,
                                14DD78B418F48D6B00950702 /* Chunk.h in Headers */,
                                14F271C818EA3990008C152F /* ObjectType.cpp in Sources */,
                                14F271C518EA397E008C152F /* Deallocator.cpp in Sources */,
                                14F271C418EA397B008C152F /* Cache.cpp in Sources */,
+                               1440AFCD1A9527AF00837FAA /* Zone.cpp in Sources */,
                        );
                        runOnlyForDeploymentPostprocessing = 0;
                };
index db40b6f..fdf31b0 100644 (file)
@@ -27,6 +27,7 @@
 #define Algorithm_h
 
 #include "Algorithm.h"
+#include "BAssert.h"
 #include <algorithm>
 #include <cstdint>
 #include <cstddef>
index d71449b..a8429ff 100644 (file)
@@ -40,7 +40,9 @@ VMHeap::VMHeap()
 void VMHeap::grow()
 {
     SuperChunk* superChunk = SuperChunk::create();
-    m_superChunks.push(superChunk);
+#if BPLATFORM(DARWIN)
+    m_zone.addSuperChunk(superChunk);
+#endif
 
     SmallChunk* smallChunk = superChunk->smallChunk();
     for (auto* it = smallChunk->begin(); it != smallChunk->end(); ++it)
index b34ba78..b0ca4b9 100644 (file)
@@ -34,6 +34,9 @@
 #include "SegregatedFreeList.h"
 #include "SmallChunk.h"
 #include "Vector.h"
+#if BPLATFORM(DARWIN)
+#include "Zone.h"
+#endif
 
 namespace bmalloc {
 
@@ -61,7 +64,9 @@ private:
     Vector<SmallPage*> m_smallPages;
     Vector<MediumPage*> m_mediumPages;
     SegregatedFreeList m_largeRanges;
-    Vector<SuperChunk*> m_superChunks;
+#if BPLATFORM(DARWIN)
+    Zone m_zone;
+#endif
 };
 
 inline SmallPage* VMHeap::allocateSmallPage()
diff --git a/Source/bmalloc/bmalloc/Zone.cpp b/Source/bmalloc/bmalloc/Zone.cpp
new file mode 100644 (file)
index 0000000..f2174ce
--- /dev/null
@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2014, 2015 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
+ */
+
+#include "Sizes.h"
+#include "Zone.h"
+
+namespace bmalloc {
+
+// The memory analysis API requires the contents of this struct to be a static
+// constant in the program binary. The leaks process will load this struct
+// out of the program binary (and not out of the running process).
+static malloc_introspection_t introspect = {
+    .enumerator = Zone::enumerator
+};
+
+template<typename T> static void remoteRead(task_t task, memory_reader_t reader, vm_address_t pointer, T& result)
+{
+    void* tmp;
+    (*reader)(task, pointer, sizeof(T), &tmp);
+    memcpy(&result, tmp, sizeof(T));
+}
+
+// This function runs inside the leaks process.
+kern_return_t Zone::enumerator(task_t task, void* context, unsigned type_mask, vm_address_t zone_address, memory_reader_t reader, vm_range_recorder_t recorder)
+{
+    Zone remoteZone;
+    remoteRead(task, reader, zone_address, remoteZone);
+    
+    for (auto* superChunk : remoteZone.superChunks()) {
+        vm_range_t range = { reinterpret_cast<vm_address_t>(superChunk), superChunkSize };
+
+        if ((type_mask & MALLOC_PTR_REGION_RANGE_TYPE))
+            (*recorder)(task, context, MALLOC_PTR_REGION_RANGE_TYPE, &range, 1);
+
+        if ((type_mask & MALLOC_PTR_IN_USE_RANGE_TYPE))
+            (*recorder)(task, context, MALLOC_PTR_IN_USE_RANGE_TYPE, &range, 1);
+    }
+
+    return 0;
+}
+
+Zone::Zone()
+{
+    version = 4;
+    zone_name = "WebKit Malloc";
+    introspect = &bmalloc::introspect;
+    malloc_zone_register(this);
+}
+
+} // namespace bmalloc
diff --git a/Source/bmalloc/bmalloc/Zone.h b/Source/bmalloc/bmalloc/Zone.h
new file mode 100644 (file)
index 0000000..b9fc228
--- /dev/null
@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2014, 2015 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
+ */
+
+#ifndef Zone_h
+#define Zone_h
+
+#include "FixedVector.h"
+#include <malloc/malloc.h>
+
+namespace bmalloc {
+
+class SuperChunk;
+
+class Zone : public malloc_zone_t {
+public:
+    // Enough capacity to track a 64GB heap, so probably enough for anything.
+    static const size_t capacity = 2048;
+
+    static kern_return_t enumerator(task_t, void* context, unsigned type_mask, vm_address_t, memory_reader_t, vm_range_recorder_t);
+
+    Zone();
+
+    void addSuperChunk(SuperChunk*);
+    FixedVector<SuperChunk*, capacity>& superChunks() { return m_superChunks; }
+    
+private:
+    // This vector has two purposes:
+    //     (1) It stores the list of SuperChunks so that we can enumerate
+    //         each SuperChunk and request that it be scanned if reachable.
+    //     (2) It roots a pointer to each SuperChunk in a global non-malloc
+    //         VM region, making each SuperChunk appear reachable, and therefore
+    //         ensuring that the leaks tool will scan it. (The leaks tool
+    //         conservatively scans all writeable VM regions that are not malloc
+    //         regions, and then scans malloc regions using the introspection API.)
+    // This prevents the leaks tool from reporting false positive leaks for
+    // objects pointed to from bmalloc memory -- though it also prevents the
+    // leaks tool from finding any leaks in bmalloc memory.
+    FixedVector<SuperChunk*, capacity> m_superChunks;
+};
+
+inline void Zone::addSuperChunk(SuperChunk* superChunk)
+{
+    if (m_superChunks.size() == m_superChunks.capacity())
+        return;
+    
+    m_superChunks.push(superChunk);
+}
+
+} // namespace bmalloc
+
+#endif // Zone_h