blob: 7af8d0397fca41876b70949d6b9858e3f5838a89 [file] [log] [blame]
Ana Krulecb43429d2019-01-09 14:28:51 -08001/*
2 * Copyright 2019 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
19#include <algorithm>
20#include <numeric>
Ady Abrahambd44e8a2023-07-24 11:30:06 -070021#include <set>
Dominik Laskowski98041832019-08-01 18:35:59 -070022#include <type_traits>
Dominik Laskowskia8626ec2021-12-15 18:13:30 -080023#include <utility>
Dominik Laskowski36dced82022-09-02 09:24:00 -070024#include <variant>
Ana Krulecb43429d2019-01-09 14:28:51 -080025
Dominik Laskowski530d6bd2022-10-10 16:55:54 -040026#include <ftl/concat.h>
Dominik Laskowski03cfce82022-11-02 12:13:29 -040027#include <ftl/optional.h>
Ady Abraham68636062022-11-16 17:07:25 -080028#include <ftl/unit.h>
Dominik Laskowskif6b4ba62021-11-09 12:46:10 -080029#include <gui/DisplayEventReceiver.h>
30
31#include <scheduler/Fps.h>
Ady Abraham68636062022-11-16 17:07:25 -080032#include <scheduler/FrameRateMode.h>
Dominik Laskowskif6b4ba62021-11-09 12:46:10 -080033#include <scheduler/Seamlessness.h>
34
Marin Shalamanov3ea1d602020-12-16 19:59:39 +010035#include "DisplayHardware/DisplayMode.h"
Ady Abraham9a2ea342021-09-03 17:32:34 -070036#include "Scheduler/OneShotTimer.h"
Ady Abraham2139f732019-11-13 18:56:40 -080037#include "Scheduler/StrongTyping.h"
Dominik Laskowskif8734e02022-08-26 09:06:59 -070038#include "ThreadContext.h"
Dominik Laskowskie70461a2022-08-30 14:42:01 -070039#include "Utils/Dumper.h"
Ana Krulec4593b692019-01-11 22:07:25 -080040
Dominik Laskowski98041832019-08-01 18:35:59 -070041namespace android::scheduler {
Ady Abrahamabc27602020-04-08 17:20:29 -070042
Ady Abraham4ccdcb42020-02-11 17:34:34 -080043using namespace std::chrono_literals;
Dominik Laskowski98041832019-08-01 18:35:59 -070044
Dominik Laskowski068173d2021-08-11 17:22:59 -070045enum class DisplayModeEvent : unsigned { None = 0b0, Changed = 0b1 };
Dominik Laskowski98041832019-08-01 18:35:59 -070046
Dominik Laskowski068173d2021-08-11 17:22:59 -070047inline DisplayModeEvent operator|(DisplayModeEvent lhs, DisplayModeEvent rhs) {
48 using T = std::underlying_type_t<DisplayModeEvent>;
49 return static_cast<DisplayModeEvent>(static_cast<T>(lhs) | static_cast<T>(rhs));
Dominik Laskowski98041832019-08-01 18:35:59 -070050}
Ana Krulecb43429d2019-01-09 14:28:51 -080051
Ady Abraham62f216c2020-10-13 19:07:23 -070052using FrameRateOverride = DisplayEventReceiver::Event::FrameRateOverride;
53
Dominik Laskowskid82e0f02022-10-26 15:23:04 -040054// Selects the refresh rate of a display by ranking its `DisplayModes` in accordance with
55// the DisplayManager (or override) `Policy`, the `LayerRequirement` of each active layer,
56// and `GlobalSignals`.
57class RefreshRateSelector {
Ana Krulecb43429d2019-01-09 14:28:51 -080058public:
Ady Abraham4ccdcb42020-02-11 17:34:34 -080059 // Margin used when matching refresh rates to the content desired ones.
60 static constexpr nsecs_t MARGIN_FOR_PERIOD_CALCULATION =
rnlee3bd610662021-06-23 16:27:57 -070061 std::chrono::nanoseconds(800us).count();
Ady Abraham4ccdcb42020-02-11 17:34:34 -080062
Ady Abraham68636062022-11-16 17:07:25 -080063 // The lowest Render Frame Rate that will ever be selected
Ady Abraham1d173042023-01-04 23:24:47 +000064 static constexpr Fps kMinSupportedFrameRate = 20_Hz;
Ady Abraham68636062022-11-16 17:07:25 -080065
Dominik Laskowski36dced82022-09-02 09:24:00 -070066 class Policy {
Marin Shalamanov30b0b3c2020-10-13 19:15:06 +020067 static constexpr int kAllowGroupSwitchingDefault = false;
68
69 public:
Marin Shalamanova7fe3042021-01-29 21:02:08 +010070 // The default mode, used to ensure we only initiate display mode switches within the
71 // same mode group as defaultMode's group.
72 DisplayModeId defaultMode;
73 // Whether or not we switch mode groups to get the best frame rate.
Marin Shalamanov30b0b3c2020-10-13 19:15:06 +020074 bool allowGroupSwitching = kAllowGroupSwitchingDefault;
Ady Abraham285f8c12022-10-11 17:12:14 -070075 // The primary refresh rate ranges. @see DisplayModeSpecs.aidl for details.
76 // TODO(b/257072060): use the render range when selecting SF render rate
77 // or the app override frame rate
78 FpsRanges primaryRanges;
79 // The app request refresh rate ranges. @see DisplayModeSpecs.aidl for details.
80 FpsRanges appRequestRanges;
Steven Thomasd4071902020-03-24 16:02:53 -070081
Steven Thomasf734df42020-04-13 21:09:28 -070082 Policy() = default;
Marin Shalamanov30b0b3c2020-10-13 19:15:06 +020083
Ady Abraham285f8c12022-10-11 17:12:14 -070084 Policy(DisplayModeId defaultMode, FpsRange range,
85 bool allowGroupSwitching = kAllowGroupSwitchingDefault)
86 : Policy(defaultMode, FpsRanges{range, range}, FpsRanges{range, range},
87 allowGroupSwitching) {}
Marin Shalamanov30b0b3c2020-10-13 19:15:06 +020088
Ady Abraham285f8c12022-10-11 17:12:14 -070089 Policy(DisplayModeId defaultMode, FpsRanges primaryRanges, FpsRanges appRequestRanges,
90 bool allowGroupSwitching = kAllowGroupSwitchingDefault)
Marin Shalamanova7fe3042021-01-29 21:02:08 +010091 : defaultMode(defaultMode),
Marin Shalamanov30b0b3c2020-10-13 19:15:06 +020092 allowGroupSwitching(allowGroupSwitching),
Ady Abraham285f8c12022-10-11 17:12:14 -070093 primaryRanges(primaryRanges),
94 appRequestRanges(appRequestRanges) {}
Steven Thomasf734df42020-04-13 21:09:28 -070095
Steven Thomasd4071902020-03-24 16:02:53 -070096 bool operator==(const Policy& other) const {
Dominik Laskowski953b7fd2022-01-08 19:34:59 -080097 using namespace fps_approx_ops;
Ady Abraham285f8c12022-10-11 17:12:14 -070098 return defaultMode == other.defaultMode && primaryRanges == other.primaryRanges &&
99 appRequestRanges == other.appRequestRanges &&
Steven Thomasd4071902020-03-24 16:02:53 -0700100 allowGroupSwitching == other.allowGroupSwitching;
101 }
102
103 bool operator!=(const Policy& other) const { return !(*this == other); }
Marin Shalamanovb6674e72020-11-06 13:05:57 +0100104 std::string toString() const;
Steven Thomasd4071902020-03-24 16:02:53 -0700105 };
106
Dominik Laskowski36dced82022-09-02 09:24:00 -0700107 enum class SetPolicyResult { Invalid, Unchanged, Changed };
Steven Thomasd4071902020-03-24 16:02:53 -0700108
109 // We maintain the display manager policy and the override policy separately. The override
110 // policy is used by CTS tests to get a consistent device state for testing. While the override
111 // policy is set, it takes precedence over the display manager policy. Once the override policy
112 // is cleared, we revert to using the display manager policy.
Dominik Laskowski36dced82022-09-02 09:24:00 -0700113 struct DisplayManagerPolicy : Policy {
114 using Policy::Policy;
115 };
Steven Thomasd4071902020-03-24 16:02:53 -0700116
Dominik Laskowski36dced82022-09-02 09:24:00 -0700117 struct OverridePolicy : Policy {
118 using Policy::Policy;
119 };
120
121 struct NoOverridePolicy {};
122
123 using PolicyVariant = std::variant<DisplayManagerPolicy, OverridePolicy, NoOverridePolicy>;
124
125 SetPolicyResult setPolicy(const PolicyVariant&) EXCLUDES(mLock) REQUIRES(kMainThreadContext);
126
127 void onModeChangeInitiated() REQUIRES(kMainThreadContext) { mNumModeSwitchesInPolicy++; }
128
Steven Thomasd4071902020-03-24 16:02:53 -0700129 // Gets the current policy, which will be the override policy if active, and the display manager
130 // policy otherwise.
131 Policy getCurrentPolicy() const EXCLUDES(mLock);
132 // Gets the display manager policy, regardless of whether an override policy is active.
133 Policy getDisplayManagerPolicy() const EXCLUDES(mLock);
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100134
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100135 // Returns true if mode is allowed by the current policy.
Ady Abrahamace3d052022-11-17 16:25:05 -0800136 bool isModeAllowed(const FrameRateMode&) const EXCLUDES(mLock);
Ady Abraham2139f732019-11-13 18:56:40 -0800137
Ady Abraham8a82ba62020-01-17 12:43:17 -0800138 // Describes the different options the layer voted for refresh rate
139 enum class LayerVoteType {
Ady Abraham71c437d2020-01-31 15:56:57 -0800140 NoVote, // Doesn't care about the refresh rate
141 Min, // Minimal refresh rate available
142 Max, // Maximal refresh rate available
143 Heuristic, // Specific refresh rate that was calculated by platform using a heuristic
144 ExplicitDefault, // Specific refresh rate that was provided by the app with Default
145 // compatibility
Ady Abrahamdd5bfa92021-01-07 17:56:08 -0800146 ExplicitExactOrMultiple, // Specific refresh rate that was provided by the app with
147 // ExactOrMultiple compatibility
148 ExplicitExact, // Specific refresh rate that was provided by the app with
149 // Exact compatibility
150
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -0700151 ftl_last = ExplicitExact
Ady Abraham8a82ba62020-01-17 12:43:17 -0800152 };
153
154 // Captures the layer requirements for a refresh rate. This will be used to determine the
155 // display refresh rate.
156 struct LayerRequirement {
Ady Abrahamaae5ed52020-06-26 09:32:43 -0700157 // Layer's name. Used for debugging purposes.
158 std::string name;
Ady Abraham62a0be22020-12-08 16:54:10 -0800159 // Layer's owner uid
160 uid_t ownerUid = static_cast<uid_t>(-1);
Ady Abrahamaae5ed52020-06-26 09:32:43 -0700161 // Layer vote type.
162 LayerVoteType vote = LayerVoteType::NoVote;
163 // Layer's desired refresh rate, if applicable.
Dominik Laskowski6eab42d2021-09-13 14:34:13 -0700164 Fps desiredRefreshRate;
Marin Shalamanov46084422020-10-13 12:33:42 +0200165 // If a seamless mode switch is required.
Marin Shalamanov53fc11d2020-11-20 14:00:13 +0100166 Seamlessness seamlessness = Seamlessness::Default;
Ady Abrahamaae5ed52020-06-26 09:32:43 -0700167 // Layer's weight in the range of [0, 1]. The higher the weight the more impact this layer
168 // would have on choosing the refresh rate.
169 float weight = 0.0f;
170 // Whether layer is in focus or not based on WindowManager's state
171 bool focused = false;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800172
173 bool operator==(const LayerRequirement& other) const {
174 return name == other.name && vote == other.vote &&
Dominik Laskowski6eab42d2021-09-13 14:34:13 -0700175 isApproxEqual(desiredRefreshRate, other.desiredRefreshRate) &&
Marin Shalamanovbe97cfa2020-12-01 16:02:07 +0100176 seamlessness == other.seamlessness && weight == other.weight &&
Ady Abrahamaae5ed52020-06-26 09:32:43 -0700177 focused == other.focused;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800178 }
179
180 bool operator!=(const LayerRequirement& other) const { return !(*this == other); }
181 };
182
Ady Abrahamdfd62162020-06-10 16:11:56 -0700183 // Global state describing signals that affect refresh rate choice.
184 struct GlobalSignals {
185 // Whether the user touched the screen recently. Used to apply touch boost.
186 bool touch = false;
187 // True if the system hasn't seen any buffers posted to layers recently.
188 bool idle = false;
ramindani38c84982022-08-29 18:02:57 +0000189 // Whether the display is about to be powered on, or has been in PowerMode::ON
190 // within the timeout of DisplayPowerTimer.
191 bool powerOnImminent = false;
Marin Shalamanov4c7831e2021-06-08 20:44:06 +0200192
Dominik Laskowski6eab42d2021-09-13 14:34:13 -0700193 bool operator==(GlobalSignals other) const {
ramindani38c84982022-08-29 18:02:57 +0000194 return touch == other.touch && idle == other.idle &&
195 powerOnImminent == other.powerOnImminent;
Marin Shalamanov4c7831e2021-06-08 20:44:06 +0200196 }
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400197
198 auto toString() const {
199 return ftl::Concat("{touch=", touch, ", idle=", idle,
200 ", powerOnImminent=", powerOnImminent, '}');
201 }
Ady Abrahamdfd62162020-06-10 16:11:56 -0700202 };
203
Ady Abraham68636062022-11-16 17:07:25 -0800204 struct ScoredFrameRate {
205 FrameRateMode frameRateMode;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400206 float score = 0.0f;
207
Ady Abraham68636062022-11-16 17:07:25 -0800208 bool operator==(const ScoredFrameRate& other) const {
209 return frameRateMode == other.frameRateMode && score == other.score;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400210 }
211
212 static bool scoresEqual(float lhs, float rhs) {
213 constexpr float kEpsilon = 0.0001f;
214 return std::abs(lhs - rhs) <= kEpsilon;
215 }
216
217 struct DescendingScore {
Ady Abraham68636062022-11-16 17:07:25 -0800218 bool operator()(const ScoredFrameRate& lhs, const ScoredFrameRate& rhs) const {
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400219 return lhs.score > rhs.score && !scoresEqual(lhs.score, rhs.score);
220 }
221 };
222 };
223
Ady Abraham68636062022-11-16 17:07:25 -0800224 using FrameRateRanking = std::vector<ScoredFrameRate>;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400225
Ady Abraham68636062022-11-16 17:07:25 -0800226 struct RankedFrameRates {
227 FrameRateRanking ranking; // Ordered by descending score.
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400228 GlobalSignals consideredSignals;
229
Ady Abraham68636062022-11-16 17:07:25 -0800230 bool operator==(const RankedFrameRates& other) const {
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400231 return ranking == other.ranking && consideredSignals == other.consideredSignals;
232 }
233 };
234
Ady Abraham68636062022-11-16 17:07:25 -0800235 RankedFrameRates getRankedFrameRates(const std::vector<LayerRequirement>&, GlobalSignals) const
236 EXCLUDES(mLock);
Ana Krulecb43429d2019-01-09 14:28:51 -0800237
Marin Shalamanoveadf2e72020-12-10 15:35:28 +0100238 FpsRange getSupportedRefreshRateRange() const EXCLUDES(mLock) {
239 std::lock_guard lock(mLock);
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800240 return {mMinRefreshRateModeIt->second->getFps(), mMaxRefreshRateModeIt->second->getFps()};
Marin Shalamanoveadf2e72020-12-10 15:35:28 +0100241 }
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700242
Ady Abraham0aa373a2022-11-22 13:56:50 -0800243 ftl::Optional<FrameRateMode> onKernelTimerChanged(
244 std::optional<DisplayModeId> desiredActiveModeId, bool timerExpired) const
245 EXCLUDES(mLock);
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700246
Ady Abrahamace3d052022-11-17 16:25:05 -0800247 void setActiveMode(DisplayModeId, Fps renderFrameRate) EXCLUDES(mLock);
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700248
Ady Abrahamace3d052022-11-17 16:25:05 -0800249 // See mActiveModeOpt for thread safety.
250 FrameRateMode getActiveMode() const EXCLUDES(mLock);
Dominik Laskowski22488f62019-03-28 09:53:04 -0700251
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700252 // Returns a known frame rate that is the closest to frameRate
Marin Shalamanove8a663d2020-11-24 17:48:00 +0100253 Fps findClosestKnownFrameRate(Fps frameRate) const;
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700254
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800255 enum class KernelIdleTimerController { Sysprop, HwcApi, ftl_last = HwcApi };
ramindani32cf0602022-03-02 02:30:29 +0000256
rnlee3bd610662021-06-23 16:27:57 -0700257 // Configuration flags.
258 struct Config {
Ady Abraham8ca643a2022-10-18 18:26:47 -0700259 enum class FrameRateOverride {
260 // Do not override the frame rate for an app
261 Disabled,
262
263 // Override the frame rate for an app to a value which is also
264 // a display refresh rate
Ady Abraham68636062022-11-16 17:07:25 -0800265 AppOverrideNativeRefreshRates,
Ady Abraham8ca643a2022-10-18 18:26:47 -0700266
267 // Override the frame rate for an app to any value
Ady Abraham68636062022-11-16 17:07:25 -0800268 AppOverride,
269
270 // Override the frame rate for all apps and all values.
Ady Abraham8ca643a2022-10-18 18:26:47 -0700271 Enabled,
272
273 ftl_last = Enabled
274 };
275 FrameRateOverride enableFrameRateOverride = FrameRateOverride::Disabled;
rnlee3bd610662021-06-23 16:27:57 -0700276
277 // Specifies the upper refresh rate threshold (inclusive) for layer vote types of multiple
278 // or heuristic, such that refresh rates higher than this value will not be voted for. 0 if
279 // no threshold is set.
280 int frameRateMultipleThreshold = 0;
Ady Abraham9a2ea342021-09-03 17:32:34 -0700281
Ady Abraham6d885932021-09-03 18:05:48 -0700282 // The Idle Timer timeout. 0 timeout means no idle timer.
ramindani32cf0602022-03-02 02:30:29 +0000283 std::chrono::milliseconds idleTimerTimeout = 0ms;
Ady Abraham6d885932021-09-03 18:05:48 -0700284
ramindani32cf0602022-03-02 02:30:29 +0000285 // The controller representing how the kernel idle timer will be configured
286 // either on the HWC api or sysprop.
Dominik Laskowski03cfce82022-11-02 12:13:29 -0400287 ftl::Optional<KernelIdleTimerController> kernelIdleTimerController;
rnlee3bd610662021-06-23 16:27:57 -0700288 };
289
Ady Abraham8ca643a2022-10-18 18:26:47 -0700290 RefreshRateSelector(
291 DisplayModes, DisplayModeId activeModeId,
292 Config config = {.enableFrameRateOverride = Config::FrameRateOverride::Disabled,
293 .frameRateMultipleThreshold = 0,
294 .idleTimerTimeout = 0ms,
295 .kernelIdleTimerController = {}});
Ana Krulec4593b692019-01-11 22:07:25 -0800296
Dominik Laskowskid82e0f02022-10-26 15:23:04 -0400297 RefreshRateSelector(const RefreshRateSelector&) = delete;
298 RefreshRateSelector& operator=(const RefreshRateSelector&) = delete;
Dominik Laskowski0c252702021-12-20 20:32:09 -0800299
Dominik Laskowski2b1037b2023-02-11 16:45:36 -0500300 const DisplayModes& displayModes() const { return mDisplayModes; }
301
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100302 // Returns whether switching modes (refresh rate or resolution) is possible.
303 // TODO(b/158780872): Consider HAL support, and skip frame rate detection if the modes only
Ady Abraham68636062022-11-16 17:07:25 -0800304 // differ in resolution. Once Config::FrameRateOverride::Enabled becomes the default,
305 // we can probably remove canSwitch altogether since all devices will be able
306 // to switch to a frame rate divisor.
Marin Shalamanoveadf2e72020-12-10 15:35:28 +0100307 bool canSwitch() const EXCLUDES(mLock) {
308 std::lock_guard lock(mLock);
Ady Abraham68636062022-11-16 17:07:25 -0800309 return mDisplayModes.size() > 1 ||
310 mFrameRateOverrideConfig == Config::FrameRateOverride::Enabled;
Marin Shalamanoveadf2e72020-12-10 15:35:28 +0100311 }
Dominik Laskowski983f2b52020-06-25 16:54:06 -0700312
TreeHugger Robot758ab612021-06-22 19:17:29 +0000313 // Class to enumerate options around toggling the kernel timer on and off.
Ana Krulecb9afd792020-06-11 13:16:15 -0700314 enum class KernelIdleTimerAction {
Dominik Laskowskid82e0f02022-10-26 15:23:04 -0400315 TurnOff, // Turn off the idle timer.
316 TurnOn // Turn on the idle timer.
Ana Krulecb9afd792020-06-11 13:16:15 -0700317 };
ramindani32cf0602022-03-02 02:30:29 +0000318
Ana Krulecb9afd792020-06-11 13:16:15 -0700319 // Checks whether kernel idle timer should be active depending the policy decisions around
320 // refresh rates.
321 KernelIdleTimerAction getIdleTimerAction() const;
322
Ady Abraham68636062022-11-16 17:07:25 -0800323 bool supportsAppFrameRateOverrideByContent() const {
Ady Abraham8ca643a2022-10-18 18:26:47 -0700324 return mFrameRateOverrideConfig != Config::FrameRateOverride::Disabled;
325 }
Ady Abraham64c2fc02020-12-29 12:07:50 -0800326
Ady Abraham68636062022-11-16 17:07:25 -0800327 bool supportsFrameRateOverride() const {
328 return mFrameRateOverrideConfig == Config::FrameRateOverride::Enabled;
329 }
330
Ady Abrahamcc315492022-02-17 17:06:39 -0800331 // Return the display refresh rate divisor to match the layer
Ady Abraham5cc2e262021-03-25 13:09:17 -0700332 // frame rate, or 0 if the display refresh rate is not a multiple of the
333 // layer refresh rate.
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800334 static int getFrameRateDivisor(Fps displayRefreshRate, Fps layerFrameRate);
Ady Abraham62a0be22020-12-08 16:54:10 -0800335
Marin Shalamanov15a0fc62021-08-16 18:20:21 +0200336 // Returns if the provided frame rates have a ratio t*1000/1001 or t*1001/1000
337 // for an integer t.
338 static bool isFractionalPairOrMultiple(Fps, Fps);
339
Ady Abraham62a0be22020-12-08 16:54:10 -0800340 using UidToFrameRateOverride = std::map<uid_t, Fps>;
Dominik Laskowski6eab42d2021-09-13 14:34:13 -0700341
Ady Abrahamdd5bfa92021-01-07 17:56:08 -0800342 // Returns the frame rate override for each uid.
Dominik Laskowski6eab42d2021-09-13 14:34:13 -0700343 UidToFrameRateOverride getFrameRateOverrides(const std::vector<LayerRequirement>&,
344 Fps displayFrameRate, GlobalSignals) const
Ady Abrahamdd5bfa92021-01-07 17:56:08 -0800345 EXCLUDES(mLock);
Ady Abraham0bb6a472020-10-12 10:22:13 -0700346
ramindani32cf0602022-03-02 02:30:29 +0000347 std::optional<KernelIdleTimerController> kernelIdleTimerController() {
348 return mConfig.kernelIdleTimerController;
349 }
Ady Abraham9a2ea342021-09-03 17:32:34 -0700350
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800351 struct IdleTimerCallbacks {
352 struct Callbacks {
353 std::function<void()> onReset;
354 std::function<void()> onExpired;
355 };
356
357 Callbacks platform;
358 Callbacks kernel;
359 };
360
361 void setIdleTimerCallbacks(IdleTimerCallbacks callbacks) EXCLUDES(mIdleTimerCallbacksMutex) {
Ady Abraham9a2ea342021-09-03 17:32:34 -0700362 std::scoped_lock lock(mIdleTimerCallbacksMutex);
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800363 mIdleTimerCallbacks = std::move(callbacks);
364 }
365
366 void clearIdleTimerCallbacks() EXCLUDES(mIdleTimerCallbacksMutex) {
367 std::scoped_lock lock(mIdleTimerCallbacksMutex);
368 mIdleTimerCallbacks.reset();
Ady Abraham11663402021-11-10 19:46:09 -0800369 }
370
371 void startIdleTimer() {
372 if (mIdleTimer) {
373 mIdleTimer->start();
374 }
375 }
376
377 void stopIdleTimer() {
378 if (mIdleTimer) {
379 mIdleTimer->stop();
380 }
Ady Abraham9a2ea342021-09-03 17:32:34 -0700381 }
382
Dominik Laskowski596a2562022-10-28 11:26:12 -0400383 void resetKernelIdleTimer() {
384 if (mIdleTimer && mConfig.kernelIdleTimerController) {
385 mIdleTimer->reset();
Ady Abraham9a2ea342021-09-03 17:32:34 -0700386 }
Dominik Laskowski596a2562022-10-28 11:26:12 -0400387 }
388
389 void resetIdleTimer() {
390 if (mIdleTimer) {
391 mIdleTimer->reset();
Ady Abraham9a2ea342021-09-03 17:32:34 -0700392 }
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800393 }
Ady Abraham9a2ea342021-09-03 17:32:34 -0700394
Dominik Laskowskie70461a2022-08-30 14:42:01 -0700395 void dump(utils::Dumper&) const EXCLUDES(mLock);
Marin Shalamanovba421a82020-11-10 21:49:26 +0100396
ramindani32cf0602022-03-02 02:30:29 +0000397 std::chrono::milliseconds getIdleTimerTimeout();
398
Dominik Laskowski22488f62019-03-28 09:53:04 -0700399private:
Dominik Laskowskid82e0f02022-10-26 15:23:04 -0400400 friend struct TestableRefreshRateSelector;
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700401
Ady Abraham2139f732019-11-13 18:56:40 -0800402 void constructAvailableRefreshRates() REQUIRES(mLock);
403
Ady Abrahamace3d052022-11-17 16:25:05 -0800404 // See mActiveModeOpt for thread safety.
405 const FrameRateMode& getActiveModeLocked() const REQUIRES(mLock);
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700406
Ady Abraham68636062022-11-16 17:07:25 -0800407 RankedFrameRates getRankedFrameRatesLocked(const std::vector<LayerRequirement>& layers,
408 GlobalSignals signals) const REQUIRES(mLock);
Marin Shalamanov4c7831e2021-06-08 20:44:06 +0200409
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800410 // Returns number of display frames and remainder when dividing the layer refresh period by
411 // display refresh period.
412 std::pair<nsecs_t, nsecs_t> getDisplayFrames(nsecs_t layerPeriod, nsecs_t displayPeriod) const;
413
Steven Thomasf734df42020-04-13 21:09:28 -0700414 // Returns the lowest refresh rate according to the current policy. May change at runtime. Only
415 // uses the primary range, not the app request range.
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800416 const DisplayModePtr& getMinRefreshRateByPolicyLocked() const REQUIRES(mLock);
Steven Thomasf734df42020-04-13 21:09:28 -0700417
418 // Returns the highest refresh rate according to the current policy. May change at runtime. Only
419 // uses the primary range, not the app request range.
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800420 const DisplayModePtr& getMaxRefreshRateByPolicyLocked(int anchorGroup) const REQUIRES(mLock);
Marin Shalamanov8cd8a992021-09-14 23:22:49 +0200421
ramindanid72ba162022-09-09 21:33:40 +0000422 struct RefreshRateScoreComparator;
423
Ady Abraham68636062022-11-16 17:07:25 -0800424 enum class RefreshRateOrder {
425 Ascending,
426 Descending,
427
428 ftl_last = Descending
429 };
ramindanid72ba162022-09-09 21:33:40 +0000430
ramindanid72ba162022-09-09 21:33:40 +0000431 // Only uses the primary range, not the app request range.
Ady Abraham68636062022-11-16 17:07:25 -0800432 FrameRateRanking rankFrameRates(
433 std::optional<int> anchorGroupOpt, RefreshRateOrder refreshRateOrder,
434 std::optional<DisplayModeId> preferredDisplayModeOpt = std::nullopt) const
435 REQUIRES(mLock);
ramindanid72ba162022-09-09 21:33:40 +0000436
Steven Thomasd4071902020-03-24 16:02:53 -0700437 const Policy* getCurrentPolicyLocked() const REQUIRES(mLock);
Marin Shalamanoveadf2e72020-12-10 15:35:28 +0100438 bool isPolicyValidLocked(const Policy& policy) const REQUIRES(mLock);
Steven Thomasd4071902020-03-24 16:02:53 -0700439
ramindanid72ba162022-09-09 21:33:40 +0000440 // Returns the refresh rate score as a ratio to max refresh rate, which has a score of 1.
Ady Abraham68636062022-11-16 17:07:25 -0800441 float calculateDistanceScoreFromMax(Fps refreshRate) const REQUIRES(mLock);
Ady Abraham62a0be22020-12-08 16:54:10 -0800442 // calculates a score for a layer. Used to determine the display refresh rate
443 // and the frame rate override for certains applications.
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800444 float calculateLayerScoreLocked(const LayerRequirement&, Fps refreshRate,
Ady Abraham62a0be22020-12-08 16:54:10 -0800445 bool isSeamlessSwitch) const REQUIRES(mLock);
446
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800447 float calculateNonExactMatchingLayerScoreLocked(const LayerRequirement&, Fps refreshRate) const
448 REQUIRES(mLock);
Ady Abraham05243be2021-09-16 15:58:52 -0700449
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700450 void updateDisplayModes(DisplayModes, DisplayModeId activeModeId) EXCLUDES(mLock)
451 REQUIRES(kMainThreadContext);
Ady Abraham3efa3942021-06-24 19:01:25 -0700452
Ady Abraham9a2ea342021-09-03 17:32:34 -0700453 void initializeIdleTimer();
454
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800455 std::optional<IdleTimerCallbacks::Callbacks> getIdleTimerCallbacks() const
456 REQUIRES(mIdleTimerCallbacksMutex) {
457 if (!mIdleTimerCallbacks) return {};
ramindani32cf0602022-03-02 02:30:29 +0000458 return mConfig.kernelIdleTimerController.has_value() ? mIdleTimerCallbacks->kernel
459 : mIdleTimerCallbacks->platform;
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800460 }
461
Ady Abraham68636062022-11-16 17:07:25 -0800462 bool isNativeRefreshRate(Fps fps) const REQUIRES(mLock) {
463 LOG_ALWAYS_FATAL_IF(mConfig.enableFrameRateOverride !=
464 Config::FrameRateOverride::AppOverrideNativeRefreshRates,
465 "should only be called when "
466 "Config::FrameRateOverride::AppOverrideNativeRefreshRates is used");
467 return mAppOverrideNativeRefreshRates.contains(fps);
468 }
469
470 std::vector<FrameRateMode> createFrameRateModes(
471 std::function<bool(const DisplayMode&)>&& filterModes, const FpsRange&) const
472 REQUIRES(mLock);
473
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800474 // The display modes of the active display. The DisplayModeIterators below are pointers into
475 // this container, so must be invalidated whenever the DisplayModes change. The Policy below
476 // is also dependent, so must be reset as well.
477 DisplayModes mDisplayModes GUARDED_BY(mLock);
Ady Abraham2139f732019-11-13 18:56:40 -0800478
Ady Abraham68636062022-11-16 17:07:25 -0800479 // Set of supported display refresh rates for easy lookup
480 // when FrameRateOverride::AppOverrideNativeRefreshRates is in use.
481 ftl::SmallMap<Fps, ftl::Unit, 8, FpsApproxEqual> mAppOverrideNativeRefreshRates;
482
Ady Abrahamace3d052022-11-17 16:25:05 -0800483 ftl::Optional<FrameRateMode> mActiveModeOpt GUARDED_BY(mLock);
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700484
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800485 DisplayModeIterator mMinRefreshRateModeIt GUARDED_BY(mLock);
486 DisplayModeIterator mMaxRefreshRateModeIt GUARDED_BY(mLock);
Steven Thomasf734df42020-04-13 21:09:28 -0700487
Dominik Laskowskib0054a22022-03-03 09:03:06 -0800488 // Display modes that satisfy the Policy's ranges, filtered and sorted by refresh rate.
Ady Abraham68636062022-11-16 17:07:25 -0800489 std::vector<FrameRateMode> mPrimaryFrameRates GUARDED_BY(mLock);
490 std::vector<FrameRateMode> mAppRequestFrameRates GUARDED_BY(mLock);
Ady Abraham2139f732019-11-13 18:56:40 -0800491
Steven Thomasd4071902020-03-24 16:02:53 -0700492 Policy mDisplayManagerPolicy GUARDED_BY(mLock);
493 std::optional<Policy> mOverridePolicy GUARDED_BY(mLock);
Ady Abraham2139f732019-11-13 18:56:40 -0800494
Dominik Laskowski36dced82022-09-02 09:24:00 -0700495 unsigned mNumModeSwitchesInPolicy GUARDED_BY(kMainThreadContext) = 0;
496
Ady Abraham2139f732019-11-13 18:56:40 -0800497 mutable std::mutex mLock;
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700498
499 // A sorted list of known frame rates that a Heuristic layer will choose
500 // from based on the closest value.
Marin Shalamanove8a663d2020-11-24 17:48:00 +0100501 const std::vector<Fps> mKnownFrameRates;
Ady Abraham64c2fc02020-12-29 12:07:50 -0800502
rnlee3bd610662021-06-23 16:27:57 -0700503 const Config mConfig;
Ady Abrahambd44e8a2023-07-24 11:30:06 -0700504
505 // A list of known frame rates that favors at least 60Hz if there is no exact match display
506 // refresh rate
507 const std::vector<Fps> mFrameRatesThatFavorsAtLeast60 = {23.976_Hz, 25_Hz, 29.97_Hz, 50_Hz,
508 59.94_Hz};
509
Ady Abraham8ca643a2022-10-18 18:26:47 -0700510 Config::FrameRateOverride mFrameRateOverrideConfig;
Marin Shalamanov4c7831e2021-06-08 20:44:06 +0200511
Ady Abraham68636062022-11-16 17:07:25 -0800512 struct GetRankedFrameRatesCache {
Dominik Laskowskia8626ec2021-12-15 18:13:30 -0800513 std::pair<std::vector<LayerRequirement>, GlobalSignals> arguments;
Ady Abraham68636062022-11-16 17:07:25 -0800514 RankedFrameRates result;
Marin Shalamanov4c7831e2021-06-08 20:44:06 +0200515 };
Ady Abraham68636062022-11-16 17:07:25 -0800516 mutable std::optional<GetRankedFrameRatesCache> mGetRankedFrameRatesCache GUARDED_BY(mLock);
Ady Abraham9a2ea342021-09-03 17:32:34 -0700517
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800518 // Declare mIdleTimer last to ensure its thread joins before the mutex/callbacks are destroyed.
Ady Abraham9a2ea342021-09-03 17:32:34 -0700519 std::mutex mIdleTimerCallbacksMutex;
520 std::optional<IdleTimerCallbacks> mIdleTimerCallbacks GUARDED_BY(mIdleTimerCallbacksMutex);
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800521 // Used to detect (lack of) frame activity.
Dominik Laskowski03cfce82022-11-02 12:13:29 -0400522 ftl::Optional<scheduler::OneShotTimer> mIdleTimer;
Ana Krulecb43429d2019-01-09 14:28:51 -0800523};
524
Dominik Laskowski98041832019-08-01 18:35:59 -0700525} // namespace android::scheduler