Butterflies should be allocated in Auxiliary MarkedSpace instead of CopiedSpace and...
[WebKit.git] / Source / JavaScriptCore / heap / WeakSet.h
1 /*
2  * Copyright (C) 2012, 2016 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 #ifndef WeakSet_h
27 #define WeakSet_h
28
29 #include "CellContainer.h"
30 #include "WeakBlock.h"
31 #include <wtf/SentinelLinkedList.h>
32
33 namespace JSC {
34
35 class Heap;
36 class WeakImpl;
37
38 class WeakSet : public BasicRawSentinelNode<WeakSet> {
39     friend class LLIntOffsetsExtractor;
40
41 public:
42     static WeakImpl* allocate(JSValue, WeakHandleOwner* = 0, void* context = 0);
43     static void deallocate(WeakImpl*);
44
45     WeakSet(VM*, CellContainer);
46     ~WeakSet();
47     void lastChanceToFinalize();
48     
49     CellContainer container() const { return m_container; }
50     void setContainer(CellContainer container) { m_container = container; }
51
52     Heap* heap() const;
53     VM* vm() const;
54
55     bool isEmpty() const;
56
57     unsigned visit(HeapRootVisitor&);
58     void reap();
59     void sweep();
60     void shrink();
61     void resetAllocator();
62
63 private:
64     JS_EXPORT_PRIVATE WeakBlock::FreeCell* findAllocator();
65     WeakBlock::FreeCell* tryFindAllocator();
66     WeakBlock::FreeCell* addAllocator();
67     void removeAllocator(WeakBlock*);
68
69     WeakBlock::FreeCell* m_allocator;
70     WeakBlock* m_nextAllocator;
71     DoublyLinkedList<WeakBlock> m_blocks;
72     VM* m_vm;
73     CellContainer m_container;
74 };
75
76 inline WeakSet::WeakSet(VM* vm, CellContainer container)
77     : m_allocator(0)
78     , m_nextAllocator(0)
79     , m_vm(vm)
80     , m_container(container)
81 {
82 }
83
84 inline VM* WeakSet::vm() const
85 {
86     return m_vm;
87 }
88
89 inline bool WeakSet::isEmpty() const
90 {
91     for (WeakBlock* block = m_blocks.head(); block; block = block->next()) {
92         if (!block->isEmpty())
93             return false;
94     }
95
96     return true;
97 }
98
99 inline void WeakSet::deallocate(WeakImpl* weakImpl)
100 {
101     weakImpl->setState(WeakImpl::Deallocated);
102 }
103
104 inline void WeakSet::lastChanceToFinalize()
105 {
106     for (WeakBlock* block = m_blocks.head(); block; block = block->next())
107         block->lastChanceToFinalize();
108 }
109
110 inline unsigned WeakSet::visit(HeapRootVisitor& visitor)
111 {
112     unsigned count = 0;
113     for (WeakBlock* block = m_blocks.head(); block; block = block->next()) {
114         count++;
115         block->visit(visitor);
116     }
117     return count;
118 }
119
120 inline void WeakSet::reap()
121 {
122     for (WeakBlock* block = m_blocks.head(); block; block = block->next())
123         block->reap();
124 }
125
126 inline void WeakSet::resetAllocator()
127 {
128     m_allocator = 0;
129     m_nextAllocator = m_blocks.head();
130 }
131
132 } // namespace JSC
133
134 #endif // WeakSet_h