Enable gigacage on iOS
[WebKit-https.git] / Source / bmalloc / bmalloc / Cache.h
1 /*
2  * Copyright (C) 2014-2017 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 #ifndef Cache_h
27 #define Cache_h
28
29 #include "Allocator.h"
30 #include "BExport.h"
31 #include "Deallocator.h"
32 #include "HeapKind.h"
33 #include "PerThread.h"
34
35 namespace bmalloc {
36
37 // Per-thread allocation / deallocation cache, backed by a per-process Heap.
38
39 class Cache {
40 public:
41     static void* tryAllocate(HeapKind, size_t);
42     static void* allocate(HeapKind, size_t);
43     static void* tryAllocate(HeapKind, size_t alignment, size_t);
44     static void* allocate(HeapKind, size_t alignment, size_t);
45     static void deallocate(HeapKind, void*);
46     static void* reallocate(HeapKind, void*, size_t);
47
48     static void scavenge(HeapKind);
49
50     Cache(HeapKind);
51
52     Allocator& allocator() { return m_allocator; }
53     Deallocator& deallocator() { return m_deallocator; }
54
55 private:
56     BEXPORT static void* tryAllocateSlowCaseNullCache(HeapKind, size_t);
57     BEXPORT static void* allocateSlowCaseNullCache(HeapKind, size_t);
58     BEXPORT static void* allocateSlowCaseNullCache(HeapKind, size_t alignment, size_t);
59     BEXPORT static void deallocateSlowCaseNullCache(HeapKind, void*);
60     BEXPORT static void* reallocateSlowCaseNullCache(HeapKind, void*, size_t);
61
62     Deallocator m_deallocator;
63     Allocator m_allocator;
64 };
65
66 inline void* Cache::tryAllocate(HeapKind heapKind, size_t size)
67 {
68     PerHeapKind<Cache>* caches = PerThread<PerHeapKind<Cache>>::getFastCase();
69     if (!caches)
70         return tryAllocateSlowCaseNullCache(heapKind, size);
71     return caches->at(mapToActiveHeapKindAfterEnsuringGigacage(heapKind)).allocator().tryAllocate(size);
72 }
73
74 inline void* Cache::allocate(HeapKind heapKind, size_t size)
75 {
76     PerHeapKind<Cache>* caches = PerThread<PerHeapKind<Cache>>::getFastCase();
77     if (!caches)
78         return allocateSlowCaseNullCache(heapKind, size);
79     return caches->at(mapToActiveHeapKindAfterEnsuringGigacage(heapKind)).allocator().allocate(size);
80 }
81
82 inline void* Cache::tryAllocate(HeapKind heapKind, size_t alignment, size_t size)
83 {
84     PerHeapKind<Cache>* caches = PerThread<PerHeapKind<Cache>>::getFastCase();
85     if (!caches)
86         return allocateSlowCaseNullCache(heapKind, alignment, size);
87     return caches->at(mapToActiveHeapKindAfterEnsuringGigacage(heapKind)).allocator().tryAllocate(alignment, size);
88 }
89
90 inline void* Cache::allocate(HeapKind heapKind, size_t alignment, size_t size)
91 {
92     PerHeapKind<Cache>* caches = PerThread<PerHeapKind<Cache>>::getFastCase();
93     if (!caches)
94         return allocateSlowCaseNullCache(heapKind, alignment, size);
95     return caches->at(mapToActiveHeapKindAfterEnsuringGigacage(heapKind)).allocator().allocate(alignment, size);
96 }
97
98 inline void Cache::deallocate(HeapKind heapKind, void* object)
99 {
100     PerHeapKind<Cache>* caches = PerThread<PerHeapKind<Cache>>::getFastCase();
101     if (!caches)
102         return deallocateSlowCaseNullCache(heapKind, object);
103     return caches->at(mapToActiveHeapKindAfterEnsuringGigacage(heapKind)).deallocator().deallocate(object);
104 }
105
106 inline void* Cache::reallocate(HeapKind heapKind, void* object, size_t newSize)
107 {
108     PerHeapKind<Cache>* caches = PerThread<PerHeapKind<Cache>>::getFastCase();
109     if (!caches)
110         return reallocateSlowCaseNullCache(heapKind, object, newSize);
111     return caches->at(mapToActiveHeapKindAfterEnsuringGigacage(heapKind)).allocator().reallocate(object, newSize);
112 }
113
114 } // namespace bmalloc
115
116 #endif // Cache_h