[Mac] Always do a full GC when simulating memory pressure.
[WebKit-https.git] / Source / WebCore / platform / mac / MemoryPressureHandlerMac.mm
1 /*
2  * Copyright (C) 2011, 2012 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 #import "config.h"
27 #import "MemoryPressureHandler.h"
28
29 #if !PLATFORM(IOS)
30
31 #import "IOSurfacePool.h"
32 #import "GCController.h"
33 #import "LayerPool.h"
34 #import "WebCoreSystemInterface.h"
35 #import <malloc/malloc.h>
36 #import <notify.h>
37 #import <wtf/CurrentTime.h>
38
39 namespace WebCore {
40
41 static dispatch_source_t _cache_event_source = 0;
42 static dispatch_source_t _timer_event_source = 0;
43 static int _notifyToken;
44
45 // Disable memory event reception for a minimum of s_minimumHoldOffTime
46 // seconds after receiving an event.  Don't let events fire any sooner than
47 // s_holdOffMultiplier times the last cleanup processing time.  Effectively 
48 // this is 1 / s_holdOffMultiplier percent of the time.
49 // These value seems reasonable and testing verifies that it throttles frequent
50 // low memory events, greatly reducing CPU usage.
51 static const unsigned s_minimumHoldOffTime = 5;
52 static const unsigned s_holdOffMultiplier = 20;
53
54 void MemoryPressureHandler::install()
55 {
56     if (m_installed || _timer_event_source)
57         return;
58
59     dispatch_async(dispatch_get_main_queue(), ^{
60 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
61         _cache_event_source = wkCreateMemoryStatusPressureCriticalDispatchOnMainQueue();
62 #else
63         _cache_event_source = wkCreateVMPressureDispatchOnMainQueue();
64 #endif
65         if (_cache_event_source) {
66             dispatch_set_context(_cache_event_source, this);
67             dispatch_source_set_event_handler(_cache_event_source, ^{ memoryPressureHandler().respondToMemoryPressure();});
68             dispatch_resume(_cache_event_source);
69         }
70     });
71
72     // Allow simulation of memory pressure with "notifyutil -p org.WebKit.lowMemory"
73     notify_register_dispatch("org.WebKit.lowMemory", &_notifyToken, dispatch_get_main_queue(), ^(int) {
74
75         // We only do a synchronous GC when *simulating* memory pressure.
76         // This gives us a more consistent picture of live objects at the end of testing.
77         gcController().garbageCollectNow();
78
79         memoryPressureHandler().respondToMemoryPressure();
80         malloc_zone_pressure_relief(nullptr, 0);
81     });
82
83     m_installed = true;
84 }
85
86 void MemoryPressureHandler::uninstall()
87 {
88     if (!m_installed)
89         return;
90
91     dispatch_async(dispatch_get_main_queue(), ^{
92         if (_cache_event_source) {
93             dispatch_source_cancel(_cache_event_source);
94             dispatch_release(_cache_event_source);
95             _cache_event_source = 0;
96         }
97
98         if (_timer_event_source) {
99             dispatch_source_cancel(_timer_event_source);
100             dispatch_release(_timer_event_source);
101             _timer_event_source = 0;
102         }
103     });
104
105     m_installed = false;
106     
107     notify_cancel(_notifyToken);
108 }
109
110 void MemoryPressureHandler::holdOff(unsigned seconds)
111 {
112     dispatch_async(dispatch_get_main_queue(), ^{
113         _timer_event_source = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, dispatch_get_main_queue());
114         if (_timer_event_source) {
115             dispatch_set_context(_timer_event_source, this);
116             dispatch_source_set_timer(_timer_event_source, dispatch_time(DISPATCH_TIME_NOW, seconds * NSEC_PER_SEC), DISPATCH_TIME_FOREVER, 1 * s_minimumHoldOffTime);
117             dispatch_source_set_event_handler(_timer_event_source, ^{
118                 if (_timer_event_source) {
119                     dispatch_source_cancel(_timer_event_source);
120                     dispatch_release(_timer_event_source);
121                     _timer_event_source = 0;
122                 }
123                 memoryPressureHandler().install();
124             });
125             dispatch_resume(_timer_event_source);
126         }
127     });
128 }
129
130 void MemoryPressureHandler::respondToMemoryPressure()
131 {
132     uninstall();
133
134     double startTime = monotonicallyIncreasingTime();
135
136     m_lowMemoryHandler(false);
137
138     unsigned holdOffTime = (monotonicallyIncreasingTime() - startTime) * s_holdOffMultiplier;
139
140     holdOff(std::max(holdOffTime, s_minimumHoldOffTime));
141 }
142
143 void MemoryPressureHandler::platformReleaseMemory(bool)
144 {
145     LayerPool::sharedPool()->drain();
146     IOSurfacePool::sharedPool().discardAllSurfaces();
147 }
148
149 } // namespace WebCore
150
151 #endif // !PLATFORM(IOS)