GC constraint solving should be parallel
[WebKit-https.git] / Source / JavaScriptCore / heap / HeapInlines.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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "GCDeferralContext.h"
29 #include "Heap.h"
30 #include "HeapCellInlines.h"
31 #include "IndexingHeader.h"
32 #include "JSCallee.h"
33 #include "JSCell.h"
34 #include "Structure.h"
35 #include <type_traits>
36 #include <wtf/Assertions.h>
37 #include <wtf/MainThread.h>
38 #include <wtf/RandomNumber.h>
39
40 namespace JSC {
41
42 ALWAYS_INLINE VM* Heap::vm() const
43 {
44     return bitwise_cast<VM*>(bitwise_cast<uintptr_t>(this) - OBJECT_OFFSETOF(VM, heap));
45 }
46
47 ALWAYS_INLINE Heap* Heap::heap(const HeapCell* cell)
48 {
49     if (!cell)
50         return nullptr;
51     return cell->heap();
52 }
53
54 inline Heap* Heap::heap(const JSValue v)
55 {
56     if (!v.isCell())
57         return nullptr;
58     return heap(v.asCell());
59 }
60
61 inline bool Heap::hasHeapAccess() const
62 {
63     return m_worldState.load() & hasAccessBit;
64 }
65
66 inline bool Heap::worldIsStopped() const
67 {
68     return m_worldIsStopped;
69 }
70
71 // FIXME: This should be an instance method, so that it can get the markingVersion() quickly.
72 // https://bugs.webkit.org/show_bug.cgi?id=179988
73 ALWAYS_INLINE bool Heap::isMarked(const void* rawCell)
74 {
75     HeapCell* cell = bitwise_cast<HeapCell*>(rawCell);
76     if (cell->isLargeAllocation())
77         return cell->largeAllocation().isMarked();
78     MarkedBlock& block = cell->markedBlock();
79     return block.isMarked(block.vm()->heap.objectSpace().markingVersion(), cell);
80 }
81
82 ALWAYS_INLINE bool Heap::testAndSetMarked(HeapVersion markingVersion, const void* rawCell)
83 {
84     HeapCell* cell = bitwise_cast<HeapCell*>(rawCell);
85     if (cell->isLargeAllocation())
86         return cell->largeAllocation().testAndSetMarked();
87     MarkedBlock& block = cell->markedBlock();
88     Dependency dependency = block.aboutToMark(markingVersion);
89     return block.testAndSetMarked(cell, dependency);
90 }
91
92 ALWAYS_INLINE size_t Heap::cellSize(const void* rawCell)
93 {
94     return bitwise_cast<HeapCell*>(rawCell)->cellSize();
95 }
96
97 inline void Heap::writeBarrier(const JSCell* from, JSValue to)
98 {
99 #if ENABLE(WRITE_BARRIER_PROFILING)
100     WriteBarrierCounters::countWriteBarrier();
101 #endif
102     if (!to.isCell())
103         return;
104     writeBarrier(from, to.asCell());
105 }
106
107 inline void Heap::writeBarrier(const JSCell* from, JSCell* to)
108 {
109 #if ENABLE(WRITE_BARRIER_PROFILING)
110     WriteBarrierCounters::countWriteBarrier();
111 #endif
112     if (!from)
113         return;
114     if (!isWithinThreshold(from->cellState(), barrierThreshold()))
115         return;
116     if (LIKELY(!to))
117         return;
118     writeBarrierSlowPath(from);
119 }
120
121 inline void Heap::writeBarrier(const JSCell* from)
122 {
123     ASSERT_GC_OBJECT_LOOKS_VALID(const_cast<JSCell*>(from));
124     if (!from)
125         return;
126     if (UNLIKELY(isWithinThreshold(from->cellState(), barrierThreshold())))
127         writeBarrierSlowPath(from);
128 }
129
130 inline void Heap::writeBarrierWithoutFence(const JSCell* from)
131 {
132     ASSERT_GC_OBJECT_LOOKS_VALID(const_cast<JSCell*>(from));
133     if (!from)
134         return;
135     if (UNLIKELY(isWithinThreshold(from->cellState(), blackThreshold)))
136         addToRememberedSet(from);
137 }
138
139 inline void Heap::mutatorFence()
140 {
141     if (isX86() || UNLIKELY(mutatorShouldBeFenced()))
142         WTF::storeStoreFence();
143 }
144
145 template<typename Functor> inline void Heap::forEachCodeBlock(const Functor& func)
146 {
147     forEachCodeBlockImpl(scopedLambdaRef<bool(CodeBlock*)>(func));
148 }
149
150 template<typename Functor> inline void Heap::forEachCodeBlockIgnoringJITPlans(const AbstractLocker& codeBlockSetLocker, const Functor& func)
151 {
152     forEachCodeBlockIgnoringJITPlansImpl(codeBlockSetLocker, scopedLambdaRef<bool(CodeBlock*)>(func));
153 }
154
155 template<typename Functor> inline void Heap::forEachProtectedCell(const Functor& functor)
156 {
157     for (auto& pair : m_protectedValues)
158         functor(pair.key);
159     m_handleSet.forEachStrongHandle(functor, m_protectedValues);
160 }
161
162 #if USE(FOUNDATION)
163 template <typename T>
164 inline void Heap::releaseSoon(RetainPtr<T>&& object)
165 {
166     m_delayedReleaseObjects.append(WTFMove(object));
167 }
168 #endif
169
170 inline void Heap::incrementDeferralDepth()
171 {
172     ASSERT(!mayBeGCThread() || m_worldIsStopped);
173     m_deferralDepth++;
174 }
175
176 inline void Heap::decrementDeferralDepth()
177 {
178     ASSERT(!mayBeGCThread() || m_worldIsStopped);
179     m_deferralDepth--;
180 }
181
182 inline void Heap::decrementDeferralDepthAndGCIfNeeded()
183 {
184     ASSERT(!mayBeGCThread() || m_worldIsStopped);
185     m_deferralDepth--;
186     
187     if (UNLIKELY(m_didDeferGCWork)) {
188         decrementDeferralDepthAndGCIfNeededSlow();
189         
190         // Here are the possible relationships between m_deferralDepth and m_didDeferGCWork.
191         // Note that prior to the call to decrementDeferralDepthAndGCIfNeededSlow,
192         // m_didDeferGCWork had to have been true. Now it can be either false or true. There is
193         // nothing we can reliably assert.
194         //
195         // Possible arrangements of m_didDeferGCWork and !!m_deferralDepth:
196         //
197         // Both false: We popped out of all DeferGCs and we did whatever work was deferred.
198         //
199         // Only m_didDeferGCWork is true: We stopped for GC and the GC did DeferGC. This is
200         // possible because of how we handle the baseline JIT's worklist. It's also perfectly
201         // safe because it only protects reportExtraMemory. We can just ignore this.
202         //
203         // Only !!m_deferralDepth is true: m_didDeferGCWork had been set spuriously. It is only
204         // cleared by decrementDeferralDepthAndGCIfNeededSlow(). So, if we had deferred work but
205         // then decrementDeferralDepth()'d, then we might have the bit set even if we GC'd since
206         // then.
207         //
208         // Both true: We're in a recursive ~DeferGC. We wanted to do something about the
209         // deferred work, but were unable to.
210     }
211 }
212
213 inline HashSet<MarkedArgumentBuffer*>& Heap::markListSet()
214 {
215     if (!m_markListSet)
216         m_markListSet = std::make_unique<HashSet<MarkedArgumentBuffer*>>();
217     return *m_markListSet;
218 }
219
220 inline void Heap::reportExtraMemoryAllocated(size_t size)
221 {
222     if (size > minExtraMemory) 
223         reportExtraMemoryAllocatedSlowCase(size);
224 }
225
226 inline void Heap::deprecatedReportExtraMemory(size_t size)
227 {
228     if (size > minExtraMemory) 
229         deprecatedReportExtraMemorySlowCase(size);
230 }
231
232 inline void Heap::acquireAccess()
233 {
234     if (m_worldState.compareExchangeWeak(0, hasAccessBit))
235         return;
236     acquireAccessSlow();
237 }
238
239 inline bool Heap::hasAccess() const
240 {
241     return m_worldState.loadRelaxed() & hasAccessBit;
242 }
243
244 inline void Heap::releaseAccess()
245 {
246     if (m_worldState.compareExchangeWeak(hasAccessBit, 0))
247         return;
248     releaseAccessSlow();
249 }
250
251 inline bool Heap::mayNeedToStop()
252 {
253     return m_worldState.loadRelaxed() != hasAccessBit;
254 }
255
256 inline void Heap::stopIfNecessary()
257 {
258     if (mayNeedToStop())
259         stopIfNecessarySlow();
260 }
261
262 template<typename Func>
263 void Heap::forEachSlotVisitor(const Func& func)
264 {
265     auto locker = holdLock(m_parallelSlotVisitorLock);
266     func(*m_collectorSlotVisitor);
267     func(*m_mutatorSlotVisitor);
268     for (auto& slotVisitor : m_parallelSlotVisitors)
269         func(*slotVisitor);
270 }
271
272 } // namespace JSC