3d07efaa2e163875b02a32dc07b809cdecf29ab9
[WebKit-https.git] / Source / JavaScriptCore / heap / GCActivityCallback.h
1 /*
2  * Copyright (C) 2010 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef GCActivityCallback_h
30 #define GCActivityCallback_h
31
32 #include "HeapTimer.h"
33 #include <wtf/RefPtr.h>
34
35 #if USE(CF)
36 #include <CoreFoundation/CoreFoundation.h>
37 #endif
38
39 namespace JSC {
40
41 class Heap;
42
43 class JS_EXPORT_PRIVATE GCActivityCallback : public HeapTimer, public ThreadSafeRefCounted<GCActivityCallback> {
44     WTF_MAKE_FAST_ALLOCATED;
45 public:
46     static RefPtr<GCActivityCallback> createFullTimer(Heap*);
47     static RefPtr<GCActivityCallback> createEdenTimer(Heap*);
48
49     GCActivityCallback(Heap*);
50
51     virtual void doWork() override;
52
53     virtual void doCollection() = 0;
54
55     virtual void didAllocate(size_t);
56     virtual void willCollect();
57     virtual void cancel();
58     bool isEnabled() const { return m_enabled; }
59     void setEnabled(bool enabled) { m_enabled = enabled; }
60
61     static bool s_shouldCreateGCTimer;
62
63 protected:
64     virtual double lastGCLength() = 0;
65     virtual double gcTimeSlice(size_t bytes) = 0;
66     virtual double deathRate() = 0;
67
68 #if USE(CF)
69     GCActivityCallback(VM* vm, CFRunLoopRef runLoop)
70         : HeapTimer(vm, runLoop)
71         , m_enabled(true)
72         , m_delay(s_decade)
73     {
74     }
75 #elif PLATFORM(EFL)
76     static constexpr double s_hour = 3600;
77     GCActivityCallback(VM* vm, bool flag)
78         : HeapTimer(vm)
79         , m_enabled(flag)
80         , m_delay(s_hour)
81     {
82     }
83 #else
84     GCActivityCallback(VM* vm)
85         : HeapTimer(vm)
86         , m_enabled(true)
87     {
88     }
89 #endif
90
91     bool m_enabled;
92
93 #if USE(CF)
94 protected:
95     GCActivityCallback(Heap*, CFRunLoopRef);
96 #endif
97 #if USE(CF) || PLATFORM(EFL)
98 protected:
99     void cancelTimer();
100     void scheduleTimer(double);
101
102 private:
103     double m_delay;
104 #endif
105 };
106
107 } // namespace JSC
108
109 #endif