Access MemoryPressureHandler global instance via a singleton() static member function
[WebKit-https.git] / Source / WebCore / platform / linux / MemoryPressureHandlerLinux.cpp
1 /*
2  * Copyright (C) 2011, 2012 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2014 Raspberry Pi Foundation. All Rights Reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "MemoryPressureHandler.h"
29
30 #if OS(LINUX)
31
32 #include "Logging.h"
33
34 #include <fcntl.h>
35 #include <malloc.h>
36 #include <sys/eventfd.h>
37 #include <sys/stat.h>
38 #include <sys/types.h>
39 #include <unistd.h>
40 #include <wtf/CurrentTime.h>
41 #include <wtf/MainThread.h>
42 #include <wtf/text/WTFString.h>
43
44 namespace WebCore {
45
46 // Disable memory event reception for a minimum of s_minimumHoldOffTime
47 // seconds after receiving an event. Don't let events fire any sooner than
48 // s_holdOffMultiplier times the last cleanup processing time. Effectively
49 // this is 1 / s_holdOffMultiplier percent of the time.
50 // These value seems reasonable and testing verifies that it throttles frequent
51 // low memory events, greatly reducing CPU usage.
52 static const unsigned s_minimumHoldOffTime = 5;
53 static const unsigned s_holdOffMultiplier = 20;
54
55 static const char* s_cgroupMemoryPressureLevel = "/sys/fs/cgroup/memory/memory.pressure_level";
56 static const char* s_cgroupEventControl = "/sys/fs/cgroup/memory/cgroup.event_control";
57 static const char* s_processStatus = "/proc/self/status";
58
59 static inline String nextToken(FILE* file)
60 {
61     if (!file)
62         return String();
63
64     static const unsigned bufferSize = 128;
65     char buffer[bufferSize] = {0, };
66     unsigned index = 0;
67     while (index < bufferSize) {
68         char ch = fgetc(file);
69         if (ch == EOF || (isASCIISpace(ch) && index)) // Break on non-initial ASCII space.
70             break;
71         if (!isASCIISpace(ch)) {
72             buffer[index] = ch;
73             index++;
74         }
75     }
76
77     return String(buffer);
78 }
79
80 void MemoryPressureHandler::waitForMemoryPressureEvent(void*)
81 {
82     ASSERT(!isMainThread());
83     int eventFD = MemoryPressureHandler::singleton().m_eventFD;
84     if (!eventFD) {
85         LOG(MemoryPressure, "Invalidate eventfd.");
86         return;
87     }
88
89     uint64_t buffer;
90     if (read(eventFD, &buffer, sizeof(buffer)) <= 0) {
91         LOG(MemoryPressure, "Failed to read eventfd.");
92         return;
93     }
94
95     // FIXME: Current memcg does not provide any way for users to know how serious the memory pressure is.
96     // So we assume all notifications from memcg are critical for now. If memcg had better inferfaces
97     // to get a detailed memory pressure level in the future, we should update here accordingly.
98     bool critical = true;
99     if (ReliefLogger::loggingEnabled())
100         LOG(MemoryPressure, "Got memory pressure notification (%s)", critical ? "critical" : "non-critical");
101
102     MemoryPressureHandler::singleton().setUnderMemoryPressure(critical);
103     callOnMainThread([critical] {
104         MemoryPressureHandler::singleton().respondToMemoryPressure(critical);
105     });
106 }
107
108 inline void MemoryPressureHandler::logErrorAndCloseFDs(const char* log)
109 {
110     if (log)
111         LOG(MemoryPressure, "%s, error : %m", log);
112
113     if (m_eventFD) {
114         close(m_eventFD);
115         m_eventFD = 0;
116     }
117     if (m_pressureLevelFD) {
118         close(m_pressureLevelFD);
119         m_pressureLevelFD = 0;
120     }
121 }
122
123 void MemoryPressureHandler::install()
124 {
125     if (m_installed)
126         return;
127
128     m_eventFD = eventfd(0, EFD_CLOEXEC);
129     if (m_eventFD == -1) {
130         LOG(MemoryPressure, "eventfd() failed: %m");
131         return;
132     }
133
134     m_pressureLevelFD = open(s_cgroupMemoryPressureLevel, O_CLOEXEC | O_RDONLY);
135     if (m_pressureLevelFD == -1) {
136         logErrorAndCloseFDs("Failed to open memory.pressure_level");
137         return;
138     }
139
140     int fd = open(s_cgroupEventControl, O_CLOEXEC | O_WRONLY);
141     if (fd == -1) {
142         logErrorAndCloseFDs("Failed to open cgroup.event_control");
143         return;
144     }
145
146     char line[128] = {0, };
147     if (snprintf(line, sizeof(line), "%d %d low", m_eventFD, m_pressureLevelFD) < 0
148         || write(fd, line, strlen(line) + 1) < 0) {
149         logErrorAndCloseFDs("Failed to write cgroup.event_control");
150         close(fd);
151         return;
152     }
153     close(fd);
154
155     m_threadID = createThread(waitForMemoryPressureEvent, this, "WebCore: MemoryPressureHandler");
156     if (!m_threadID) {
157         logErrorAndCloseFDs("Failed to create a thread for MemoryPressureHandler");
158         return;
159     }
160
161     if (ReliefLogger::loggingEnabled() && isUnderMemoryPressure())
162         LOG(MemoryPressure, "System is no longer under memory pressure.");
163
164     setUnderMemoryPressure(false);
165     m_installed = true;
166 }
167
168 void MemoryPressureHandler::uninstall()
169 {
170     if (!m_installed)
171         return;
172
173     if (m_threadID) {
174         detachThread(m_threadID);
175         m_threadID = 0;
176     }
177
178     logErrorAndCloseFDs(nullptr);
179     m_installed = false;
180 }
181
182 void MemoryPressureHandler::holdOffTimerFired()
183 {
184     install();
185 }
186
187 void MemoryPressureHandler::holdOff(unsigned seconds)
188 {
189     m_holdOffTimer.startOneShot(seconds);
190 }
191
192 void MemoryPressureHandler::respondToMemoryPressure(bool critical)
193 {
194     uninstall();
195
196     double startTime = monotonicallyIncreasingTime();
197     m_lowMemoryHandler(critical);
198     unsigned holdOffTime = (monotonicallyIncreasingTime() - startTime) * s_holdOffMultiplier;
199     holdOff(std::max(holdOffTime, s_minimumHoldOffTime));
200 }
201
202 void MemoryPressureHandler::platformReleaseMemory(bool)
203 {
204     ReliefLogger log("Run malloc_trim");
205     malloc_trim(0);
206 }
207
208 void MemoryPressureHandler::ReliefLogger::platformLog()
209 {
210     size_t currentMemory = platformMemoryUsage();
211     if (currentMemory == static_cast<size_t>(-1) || m_initialMemory == static_cast<size_t>(-1)) {
212         LOG(MemoryPressure, "%s (Unable to get dirty memory information for process)", m_logString);
213         return;
214     }
215
216     ssize_t memoryDiff = currentMemory - m_initialMemory;
217     if (memoryDiff < 0)
218         LOG(MemoryPressure, "Pressure relief: %s: -dirty %lu bytes (from %lu to %lu)", m_logString, static_cast<unsigned long>(memoryDiff * -1), static_cast<unsigned long>(m_initialMemory), static_cast<unsigned long>(currentMemory));
219     else if (memoryDiff > 0)
220         LOG(MemoryPressure, "Pressure relief: %s: +dirty %lu bytes (from %lu to %lu)", m_logString, static_cast<unsigned long>(memoryDiff), static_cast<unsigned long>(m_initialMemory), static_cast<unsigned long>(currentMemory));
221     else
222         LOG(MemoryPressure, "Pressure relief: %s: =dirty (at %lu bytes)", m_logString, static_cast<unsigned long>(currentMemory));
223 }
224
225 size_t MemoryPressureHandler::ReliefLogger::platformMemoryUsage()
226 {
227     FILE* file = fopen(s_processStatus, "r");
228     if (!file)
229         return static_cast<size_t>(-1);
230
231     size_t vmSize = static_cast<size_t>(-1); // KB
232     String token = nextToken(file);
233     while (!token.isEmpty()) {
234         if (token == "VmSize:") {
235             vmSize = nextToken(file).toInt() * KB;
236             break;
237         }
238         token = nextToken(file);
239     }
240     fclose(file);
241
242     return vmSize;
243 }
244
245 } // namespace WebCore
246
247 #endif // OS(LINUX)