Use WTF::Lock and WTF::Condition instead of WTF::Mutex, WTF::ThreadCondition, std...
[WebKit-https.git] / Source / JavaScriptCore / heap / CopiedSpace.h
1 /*
2  * Copyright (C) 2011 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 #ifndef CopiedSpace_h
27 #define CopiedSpace_h
28
29 #include "CopiedAllocator.h"
30 #include "HeapOperation.h"
31 #include "TinyBloomFilter.h"
32 #include <wtf/Assertions.h>
33 #include <wtf/CheckedBoolean.h>
34 #include <wtf/Condition.h>
35 #include <wtf/DoublyLinkedList.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/Lock.h>
38 #include <wtf/OSAllocator.h>
39 #include <wtf/PageBlock.h>
40 #include <wtf/StdLibExtras.h>
41
42 namespace JSC {
43
44 class Heap;
45 class CopiedBlock;
46
47 class CopiedSpace {
48     friend class CopyVisitor;
49     friend class GCThreadSharedData;
50     friend class SlotVisitor;
51     friend class JIT;
52 public:
53     CopiedSpace(Heap*);
54     ~CopiedSpace();
55     void init();
56
57     CheckedBoolean tryAllocate(size_t, void**);
58     CheckedBoolean tryReallocate(void**, size_t, size_t);
59     
60     CopiedAllocator& allocator() { return m_allocator; }
61
62     void didStartFullCollection();
63
64     template <HeapOperation collectionType>
65     void startedCopying();
66     void startedEdenCopy();
67     void startedFullCopy();
68     void doneCopying();
69     bool isInCopyPhase() { return m_inCopyingPhase; }
70
71     void pin(CopiedBlock*);
72     bool isPinned(void*);
73
74     bool contains(CopiedBlock*);
75     bool contains(void*, CopiedBlock*&);
76     
77     void pinIfNecessary(void* pointer);
78
79     size_t size();
80     size_t capacity();
81
82     bool isPagedOut(double deadline);
83     bool shouldDoCopyPhase() { return m_shouldDoCopyPhase; }
84
85     static CopiedBlock* blockFor(void*);
86
87     Heap* heap() const { return m_heap; }
88     
89     size_t takeBytesRemovedFromOldSpaceDueToReallocation()
90     {
91         size_t result = 0;
92         std::swap(m_bytesRemovedFromOldSpaceDueToReallocation, result);
93         return result;
94     }
95
96 private:
97     static bool isOversize(size_t);
98
99     JS_EXPORT_PRIVATE CheckedBoolean tryAllocateSlowCase(size_t, void**);
100     CheckedBoolean tryAllocateOversize(size_t, void**);
101     CheckedBoolean tryReallocateOversize(void**, size_t, size_t);
102     
103     void allocateBlock();
104     CopiedBlock* allocateBlockForCopyingPhase();
105
106     void doneFillingBlock(CopiedBlock*, CopiedBlock**);
107     void recycleEvacuatedBlock(CopiedBlock*, HeapOperation collectionType);
108     void recycleBorrowedBlock(CopiedBlock*);
109
110     Heap* m_heap;
111
112     CopiedAllocator m_allocator;
113
114     HashSet<CopiedBlock*> m_blockSet;
115
116     Lock m_toSpaceLock;
117
118     struct CopiedGeneration {
119         CopiedGeneration()
120             : toSpace(0)
121             , fromSpace(0)
122         {
123         }
124
125         DoublyLinkedList<CopiedBlock>* toSpace;
126         DoublyLinkedList<CopiedBlock>* fromSpace;
127         
128         DoublyLinkedList<CopiedBlock> blocks1;
129         DoublyLinkedList<CopiedBlock> blocks2;
130         DoublyLinkedList<CopiedBlock> oversizeBlocks;
131
132         TinyBloomFilter blockFilter;
133     };
134
135     CopiedGeneration m_oldGen;
136     CopiedGeneration m_newGen;
137    
138     bool m_inCopyingPhase;
139     bool m_shouldDoCopyPhase;
140
141     Lock m_loanedBlocksLock; 
142     Condition m_loanedBlocksCondition;
143     size_t m_numberOfLoanedBlocks;
144     
145     size_t m_bytesRemovedFromOldSpaceDueToReallocation;
146
147     static const size_t s_maxAllocationSize = CopiedBlock::blockSize / 2;
148     static const size_t s_initialBlockNum = 16;
149     static const size_t s_blockMask = ~(CopiedBlock::blockSize - 1);
150 };
151
152 } // namespace JSC
153
154 #endif