blob: 8a76436fda86cfe25f6a273dbfc01039d75b39dc [file] [log] [blame]
Ana Krulec98b5b242018-08-10 15:03:23 -07001/*
2 * Copyright 2018 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
Dominik Laskowski98041832019-08-01 18:35:59 -070019#include <atomic>
Dominik Laskowski62eff352021-12-06 09:59:41 -080020#include <cstdint>
Kevin DuBois413287f2019-02-25 08:46:47 -080021#include <functional>
Dominik Laskowski756b7892021-08-04 12:53:59 -070022#include <future>
Ana Krulec98b5b242018-08-10 15:03:23 -070023#include <memory>
Dominik Laskowski98041832019-08-01 18:35:59 -070024#include <mutex>
Dominik Laskowski98041832019-08-01 18:35:59 -070025#include <unordered_map>
ramindani69b58e82022-09-26 16:48:36 -070026#include <utility>
Ana Krulec98b5b242018-08-10 15:03:23 -070027
Ady Abrahamdec1a412020-01-24 10:23:50 -080028// TODO(b/129481165): remove the #pragma below and fix conversion issues
29#pragma clang diagnostic push
30#pragma clang diagnostic ignored "-Wconversion"
Marin Shalamanovbed7fd32020-12-21 20:02:20 +010031#pragma clang diagnostic ignored "-Wextra"
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -080032#include <ui/GraphicTypes.h>
Marin Shalamanovbed7fd32020-12-21 20:02:20 +010033#pragma clang diagnostic pop // ignored "-Wconversion -Wextra"
Ana Krulec98b5b242018-08-10 15:03:23 -070034
Dominik Laskowski596a2562022-10-28 11:26:12 -040035#include <ftl/fake_guard.h>
Dominik Laskowskifb4b7372023-11-22 09:56:54 -050036#include <ftl/non_null.h>
Dominik Laskowski596a2562022-10-28 11:26:12 -040037#include <ftl/optional.h>
Dominik Laskowski068173d2021-08-11 17:22:59 -070038#include <scheduler/Features.h>
Dominik Laskowskib418dd72023-06-13 17:31:04 -040039#include <scheduler/FrameTargeter.h>
Dominik Laskowski5d164f22022-07-07 07:56:07 -070040#include <scheduler/Time.h>
Dominik Laskowski1c99a002023-01-20 17:10:36 -050041#include <scheduler/VsyncConfig.h>
Dominik Laskowski01602522022-10-07 19:02:28 -040042#include <ui/DisplayId.h>
Dominik Laskowski6b049ff2023-01-29 15:46:45 -050043#include <ui/DisplayMap.h>
Dominik Laskowski068173d2021-08-11 17:22:59 -070044
Dominik Laskowski530d6bd2022-10-10 16:55:54 -040045#include "Display/DisplayModeRequest.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070046#include "EventThread.h"
Andy Yu2ae6b6b2021-11-18 14:51:06 -080047#include "FrameRateOverrideMappings.h"
Leon Scroggins IIIc275df42023-02-07 16:40:21 -050048#include "ISchedulerCallback.h"
Ana Krulec3084c052018-11-21 20:27:17 +010049#include "LayerHistory.h"
Dominik Laskowski756b7892021-08-04 12:53:59 -070050#include "MessageQueue.h"
Ana Krulecf2c006d2019-06-21 15:37:07 -070051#include "OneShotTimer.h"
Dominik Laskowskid82e0f02022-10-26 15:23:04 -040052#include "RefreshRateSelector.h"
Tony Huang9ac5e6e2023-08-24 09:01:44 +000053#include "SmallAreaDetectionAllowMappings.h"
Dominik Laskowski03cfce82022-11-02 12:13:29 -040054#include "Utils/Dumper.h"
Dominik Laskowski1c99a002023-01-20 17:10:36 -050055#include "VsyncModulator.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070056
Ady Abraham822ecbd2023-07-07 16:16:09 -070057#include <FrontEnd/LayerHierarchy.h>
58
Dominik Laskowski62eff352021-12-06 09:59:41 -080059namespace android::scheduler {
60
61// Opaque handle to scheduler connection.
62struct ConnectionHandle {
63 using Id = std::uintptr_t;
64 static constexpr Id INVALID_ID = static_cast<Id>(-1);
65
66 Id id = INVALID_ID;
67
68 explicit operator bool() const { return id != INVALID_ID; }
69};
70
71inline bool operator==(ConnectionHandle lhs, ConnectionHandle rhs) {
72 return lhs.id == rhs.id;
73}
74
75} // namespace android::scheduler
76
77namespace std {
78
79template <>
80struct hash<android::scheduler::ConnectionHandle> {
81 size_t operator()(android::scheduler::ConnectionHandle handle) const {
82 return hash<android::scheduler::ConnectionHandle::Id>()(handle.id);
83 }
84};
85
86} // namespace std
87
Ana Krulec98b5b242018-08-10 15:03:23 -070088namespace android {
89
Dominik Laskowski98041832019-08-01 18:35:59 -070090class FenceTime;
Ana Krulece588e312018-09-18 12:32:24 -070091
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -070092namespace frametimeline {
93class TokenManager;
94} // namespace frametimeline
95
Dominik Laskowski068173d2021-08-11 17:22:59 -070096namespace scheduler {
97
Dominik Laskowskid82e0f02022-10-26 15:23:04 -040098using GlobalSignals = RefreshRateSelector::GlobalSignals;
ramindani69b58e82022-09-26 16:48:36 -070099
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500100class VsyncSchedule;
101
Ady Abrahamf2851612023-09-25 17:19:00 -0700102class Scheduler : public IEventThreadCallback, android::impl::MessageQueue {
Patrick Williams83f36b22022-09-14 17:57:35 +0000103 using Impl = android::impl::MessageQueue;
Dominik Laskowski756b7892021-08-04 12:53:59 -0700104
Ana Krulec98b5b242018-08-10 15:03:23 -0700105public:
ramindanid4354a92023-10-02 15:11:09 -0700106 Scheduler(ICompositor&, ISchedulerCallback&, FeatureFlags, sp<VsyncModulator>,
107 IVsyncTrackerCallback&);
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800108 virtual ~Scheduler();
109
110 void startTimers();
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800111
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500112 // TODO(b/241285191): Remove this API by promoting pacesetter in onScreen{Acquired,Released}.
113 void setPacesetterDisplay(std::optional<PhysicalDisplayId>) REQUIRES(kMainThreadContext)
Dominik Laskowski596a2562022-10-28 11:26:12 -0400114 EXCLUDES(mDisplayLock);
Dominik Laskowskib5a094b2022-10-27 12:00:12 -0400115
Dominik Laskowski596a2562022-10-28 11:26:12 -0400116 using RefreshRateSelectorPtr = std::shared_ptr<RefreshRateSelector>;
117
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500118 using ConstVsyncSchedulePtr = std::shared_ptr<const VsyncSchedule>;
119 using VsyncSchedulePtr = std::shared_ptr<VsyncSchedule>;
120
Dominik Laskowski596a2562022-10-28 11:26:12 -0400121 void registerDisplay(PhysicalDisplayId, RefreshRateSelectorPtr) REQUIRES(kMainThreadContext)
122 EXCLUDES(mDisplayLock);
123 void unregisterDisplay(PhysicalDisplayId) REQUIRES(kMainThreadContext) EXCLUDES(mDisplayLock);
Dominik Laskowski01602522022-10-07 19:02:28 -0400124
Dominik Laskowski83bd7712022-01-07 14:30:53 -0800125 void run();
Ana Krulec98b5b242018-08-10 15:03:23 -0700126
Dominik Laskowski756b7892021-08-04 12:53:59 -0700127 using Impl::initVsync;
Dominik Laskowski756b7892021-08-04 12:53:59 -0700128
129 using Impl::getScheduledFrameTime;
130 using Impl::setDuration;
131
Dominik Laskowskif11728a2022-07-28 13:07:42 -0700132 using Impl::scheduleConfigure;
Dominik Laskowski46f3e3b2021-08-10 11:44:24 -0700133 using Impl::scheduleFrame;
Dominik Laskowski756b7892021-08-04 12:53:59 -0700134
135 // Schedule an asynchronous or synchronous task on the main thread.
136 template <typename F, typename T = std::invoke_result_t<F>>
137 [[nodiscard]] std::future<T> schedule(F&& f) {
138 auto [task, future] = makeTask(std::move(f));
139 postMessage(std::move(task));
140 return std::move(future);
141 }
Dominik Laskowski9c93d602021-10-07 19:38:26 -0700142
Chavi Weingarten076acac2023-01-19 17:20:43 +0000143 template <typename F, typename T = std::invoke_result_t<F>>
144 [[nodiscard]] std::future<T> scheduleDelayed(F&& f, nsecs_t uptimeDelay) {
145 auto [task, future] = makeTask(std::move(f));
146 postMessageDelayed(std::move(task), uptimeDelay);
147 return std::move(future);
148 }
149
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500150 enum class Cycle {
151 Render, // Surface rendering.
152 LastComposite // Ahead of display compositing by one refresh period.
153 };
154
155 ConnectionHandle createEventThread(Cycle, frametimeline::TokenManager*,
156 std::chrono::nanoseconds workDuration,
157 std::chrono::nanoseconds readyDuration);
Ana Krulec98b5b242018-08-10 15:03:23 -0700158
Ady Abraham62f216c2020-10-13 19:07:23 -0700159 sp<IDisplayEventConnection> createDisplayEventConnection(
Rachel Lee2248f522023-01-27 16:45:23 -0800160 ConnectionHandle, EventRegistrationFlags eventRegistration = {},
Ady Abraham822ecbd2023-07-07 16:16:09 -0700161 const sp<IBinder>& layerHandle = nullptr) EXCLUDES(mChoreographerLock);
Ana Krulece588e312018-09-18 12:32:24 -0700162
Dominik Laskowski98041832019-08-01 18:35:59 -0700163 sp<EventThreadConnection> getEventConnection(ConnectionHandle);
Kevin DuBois413287f2019-02-25 08:46:47 -0800164
Dominik Laskowski98041832019-08-01 18:35:59 -0700165 void onHotplugReceived(ConnectionHandle, PhysicalDisplayId, bool connected);
Brian Johnson5dcd75d2023-08-15 09:36:37 -0700166 void onHotplugConnectionError(ConnectionHandle, int32_t errorCode);
167
Ady Abrahamace3d052022-11-17 16:25:05 -0800168 void onPrimaryDisplayModeChanged(ConnectionHandle, const FrameRateMode&) EXCLUDES(mPolicyLock);
169 void onNonPrimaryDisplayModeChanged(ConnectionHandle, const FrameRateMode&);
Dominik Laskowskie99b98c2023-02-02 12:37:23 -0500170
171 void enableSyntheticVsync(bool = true) REQUIRES(kMainThreadContext);
Ana Krulece588e312018-09-18 12:32:24 -0700172
Ady Abraham62a0be22020-12-08 16:54:10 -0800173 void onFrameRateOverridesChanged(ConnectionHandle, PhysicalDisplayId)
Andy Yu2ae6b6b2021-11-18 14:51:06 -0800174 EXCLUDES(mConnectionsLock);
Ady Abraham62f216c2020-10-13 19:07:23 -0700175
Ady Abraham9c53ee72020-07-22 21:16:18 -0700176 // Modifies work duration in the event thread.
177 void setDuration(ConnectionHandle, std::chrono::nanoseconds workDuration,
178 std::chrono::nanoseconds readyDuration);
Ana Krulec98b5b242018-08-10 15:03:23 -0700179
Dominik Laskowski14956dc2023-02-22 13:43:57 -0500180 VsyncModulator& vsyncModulator() { return *mVsyncModulator; }
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500181
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500182 // In some cases, we should only modulate for the pacesetter display. In those
Leon Scroggins III67388622023-02-06 20:36:20 -0500183 // cases, the caller should pass in the relevant display, and the method
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500184 // will no-op if it's not the pacesetter. Other cases are not specific to a
Leon Scroggins III67388622023-02-06 20:36:20 -0500185 // display.
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500186 template <typename... Args,
187 typename Handler = std::optional<VsyncConfig> (VsyncModulator::*)(Args...)>
Leon Scroggins III67388622023-02-06 20:36:20 -0500188 void modulateVsync(std::optional<PhysicalDisplayId> id, Handler handler, Args... args) {
189 if (id) {
190 std::scoped_lock lock(mDisplayLock);
191 ftl::FakeGuard guard(kMainThreadContext);
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500192 if (id != mPacesetterDisplayId) {
Leon Scroggins III67388622023-02-06 20:36:20 -0500193 return;
194 }
195 }
196
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500197 if (const auto config = (*mVsyncModulator.*handler)(args...)) {
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500198 setVsyncConfig(*config, getPacesetterVsyncPeriod());
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500199 }
200 }
201
202 void setVsyncConfigSet(const VsyncConfigSet&, Period vsyncPeriod);
203
Ady Abrahamace3d052022-11-17 16:25:05 -0800204 // Sets the render rate for the scheduler to run at.
Leon Scroggins III67388622023-02-06 20:36:20 -0500205 void setRenderRate(PhysicalDisplayId, Fps);
Ady Abrahamace3d052022-11-17 16:25:05 -0800206
Leon Scroggins III4235ea02023-04-17 15:14:20 -0400207 void enableHardwareVsync(PhysicalDisplayId) REQUIRES(kMainThreadContext);
208 void disableHardwareVsync(PhysicalDisplayId, bool disallow) REQUIRES(kMainThreadContext);
Dominik Laskowski98041832019-08-01 18:35:59 -0700209
Alec Mourif8e689c2019-05-20 18:32:22 -0700210 // Resyncs the scheduler to hardware vsync.
Leon Scroggins IIIc275df42023-02-07 16:40:21 -0500211 // If allowToEnable is true, then hardware vsync will be turned on.
Alec Mourif8e689c2019-05-20 18:32:22 -0700212 // Otherwise, if hardware vsync is not already enabled then this method will
213 // no-op.
Ady Abrahamc585dba2023-11-15 18:41:35 -0800214 // If modePtr is nullopt, use the active display mode.
Leon Scroggins III67388622023-02-06 20:36:20 -0500215 void resyncToHardwareVsync(PhysicalDisplayId id, bool allowToEnable,
Ady Abrahamc585dba2023-11-15 18:41:35 -0800216 DisplayModePtr modePtr = nullptr) EXCLUDES(mDisplayLock) {
Leon Scroggins III67388622023-02-06 20:36:20 -0500217 std::scoped_lock lock(mDisplayLock);
218 ftl::FakeGuard guard(kMainThreadContext);
Ady Abrahamc585dba2023-11-15 18:41:35 -0800219 resyncToHardwareVsyncLocked(id, allowToEnable, modePtr);
Leon Scroggins III67388622023-02-06 20:36:20 -0500220 }
Ady Abrahame9befd72022-02-24 17:24:44 -0800221 void forceNextResync() { mLastResyncTime = 0; }
Dominik Laskowski98041832019-08-01 18:35:59 -0700222
Leon Scroggins IIIc275df42023-02-07 16:40:21 -0500223 // Passes a vsync sample to VsyncController. Returns true if
224 // VsyncController detected that the vsync period changed and false
225 // otherwise.
Leon Scroggins III67388622023-02-06 20:36:20 -0500226 bool addResyncSample(PhysicalDisplayId, nsecs_t timestamp,
227 std::optional<nsecs_t> hwcVsyncPeriod);
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500228 void addPresentFence(PhysicalDisplayId, std::shared_ptr<FenceTime>)
Leon Scroggins III4235ea02023-04-17 15:14:20 -0400229 REQUIRES(kMainThreadContext);
Ady Abraham8f1ee7f2019-04-05 10:32:50 -0700230
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700231 // Layers are registered on creation, and unregistered when the weak reference expires.
232 void registerLayer(Layer*);
Vishnu Nairef68d6d2023-02-28 06:18:27 +0000233 void recordLayerHistory(int32_t id, const LayerProps& layerProps, nsecs_t presentTime,
Vishnu Nair47b7bb42023-09-29 16:27:33 -0700234 nsecs_t now, LayerHistory::LayerUpdateType) EXCLUDES(mDisplayLock);
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100235 void setModeChangePending(bool pending);
Vishnu Nair80e8cfe2023-09-29 17:03:45 -0700236 void setDefaultFrameRateCompatibility(int32_t id, scheduler::FrameRateCompatibility);
Vishnu Nair41376b62023-11-08 05:08:58 -0800237 void setLayerProperties(int32_t id, const LayerProps&);
Ady Abrahambdda8f02021-04-01 16:06:11 -0700238 void deregisterLayer(Layer*);
Ady Abraham822ecbd2023-07-07 16:16:09 -0700239 void onLayerDestroyed(Layer*) EXCLUDES(mChoreographerLock);
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700240
Dominik Laskowski49cea512019-11-12 14:13:23 -0800241 // Detects content using layer history, and selects a matching refresh rate.
Ady Abraham822ecbd2023-07-07 16:16:09 -0700242 void chooseRefreshRateForContent(const surfaceflinger::frontend::LayerHierarchy*,
243 bool updateAttachedChoreographer) EXCLUDES(mDisplayLock);
Ady Abraham97d04232019-03-05 19:48:12 -0800244
Ady Abraham8532d012019-05-08 14:50:56 -0700245 void resetIdleTimer();
246
Dominik Laskowski8da6b0e2021-05-12 15:34:13 -0700247 // Indicates that touch interaction is taking place.
248 void onTouchHint();
Ady Abraham8532d012019-05-08 14:50:56 -0700249
Leon Scroggins III67388622023-02-06 20:36:20 -0500250 void setDisplayPowerMode(PhysicalDisplayId, hal::PowerMode powerMode)
251 REQUIRES(kMainThreadContext);
Ady Abraham6fe2c172019-07-12 12:37:57 -0700252
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500253 ConstVsyncSchedulePtr getVsyncSchedule(std::optional<PhysicalDisplayId> = std::nullopt) const
254 EXCLUDES(mDisplayLock);
255
256 VsyncSchedulePtr getVsyncSchedule(std::optional<PhysicalDisplayId> idOpt = std::nullopt)
257 EXCLUDES(mDisplayLock) {
258 return std::const_pointer_cast<VsyncSchedule>(std::as_const(*this).getVsyncSchedule(idOpt));
Leon Scroggins III67388622023-02-06 20:36:20 -0500259 }
Ady Abraham55fa7272020-09-30 19:19:27 -0700260
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500261 TimePoint expectedPresentTimeForPacesetter() const EXCLUDES(mDisplayLock) {
262 std::scoped_lock lock(mDisplayLock);
263 return pacesetterDisplayLocked()
264 .transform([](const Display& display) {
265 return display.targeterPtr->target().expectedPresentTime();
266 })
267 .value_or(TimePoint());
268 }
Dominik Laskowskib418dd72023-06-13 17:31:04 -0400269
Leon Scroggins IIIdb16a2b2023-02-06 17:50:05 -0500270 // Returns true if a given vsync timestamp is considered valid vsync
271 // for a given uid
Dominik Laskowskib418dd72023-06-13 17:31:04 -0400272 bool isVsyncValid(TimePoint expectedVsyncTime, uid_t uid) const;
Leon Scroggins IIIdb16a2b2023-02-06 17:50:05 -0500273
Leon Scroggins III67388622023-02-06 20:36:20 -0500274 bool isVsyncInPhase(TimePoint expectedVsyncTime, Fps frameRate) const;
Huihong Luo1768cb02022-10-11 11:10:34 -0700275
Dominik Laskowski03cfce82022-11-02 12:13:29 -0400276 void dump(utils::Dumper&) const;
Dominik Laskowski98041832019-08-01 18:35:59 -0700277 void dump(ConnectionHandle, std::string&) const;
Leon Scroggins III67388622023-02-06 20:36:20 -0500278 void dumpVsync(std::string&) const EXCLUDES(mDisplayLock);
Ana Krulec0c8cd522018-08-31 12:27:28 -0700279
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500280 // Returns the preferred refresh rate and frame rate for the pacesetter display.
Dominik Laskowskifc378b02022-12-02 14:56:05 -0500281 FrameRateMode getPreferredDisplayMode();
Daniel Solomon0f0ddc12019-08-19 19:31:09 -0700282
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800283 // Notifies the scheduler about a refresh rate timeline change.
Peiyong Line9d809e2020-04-14 13:10:48 -0700284 void onNewVsyncPeriodChangeTimeline(const hal::VsyncPeriodChangeTimeline& timeline);
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800285
Leon Scroggins III5b581492023-10-31 14:29:41 -0400286 // Notifies the scheduler once the composition is presented. Returns if recomposite is needed.
287 bool onCompositionPresented(nsecs_t presentTime);
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800288
Ady Abraham8a82ba62020-01-17 12:43:17 -0800289 // Notifies the scheduler when the display size has changed. Called from SF's main thread
Ady Abraham7825c682021-05-17 15:12:14 -0700290 void onActiveDisplayAreaChanged(uint32_t displayArea);
Ady Abraham8a82ba62020-01-17 12:43:17 -0800291
Ady Abraham62a0be22020-12-08 16:54:10 -0800292 // Stores the preferred refresh rate that an app should run at.
293 // FrameRateOverride.refreshRateHz == 0 means no preference.
Andy Yu2ae6b6b2021-11-18 14:51:06 -0800294 void setPreferredRefreshRateForUid(FrameRateOverride);
295
296 void setGameModeRefreshRateForUid(FrameRateOverride);
297
Tony Huangf3621102023-09-04 17:14:22 +0800298 void updateSmallAreaDetection(std::vector<std::pair<int32_t, float>>& uidThresholdMappings);
Tony Huang9ac5e6e2023-08-24 09:01:44 +0000299
Tony Huangf3621102023-09-04 17:14:22 +0800300 void setSmallAreaDetectionThreshold(int32_t appId, float threshold);
Tony Huang9ac5e6e2023-08-24 09:01:44 +0000301
302 // Returns true if the dirty area is less than threshold.
Tony Huangf3621102023-09-04 17:14:22 +0800303 bool isSmallDirtyArea(int32_t appId, uint32_t dirtyArea);
Tony Huang9ac5e6e2023-08-24 09:01:44 +0000304
Alec Mouri7d436ec2021-01-27 20:40:50 -0800305 // Retrieves the overridden refresh rate for a given uid.
Dominik Laskowski596a2562022-10-28 11:26:12 -0400306 std::optional<Fps> getFrameRateOverride(uid_t) const EXCLUDES(mDisplayLock);
Ady Abraham3efa3942021-06-24 19:01:25 -0700307
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500308 Period getPacesetterVsyncPeriod() const EXCLUDES(mDisplayLock) {
309 return pacesetterSelectorPtr()->getActiveMode().fps.getPeriod();
Ady Abraham3efa3942021-06-24 19:01:25 -0700310 }
Ady Abraham62a0be22020-12-08 16:54:10 -0800311
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500312 Fps getPacesetterRefreshRate() const EXCLUDES(mDisplayLock) {
313 return pacesetterSelectorPtr()->getActiveMode().fps;
Huihong Luo1768cb02022-10-11 11:10:34 -0700314 }
315
Nathaniel Nifong1303d912021-10-06 09:41:24 -0400316 // Returns the framerate of the layer with the given sequence ID
317 float getLayerFramerate(nsecs_t now, int32_t id) const {
318 return mLayerHistory.getLayerFramerate(now, id);
319 }
320
Ady Abraham33a386b2023-07-18 15:37:11 -0700321 bool updateFrameRateOverrides(GlobalSignals, Fps displayRefreshRate) EXCLUDES(mPolicyLock);
322
Arthur Hungc70bee22023-06-02 01:35:52 +0000323 // Returns true if the small dirty detection is enabled.
324 bool supportSmallDirtyDetection() const {
325 return mFeatures.test(Feature::kSmallDirtyContentDetection);
326 }
327
Alec Mouri1c7938e2023-09-22 04:17:23 +0000328 // Injects a delay that is a fraction of the predicted frame duration for the next frame.
329 void injectPacesetterDelay(float frameDurationFraction) REQUIRES(kMainThreadContext) {
330 mPacesetterFrameDurationFractionToSkip = frameDurationFraction;
331 }
332
Ana Krulec98b5b242018-08-10 15:03:23 -0700333private:
Ana Krulecafb45842019-02-13 13:33:03 -0800334 friend class TestableScheduler;
335
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700336 enum class ContentDetectionState { Off, On };
337 enum class TimerState { Reset, Expired };
338 enum class TouchState { Inactive, Active };
Ana Krulecfefd6ae2019-02-13 17:53:08 -0800339
Dominik Laskowski08fbd852022-07-14 08:53:42 -0700340 // impl::MessageQueue overrides:
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500341 void onFrameSignal(ICompositor&, VsyncId, TimePoint expectedVsyncTime) override
342 REQUIRES(kMainThreadContext, mDisplayLock);
Dominik Laskowski08fbd852022-07-14 08:53:42 -0700343
Dominik Laskowski6505f792019-09-18 11:10:05 -0700344 // Create a connection on the given EventThread.
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700345 ConnectionHandle createConnection(std::unique_ptr<EventThread>);
Dominik Laskowskiccf37d72019-02-01 16:47:58 -0800346
Dominik Laskowski3a80a382019-07-25 11:16:07 -0700347 // Update feature state machine to given state when corresponding timer resets or expires.
Dominik Laskowski596a2562022-10-28 11:26:12 -0400348 void kernelIdleTimerCallback(TimerState) EXCLUDES(mDisplayLock);
Dominik Laskowski3a80a382019-07-25 11:16:07 -0700349 void idleTimerCallback(TimerState);
350 void touchTimerCallback(TimerState);
351 void displayPowerTimerCallback(TimerState);
352
Dominik Laskowski66295432023-03-14 12:25:36 -0400353 // VsyncSchedule delegate.
354 void onHardwareVsyncRequest(PhysicalDisplayId, bool enable);
355
Leon Scroggins III67388622023-02-06 20:36:20 -0500356 void resyncToHardwareVsyncLocked(PhysicalDisplayId, bool allowToEnable,
Ady Abrahamc585dba2023-11-15 18:41:35 -0800357 DisplayModePtr modePtr = nullptr)
Leon Scroggins III67388622023-02-06 20:36:20 -0500358 REQUIRES(kMainThreadContext, mDisplayLock);
359 void resyncAllToHardwareVsync(bool allowToEnable) EXCLUDES(mDisplayLock);
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500360 void setVsyncConfig(const VsyncConfig&, Period vsyncPeriod);
Dominik Laskowski98041832019-08-01 18:35:59 -0700361
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500362 // Chooses a pacesetter among the registered displays, unless `pacesetterIdOpt` is specified.
363 // The new `mPacesetterDisplayId` is never `std::nullopt`.
364 void promotePacesetterDisplay(std::optional<PhysicalDisplayId> pacesetterIdOpt = std::nullopt)
Leon Scroggins III6fc45192023-03-16 12:13:28 -0400365 REQUIRES(kMainThreadContext) EXCLUDES(mDisplayLock);
366
367 // Changes to the displays (e.g. registering and unregistering) must be made
368 // while mDisplayLock is locked, and the new pacesetter then must be promoted while
369 // mDisplayLock is still locked. However, a new pacesetter means that
370 // MessageQueue and EventThread need to use the new pacesetter's
371 // VsyncSchedule, and this must happen while mDisplayLock is *not* locked,
372 // or else we may deadlock with EventThread.
373 std::shared_ptr<VsyncSchedule> promotePacesetterDisplayLocked(
374 std::optional<PhysicalDisplayId> pacesetterIdOpt = std::nullopt)
Dominik Laskowski596a2562022-10-28 11:26:12 -0400375 REQUIRES(kMainThreadContext, mDisplayLock);
Leon Scroggins39d25342023-04-19 17:11:01 +0000376 void applyNewVsyncSchedule(std::shared_ptr<VsyncSchedule>) EXCLUDES(mDisplayLock);
Dominik Laskowski596a2562022-10-28 11:26:12 -0400377
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500378 // Blocks until the pacesetter's idle timer thread exits. `mDisplayLock` must not be locked by
379 // the caller on the main thread to avoid deadlock, since the timer thread locks it before exit.
380 void demotePacesetterDisplay() REQUIRES(kMainThreadContext) EXCLUDES(mDisplayLock, mPolicyLock);
Dominik Laskowski596a2562022-10-28 11:26:12 -0400381
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500382 void registerDisplayInternal(PhysicalDisplayId, RefreshRateSelectorPtr, VsyncSchedulePtr)
383 REQUIRES(kMainThreadContext) EXCLUDES(mDisplayLock);
Leon Scroggins III67388622023-02-06 20:36:20 -0500384
Dominik Laskowski0c41ffa2021-12-24 16:45:12 -0800385 struct Policy;
386
387 // Sets the S state of the policy to the T value under mPolicyLock, and chooses a display mode
388 // that fulfills the new policy if the state changed. Returns the signals that were considered.
389 template <typename S, typename T>
390 GlobalSignals applyPolicy(S Policy::*, T&&) EXCLUDES(mPolicyLock);
391
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400392 struct DisplayModeChoice {
Ady Abrahamace3d052022-11-17 16:25:05 -0800393 DisplayModeChoice(FrameRateMode mode, GlobalSignals consideredSignals)
394 : mode(std::move(mode)), consideredSignals(consideredSignals) {}
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400395
Ady Abrahamace3d052022-11-17 16:25:05 -0800396 FrameRateMode mode;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400397 GlobalSignals consideredSignals;
398
399 bool operator==(const DisplayModeChoice& other) const {
Ady Abrahamace3d052022-11-17 16:25:05 -0800400 return mode == other.mode && consideredSignals == other.consideredSignals;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400401 }
402
403 // For tests.
404 friend std::ostream& operator<<(std::ostream& stream, const DisplayModeChoice& choice) {
Ady Abrahamace3d052022-11-17 16:25:05 -0800405 return stream << '{' << to_string(*choice.mode.modePtr) << " considering "
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400406 << choice.consideredSignals.toString().c_str() << '}';
407 }
408 };
409
Dominik Laskowski6b049ff2023-01-29 15:46:45 -0500410 using DisplayModeChoiceMap = ui::PhysicalDisplayMap<PhysicalDisplayId, DisplayModeChoice>;
Dominik Laskowski596a2562022-10-28 11:26:12 -0400411
412 // See mDisplayLock for thread safety.
413 DisplayModeChoiceMap chooseDisplayModes() const
414 REQUIRES(mPolicyLock, mDisplayLock, kMainThreadContext);
ramindani69b58e82022-09-26 16:48:36 -0700415
Dominik Laskowski95df6a12022-10-07 18:11:07 -0400416 GlobalSignals makeGlobalSignals() const REQUIRES(mPolicyLock);
ramindani69b58e82022-09-26 16:48:36 -0700417
Ady Abraham33a386b2023-07-18 15:37:11 -0700418 bool updateFrameRateOverridesLocked(GlobalSignals, Fps displayRefreshRate)
419 REQUIRES(mPolicyLock);
Ady Abraham822ecbd2023-07-07 16:16:09 -0700420 void updateAttachedChoreographers(const surfaceflinger::frontend::LayerHierarchy&,
421 Fps displayRefreshRate);
422 int updateAttachedChoreographersInternal(const surfaceflinger::frontend::LayerHierarchy&,
423 Fps displayRefreshRate, int parentDivisor);
424 void updateAttachedChoreographersFrameRate(const surfaceflinger::frontend::RequestedLayerState&,
425 Fps fps) EXCLUDES(mChoreographerLock);
Ana Krulec7ab56032018-11-02 20:51:06 +0100426
Dominik Laskowski596a2562022-10-28 11:26:12 -0400427 void dispatchCachedReportedMode() REQUIRES(mPolicyLock) EXCLUDES(mDisplayLock);
Ady Abraham62a0be22020-12-08 16:54:10 -0800428
Ady Abrahamf2851612023-09-25 17:19:00 -0700429 // IEventThreadCallback overrides
430 bool throttleVsync(TimePoint, uid_t) override;
431 Period getVsyncPeriod(uid_t) override EXCLUDES(mDisplayLock);
432 void resync() override EXCLUDES(mDisplayLock);
Leon Scroggins IIIdb16a2b2023-02-06 17:50:05 -0500433
Dominik Laskowski98041832019-08-01 18:35:59 -0700434 // Stores EventThread associated with a given VSyncSource, and an initial EventThreadConnection.
435 struct Connection {
436 sp<EventThreadConnection> connection;
437 std::unique_ptr<EventThread> thread;
438 };
Ady Abraham09bd3922019-04-08 10:44:56 -0700439
Dominik Laskowski98041832019-08-01 18:35:59 -0700440 ConnectionHandle::Id mNextConnectionHandleId = 0;
Ana Krulec6ddd2612020-09-24 13:06:33 -0700441 mutable std::mutex mConnectionsLock;
442 std::unordered_map<ConnectionHandle, Connection> mConnections GUARDED_BY(mConnectionsLock);
Ana Krulece588e312018-09-18 12:32:24 -0700443
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500444 ConnectionHandle mAppConnectionHandle;
445 ConnectionHandle mSfConnectionHandle;
446
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700447 std::atomic<nsecs_t> mLastResyncTime = 0;
Ana Krulece588e312018-09-18 12:32:24 -0700448
Dominik Laskowski068173d2021-08-11 17:22:59 -0700449 const FeatureFlags mFeatures;
Ana Krulec7ab56032018-11-02 20:51:06 +0100450
Dominik Laskowski1c99a002023-01-20 17:10:36 -0500451 // Shifts the VSYNC phase during certain transactions and refresh rate changes.
452 const sp<VsyncModulator> mVsyncModulator;
453
Dominik Laskowski49cea512019-11-12 14:13:23 -0800454 // Used to choose refresh rate if content detection is enabled.
Dominik Laskowski9c93d602021-10-07 19:38:26 -0700455 LayerHistory mLayerHistory;
Ana Krulecfb772822018-11-30 10:44:07 +0100456
Ady Abraham8532d012019-05-08 14:50:56 -0700457 // Timer used to monitor touch events.
Dominik Laskowski03cfce82022-11-02 12:13:29 -0400458 ftl::Optional<OneShotTimer> mTouchTimer;
Ady Abraham6fe2c172019-07-12 12:37:57 -0700459 // Timer used to monitor display power mode.
Dominik Laskowski03cfce82022-11-02 12:13:29 -0400460 ftl::Optional<OneShotTimer> mDisplayPowerTimer;
Ady Abraham6fe2c172019-07-12 12:37:57 -0700461
Alec Mouri1c7938e2023-09-22 04:17:23 +0000462 // Injected delay prior to compositing, for simulating jank.
463 float mPacesetterFrameDurationFractionToSkip GUARDED_BY(kMainThreadContext) = 0.f;
464
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800465 ISchedulerCallback& mSchedulerCallback;
Ana Krulecfefd6ae2019-02-13 17:53:08 -0800466
ramindanid4354a92023-10-02 15:11:09 -0700467 IVsyncTrackerCallback& mVsyncTrackerCallback;
468
Dominik Laskowski596a2562022-10-28 11:26:12 -0400469 // mDisplayLock may be locked while under mPolicyLock.
Dominik Laskowski068173d2021-08-11 17:22:59 -0700470 mutable std::mutex mPolicyLock;
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700471
Dominik Laskowski596a2562022-10-28 11:26:12 -0400472 // Only required for reads outside kMainThreadContext. kMainThreadContext is the only writer, so
473 // must lock for writes but not reads. See also mPolicyLock for locking order.
474 mutable std::mutex mDisplayLock;
475
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500476 using FrameTargeterPtr = std::unique_ptr<FrameTargeter>;
477
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500478 struct Display {
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500479 Display(PhysicalDisplayId displayId, RefreshRateSelectorPtr selectorPtr,
480 VsyncSchedulePtr schedulePtr, FeatureFlags features)
481 : displayId(displayId),
482 selectorPtr(std::move(selectorPtr)),
483 schedulePtr(std::move(schedulePtr)),
484 targeterPtr(std::make_unique<
485 FrameTargeter>(displayId,
486 features.test(Feature::kBackpressureGpuComposition))) {}
487
488 const PhysicalDisplayId displayId;
Dominik Laskowski596a2562022-10-28 11:26:12 -0400489
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500490 // Effectively const except in move constructor.
491 RefreshRateSelectorPtr selectorPtr;
492 VsyncSchedulePtr schedulePtr;
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500493 FrameTargeterPtr targeterPtr;
Dominik Laskowski66295432023-03-14 12:25:36 -0400494
495 hal::PowerMode powerMode = hal::PowerMode::OFF;
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500496 };
497
498 using DisplayRef = std::reference_wrapper<Display>;
499 using ConstDisplayRef = std::reference_wrapper<const Display>;
500
Dominik Laskowski6b049ff2023-01-29 15:46:45 -0500501 ui::PhysicalDisplayMap<PhysicalDisplayId, Display> mDisplays GUARDED_BY(mDisplayLock)
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500502 GUARDED_BY(kMainThreadContext);
Leon Scroggins III67388622023-02-06 20:36:20 -0500503
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500504 ftl::Optional<PhysicalDisplayId> mPacesetterDisplayId GUARDED_BY(mDisplayLock)
Dominik Laskowski596a2562022-10-28 11:26:12 -0400505 GUARDED_BY(kMainThreadContext);
506
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500507 ftl::Optional<DisplayRef> pacesetterDisplayLocked() REQUIRES(mDisplayLock) {
508 return static_cast<const Scheduler*>(this)->pacesetterDisplayLocked().transform(
509 [](const Display& display) { return std::ref(const_cast<Display&>(display)); });
510 }
511
512 ftl::Optional<ConstDisplayRef> pacesetterDisplayLocked() const REQUIRES(mDisplayLock) {
513 ftl::FakeGuard guard(kMainThreadContext);
514 return mPacesetterDisplayId.and_then([this](PhysicalDisplayId pacesetterId)
515 REQUIRES(mDisplayLock, kMainThreadContext) {
516 return mDisplays.get(pacesetterId);
517 });
518 }
519
Dominik Laskowskifb4b7372023-11-22 09:56:54 -0500520 // The pacesetter must exist as a precondition.
521 ftl::NonNull<const Display*> pacesetterPtrLocked() const REQUIRES(mDisplayLock) {
522 return ftl::as_non_null(&pacesetterDisplayLocked()->get());
523 }
524
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500525 RefreshRateSelectorPtr pacesetterSelectorPtr() const EXCLUDES(mDisplayLock) {
Dominik Laskowski596a2562022-10-28 11:26:12 -0400526 std::scoped_lock lock(mDisplayLock);
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500527 return pacesetterSelectorPtrLocked();
Dominik Laskowski596a2562022-10-28 11:26:12 -0400528 }
529
Leon Scroggins III1af0fb62023-03-02 14:21:44 -0500530 RefreshRateSelectorPtr pacesetterSelectorPtrLocked() const REQUIRES(mDisplayLock) {
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500531 return pacesetterDisplayLocked()
532 .transform([](const Display& display) { return display.selectorPtr; })
533 .or_else([] { return std::optional<RefreshRateSelectorPtr>(nullptr); })
Dominik Laskowski80872bd2022-11-15 11:34:33 -0500534 .value();
Dominik Laskowski596a2562022-10-28 11:26:12 -0400535 }
ramindani69b58e82022-09-26 16:48:36 -0700536
Dominik Laskowskic404cb42023-03-03 19:57:53 -0500537 ConstVsyncSchedulePtr getVsyncScheduleLocked(
538 std::optional<PhysicalDisplayId> = std::nullopt) const REQUIRES(mDisplayLock);
539
540 VsyncSchedulePtr getVsyncScheduleLocked(std::optional<PhysicalDisplayId> idOpt = std::nullopt)
541 REQUIRES(mDisplayLock) {
Leon Scroggins III67388622023-02-06 20:36:20 -0500542 return std::const_pointer_cast<VsyncSchedule>(
543 static_cast<const Scheduler*>(this)->getVsyncScheduleLocked(idOpt));
544 }
545
Dominik Laskowski0c41ffa2021-12-24 16:45:12 -0800546 struct Policy {
Dominik Laskowski068173d2021-08-11 17:22:59 -0700547 // Policy for choosing the display mode.
548 LayerHistory::Summary contentRequirements;
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700549 TimerState idleTimer = TimerState::Reset;
550 TouchState touch = TouchState::Inactive;
551 TimerState displayPowerTimer = TimerState::Expired;
Rachel Lee6a9731d2022-06-06 17:08:14 -0700552 hal::PowerMode displayPowerMode = hal::PowerMode::ON;
Ady Abrahamdfd62162020-06-10 16:11:56 -0700553
Dominik Laskowski068173d2021-08-11 17:22:59 -0700554 // Chosen display mode.
Ady Abrahamace3d052022-11-17 16:25:05 -0800555 ftl::Optional<FrameRateMode> modeOpt;
Dominik Laskowski068173d2021-08-11 17:22:59 -0700556
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100557 struct ModeChangedParams {
Ady Abrahamdfd62162020-06-10 16:11:56 -0700558 ConnectionHandle handle;
Ady Abrahamace3d052022-11-17 16:25:05 -0800559 FrameRateMode mode;
Ady Abrahamdfd62162020-06-10 16:11:56 -0700560 };
561
Dominik Laskowski068173d2021-08-11 17:22:59 -0700562 // Parameters for latest dispatch of mode change event.
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100563 std::optional<ModeChangedParams> cachedModeChangedParams;
Dominik Laskowski068173d2021-08-11 17:22:59 -0700564 } mPolicy GUARDED_BY(mPolicyLock);
Ady Abraham09bd3922019-04-08 10:44:56 -0700565
Ady Abraham822ecbd2023-07-07 16:16:09 -0700566 std::mutex mChoreographerLock;
567
568 struct AttachedChoreographers {
569 Fps frameRate;
570 std::unordered_set<wp<EventThreadConnection>, WpHash> connections;
571 };
572 // Map keyed by layer ID (sequence) to choreographer connections.
573 std::unordered_map<int32_t, AttachedChoreographers> mAttachedChoreographers
574 GUARDED_BY(mChoreographerLock);
575
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800576 std::mutex mVsyncTimelineLock;
Peiyong Line9d809e2020-04-14 13:10:48 -0700577 std::optional<hal::VsyncPeriodChangeTimeline> mLastVsyncPeriodChangeTimeline
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800578 GUARDED_BY(mVsyncTimelineLock);
579 static constexpr std::chrono::nanoseconds MAX_VSYNC_APPLIED_TIME = 200ms;
Ady Abraham8735eac2020-08-12 16:35:04 -0700580
Andy Yu2ae6b6b2021-11-18 14:51:06 -0800581 FrameRateOverrideMappings mFrameRateOverrideMappings;
Tony Huang9ac5e6e2023-08-24 09:01:44 +0000582 SmallAreaDetectionAllowMappings mSmallAreaDetectionAllowMappings;
Ana Krulec98b5b242018-08-10 15:03:23 -0700583};
584
Dominik Laskowski068173d2021-08-11 17:22:59 -0700585} // namespace scheduler
Ana Krulec7ab56032018-11-02 20:51:06 +0100586} // namespace android