blob: 64838cab7dc062758ccffb264c9e16a8dd7dbd94 [file] [log] [blame]
Lloyd Piquef58625d2017-12-19 13:22:33 -08001/*
2 * Copyright (C) 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
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080019#include <compositionengine/Display.h>
Lloyd Pique9755fb72019-03-26 14:44:40 -070020#include <compositionengine/LayerFECompositionState.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080021#include <compositionengine/OutputLayer.h>
Lloyd Pique70d91362018-10-18 16:02:55 -070022#include <compositionengine/impl/CompositionEngine.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080023#include <compositionengine/impl/OutputLayerCompositionState.h>
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -070024#include <compositionengine/mock/DisplaySurface.h>
Lloyd Pique70d91362018-10-18 16:02:55 -070025
Lloyd Pique90c115d2018-09-18 21:39:42 -070026#include "BufferQueueLayer.h"
27#include "BufferStateLayer.h"
28#include "ColorLayer.h"
29#include "ContainerLayer.h"
Lloyd Piquef58625d2017-12-19 13:22:33 -080030#include "DisplayDevice.h"
Ana Krulec757f63a2019-01-25 10:46:18 -080031#include "FakePhaseOffsets.h"
Lloyd Piqued6b579f2018-04-06 15:29:10 -070032#include "Layer.h"
Lloyd Pique90c115d2018-09-18 21:39:42 -070033#include "NativeWindowSurface.h"
Dominik Laskowski9dab3432019-03-27 13:21:10 -070034#include "Scheduler/MessageQueue.h"
Steven Thomas2bbaabe2019-08-28 16:08:35 -070035#include "Scheduler/RefreshRateConfigs.h"
Lloyd Pique90c115d2018-09-18 21:39:42 -070036#include "StartPropertySetThread.h"
Lloyd Piquef58625d2017-12-19 13:22:33 -080037#include "SurfaceFlinger.h"
Lloyd Pique24f3bfe2019-10-02 19:29:10 -070038#include "SurfaceFlingerDefaultFactory.h"
Lloyd Pique90c115d2018-09-18 21:39:42 -070039#include "SurfaceInterceptor.h"
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -070040#include "TestableScheduler.h"
Yiwei Zhang7e666a52018-11-15 13:33:42 -080041
Lloyd Piquef58625d2017-12-19 13:22:33 -080042namespace android {
43
Lloyd Piquee39cad22017-12-20 17:01:29 -080044class EventThread;
45
Peiyong Lin833074a2018-08-28 11:53:54 -070046namespace renderengine {
Lloyd Pique90c115d2018-09-18 21:39:42 -070047
Lloyd Piquee39cad22017-12-20 17:01:29 -080048class RenderEngine;
Lloyd Pique90c115d2018-09-18 21:39:42 -070049
50} // namespace renderengine
Lloyd Piquee39cad22017-12-20 17:01:29 -080051
52namespace Hwc2 {
Lloyd Pique90c115d2018-09-18 21:39:42 -070053
Lloyd Piquee39cad22017-12-20 17:01:29 -080054class Composer;
Lloyd Pique90c115d2018-09-18 21:39:42 -070055
56} // namespace Hwc2
57
58namespace surfaceflinger::test {
59
60class Factory final : public surfaceflinger::Factory {
61public:
62 ~Factory() = default;
63
Dominik Laskowski98041832019-08-01 18:35:59 -070064 std::unique_ptr<DispSync> createDispSync(const char*, bool) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070065 return nullptr;
66 }
67
68 std::unique_ptr<EventControlThread> createEventControlThread(
69 std::function<void(bool)>) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070070 return nullptr;
71 }
72
73 std::unique_ptr<HWComposer> createHWComposer(const std::string&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070074 return nullptr;
75 }
76
77 std::unique_ptr<MessageQueue> createMessageQueue() override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070078 return std::make_unique<android::impl::MessageQueue>();
79 }
80
Ady Abraham9e16a482019-12-03 17:19:41 -080081 std::unique_ptr<scheduler::PhaseConfiguration> createPhaseConfiguration(
82 const scheduler::RefreshRateConfigs& /*refreshRateConfigs*/) override {
Ana Krulec757f63a2019-01-25 10:46:18 -080083 return std::make_unique<scheduler::FakePhaseOffsets>();
84 }
85
Ady Abraham09bd3922019-04-08 10:44:56 -070086 std::unique_ptr<Scheduler> createScheduler(std::function<void(bool)>,
Ady Abraham3a77a7b2019-12-02 18:46:59 -080087 const scheduler::RefreshRateConfigs&,
88 ISchedulerCallback&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070089 return nullptr;
90 }
91
92 std::unique_ptr<SurfaceInterceptor> createSurfaceInterceptor(SurfaceFlinger* flinger) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070093 return std::make_unique<android::impl::SurfaceInterceptor>(flinger);
94 }
95
96 sp<StartPropertySetThread> createStartPropertySetThread(bool timestampPropertyValue) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070097 return new StartPropertySetThread(timestampPropertyValue);
98 }
99
100 sp<DisplayDevice> createDisplayDevice(DisplayDeviceCreationArgs&& creationArgs) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700101 return new DisplayDevice(std::move(creationArgs));
102 }
103
104 sp<GraphicBuffer> createGraphicBuffer(uint32_t width, uint32_t height, PixelFormat format,
105 uint32_t layerCount, uint64_t usage,
106 std::string requestorName) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700107 return new GraphicBuffer(width, height, format, layerCount, usage, requestorName);
108 }
109
110 void createBufferQueue(sp<IGraphicBufferProducer>* outProducer,
111 sp<IGraphicBufferConsumer>* outConsumer,
112 bool consumerIsSurfaceFlinger) override {
Lloyd Piquee300b312019-10-03 13:03:45 -0700113 if (!mCreateBufferQueue) {
114 BufferQueue::createBufferQueue(outProducer, outConsumer, consumerIsSurfaceFlinger);
115 return;
116 }
Lloyd Pique90c115d2018-09-18 21:39:42 -0700117 mCreateBufferQueue(outProducer, outConsumer, consumerIsSurfaceFlinger);
118 }
119
Lloyd Piquee300b312019-10-03 13:03:45 -0700120 sp<IGraphicBufferProducer> createMonitoredProducer(const sp<IGraphicBufferProducer>& producer,
121 const sp<SurfaceFlinger>& flinger,
122 const wp<Layer>& layer) override {
123 return new MonitoredProducer(producer, flinger, layer);
124 }
125
126 sp<BufferLayerConsumer> createBufferLayerConsumer(const sp<IGraphicBufferConsumer>& consumer,
127 renderengine::RenderEngine& renderEngine,
128 uint32_t textureName, Layer* layer) override {
129 return new BufferLayerConsumer(consumer, renderEngine, textureName, layer);
130 }
131
Lloyd Pique90c115d2018-09-18 21:39:42 -0700132 std::unique_ptr<surfaceflinger::NativeWindowSurface> createNativeWindowSurface(
133 const sp<IGraphicBufferProducer>& producer) override {
134 if (!mCreateNativeWindowSurface) return nullptr;
135 return mCreateNativeWindowSurface(producer);
136 }
137
Lloyd Pique70d91362018-10-18 16:02:55 -0700138 std::unique_ptr<compositionengine::CompositionEngine> createCompositionEngine() override {
139 return compositionengine::impl::createCompositionEngine();
140 }
141
Lloyd Pique90c115d2018-09-18 21:39:42 -0700142 sp<BufferQueueLayer> createBufferQueueLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700143 return nullptr;
144 }
145
146 sp<BufferStateLayer> createBufferStateLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700147 return nullptr;
148 }
149
150 sp<ColorLayer> createColorLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700151 return nullptr;
152 }
153
154 sp<ContainerLayer> createContainerLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700155 return nullptr;
156 }
157
158 using CreateBufferQueueFunction =
159 std::function<void(sp<IGraphicBufferProducer>* /* outProducer */,
160 sp<IGraphicBufferConsumer>* /* outConsumer */,
161 bool /* consumerIsSurfaceFlinger */)>;
162 CreateBufferQueueFunction mCreateBufferQueue;
163
164 using CreateNativeWindowSurfaceFunction =
165 std::function<std::unique_ptr<surfaceflinger::NativeWindowSurface>(
166 const sp<IGraphicBufferProducer>&)>;
167 CreateNativeWindowSurfaceFunction mCreateNativeWindowSurface;
Lloyd Pique70d91362018-10-18 16:02:55 -0700168
169 using CreateCompositionEngineFunction =
170 std::function<std::unique_ptr<compositionengine::CompositionEngine>()>;
171 CreateCompositionEngineFunction mCreateCompositionEngine;
Lloyd Pique90c115d2018-09-18 21:39:42 -0700172};
173
174} // namespace surfaceflinger::test
Lloyd Piquee39cad22017-12-20 17:01:29 -0800175
Lloyd Piquef58625d2017-12-19 13:22:33 -0800176class TestableSurfaceFlinger {
177public:
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700178 SurfaceFlinger* flinger() { return mFlinger.get(); }
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700179 TestableScheduler* scheduler() { return mScheduler; }
180
Lloyd Piquef58625d2017-12-19 13:22:33 -0800181 // Extend this as needed for accessing SurfaceFlinger private (and public)
182 // functions.
183
Peiyong Lin833074a2018-08-28 11:53:54 -0700184 void setupRenderEngine(std::unique_ptr<renderengine::RenderEngine> renderEngine) {
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700185 mFlinger->mCompositionEngine->setRenderEngine(std::move(renderEngine));
Lloyd Piquee39cad22017-12-20 17:01:29 -0800186 }
187
188 void setupComposer(std::unique_ptr<Hwc2::Composer> composer) {
Lloyd Pique441d5042018-10-18 16:49:51 -0700189 mFlinger->mCompositionEngine->setHwComposer(
190 std::make_unique<impl::HWComposer>(std::move(composer)));
Lloyd Piquee39cad22017-12-20 17:01:29 -0800191 }
192
Alec Mourie4034bb2019-11-19 12:45:54 -0800193 void setupTimeStats(const std::shared_ptr<TimeStats>& timeStats) {
194 mFlinger->mCompositionEngine->setTimeStats(timeStats);
195 }
196
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700197 void setupScheduler(std::unique_ptr<DispSync> primaryDispSync,
198 std::unique_ptr<EventControlThread> eventControlThread,
199 std::unique_ptr<EventThread> appEventThread,
Ady Abraham8a82ba62020-01-17 12:43:17 -0800200 std::unique_ptr<EventThread> sfEventThread,
201 bool useContentDetectionV2 = false) {
Ady Abraham2139f732019-11-13 18:56:40 -0800202 std::vector<scheduler::RefreshRateConfigs::InputConfig> configs{
203 {{HwcConfigIndexType(0), HwcConfigGroupType(0), 16666667}}};
204 mFlinger->mRefreshRateConfigs = std::make_unique<
205 scheduler::RefreshRateConfigs>(/*refreshRateSwitching=*/false, configs,
206 /*currentConfig=*/HwcConfigIndexType(0));
207 mFlinger->mRefreshRateStats = std::make_unique<
208 scheduler::RefreshRateStats>(*mFlinger->mRefreshRateConfigs, *mFlinger->mTimeStats,
209 /*currentConfig=*/HwcConfigIndexType(0),
210 /*powerMode=*/HWC_POWER_MODE_OFF);
Ady Abraham9e16a482019-12-03 17:19:41 -0800211 mFlinger->mPhaseConfiguration =
212 mFactory.createPhaseConfiguration(*mFlinger->mRefreshRateConfigs);
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700213
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700214 mScheduler =
215 new TestableScheduler(std::move(primaryDispSync), std::move(eventControlThread),
Ady Abraham8a82ba62020-01-17 12:43:17 -0800216 *mFlinger->mRefreshRateConfigs, useContentDetectionV2);
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700217
Dominik Laskowski98041832019-08-01 18:35:59 -0700218 mFlinger->mAppConnectionHandle = mScheduler->createConnection(std::move(appEventThread));
219 mFlinger->mSfConnectionHandle = mScheduler->createConnection(std::move(sfEventThread));
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700220 resetScheduler(mScheduler);
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700221
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700222 mFlinger->mVSyncModulator.emplace(*mScheduler, mFlinger->mAppConnectionHandle,
223 mFlinger->mSfConnectionHandle,
Ady Abraham9e16a482019-12-03 17:19:41 -0800224 mFlinger->mPhaseConfiguration->getCurrentOffsets());
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700225 }
226
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700227 void resetScheduler(Scheduler* scheduler) { mFlinger->mScheduler.reset(scheduler); }
228
Lloyd Pique90c115d2018-09-18 21:39:42 -0700229 using CreateBufferQueueFunction = surfaceflinger::test::Factory::CreateBufferQueueFunction;
Lloyd Pique5b36f3f2018-01-17 11:57:07 -0800230 void setCreateBufferQueueFunction(CreateBufferQueueFunction f) {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700231 mFactory.mCreateBufferQueue = f;
Lloyd Pique5b36f3f2018-01-17 11:57:07 -0800232 }
233
Lloyd Pique90c115d2018-09-18 21:39:42 -0700234 using CreateNativeWindowSurfaceFunction =
235 surfaceflinger::test::Factory::CreateNativeWindowSurfaceFunction;
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800236 void setCreateNativeWindowSurface(CreateNativeWindowSurfaceFunction f) {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700237 mFactory.mCreateNativeWindowSurface = f;
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800238 }
239
Daniel Solomon42d04562019-01-20 21:03:19 -0800240 void setInternalDisplayPrimaries(const ui::DisplayPrimaries& primaries) {
241 memcpy(&mFlinger->mInternalDisplayPrimaries, &primaries, sizeof(ui::DisplayPrimaries));
242 }
243
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800244 using HotplugEvent = SurfaceFlinger::HotplugEvent;
245
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800246 auto& mutableLayerCurrentState(sp<Layer> layer) { return layer->mCurrentState; }
247 auto& mutableLayerDrawingState(sp<Layer> layer) { return layer->mDrawingState; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700248
Valerie Haud251afb2019-03-29 14:19:02 -0700249 auto& mutableStateLock() { return mFlinger->mStateLock; }
250
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700251 void setLayerSidebandStream(sp<Layer> layer, sp<NativeHandle> sidebandStream) {
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800252 layer->mDrawingState.sidebandStream = sidebandStream;
Lloyd Pique0b785d82018-12-04 17:25:27 -0800253 layer->mSidebandStream = sidebandStream;
Lloyd Piquede196652020-01-22 17:29:58 -0800254 layer->editCompositionState()->sidebandStream = sidebandStream;
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700255 }
256
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800257 void setLayerCompositionType(sp<Layer> layer, HWC2::Composition type) {
258 auto outputLayer = layer->findOutputLayerForDisplay(mFlinger->getDefaultDisplayDevice());
259 LOG_ALWAYS_FATAL_IF(!outputLayer);
260 auto& state = outputLayer->editState();
261 LOG_ALWAYS_FATAL_IF(!outputLayer->getState().hwc);
262 (*state.hwc).hwcCompositionType = static_cast<Hwc2::IComposerClient::Composition>(type);
263 };
264
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700265 void setLayerPotentialCursor(sp<Layer> layer, bool potentialCursor) {
266 layer->mPotentialCursor = potentialCursor;
267 }
268
Lloyd Piquef58625d2017-12-19 13:22:33 -0800269 /* ------------------------------------------------------------------------
270 * Forwarding for functions being tested
271 */
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800272
Lloyd Piquea482f992018-01-22 19:00:34 -0800273 auto createDisplay(const String8& displayName, bool secure) {
274 return mFlinger->createDisplay(displayName, secure);
275 }
276
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700277 auto destroyDisplay(const sp<IBinder>& displayToken) {
278 return mFlinger->destroyDisplay(displayToken);
279 }
Lloyd Piquea482f992018-01-22 19:00:34 -0800280
Lloyd Piqued6fbb8a2018-01-22 19:08:36 -0800281 auto resetDisplayState() { return mFlinger->resetDisplayState(); }
282
Dominik Laskowski075d3172018-05-24 15:50:06 -0700283 auto setupNewDisplayDeviceInternal(const wp<IBinder>& displayToken,
284 const std::optional<DisplayId>& displayId,
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800285 const DisplayDeviceState& state,
Lloyd Pique542307f2018-10-19 13:24:08 -0700286 const sp<compositionengine::DisplaySurface>& dispSurface,
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800287 const sp<IGraphicBufferProducer>& producer) {
Dominik Laskowski7e045462018-05-30 13:02:02 -0700288 return mFlinger->setupNewDisplayDeviceInternal(displayToken, displayId, state, dispSurface,
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800289 producer);
290 }
291
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800292 auto handleTransactionLocked(uint32_t transactionFlags) {
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800293 Mutex::Autolock _l(mFlinger->mStateLock);
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800294 return mFlinger->handleTransactionLocked(transactionFlags);
295 }
Lloyd Piquef58625d2017-12-19 13:22:33 -0800296
Lloyd Pique6cf11032018-01-22 18:57:44 -0800297 auto onHotplugReceived(int32_t sequenceId, hwc2_display_t display,
298 HWC2::Connection connection) {
299 return mFlinger->onHotplugReceived(sequenceId, display, connection);
300 }
301
Vishnu Nairce5d0cc2019-02-28 14:38:41 -0800302 auto setDisplayStateLocked(const DisplayState& s) {
303 Mutex::Autolock _l(mFlinger->mStateLock);
304 return mFlinger->setDisplayStateLocked(s);
305 }
Lloyd Pique9d9cf402018-02-16 17:47:13 -0800306
Dominik Laskowski83b88212018-12-11 13:34:06 -0800307 // Allow reading display state without locking, as if called on the SF main thread.
308 auto onInitializeDisplays() NO_THREAD_SAFETY_ANALYSIS {
309 return mFlinger->onInitializeDisplays();
310 }
Lloyd Pique86016da2018-03-01 16:09:38 -0800311
Dominik Laskowski83b88212018-12-11 13:34:06 -0800312 // Allow reading display state without locking, as if called on the SF main thread.
313 auto setPowerModeInternal(const sp<DisplayDevice>& display,
314 int mode) NO_THREAD_SAFETY_ANALYSIS {
Dominik Laskowskie9774092018-12-11 10:04:24 -0800315 return mFlinger->setPowerModeInternal(display, mode);
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800316 }
317
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700318 auto onMessageReceived(int32_t what) { return mFlinger->onMessageReceived(what); }
319
Robert Carr108b2c72019-04-02 16:32:58 -0700320 auto captureScreenImplLocked(
321 const RenderArea& renderArea, SurfaceFlinger::TraverseLayersFunction traverseLayers,
322 ANativeWindowBuffer* buffer, bool useIdentityTransform, bool forSystem, int* outSyncFd) {
323 bool ignored;
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700324 return mFlinger->captureScreenImplLocked(renderArea, traverseLayers, buffer,
Robert Carr108b2c72019-04-02 16:32:58 -0700325 useIdentityTransform, forSystem, outSyncFd,
326 ignored);
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700327 }
328
chaviw0e3479f2018-09-10 16:49:30 -0700329 auto traverseLayersInDisplay(const sp<const DisplayDevice>& display,
330 const LayerVector::Visitor& visitor) {
331 return mFlinger->SurfaceFlinger::traverseLayersInDisplay(display, visitor);
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700332 }
333
Daniel Solomon42d04562019-01-20 21:03:19 -0800334 auto getDisplayNativePrimaries(const sp<IBinder>& displayToken,
335 ui::DisplayPrimaries &primaries) {
336 return mFlinger->SurfaceFlinger::getDisplayNativePrimaries(displayToken, primaries);
337 }
338
Valerie Haud251afb2019-03-29 14:19:02 -0700339 auto& getTransactionQueue() { return mFlinger->mTransactionQueues; }
340
341 auto setTransactionState(const Vector<ComposerState>& states,
342 const Vector<DisplayState>& displays, uint32_t flags,
343 const sp<IBinder>& applyToken,
344 const InputWindowCommands& inputWindowCommands,
345 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
346 bool hasListenerCallbacks,
347 std::vector<ListenerCallbacks>& listenerCallbacks) {
348 return mFlinger->setTransactionState(states, displays, flags, applyToken,
349 inputWindowCommands, desiredPresentTime, uncacheBuffer,
350 hasListenerCallbacks, listenerCallbacks);
351 }
352
353 auto flushTransactionQueues() { return mFlinger->flushTransactionQueues(); };
354
Lloyd Pique86016da2018-03-01 16:09:38 -0800355 /* ------------------------------------------------------------------------
356 * Read-only access to private data to assert post-conditions.
357 */
358
359 const auto& getAnimFrameTracker() const { return mFlinger->mAnimFrameTracker; }
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800360 const auto& getHasPoweredOff() const { return mFlinger->mHasPoweredOff; }
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800361 const auto& getVisibleRegionsDirty() const { return mFlinger->mVisibleRegionsDirty; }
Lloyd Pique441d5042018-10-18 16:49:51 -0700362 auto& getHwComposer() const {
363 return static_cast<impl::HWComposer&>(mFlinger->getHwComposer());
364 }
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800365
Lloyd Pique86016da2018-03-01 16:09:38 -0800366 const auto& getCompositorTiming() const { return mFlinger->getBE().mCompositorTiming; }
367
Lloyd Piquef58625d2017-12-19 13:22:33 -0800368 /* ------------------------------------------------------------------------
369 * Read-write access to private data to set up preconditions and assert
370 * post-conditions.
371 */
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800372
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800373 auto& mutableHasWideColorDisplay() { return SurfaceFlinger::hasWideColorDisplay; }
Peiyong Lin13effd12018-07-24 17:01:47 -0700374 auto& mutableUseColorManagement() { return SurfaceFlinger::useColorManagement; }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800375
Lloyd Piquee39cad22017-12-20 17:01:29 -0800376 auto& mutableCurrentState() { return mFlinger->mCurrentState; }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800377 auto& mutableDisplayColorSetting() { return mFlinger->mDisplayColorSetting; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700378 auto& mutableDisplays() { return mFlinger->mDisplays; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800379 auto& mutableDrawingState() { return mFlinger->mDrawingState; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800380 auto& mutableEventQueue() { return mFlinger->mEventQueue; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700381 auto& mutableGeometryInvalid() { return mFlinger->mGeometryInvalid; }
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800382 auto& mutableInterceptor() { return mFlinger->mInterceptor; }
Lloyd Pique6cf11032018-01-22 18:57:44 -0800383 auto& mutableMainThreadId() { return mFlinger->mMainThreadId; }
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800384 auto& mutablePendingHotplugEvents() { return mFlinger->mPendingHotplugEvents; }
Dominik Laskowski075d3172018-05-24 15:50:06 -0700385 auto& mutablePhysicalDisplayTokens() { return mFlinger->mPhysicalDisplayTokens; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700386 auto& mutableTexturePool() { return mFlinger->mTexturePool; }
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800387 auto& mutableTransactionFlags() { return mFlinger->mTransactionFlags; }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800388 auto& mutableUseHwcVirtualDisplays() { return mFlinger->mUseHwcVirtualDisplays; }
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800389 auto& mutablePowerAdvisor() { return mFlinger->mPowerAdvisor; }
Lloyd Pique4fe29402019-08-12 16:51:24 -0700390 auto& mutableDebugDisableHWC() { return mFlinger->mDebugDisableHWC; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800391
Lloyd Pique6cf11032018-01-22 18:57:44 -0800392 auto& mutableComposerSequenceId() { return mFlinger->getBE().mComposerSequenceId; }
Lloyd Pique441d5042018-10-18 16:49:51 -0700393 auto& mutableHwcDisplayData() { return getHwComposer().mDisplayData; }
394 auto& mutableHwcPhysicalDisplayIdMap() { return getHwComposer().mPhysicalDisplayIdMap; }
395 auto& mutableInternalHwcDisplayId() { return getHwComposer().mInternalHwcDisplayId; }
396 auto& mutableExternalHwcDisplayId() { return getHwComposer().mExternalHwcDisplayId; }
Lloyd Piquea618d852018-01-17 11:52:30 -0800397
Valerie Hau09e60052019-12-15 14:51:15 -0800398 auto fromHandle(const sp<IBinder>& handle) {
399 Mutex::Autolock _l(mFlinger->mStateLock);
400 return mFlinger->fromHandle(handle);
401 }
402
Lloyd Piquee39cad22017-12-20 17:01:29 -0800403 ~TestableSurfaceFlinger() {
404 // All these pointer and container clears help ensure that GMock does
405 // not report a leaked object, since the SurfaceFlinger instance may
406 // still be referenced by something despite our best efforts to destroy
407 // it after each test is done.
408 mutableDisplays().clear();
Ady Abraham2939f092019-03-04 17:44:06 -0800409 mutableCurrentState().displays.clear();
410 mutableDrawingState().displays.clear();
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800411 mutableEventQueue().reset();
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800412 mutableInterceptor().reset();
Lloyd Pique2eb71eb2019-08-13 13:23:03 -0700413 mFlinger->mScheduler.reset();
Lloyd Pique441d5042018-10-18 16:49:51 -0700414 mFlinger->mCompositionEngine->setHwComposer(std::unique_ptr<HWComposer>());
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700415 mFlinger->mCompositionEngine->setRenderEngine(
416 std::unique_ptr<renderengine::RenderEngine>());
Lloyd Piquee39cad22017-12-20 17:01:29 -0800417 }
Lloyd Piquef58625d2017-12-19 13:22:33 -0800418
Lloyd Piquea618d852018-01-17 11:52:30 -0800419 /* ------------------------------------------------------------------------
420 * Wrapper classes for Read-write access to private data to set up
421 * preconditions and assert post-conditions.
422 */
Ana Krulec4593b692019-01-11 22:07:25 -0800423 struct HWC2Display : public HWC2::impl::Display {
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800424 HWC2Display(Hwc2::Composer& composer,
Lloyd Piquea618d852018-01-17 11:52:30 -0800425 const std::unordered_set<HWC2::Capability>& capabilities, hwc2_display_t id,
426 HWC2::DisplayType type)
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800427 : HWC2::impl::Display(composer, capabilities, id, type) {}
Lloyd Piquea618d852018-01-17 11:52:30 -0800428 ~HWC2Display() {
429 // Prevents a call to disable vsyncs.
430 mType = HWC2::DisplayType::Invalid;
431 }
432
433 auto& mutableIsConnected() { return this->mIsConnected; }
434 auto& mutableConfigs() { return this->mConfigs; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700435 auto& mutableLayers() { return this->mLayers; }
Lloyd Piquea618d852018-01-17 11:52:30 -0800436 };
437
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800438 class FakeHwcDisplayInjector {
439 public:
440 static constexpr hwc2_display_t DEFAULT_HWC_DISPLAY_ID = 1000;
441 static constexpr int32_t DEFAULT_WIDTH = 1920;
442 static constexpr int32_t DEFAULT_HEIGHT = 1280;
443 static constexpr int32_t DEFAULT_REFRESH_RATE = 16'666'666;
Ady Abraham2139f732019-11-13 18:56:40 -0800444 static constexpr int32_t DEFAULT_CONFIG_GROUP = 7;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800445 static constexpr int32_t DEFAULT_DPI = 320;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800446 static constexpr hwc2_config_t DEFAULT_ACTIVE_CONFIG = 0;
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700447 static constexpr int32_t DEFAULT_POWER_MODE = 2;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800448
Dominik Laskowski075d3172018-05-24 15:50:06 -0700449 FakeHwcDisplayInjector(DisplayId displayId, HWC2::DisplayType hwcDisplayType,
450 bool isPrimary)
451 : mDisplayId(displayId), mHwcDisplayType(hwcDisplayType), mIsPrimary(isPrimary) {}
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800452
453 auto& setHwcDisplayId(hwc2_display_t displayId) {
454 mHwcDisplayId = displayId;
455 return *this;
456 }
457
458 auto& setWidth(int32_t width) {
459 mWidth = width;
460 return *this;
461 }
462
463 auto& setHeight(int32_t height) {
464 mHeight = height;
465 return *this;
466 }
467
Ady Abraham8a82ba62020-01-17 12:43:17 -0800468 auto& setRefreshRate(int32_t refreshRate) {
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800469 mRefreshRate = refreshRate;
470 return *this;
471 }
472
473 auto& setDpiX(int32_t dpi) {
474 mDpiX = dpi;
475 return *this;
476 }
477
478 auto& setDpiY(int32_t dpi) {
479 mDpiY = dpi;
480 return *this;
481 }
482
Ady Abraham8a82ba62020-01-17 12:43:17 -0800483 auto& setActiveConfig(hwc2_config_t config) {
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800484 mActiveConfig = config;
485 return *this;
486 }
487
Lloyd Piquee22f0332018-07-16 16:35:56 -0700488 auto& setCapabilities(const std::unordered_set<HWC2::Capability>* capabilities) {
489 mCapabilities = capabilities;
490 return *this;
491 }
492
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700493 auto& setPowerMode(int mode) {
494 mPowerMode = mode;
495 return *this;
496 }
497
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800498 void inject(TestableSurfaceFlinger* flinger, Hwc2::Composer* composer) {
Lloyd Piquee22f0332018-07-16 16:35:56 -0700499 static const std::unordered_set<HWC2::Capability> defaultCapabilities;
500 if (mCapabilities == nullptr) mCapabilities = &defaultCapabilities;
501
502 // Caution - Make sure that any values passed by reference here do
503 // not refer to an instance owned by FakeHwcDisplayInjector. This
504 // class has temporary lifetime, while the constructed HWC2::Display
505 // is much longer lived.
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800506 auto display = std::make_unique<HWC2Display>(*composer, *mCapabilities, mHwcDisplayId,
507 mHwcDisplayType);
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800508
509 auto config = HWC2::Display::Config::Builder(*display, mActiveConfig);
510 config.setWidth(mWidth);
511 config.setHeight(mHeight);
512 config.setVsyncPeriod(mRefreshRate);
513 config.setDpiX(mDpiX);
514 config.setDpiY(mDpiY);
Ady Abraham2139f732019-11-13 18:56:40 -0800515 config.setConfigGroup(mConfigGroup);
Ady Abraham8a82ba62020-01-17 12:43:17 -0800516 display->mutableConfigs().emplace(static_cast<int32_t>(mActiveConfig), config.build());
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800517 display->mutableIsConnected() = true;
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700518 display->setPowerMode(static_cast<HWC2::PowerMode>(mPowerMode));
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800519
Peiyong Linbdd08cc2019-12-17 21:35:14 -0800520 flinger->mutableHwcDisplayData()[mDisplayId].hwcDisplay = std::move(display);
Dominik Laskowski075d3172018-05-24 15:50:06 -0700521
522 if (mHwcDisplayType == HWC2::DisplayType::Physical) {
523 flinger->mutableHwcPhysicalDisplayIdMap().emplace(mHwcDisplayId, mDisplayId);
524 (mIsPrimary ? flinger->mutableInternalHwcDisplayId()
525 : flinger->mutableExternalHwcDisplayId()) = mHwcDisplayId;
526 }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800527 }
528
529 private:
Dominik Laskowski075d3172018-05-24 15:50:06 -0700530 const DisplayId mDisplayId;
531 const HWC2::DisplayType mHwcDisplayType;
532 const bool mIsPrimary;
533
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800534 hwc2_display_t mHwcDisplayId = DEFAULT_HWC_DISPLAY_ID;
535 int32_t mWidth = DEFAULT_WIDTH;
536 int32_t mHeight = DEFAULT_HEIGHT;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800537 int32_t mRefreshRate = DEFAULT_REFRESH_RATE;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800538 int32_t mDpiX = DEFAULT_DPI;
Ady Abraham2139f732019-11-13 18:56:40 -0800539 int32_t mConfigGroup = DEFAULT_CONFIG_GROUP;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800540 int32_t mDpiY = DEFAULT_DPI;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800541 hwc2_config_t mActiveConfig = DEFAULT_ACTIVE_CONFIG;
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700542 int32_t mPowerMode = DEFAULT_POWER_MODE;
Lloyd Piquee22f0332018-07-16 16:35:56 -0700543 const std::unordered_set<HWC2::Capability>* mCapabilities = nullptr;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800544 };
545
546 class FakeDisplayDeviceInjector {
547 public:
Dominik Laskowski075d3172018-05-24 15:50:06 -0700548 FakeDisplayDeviceInjector(TestableSurfaceFlinger& flinger,
549 const std::optional<DisplayId>& displayId, bool isVirtual,
550 bool isPrimary)
551 : mFlinger(flinger), mCreationArgs(flinger.mFlinger.get(), mDisplayToken, displayId) {
552 mCreationArgs.isVirtual = isVirtual;
553 mCreationArgs.isPrimary = isPrimary;
554 }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800555
556 sp<IBinder> token() const { return mDisplayToken; }
557
558 DisplayDeviceState& mutableDrawingDisplayState() {
559 return mFlinger.mutableDrawingState().displays.editValueFor(mDisplayToken);
560 }
561
562 DisplayDeviceState& mutableCurrentDisplayState() {
563 return mFlinger.mutableCurrentState().displays.editValueFor(mDisplayToken);
564 }
565
Lloyd Pique9d9cf402018-02-16 17:47:13 -0800566 const auto& getDrawingDisplayState() {
567 return mFlinger.mutableDrawingState().displays.valueFor(mDisplayToken);
568 }
569
570 const auto& getCurrentDisplayState() {
571 return mFlinger.mutableCurrentState().displays.valueFor(mDisplayToken);
572 }
573
Dominik Laskowski9fae1022018-05-29 13:17:40 -0700574 auto& mutableDisplayDevice() { return mFlinger.mutableDisplays()[mDisplayToken]; }
Lloyd Pique9d9cf402018-02-16 17:47:13 -0800575
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800576 auto& setNativeWindow(const sp<ANativeWindow>& nativeWindow) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700577 mCreationArgs.nativeWindow = nativeWindow;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800578 return *this;
579 }
580
Lloyd Pique542307f2018-10-19 13:24:08 -0700581 auto& setDisplaySurface(const sp<compositionengine::DisplaySurface>& displaySurface) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700582 mCreationArgs.displaySurface = displaySurface;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800583 return *this;
584 }
585
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800586 auto& setSecure(bool secure) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700587 mCreationArgs.isSecure = secure;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800588 return *this;
589 }
590
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700591 auto& setPowerMode(int mode) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700592 mCreationArgs.initialPowerMode = mode;
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700593 return *this;
594 }
595
Valerie Hau9758ae02018-10-09 16:05:09 -0700596 auto& setHwcColorModes(
597 const std::unordered_map<ui::ColorMode, std::vector<ui::RenderIntent>>
598 hwcColorModes) {
599 mCreationArgs.hwcColorModes = hwcColorModes;
600 return *this;
601 }
602
603 auto& setHasWideColorGamut(bool hasWideColorGamut) {
604 mCreationArgs.hasWideColorGamut = hasWideColorGamut;
605 return *this;
606 }
607
Lloyd Pique33050472019-12-19 17:12:44 -0800608 auto& setPhysicalOrientation(ui::Rotation orientation) {
609 mCreationArgs.physicalOrientation = orientation;
610 return *this;
611 }
612
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800613 sp<DisplayDevice> inject() {
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800614 DisplayDeviceState state;
Dominik Laskowski075d3172018-05-24 15:50:06 -0700615 state.displayId = mCreationArgs.isVirtual ? std::nullopt : mCreationArgs.displayId;
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700616 state.isSecure = mCreationArgs.isSecure;
617
618 sp<DisplayDevice> device = new DisplayDevice(std::move(mCreationArgs));
619 mFlinger.mutableDisplays().emplace(mDisplayToken, device);
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800620 mFlinger.mutableCurrentState().displays.add(mDisplayToken, state);
621 mFlinger.mutableDrawingState().displays.add(mDisplayToken, state);
622
Dominik Laskowski075d3172018-05-24 15:50:06 -0700623 if (!mCreationArgs.isVirtual) {
624 LOG_ALWAYS_FATAL_IF(!state.displayId);
625 mFlinger.mutablePhysicalDisplayTokens()[*state.displayId] = mDisplayToken;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800626 }
627
628 return device;
629 }
630
631 private:
632 TestableSurfaceFlinger& mFlinger;
633 sp<BBinder> mDisplayToken = new BBinder();
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700634 DisplayDeviceCreationArgs mCreationArgs;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800635 };
636
Lloyd Pique90c115d2018-09-18 21:39:42 -0700637 surfaceflinger::test::Factory mFactory;
638 sp<SurfaceFlinger> mFlinger = new SurfaceFlinger(mFactory, SurfaceFlinger::SkipInitialization);
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700639 TestableScheduler* mScheduler = nullptr;
Lloyd Piquef58625d2017-12-19 13:22:33 -0800640};
641
642} // namespace android