blob: 04a83906b19ff32e1781f087f10273bcdede486d [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>
Kevin DuBois413287f2019-02-25 08:46:47 -080020#include <functional>
Ana Krulec98b5b242018-08-10 15:03:23 -070021#include <memory>
Dominik Laskowski98041832019-08-01 18:35:59 -070022#include <mutex>
23#include <optional>
24#include <unordered_map>
Ana Krulec98b5b242018-08-10 15:03:23 -070025
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -080026#include <ui/GraphicTypes.h>
Ana Krulec98b5b242018-08-10 15:03:23 -070027
Ana Krulece588e312018-09-18 12:32:24 -070028#include "EventControlThread.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070029#include "EventThread.h"
Ana Krulec3084c052018-11-21 20:27:17 +010030#include "LayerHistory.h"
Ana Krulecf2c006d2019-06-21 15:37:07 -070031#include "OneShotTimer.h"
Ana Krulec8d3e4f32019-03-05 10:40:33 -080032#include "RefreshRateConfigs.h"
Ana Krulec434c22d2018-11-28 13:48:36 +010033#include "SchedulerUtils.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070034
35namespace android {
36
Ady Abraham2139f732019-11-13 18:56:40 -080037using namespace std::chrono_literals;
38
Dominik Laskowski98041832019-08-01 18:35:59 -070039class DispSync;
40class FenceTime;
Dominik Laskowski6505f792019-09-18 11:10:05 -070041class InjectVSyncSource;
Dominik Laskowski98041832019-08-01 18:35:59 -070042struct DisplayStateInfo;
Ana Krulece588e312018-09-18 12:32:24 -070043
Ana Krulec98b5b242018-08-10 15:03:23 -070044class Scheduler {
45public:
Ady Abraham2139f732019-11-13 18:56:40 -080046 using RefreshRate = scheduler::RefreshRateConfigs::RefreshRate;
Dominik Laskowski98041832019-08-01 18:35:59 -070047 using ConfigEvent = scheduler::RefreshRateConfigEvent;
48
Ady Abraham2139f732019-11-13 18:56:40 -080049 class ISchedulerCallback {
50 public:
51 virtual ~ISchedulerCallback() = default;
52 virtual void changeRefreshRate(const RefreshRate&, ConfigEvent) = 0;
53 };
Ana Krulec7d1d6832018-12-27 11:10:09 -080054
Dominik Laskowski98041832019-08-01 18:35:59 -070055 // Indicates whether to start the transaction early, or at vsync time.
Ana Krulec7ecce8c2018-10-12 13:44:41 -070056 enum class TransactionStart { EARLY, NORMAL };
57
Dominik Laskowski98041832019-08-01 18:35:59 -070058 Scheduler(impl::EventControlThread::SetVSyncEnabledFunction,
59 const scheduler::RefreshRateConfigs&);
Ana Krulece588e312018-09-18 12:32:24 -070060
Ana Krulec0c8cd522018-08-31 12:27:28 -070061 virtual ~Scheduler();
Ana Krulec98b5b242018-08-10 15:03:23 -070062
Dominik Laskowski98041832019-08-01 18:35:59 -070063 DispSync& getPrimaryDispSync();
Ana Krulece588e312018-09-18 12:32:24 -070064
Dominik Laskowski98041832019-08-01 18:35:59 -070065 using ConnectionHandle = scheduler::ConnectionHandle;
66 ConnectionHandle createConnection(const char* connectionName, nsecs_t phaseOffsetNs,
Steven Thomas2bbaabe2019-08-28 16:08:35 -070067 nsecs_t offsetThresholdForNextVsync,
Dominik Laskowski98041832019-08-01 18:35:59 -070068 impl::EventThread::InterceptVSyncsCallback);
Ana Krulec98b5b242018-08-10 15:03:23 -070069
Steven Thomas2bbaabe2019-08-28 16:08:35 -070070 sp<IDisplayEventConnection> createDisplayEventConnection(ConnectionHandle,
Dominik Laskowski98041832019-08-01 18:35:59 -070071 ISurfaceComposer::ConfigChanged);
Ana Krulece588e312018-09-18 12:32:24 -070072
Dominik Laskowski98041832019-08-01 18:35:59 -070073 sp<EventThreadConnection> getEventConnection(ConnectionHandle);
Kevin DuBois413287f2019-02-25 08:46:47 -080074
Dominik Laskowski98041832019-08-01 18:35:59 -070075 void onHotplugReceived(ConnectionHandle, PhysicalDisplayId, bool connected);
Ady Abraham2139f732019-11-13 18:56:40 -080076 void onConfigChanged(ConnectionHandle, PhysicalDisplayId, HwcConfigIndexType configId);
Ana Krulec98b5b242018-08-10 15:03:23 -070077
Dominik Laskowski98041832019-08-01 18:35:59 -070078 void onScreenAcquired(ConnectionHandle);
79 void onScreenReleased(ConnectionHandle);
Ana Krulece588e312018-09-18 12:32:24 -070080
Dominik Laskowski98041832019-08-01 18:35:59 -070081 // Modifies phase offset in the event thread.
82 void setPhaseOffset(ConnectionHandle, nsecs_t phaseOffset);
Ana Krulec98b5b242018-08-10 15:03:23 -070083
Ana Krulece588e312018-09-18 12:32:24 -070084 void getDisplayStatInfo(DisplayStatInfo* stats);
85
Dominik Laskowski6505f792019-09-18 11:10:05 -070086 // Returns injector handle if injection has toggled, or an invalid handle otherwise.
87 ConnectionHandle enableVSyncInjection(bool enable);
88
89 // Returns false if injection is disabled.
90 bool injectVSync(nsecs_t when);
91
Ana Krulece588e312018-09-18 12:32:24 -070092 void enableHardwareVsync();
93 void disableHardwareVsync(bool makeUnavailable);
Dominik Laskowski98041832019-08-01 18:35:59 -070094
Alec Mourif8e689c2019-05-20 18:32:22 -070095 // Resyncs the scheduler to hardware vsync.
96 // If makeAvailable is true, then hardware vsync will be turned on.
97 // Otherwise, if hardware vsync is not already enabled then this method will
98 // no-op.
99 // The period is the vsync period from the current display configuration.
Ana Krulecc2870422019-01-29 19:00:58 -0800100 void resyncToHardwareVsync(bool makeAvailable, nsecs_t period);
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700101 void resync();
Dominik Laskowski98041832019-08-01 18:35:59 -0700102
Alec Mourif8e689c2019-05-20 18:32:22 -0700103 // Passes a vsync sample to DispSync. periodFlushed will be true if
104 // DispSync detected that the vsync period changed, and false otherwise.
Dominik Laskowski98041832019-08-01 18:35:59 -0700105 void addResyncSample(nsecs_t timestamp, bool* periodFlushed);
106 void addPresentFence(const std::shared_ptr<FenceTime>&);
Ana Krulece588e312018-09-18 12:32:24 -0700107 void setIgnorePresentFences(bool ignore);
Ady Abraham8fe11022019-06-12 17:11:12 -0700108 nsecs_t getDispSyncExpectedPresentTime();
Ady Abraham8f1ee7f2019-04-05 10:32:50 -0700109
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700110 // Layers are registered on creation, and unregistered when the weak reference expires.
111 void registerLayer(Layer*);
Ady Abraham2139f732019-11-13 18:56:40 -0800112 void recordLayerHistory(Layer*, nsecs_t presentTime);
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700113
Dominik Laskowski49cea512019-11-12 14:13:23 -0800114 // Detects content using layer history, and selects a matching refresh rate.
115 void chooseRefreshRateForContent();
Ady Abraham97d04232019-03-05 19:48:12 -0800116
Ady Abraham2139f732019-11-13 18:56:40 -0800117 // Called by Scheduler to control SurfaceFlinger operations.
118 void setSchedulerCallback(ISchedulerCallback*);
Ady Abraham09bd3922019-04-08 10:44:56 -0700119
Dominik Laskowski98041832019-08-01 18:35:59 -0700120 bool isIdleTimerEnabled() const { return mIdleTimer.has_value(); }
Ady Abraham8532d012019-05-08 14:50:56 -0700121 void resetIdleTimer();
122
123 // Function that resets the touch timer.
124 void notifyTouchEvent();
125
Ady Abraham6fe2c172019-07-12 12:37:57 -0700126 void setDisplayPowerState(bool normal);
127
Dominik Laskowski98041832019-08-01 18:35:59 -0700128 void dump(std::string&) const;
129 void dump(ConnectionHandle, std::string&) const;
Ana Krulec0c8cd522018-08-31 12:27:28 -0700130
Ady Abraham2139f732019-11-13 18:56:40 -0800131 // Get the appropriate refresh for current conditions.
132 std::optional<HwcConfigIndexType> getPreferredConfigId();
Daniel Solomon0f0ddc12019-08-19 19:31:09 -0700133
Ana Krulec98b5b242018-08-10 15:03:23 -0700134private:
Ana Krulecafb45842019-02-13 13:33:03 -0800135 friend class TestableScheduler;
136
Ana Krulecfefd6ae2019-02-13 17:53:08 -0800137 // In order to make sure that the features don't override themselves, we need a state machine
138 // to keep track which feature requested the config change.
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700139 enum class ContentDetectionState { Off, On };
140 enum class TimerState { Reset, Expired };
141 enum class TouchState { Inactive, Active };
Ana Krulecfefd6ae2019-02-13 17:53:08 -0800142
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700143 // Used by tests to inject mocks.
144 Scheduler(std::unique_ptr<DispSync>, std::unique_ptr<EventControlThread>,
145 const scheduler::RefreshRateConfigs&);
146
Dominik Laskowski6505f792019-09-18 11:10:05 -0700147 std::unique_ptr<VSyncSource> makePrimaryDispSyncSource(const char* name, nsecs_t phaseOffsetNs,
148 nsecs_t offsetThresholdForNextVsync);
Dominik Laskowski98041832019-08-01 18:35:59 -0700149
Dominik Laskowski6505f792019-09-18 11:10:05 -0700150 // Create a connection on the given EventThread.
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700151 ConnectionHandle createConnection(std::unique_ptr<EventThread>);
152 sp<EventThreadConnection> createConnectionInternal(EventThread*,
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700153 ISurfaceComposer::ConfigChanged);
Dominik Laskowskiccf37d72019-02-01 16:47:58 -0800154
Dominik Laskowski3a80a382019-07-25 11:16:07 -0700155 // Update feature state machine to given state when corresponding timer resets or expires.
156 void kernelIdleTimerCallback(TimerState);
157 void idleTimerCallback(TimerState);
158 void touchTimerCallback(TimerState);
159 void displayPowerTimerCallback(TimerState);
160
Ady Abraham6fe2c172019-07-12 12:37:57 -0700161 // handles various timer features to change the refresh rate.
162 template <class T>
163 void handleTimerStateChanged(T* currentState, T newState, bool eventOnContentDetection);
Dominik Laskowski98041832019-08-01 18:35:59 -0700164
165 void setVsyncPeriod(nsecs_t period);
166
Ady Abraham2139f732019-11-13 18:56:40 -0800167 HwcConfigIndexType calculateRefreshRateType() REQUIRES(mFeatureStateLock);
Dominik Laskowski98041832019-08-01 18:35:59 -0700168 // Acquires a lock and calls the ChangeRefreshRateCallback with given parameters.
Ady Abraham2139f732019-11-13 18:56:40 -0800169 void changeRefreshRate(const RefreshRate&, ConfigEvent);
Ana Krulec7ab56032018-11-02 20:51:06 +0100170
Dominik Laskowski98041832019-08-01 18:35:59 -0700171 // Stores EventThread associated with a given VSyncSource, and an initial EventThreadConnection.
172 struct Connection {
173 sp<EventThreadConnection> connection;
174 std::unique_ptr<EventThread> thread;
175 };
Ady Abraham09bd3922019-04-08 10:44:56 -0700176
Dominik Laskowski98041832019-08-01 18:35:59 -0700177 ConnectionHandle::Id mNextConnectionHandleId = 0;
178 std::unordered_map<ConnectionHandle, Connection> mConnections;
Ana Krulece588e312018-09-18 12:32:24 -0700179
Dominik Laskowski6505f792019-09-18 11:10:05 -0700180 bool mInjectVSyncs = false;
181 InjectVSyncSource* mVSyncInjector = nullptr;
182 ConnectionHandle mInjectorConnectionHandle;
183
Ana Krulece588e312018-09-18 12:32:24 -0700184 std::mutex mHWVsyncLock;
Dominik Laskowski98041832019-08-01 18:35:59 -0700185 bool mPrimaryHWVsyncEnabled GUARDED_BY(mHWVsyncLock) = false;
186 bool mHWVsyncAvailable GUARDED_BY(mHWVsyncLock) = false;
187
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700188 std::atomic<nsecs_t> mLastResyncTime = 0;
Ana Krulece588e312018-09-18 12:32:24 -0700189
190 std::unique_ptr<DispSync> mPrimaryDispSync;
191 std::unique_ptr<EventControlThread> mEventControlThread;
Ana Krulec7ab56032018-11-02 20:51:06 +0100192
Dominik Laskowski49cea512019-11-12 14:13:23 -0800193 // Used to choose refresh rate if content detection is enabled.
194 std::optional<scheduler::LayerHistory> mLayerHistory;
Ana Krulecfb772822018-11-30 10:44:07 +0100195
Dominik Laskowski98041832019-08-01 18:35:59 -0700196 // Whether to use idle timer callbacks that support the kernel timer.
197 const bool mSupportKernelTimer;
Ana Krulec7d1d6832018-12-27 11:10:09 -0800198
Dominik Laskowski98041832019-08-01 18:35:59 -0700199 // Timer that records time between requests for next vsync.
200 std::optional<scheduler::OneShotTimer> mIdleTimer;
Ady Abraham8532d012019-05-08 14:50:56 -0700201 // Timer used to monitor touch events.
Dominik Laskowski98041832019-08-01 18:35:59 -0700202 std::optional<scheduler::OneShotTimer> mTouchTimer;
Ady Abraham6fe2c172019-07-12 12:37:57 -0700203 // Timer used to monitor display power mode.
Dominik Laskowski98041832019-08-01 18:35:59 -0700204 std::optional<scheduler::OneShotTimer> mDisplayPowerTimer;
Ady Abraham6fe2c172019-07-12 12:37:57 -0700205
Ana Krulec7d1d6832018-12-27 11:10:09 -0800206 std::mutex mCallbackLock;
Ady Abraham2139f732019-11-13 18:56:40 -0800207 ISchedulerCallback* mSchedulerCallback GUARDED_BY(mCallbackLock) = nullptr;
Ana Krulecfefd6ae2019-02-13 17:53:08 -0800208
209 // In order to make sure that the features don't override themselves, we need a state machine
210 // to keep track which feature requested the config change.
211 std::mutex mFeatureStateLock;
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700212
213 struct {
214 ContentDetectionState contentDetection = ContentDetectionState::Off;
215 TimerState idleTimer = TimerState::Reset;
216 TouchState touch = TouchState::Inactive;
217 TimerState displayPowerTimer = TimerState::Expired;
218
Ady Abraham2139f732019-11-13 18:56:40 -0800219 std::optional<HwcConfigIndexType> configId;
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700220 uint32_t contentRefreshRate = 0;
221
Dominik Laskowskidd252cd2019-07-26 09:10:16 -0700222 bool isDisplayPowerStateNormal = true;
223 } mFeatures GUARDED_BY(mFeatureStateLock);
Ady Abraham09bd3922019-04-08 10:44:56 -0700224
225 const scheduler::RefreshRateConfigs& mRefreshRateConfigs;
Ana Krulec98b5b242018-08-10 15:03:23 -0700226};
227
Ana Krulec7ab56032018-11-02 20:51:06 +0100228} // namespace android