memoryFootprint should return size_t not optional<size_t>
[WebKit-https.git] / Source / WTF / wtf / 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  * Copyright (C) 2018 Igalia S.L.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #include "MemoryPressureHandler.h"
30
31 #if OS(LINUX)
32
33 #include <malloc.h>
34 #include <unistd.h>
35 #include <wtf/MainThread.h>
36 #include <wtf/MemoryFootprint.h>
37 #include <wtf/linux/CurrentProcessMemoryStatus.h>
38 #include <wtf/text/WTFString.h>
39
40 #define LOG_CHANNEL_PREFIX Log
41
42 namespace WTF {
43
44 // Disable memory event reception for a minimum of s_minimumHoldOffTime
45 // seconds after receiving an event. Don't let events fire any sooner than
46 // s_holdOffMultiplier times the last cleanup processing time. Effectively
47 // this is 1 / s_holdOffMultiplier percent of the time.
48 // If after releasing the memory we don't free at least s_minimumBytesFreedToUseMinimumHoldOffTime,
49 // we wait longer to try again (s_maximumHoldOffTime).
50 // These value seems reasonable and testing verifies that it throttles frequent
51 // low memory events, greatly reducing CPU usage.
52 static const Seconds s_minimumHoldOffTime { 5_s };
53 static const Seconds s_maximumHoldOffTime { 30_s };
54 static const size_t s_minimumBytesFreedToUseMinimumHoldOffTime = 1 * MB;
55 static const unsigned s_holdOffMultiplier = 20;
56
57 void MemoryPressureHandler::triggerMemoryPressureEvent(bool isCritical)
58 {
59     if (!m_installed)
60         return;
61
62     if (ReliefLogger::loggingEnabled())
63         LOG(MemoryPressure, "Got memory pressure notification (%s)", isCritical ? "critical" : "non-critical");
64
65     setUnderMemoryPressure(true);
66
67     if (isMainThread())
68         respondToMemoryPressure(isCritical ? Critical::Yes : Critical::No);
69     else
70         RunLoop::main().dispatch([this, isCritical] {
71             respondToMemoryPressure(isCritical ? Critical::Yes : Critical::No);
72         });
73
74     if (ReliefLogger::loggingEnabled() && isUnderMemoryPressure())
75         LOG(MemoryPressure, "System is no longer under memory pressure.");
76
77     setUnderMemoryPressure(false);
78 }
79
80 void MemoryPressureHandler::install()
81 {
82     if (m_installed || m_holdOffTimer.isActive())
83         return;
84
85     m_installed = true;
86 }
87
88 void MemoryPressureHandler::uninstall()
89 {
90     if (!m_installed)
91         return;
92
93     m_holdOffTimer.stop();
94
95     m_installed = false;
96 }
97
98 void MemoryPressureHandler::holdOffTimerFired()
99 {
100     install();
101 }
102
103 void MemoryPressureHandler::holdOff(Seconds seconds)
104 {
105     m_holdOffTimer.startOneShot(seconds);
106 }
107
108 static size_t processMemoryUsage()
109 {
110     ProcessMemoryStatus memoryStatus;
111     currentProcessMemoryStatus(memoryStatus);
112     return (memoryStatus.resident - memoryStatus.shared);
113 }
114
115 void MemoryPressureHandler::respondToMemoryPressure(Critical critical, Synchronous synchronous)
116 {
117     uninstall();
118
119     MonotonicTime startTime = MonotonicTime::now();
120     int64_t processMemory = processMemoryUsage();
121     releaseMemory(critical, synchronous);
122     int64_t bytesFreed = processMemory - processMemoryUsage();
123     Seconds holdOffTime = s_maximumHoldOffTime;
124     if (bytesFreed > 0 && static_cast<size_t>(bytesFreed) >= s_minimumBytesFreedToUseMinimumHoldOffTime)
125         holdOffTime = (MonotonicTime::now() - startTime) * s_holdOffMultiplier;
126     holdOff(std::max(holdOffTime, s_minimumHoldOffTime));
127 }
128
129 void MemoryPressureHandler::platformReleaseMemory(Critical)
130 {
131 #ifdef __GLIBC__
132     malloc_trim(0);
133 #endif
134 }
135
136 std::optional<MemoryPressureHandler::ReliefLogger::MemoryUsage> MemoryPressureHandler::ReliefLogger::platformMemoryUsage()
137 {
138     return MemoryUsage {processMemoryUsage(), memoryFootprint()};
139 }
140
141
142 } // namespace WTF
143
144 #endif // OS(LINUX)