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