1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* Copyright (C) 2014 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "Logging.h"
#include "ProcessAssertion.h"
#include <wtf/ProcessID.h>
#include <wtf/RefCountedAndCanMakeWeakPtr.h>
#include <wtf/RefCounter.h>
#include <wtf/RunLoop.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/UniqueRef.h>
#include <wtf/WeakPtr.h>
namespace WTF {
class TextStream;
}
namespace WebKit {
class AuxiliaryProcessProxy;
class ProcessThrottler;
enum UserObservablePageCounterType { };
using UserObservablePageCounter = RefCounter<UserObservablePageCounterType>;
enum ProcessSuppressionDisabledCounterType { };
using ProcessSuppressionDisabledCounter = RefCounter<ProcessSuppressionDisabledCounterType>;
using ProcessSuppressionDisabledToken = ProcessSuppressionDisabledCounter::Token;
enum class IsQuietActivity : bool { No, Yes };
enum class IsSuspensionImminent : bool { No, Yes };
enum class ProcessThrottleState : uint8_t { Suspended, Background, Foreground };
enum class ProcessThrottlerActivityType : bool { Background, Foreground };
class ProcessThrottlerActivity : public RefCountedAndCanMakeWeakPtr<ProcessThrottlerActivity> {
WTF_MAKE_TZONE_ALLOCATED(ProcessThrottlerActivity);
WTF_MAKE_NONCOPYABLE(ProcessThrottlerActivity);
public:
static Ref<ProcessThrottlerActivity> create(ProcessThrottler&, ASCIILiteral name, ProcessThrottlerActivityType, IsQuietActivity);
~ProcessThrottlerActivity()
{
ASSERT(isMainRunLoop());
if (isValid())
invalidate(ForceEnableActivityLogging::No);
}
bool isValid() const { return !!m_throttler; }
ASCIILiteral name() const { return m_name; }
bool isQuietActivity() const { return m_isQuietActivity == IsQuietActivity::Yes; }
bool isForeground() const { return m_type != ProcessThrottlerActivityType::Background; }
private:
friend class ProcessThrottler;
ProcessThrottlerActivity(ProcessThrottler&, ASCIILiteral name, ProcessThrottlerActivityType, IsQuietActivity);
enum class ForceEnableActivityLogging : bool { No, Yes };
void invalidate(ForceEnableActivityLogging);
WeakPtr<ProcessThrottler> m_throttler;
ASCIILiteral m_name;
ProcessThrottlerActivityType m_type;
IsQuietActivity m_isQuietActivity;
};
class ProcessThrottlerTimedActivity : public RefCounted<ProcessThrottlerTimedActivity> {
WTF_MAKE_TZONE_ALLOCATED(ProcessThrottlerTimedActivity);
WTF_MAKE_NONCOPYABLE(ProcessThrottlerTimedActivity);
using Activity = ProcessThrottlerActivity;
public:
static Ref<ProcessThrottlerTimedActivity> create(Seconds, RefPtr<Activity>&& = nullptr);
const RefPtr<Activity> activity() const { return m_activity; }
void setTimeout(Seconds);
void setActivity(RefPtr<Activity>&&);
private:
explicit ProcessThrottlerTimedActivity(Seconds, RefPtr<Activity>&&);
void activityTimedOut();
void updateTimer();
RunLoop::Timer m_timer;
Seconds m_timeout;
RefPtr<Activity> m_activity;
};
class ProcessThrottler : public CanMakeWeakPtr<ProcessThrottler> {
public:
ProcessThrottler(AuxiliaryProcessProxy&, bool shouldTakeUIBackgroundAssertion);
~ProcessThrottler();
using Activity = ProcessThrottlerActivity;
void ref() const;
void deref() const;
using ForegroundActivity = Activity;
Ref<Activity> foregroundActivity(ASCIILiteral name);
using BackgroundActivity = Activity;
Ref<Activity> backgroundActivity(ASCIILiteral name);
Ref<Activity> quietBackgroundActivity(ASCIILiteral name);
static bool isValidBackgroundActivity(const Activity*);
static bool isValidForegroundActivity(const Activity*);
using TimedActivity = ProcessThrottlerTimedActivity;
void didConnectToProcess(AuxiliaryProcessProxy&);
void didDisconnectFromProcess();
bool shouldBeRunnable() const { return !m_foregroundActivities.isEmptyIgnoringNullReferences() || !m_backgroundActivities.isEmptyIgnoringNullReferences(); }
void setAllowsActivities(bool);
void setShouldDropNearSuspendedAssertionAfterDelay(bool);
void setShouldTakeNearSuspendedAssertion(bool);
bool isSuspended() const { return m_isConnectedToProcess && !m_assertion; }
ProcessThrottleState currentState() const { return m_state; }
bool isHoldingNearSuspendedAssertion() const { return m_assertion && m_assertion->type() == ProcessAssertionType::NearSuspended; }
void invalidateAllActivitiesAndDropAssertion();
private:
friend class ProcessThrottlerActivity;
friend WTF::TextStream& operator<<(WTF::TextStream&, const ProcessThrottler&);
ProcessThrottleState expectedThrottleState();
void updateThrottleStateIfNeeded(ASCIILiteral);
void updateThrottleStateNow();
void setAssertionType(ProcessAssertionType);
void setThrottleState(ProcessThrottleState);
void prepareToSuspendTimeoutTimerFired();
void dropNearSuspendedAssertionTimerFired();
void prepareToDropLastAssertionTimeoutTimerFired();
void sendPrepareToSuspendIPC(IsSuspensionImminent);
void processReadyToSuspend();
bool addActivity(Activity&);
void removeActivity(Activity&);
void invalidateAllActivities();
String assertionName(ProcessAssertionType) const;
ProcessAssertionType assertionTypeForState(ProcessThrottleState);
void uiAssertionWillExpireImminently();
void assertionWasInvalidated();
void clearPendingRequestToSuspend();
void clearAssertion();
void dropLastAssertion();
class ProcessAssertionCache;
Ref<AuxiliaryProcessProxy> protectedProcess() const;
UniqueRef<ProcessAssertionCache> m_assertionCache;
WeakRef<AuxiliaryProcessProxy> m_process;
RefPtr<ProcessAssertion> m_assertion;
RefPtr<ProcessAssertion> m_assertionToClearAfterPrepareToDropLastAssertion;
RunLoop::Timer m_prepareToSuspendTimeoutTimer;
RunLoop::Timer m_dropNearSuspendedAssertionTimer;
RunLoop::Timer m_prepareToDropLastAssertionTimeoutTimer;
WeakHashSet<Activity> m_foregroundActivities;
WeakHashSet<Activity> m_backgroundActivities;
std::optional<uint64_t> m_pendingRequestToSuspendID;
ProcessThrottleState m_state { ProcessThrottleState::Suspended };
bool m_shouldDropNearSuspendedAssertionAfterDelay { false };
const bool m_shouldTakeUIBackgroundAssertion { false };
bool m_shouldTakeNearSuspendedAssertion { true };
bool m_allowsActivities { true };
bool m_isConnectedToProcess { false };
};
inline auto ProcessThrottler::foregroundActivity(ASCIILiteral name) -> Ref<Activity>
{
return Activity::create(*this, name, ProcessThrottlerActivityType::Foreground, IsQuietActivity::No);
}
inline auto ProcessThrottler::backgroundActivity(ASCIILiteral name) -> Ref<Activity>
{
return Activity::create(*this, name, ProcessThrottlerActivityType::Background, IsQuietActivity::No);
}
inline auto ProcessThrottler::quietBackgroundActivity(ASCIILiteral name) -> Ref<Activity>
{
return Activity::create(*this, name, ProcessThrottlerActivityType::Background, IsQuietActivity::Yes);
}
WTF::TextStream& operator<<(WTF::TextStream&, const ProcessThrottler&);
} // namespace WebKit
|
