[WTF] Use m_suspendCount instead of m_suspended flag in Thread
[WebKit-https.git] / Source / JavaScriptCore / heap / LargeAllocation.h
1 /*
2  * Copyright (C) 2016-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 #pragma once
27
28 #include "MarkedBlock.h"
29 #include "WeakSet.h"
30
31 namespace JSC {
32
33 class SlotVisitor;
34
35 // WebKit has a good malloc that already knows what to do for large allocations. The GC shouldn't
36 // have to think about such things. That's where LargeAllocation comes in. We will allocate large
37 // objects directly using malloc, and put the LargeAllocation header just before them. We can detect
38 // when a HeapCell* is a LargeAllocation because it will have the MarkedBlock::atomSize / 2 bit set.
39
40 class LargeAllocation : public BasicRawSentinelNode<LargeAllocation> {
41 public:
42     static LargeAllocation* tryCreate(Heap&, size_t, Subspace*);
43     
44     ~LargeAllocation();
45     
46     static LargeAllocation* fromCell(const void* cell)
47     {
48         return bitwise_cast<LargeAllocation*>(bitwise_cast<char*>(cell) - headerSize());
49     }
50     
51     HeapCell* cell() const
52     {
53         return bitwise_cast<HeapCell*>(bitwise_cast<char*>(this) + headerSize());
54     }
55     
56     static bool isLargeAllocation(HeapCell* cell)
57     {
58         return bitwise_cast<uintptr_t>(cell) & halfAlignment;
59     }
60     
61     void lastChanceToFinalize();
62     
63     Heap* heap() const { return m_weakSet.heap(); }
64     VM* vm() const { return m_weakSet.vm(); }
65     WeakSet& weakSet() { return m_weakSet; }
66     
67     void shrink();
68     
69     void visitWeakSet(SlotVisitor&);
70     void reapWeakSet();
71     
72     void clearNewlyAllocated() { m_isNewlyAllocated = false; }
73     void flip();
74     
75     bool isNewlyAllocated() const { return m_isNewlyAllocated; }
76     ALWAYS_INLINE bool isMarked() { return m_isMarked.load(std::memory_order_relaxed); }
77     ALWAYS_INLINE bool isMarked(HeapCell*) { return isMarked(); }
78     ALWAYS_INLINE bool isMarked(HeapCell*, Dependency) { return isMarked(); }
79     ALWAYS_INLINE bool isMarkedConcurrently(HeapVersion, HeapCell*) { return isMarked(); }
80     bool isLive() { return isMarked() || isNewlyAllocated(); }
81     
82     bool hasValidCell() const { return m_hasValidCell; }
83     
84     bool isEmpty();
85     
86     size_t cellSize() const { return m_cellSize; }
87     
88     bool aboveLowerBound(const void* rawPtr)
89     {
90         char* ptr = bitwise_cast<char*>(rawPtr);
91         char* begin = bitwise_cast<char*>(cell());
92         return ptr >= begin;
93     }
94     
95     bool belowUpperBound(const void* rawPtr)
96     {
97         char* ptr = bitwise_cast<char*>(rawPtr);
98         char* begin = bitwise_cast<char*>(cell());
99         char* end = begin + cellSize();
100         // We cannot #include IndexingHeader.h because reasons. The fact that IndexingHeader is 8
101         // bytes is wired deep into our engine, so this isn't so bad.
102         size_t sizeOfIndexingHeader = 8;
103         return ptr <= end + sizeOfIndexingHeader;
104     }
105     
106     bool contains(const void* rawPtr)
107     {
108         return aboveLowerBound(rawPtr) && belowUpperBound(rawPtr);
109     }
110     
111     const AllocatorAttributes& attributes() const { return m_attributes; }
112     
113     Dependency aboutToMark(HeapVersion) { return nullDependency(); }
114     
115     ALWAYS_INLINE bool testAndSetMarked()
116     {
117         // This method is usually called when the object is already marked. This avoids us
118         // having to CAS in that case. It's profitable to reduce the total amount of CAS
119         // traffic.
120         if (isMarked())
121             return true;
122         return m_isMarked.compareExchangeStrong(false, true);
123     }
124     ALWAYS_INLINE bool testAndSetMarked(HeapCell*, Dependency) { return testAndSetMarked(); }
125     void clearMarked() { m_isMarked.store(false); }
126     
127     void noteMarked() { }
128     
129 #if ASSERT_DISABLED
130     void assertValidCell(VM&, HeapCell*) const { }
131 #else
132     void assertValidCell(VM&, HeapCell*) const;
133 #endif
134     
135     void sweep();
136     
137     void destroy();
138     
139     void dump(PrintStream&) const;
140     
141 private:
142     LargeAllocation(Heap&, size_t, Subspace*);
143     
144     static const unsigned alignment = MarkedBlock::atomSize;
145     static const unsigned halfAlignment = alignment / 2;
146
147     static unsigned headerSize();
148     
149     size_t m_cellSize;
150     bool m_isNewlyAllocated;
151     bool m_hasValidCell;
152     Atomic<bool> m_isMarked;
153     AllocatorAttributes m_attributes;
154     Subspace* m_subspace;
155     WeakSet m_weakSet;
156 };
157
158 inline unsigned LargeAllocation::headerSize()
159 {
160     return ((sizeof(LargeAllocation) + halfAlignment - 1) & ~(halfAlignment - 1)) | halfAlignment;
161 }
162
163 } // namespace JSC
164