Allow one sync GC per gcTimer interval on critical memory pressure warning
[WebKit-https.git] / Source / JavaScriptCore / heap / IncrementalSweeper.h
1 /*
2  * Copyright (C) 2012 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 IncrementalSweeper_h
27 #define IncrementalSweeper_h
28
29 #include "HeapTimer.h"
30 #include <wtf/Vector.h>
31
32 namespace JSC {
33
34 class Heap;
35 class MarkedBlock;
36
37 class IncrementalSweeper : public HeapTimer {
38     WTF_MAKE_FAST_ALLOCATED;
39 public:
40 #if USE(CF)
41     JS_EXPORT_PRIVATE IncrementalSweeper(Heap*, CFRunLoopRef);
42 #else
43     explicit IncrementalSweeper(VM*);
44 #endif
45
46     void startSweeping();
47
48     JS_EXPORT_PRIVATE virtual void doWork() override;
49     bool sweepNextBlock();
50     void willFinishSweeping();
51
52 #if USE(CF)
53 private:
54     void doSweep(double startTime);
55     void scheduleTimer();
56     void cancelTimer();
57     
58     Vector<MarkedBlock*>& m_blocksToSweep;
59 #endif
60 };
61
62 } // namespace JSC
63
64 #endif