25a6094f1e17f7f3f1a58c70212cf782699a38c4
[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;
34     (*reader)(task, remotePointer, sizeof(T), &tmp);
35     memcpy(&result, tmp, sizeof(T));
36 }
37
38 // These function pointers are invoked unconditionally on all zones by various
39 // system tools. We don't support any of these features, but we provide
40 // just enough functionality not to crash.
41
42 static size_t good_size(malloc_zone_t*, size_t size)
43 {
44     return size;
45 }
46
47 static boolean_t check(malloc_zone_t*)
48 {
49     return true;
50 }
51
52 static void print(malloc_zone_t*, boolean_t)
53 {
54 }
55
56 static void log(malloc_zone_t*, void*)
57 {
58 }
59
60 static void force_lock(malloc_zone_t*)
61 {
62 }
63
64 static void force_unlock(malloc_zone_t*)
65 {
66 }
67
68 static void statistics(malloc_zone_t*, malloc_statistics_t* statistics)
69 {
70     memset(statistics, 0, sizeof(malloc_statistics_t));
71 }
72
73 static size_t size(malloc_zone_t*, const void*)
74 {
75     // Our zone is not public API, so no pointer can belong to us.
76     return 0;
77 }
78
79 // This function runs inside the leaks process.
80 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)
81 {
82     Zone remoteZone(task, reader, zone_address);
83     for (auto* superChunk : remoteZone.superChunks()) {
84         vm_range_t range = { reinterpret_cast<vm_address_t>(superChunk), superChunkSize };
85
86         if ((type_mask & MALLOC_PTR_REGION_RANGE_TYPE))
87             (*recorder)(task, context, MALLOC_PTR_REGION_RANGE_TYPE, &range, 1);
88
89         if ((type_mask & MALLOC_PTR_IN_USE_RANGE_TYPE))
90             (*recorder)(task, context, MALLOC_PTR_IN_USE_RANGE_TYPE, &range, 1);
91     }
92
93     return 0;
94 }
95
96 // The memory analysis API requires the contents of this struct to be a static
97 // constant in the program binary. The leaks process will load this struct
98 // out of the program binary (and not out of the running process).
99 static malloc_introspection_t introspect = {
100     .enumerator = bmalloc::enumerator,
101     .good_size = bmalloc::good_size,
102     .check = bmalloc::check,
103     .print = bmalloc::print,
104     .log = bmalloc::log,
105     .force_lock = bmalloc::force_lock,
106     .force_unlock = bmalloc::force_unlock,
107     .statistics = bmalloc::statistics
108 };
109
110 Zone::Zone()
111 {
112     malloc_zone_t::size = &bmalloc::size;
113     malloc_zone_t::zone_name = "WebKit Malloc";
114     malloc_zone_t::introspect = &bmalloc::introspect;
115     malloc_zone_t::version = 4;
116     malloc_zone_register(this);
117 }
118
119 Zone::Zone(task_t task, memory_reader_t reader, vm_address_t remotePointer)
120 {
121     remoteRead(task, reader, remotePointer, *this);
122 }
123
124 } // namespace bmalloc