Bmalloc and GC should put auxiliaries (butterflies, typed array backing stores) in...
[WebKit.git] / Source / bmalloc / bmalloc / bmalloc.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 #include "AvailableMemory.h"
27 #include "Cache.h"
28 #include "Gigacage.h"
29 #include "Heap.h"
30 #include "PerHeapKind.h"
31 #include "PerProcess.h"
32 #include "Scavenger.h"
33 #include "StaticMutex.h"
34
35 namespace bmalloc {
36 namespace api {
37
38 // Returns null on failure.
39 inline void* tryMalloc(size_t size, HeapKind kind = HeapKind::Primary)
40 {
41     return Cache::tryAllocate(kind, size);
42 }
43
44 // Crashes on failure.
45 inline void* malloc(size_t size, HeapKind kind = HeapKind::Primary)
46 {
47     return Cache::allocate(kind, size);
48 }
49
50 // Returns null on failure.
51 inline void* tryMemalign(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
52 {
53     return Cache::tryAllocate(kind, alignment, size);
54 }
55
56 // Crashes on failure.
57 inline void* memalign(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
58 {
59     return Cache::allocate(kind, alignment, size);
60 }
61
62 // Crashes on failure.
63 inline void* realloc(void* object, size_t newSize, HeapKind kind = HeapKind::Primary)
64 {
65     return Cache::reallocate(kind, object, newSize);
66 }
67
68 // Returns null for failure
69 inline void* tryLargeMemalignVirtual(size_t alignment, size_t size, HeapKind kind = HeapKind::Primary)
70 {
71     Heap& heap = PerProcess<PerHeapKind<Heap>>::get()->at(kind);
72     std::lock_guard<StaticMutex> lock(Heap::mutex());
73     return heap.allocateLarge(lock, alignment, size, AllocationKind::Virtual);
74 }
75
76 inline void free(void* object, HeapKind kind = HeapKind::Primary)
77 {
78     Cache::deallocate(kind, object);
79 }
80
81 inline void freeLargeVirtual(void* object, HeapKind kind = HeapKind::Primary)
82 {
83     Heap& heap = PerProcess<PerHeapKind<Heap>>::get()->at(kind);
84     std::lock_guard<StaticMutex> lock(Heap::mutex());
85     heap.deallocateLarge(lock, object, AllocationKind::Virtual);
86 }
87
88 inline void scavengeThisThread()
89 {
90     for (unsigned i = numHeaps; i--;)
91         Cache::scavenge(static_cast<HeapKind>(i));
92 }
93
94 inline void scavenge()
95 {
96     scavengeThisThread();
97
98     PerProcess<Scavenger>::get()->scavenge();
99 }
100
101 inline bool isEnabled(HeapKind kind = HeapKind::Primary)
102 {
103     std::unique_lock<StaticMutex> lock(Heap::mutex());
104     return !PerProcess<PerHeapKind<Heap>>::getFastCase()->at(kind).debugHeap();
105 }
106     
107 inline size_t availableMemory()
108 {
109     return bmalloc::availableMemory();
110 }
111     
112 #if BPLATFORM(IOS)
113 inline size_t memoryFootprint()
114 {
115     return bmalloc::memoryFootprint();
116 }
117
118 inline double percentAvailableMemoryInUse()
119 {
120     return bmalloc::percentAvailableMemoryInUse();
121 }
122 #endif
123
124 #if BOS(DARWIN)
125 inline void setScavengerThreadQOSClass(qos_class_t overrideClass)
126 {
127     std::unique_lock<StaticMutex> lock(Heap::mutex());
128     PerProcess<Scavenger>::get()->setScavengerThreadQOSClass(overrideClass);
129 }
130 #endif
131
132 } // namespace api
133 } // namespace bmalloc