fd5a59aaa20ac8eae1363493e030a0ecfe85e4fd
[WebKit-https.git] / Source / WebCore / platform / MemoryPressureHandler.cpp
1 /*
2  * Copyright (C) 2011, 2014 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 #include "config.h"
27 #include "MemoryPressureHandler.h"
28
29 #include "CSSValuePool.h"
30 #include "Chrome.h"
31 #include "ChromeClient.h"
32 #include "DOMWindow.h"
33 #include "Document.h"
34 #include "FontCache.h"
35 #include "FontCascade.h"
36 #include "GCController.h"
37 #include "HTMLMediaElement.h"
38 #include "JSDOMWindow.h"
39 #include "MemoryCache.h"
40 #include "Page.h"
41 #include "PageCache.h"
42 #include "ScrollingThread.h"
43 #include "StyledElement.h"
44 #include "WorkerThread.h"
45 #include <JavaScriptCore/IncrementalSweeper.h>
46 #include <wtf/CurrentTime.h>
47 #include <wtf/FastMalloc.h>
48 #include <wtf/StdLibExtras.h>
49
50 namespace WebCore {
51
52 WEBCORE_EXPORT bool MemoryPressureHandler::ReliefLogger::s_loggingEnabled = false;
53
54 MemoryPressureHandler& MemoryPressureHandler::singleton()
55 {
56     static NeverDestroyed<MemoryPressureHandler> memoryPressureHandler;
57     return memoryPressureHandler;
58 }
59
60 MemoryPressureHandler::MemoryPressureHandler() 
61     : m_installed(false)
62     , m_lastRespondTime(0)
63     , m_lowMemoryHandler([this] (Critical critical, Synchronous synchronous) { releaseMemory(critical, synchronous); })
64     , m_underMemoryPressure(false)
65 #if PLATFORM(IOS)
66     // FIXME: Can we share more of this with OpenSource?
67     , m_memoryPressureReason(MemoryPressureReasonNone)
68     , m_clearPressureOnMemoryRelease(true)
69     , m_releaseMemoryBlock(0)
70     , m_observer(0)
71 #elif OS(LINUX)
72     , m_eventFD(0)
73     , m_pressureLevelFD(0)
74     , m_threadID(0)
75     , m_holdOffTimer(*this, &MemoryPressureHandler::holdOffTimerFired)
76 #endif
77 {
78 }
79
80 void MemoryPressureHandler::releaseNoncriticalMemory()
81 {
82     {
83         ReliefLogger log("Purge inactive FontData");
84         FontCache::singleton().purgeInactiveFontData();
85     }
86
87     {
88         ReliefLogger log("Clear WidthCaches");
89         clearWidthCaches();
90     }
91
92     {
93         ReliefLogger log("Discard Selector Query Cache");
94         for (auto* document : Document::allDocuments())
95             document->clearSelectorQueryCache();
96     }
97
98     {
99         ReliefLogger log("Prune MemoryCache dead resources");
100         MemoryCache::singleton().pruneDeadResourcesToSize(0);
101     }
102
103     {
104         ReliefLogger log("Prune presentation attribute cache");
105         StyledElement::clearPresentationAttributeCache();
106     }
107 }
108
109 void MemoryPressureHandler::releaseCriticalMemory(Synchronous synchronous)
110 {
111     {
112         ReliefLogger log("Empty the PageCache");
113         // Right now, the only reason we call release critical memory while not under memory pressure is if the process is about to be suspended.
114         PruningReason pruningReason = isUnderMemoryPressure() ? PruningReason::MemoryPressure : PruningReason::ProcessSuspended;
115         PageCache::singleton().pruneToSizeNow(0, pruningReason);
116     }
117
118     {
119         ReliefLogger log("Prune MemoryCache live resources");
120         MemoryCache::singleton().pruneLiveResourcesToSize(0, /*shouldDestroyDecodedDataForAllLiveResources*/ true);
121     }
122
123     {
124         ReliefLogger log("Drain CSSValuePool");
125         CSSValuePool::singleton().drain();
126     }
127
128     {
129         ReliefLogger log("Discard StyleResolvers");
130         Vector<RefPtr<Document>> documents;
131         copyToVector(Document::allDocuments(), documents);
132         for (auto& document : documents)
133             document->clearStyleResolver();
134     }
135
136     {
137         ReliefLogger log("Discard all JIT-compiled code");
138         GCController::singleton().deleteAllCode();
139     }
140
141 #if ENABLE(VIDEO)
142     {
143         ReliefLogger log("Dropping buffered data from paused media elements");
144         for (auto* mediaElement: HTMLMediaElement::allMediaElements()) {
145             if (mediaElement->paused())
146                 mediaElement->purgeBufferedDataIfPossible();
147         }
148     }
149 #endif
150
151     if (synchronous == Synchronous::Yes) {
152         ReliefLogger log("Collecting JavaScript garbage");
153         GCController::singleton().garbageCollectNow();
154     } else
155         GCController::singleton().garbageCollectNowIfNotDoneRecently();
156
157     // We reduce tiling coverage while under memory pressure, so make sure to drop excess tiles ASAP.
158     Page::forEachPage([](Page& page) {
159         page.chrome().client().scheduleCompositingLayerFlush();
160     });
161 }
162
163 void MemoryPressureHandler::releaseMemory(Critical critical, Synchronous synchronous)
164 {
165     if (critical == Critical::Yes)
166         releaseCriticalMemory(synchronous);
167
168     releaseNoncriticalMemory();
169
170     platformReleaseMemory(critical);
171
172     {
173         ReliefLogger log("Release free FastMalloc memory");
174         // FastMalloc has lock-free thread specific caches that can only be cleared from the thread itself.
175         WorkerThread::releaseFastMallocFreeMemoryInAllThreads();
176 #if ENABLE(ASYNC_SCROLLING) && !PLATFORM(IOS)
177         ScrollingThread::dispatch(WTF::releaseFastMallocFreeMemory);
178 #endif
179         WTF::releaseFastMallocFreeMemory();
180     }
181 }
182
183 void MemoryPressureHandler::ReliefLogger::logMemoryUsageChange()
184 {
185 #if !LOG_ALWAYS_DISABLED
186 #define STRING_SPECIFICATION "%{public}s"
187 #define MEMORYPRESSURE_LOG(...) LOG_ALWAYS(true, __VA_ARGS__)
188 #else
189 #define STRING_SPECIFICATION "%s"
190 #define MEMORYPRESSURE_LOG(...) WTFLogAlways(__VA_ARGS__)
191 #endif
192
193     size_t currentMemory = platformMemoryUsage();
194     if (currentMemory == static_cast<size_t>(-1) || m_initialMemory == static_cast<size_t>(-1)) {
195         MEMORYPRESSURE_LOG("Memory pressure relief: " STRING_SPECIFICATION ": (Unable to get dirty memory information for process)", m_logString);
196         return;
197     }
198
199     long memoryDiff = currentMemory - m_initialMemory;
200     if (memoryDiff < 0)
201         MEMORYPRESSURE_LOG("Memory pressure relief: " STRING_SPECIFICATION ": -dirty %ld bytes (from %lu to %lu)", m_logString, (memoryDiff * -1), m_initialMemory, currentMemory);
202     else if (memoryDiff > 0)
203         MEMORYPRESSURE_LOG("Memory pressure relief: " STRING_SPECIFICATION ": +dirty %ld bytes (from %lu to %lu)", m_logString, memoryDiff, m_initialMemory, currentMemory);
204     else
205         MEMORYPRESSURE_LOG("Memory pressure relief: " STRING_SPECIFICATION ": =dirty (at %lu bytes)", m_logString, currentMemory);
206 }
207
208 #if !PLATFORM(COCOA) && !OS(LINUX) && !PLATFORM(WIN)
209 void MemoryPressureHandler::install() { }
210 void MemoryPressureHandler::uninstall() { }
211 void MemoryPressureHandler::holdOff(unsigned) { }
212 void MemoryPressureHandler::respondToMemoryPressure(Critical, Synchronous) { }
213 void MemoryPressureHandler::platformReleaseMemory(Critical) { }
214 size_t MemoryPressureHandler::ReliefLogger::platformMemoryUsage() { return 0; }
215 #endif
216
217 } // namespace WebCore