Log number of bytes reclaimed at each step of memory pressure relief.
[WebKit-https.git] / Source / WebCore / platform / MemoryPressureHandler.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 MemoryPressureHandler_h
27 #define MemoryPressureHandler_h
28
29 #include <atomic>
30 #include <time.h>
31 #include <wtf/FastMalloc.h>
32
33 #if PLATFORM(IOS)
34 #include <wtf/ThreadingPrimitives.h>
35 #endif
36
37 namespace WebCore {
38
39 #if PLATFORM(IOS)
40 enum MemoryPressureReason {
41     MemoryPressureReasonNone = 0 << 0,
42     MemoryPressureReasonVMPressure = 1 << 0,
43     MemoryPressureReasonVMStatus = 1 << 1,
44 };
45 #endif
46
47 typedef void (*LowMemoryHandler)(bool critical);
48
49 class MemoryPressureHandler {
50     WTF_MAKE_FAST_ALLOCATED;
51 public:
52     friend MemoryPressureHandler& memoryPressureHandler();
53
54     void install();
55
56     void setLowMemoryHandler(LowMemoryHandler handler)
57     {
58         ASSERT(!m_installed);
59         m_lowMemoryHandler = handler;
60     }
61
62     bool isUnderMemoryPressure() const { return m_underMemoryPressure; }
63
64 #if PLATFORM(IOS)
65     // FIXME: Can we share more of this with OpenSource?
66     void installMemoryReleaseBlock(void (^releaseMemoryBlock)(), bool clearPressureOnMemoryRelease = true);
67     void setReceivedMemoryPressure(MemoryPressureReason);
68     void clearMemoryPressure();
69     bool shouldWaitForMemoryClearMessage();
70     void respondToMemoryPressureIfNeeded();
71 #endif
72
73     class ReliefLogger {
74     public:
75         explicit ReliefLogger(const char *log)
76             : m_logString(log)
77             , m_initialMemory(platformMemoryUsage())
78         {
79         }
80
81         ~ReliefLogger()
82         {
83             platformLog();
84         }
85
86     private:
87         size_t platformMemoryUsage();
88         void platformLog();
89
90         const char* m_logString;
91         size_t m_initialMemory;
92 };
93
94 private:
95     void uninstall();
96
97     void holdOff(unsigned);
98
99     MemoryPressureHandler();
100     ~MemoryPressureHandler();
101
102     void respondToMemoryPressure();
103     static void releaseMemory(bool critical);
104     static void platformReleaseMemory(bool critical);
105
106     bool m_installed;
107     time_t m_lastRespondTime;
108     LowMemoryHandler m_lowMemoryHandler;
109
110     std::atomic<bool> m_underMemoryPressure;
111
112 #if PLATFORM(IOS)
113     uint32_t m_memoryPressureReason;
114     bool m_clearPressureOnMemoryRelease;
115     void (^m_releaseMemoryBlock)();
116     CFRunLoopObserverRef m_observer;
117     Mutex m_observerMutex;
118 #endif
119 };
120  
121 // Function to obtain the global memory pressure object.
122 MemoryPressureHandler& memoryPressureHandler();
123
124 } // namespace WebCore
125
126 #endif // MemoryPressureHandler_h