vmmap crash at JavaScriptCore: 0x31cd12f6 (the JavaScript malloc zone enumerator)
[WebKit-https.git] / Source / bmalloc / bmalloc / Zone.cpp
1 /*
2  * Copyright (C) 2014, 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "Sizes.h"
27 #include "Zone.h"
28
29 namespace bmalloc {
30
31 template<typename T> static void remoteRead(task_t task, memory_reader_t reader, vm_address_t remotePointer, T& result)
32 {
33     void* tmp = nullptr;
34     kern_return_t error = reader(task, remotePointer, sizeof(T), &tmp);
35
36     // This read sometimes fails for unknown reasons (<rdar://problem/14093757>).
37     // Avoid a crash by skipping the memcpy when this happens.
38     if (error || !tmp) {
39         fprintf(stderr, "bmalloc: error reading remote process: 0x%x\n", error);
40         return;
41     }
42
43     memcpy(&result, tmp, sizeof(T));
44 }
45
46 // These function pointers are invoked unconditionally on all zones by various
47 // system tools. We don't support any of these features, but we provide
48 // just enough functionality not to crash.
49
50 static size_t good_size(malloc_zone_t*, size_t size)
51 {
52     return size;
53 }
54
55 static boolean_t check(malloc_zone_t*)
56 {
57     return true;
58 }
59
60 static void print(malloc_zone_t*, boolean_t)
61 {
62 }
63
64 static void log(malloc_zone_t*, void*)
65 {
66 }
67
68 static void force_lock(malloc_zone_t*)
69 {
70 }
71
72 static void force_unlock(malloc_zone_t*)
73 {
74 }
75
76 static void statistics(malloc_zone_t*, malloc_statistics_t* statistics)
77 {
78     memset(statistics, 0, sizeof(malloc_statistics_t));
79 }
80
81 static size_t size(malloc_zone_t*, const void*)
82 {
83     // Our zone is not public API, so no pointer can belong to us.
84     return 0;
85 }
86
87 // This function runs inside the leaks process.
88 static kern_return_t enumerator(task_t task, void* context, unsigned type_mask, vm_address_t zone_address, memory_reader_t reader, vm_range_recorder_t recorder)
89 {
90     Zone remoteZone(task, reader, zone_address);
91     for (auto* superChunk : remoteZone.superChunks()) {
92         vm_range_t range = { reinterpret_cast<vm_address_t>(superChunk), superChunkSize };
93
94         if ((type_mask & MALLOC_PTR_REGION_RANGE_TYPE))
95             (*recorder)(task, context, MALLOC_PTR_REGION_RANGE_TYPE, &range, 1);
96
97         if ((type_mask & MALLOC_PTR_IN_USE_RANGE_TYPE))
98             (*recorder)(task, context, MALLOC_PTR_IN_USE_RANGE_TYPE, &range, 1);
99     }
100
101     return 0;
102 }
103
104 // The memory analysis API requires the contents of this struct to be a static
105 // constant in the program binary. The leaks process will load this struct
106 // out of the program binary (and not out of the running process).
107 static malloc_introspection_t introspect = {
108     .enumerator = bmalloc::enumerator,
109     .good_size = bmalloc::good_size,
110     .check = bmalloc::check,
111     .print = bmalloc::print,
112     .log = bmalloc::log,
113     .force_lock = bmalloc::force_lock,
114     .force_unlock = bmalloc::force_unlock,
115     .statistics = bmalloc::statistics
116 };
117
118 Zone::Zone()
119 {
120     malloc_zone_t::size = &bmalloc::size;
121     malloc_zone_t::zone_name = "WebKit Malloc";
122     malloc_zone_t::introspect = &bmalloc::introspect;
123     malloc_zone_t::version = 4;
124     malloc_zone_register(this);
125 }
126
127 Zone::Zone(task_t task, memory_reader_t reader, vm_address_t remotePointer)
128 {
129     remoteRead(task, reader, remotePointer, *this);
130 }
131
132 } // namespace bmalloc