blob: c7664fb9acf1710faf6f1e601be9d9b764d0805d [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 Pique0b785d82018-12-04 17:25:27 -080020#include <compositionengine/Layer.h>
Lloyd Pique9755fb72019-03-26 14:44:40 -070021#include <compositionengine/LayerFECompositionState.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080022#include <compositionengine/OutputLayer.h>
Lloyd Pique70d91362018-10-18 16:02:55 -070023#include <compositionengine/impl/CompositionEngine.h>
Lloyd Pique37c2c9b2018-12-04 17:25:10 -080024#include <compositionengine/impl/OutputLayerCompositionState.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
Ana Krulec757f63a2019-01-25 10:46:18 -080081 std::unique_ptr<scheduler::PhaseOffsets> createPhaseOffsets() override {
82 return std::make_unique<scheduler::FakePhaseOffsets>();
83 }
84
Ady Abraham09bd3922019-04-08 10:44:56 -070085 std::unique_ptr<Scheduler> createScheduler(std::function<void(bool)>,
86 const scheduler::RefreshRateConfigs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070087 return nullptr;
88 }
89
90 std::unique_ptr<SurfaceInterceptor> createSurfaceInterceptor(SurfaceFlinger* flinger) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070091 return std::make_unique<android::impl::SurfaceInterceptor>(flinger);
92 }
93
94 sp<StartPropertySetThread> createStartPropertySetThread(bool timestampPropertyValue) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070095 return new StartPropertySetThread(timestampPropertyValue);
96 }
97
98 sp<DisplayDevice> createDisplayDevice(DisplayDeviceCreationArgs&& creationArgs) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -070099 return new DisplayDevice(std::move(creationArgs));
100 }
101
102 sp<GraphicBuffer> createGraphicBuffer(uint32_t width, uint32_t height, PixelFormat format,
103 uint32_t layerCount, uint64_t usage,
104 std::string requestorName) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700105 return new GraphicBuffer(width, height, format, layerCount, usage, requestorName);
106 }
107
108 void createBufferQueue(sp<IGraphicBufferProducer>* outProducer,
109 sp<IGraphicBufferConsumer>* outConsumer,
110 bool consumerIsSurfaceFlinger) override {
Lloyd Piquee300b312019-10-03 13:03:45 -0700111 if (!mCreateBufferQueue) {
112 BufferQueue::createBufferQueue(outProducer, outConsumer, consumerIsSurfaceFlinger);
113 return;
114 }
Lloyd Pique90c115d2018-09-18 21:39:42 -0700115 mCreateBufferQueue(outProducer, outConsumer, consumerIsSurfaceFlinger);
116 }
117
Lloyd Piquee300b312019-10-03 13:03:45 -0700118 sp<IGraphicBufferProducer> createMonitoredProducer(const sp<IGraphicBufferProducer>& producer,
119 const sp<SurfaceFlinger>& flinger,
120 const wp<Layer>& layer) override {
121 return new MonitoredProducer(producer, flinger, layer);
122 }
123
124 sp<BufferLayerConsumer> createBufferLayerConsumer(const sp<IGraphicBufferConsumer>& consumer,
125 renderengine::RenderEngine& renderEngine,
126 uint32_t textureName, Layer* layer) override {
127 return new BufferLayerConsumer(consumer, renderEngine, textureName, layer);
128 }
129
Lloyd Pique90c115d2018-09-18 21:39:42 -0700130 std::unique_ptr<surfaceflinger::NativeWindowSurface> createNativeWindowSurface(
131 const sp<IGraphicBufferProducer>& producer) override {
132 if (!mCreateNativeWindowSurface) return nullptr;
133 return mCreateNativeWindowSurface(producer);
134 }
135
Lloyd Pique70d91362018-10-18 16:02:55 -0700136 std::unique_ptr<compositionengine::CompositionEngine> createCompositionEngine() override {
137 return compositionengine::impl::createCompositionEngine();
138 }
139
Lloyd Pique90c115d2018-09-18 21:39:42 -0700140 sp<BufferQueueLayer> createBufferQueueLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700141 return nullptr;
142 }
143
144 sp<BufferStateLayer> createBufferStateLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700145 return nullptr;
146 }
147
148 sp<ColorLayer> createColorLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700149 return nullptr;
150 }
151
152 sp<ContainerLayer> createContainerLayer(const LayerCreationArgs&) override {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700153 return nullptr;
154 }
155
156 using CreateBufferQueueFunction =
157 std::function<void(sp<IGraphicBufferProducer>* /* outProducer */,
158 sp<IGraphicBufferConsumer>* /* outConsumer */,
159 bool /* consumerIsSurfaceFlinger */)>;
160 CreateBufferQueueFunction mCreateBufferQueue;
161
162 using CreateNativeWindowSurfaceFunction =
163 std::function<std::unique_ptr<surfaceflinger::NativeWindowSurface>(
164 const sp<IGraphicBufferProducer>&)>;
165 CreateNativeWindowSurfaceFunction mCreateNativeWindowSurface;
Lloyd Pique70d91362018-10-18 16:02:55 -0700166
167 using CreateCompositionEngineFunction =
168 std::function<std::unique_ptr<compositionengine::CompositionEngine>()>;
169 CreateCompositionEngineFunction mCreateCompositionEngine;
Lloyd Pique90c115d2018-09-18 21:39:42 -0700170};
171
172} // namespace surfaceflinger::test
Lloyd Piquee39cad22017-12-20 17:01:29 -0800173
Lloyd Piquef58625d2017-12-19 13:22:33 -0800174class TestableSurfaceFlinger {
175public:
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700176 TestableScheduler* scheduler() { return mScheduler; }
177
Lloyd Piquef58625d2017-12-19 13:22:33 -0800178 // Extend this as needed for accessing SurfaceFlinger private (and public)
179 // functions.
180
Peiyong Lin833074a2018-08-28 11:53:54 -0700181 void setupRenderEngine(std::unique_ptr<renderengine::RenderEngine> renderEngine) {
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700182 mFlinger->mCompositionEngine->setRenderEngine(std::move(renderEngine));
Lloyd Piquee39cad22017-12-20 17:01:29 -0800183 }
184
185 void setupComposer(std::unique_ptr<Hwc2::Composer> composer) {
Lloyd Pique441d5042018-10-18 16:49:51 -0700186 mFlinger->mCompositionEngine->setHwComposer(
187 std::make_unique<impl::HWComposer>(std::move(composer)));
Lloyd Piquee39cad22017-12-20 17:01:29 -0800188 }
189
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700190 void setupScheduler(std::unique_ptr<DispSync> primaryDispSync,
191 std::unique_ptr<EventControlThread> eventControlThread,
192 std::unique_ptr<EventThread> appEventThread,
193 std::unique_ptr<EventThread> sfEventThread) {
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700194 std::vector<scheduler::RefreshRateConfigs::InputConfig> configs{{/*hwcId=*/0, 16666667}};
195 mFlinger->mRefreshRateConfigs =
196 std::make_unique<scheduler::RefreshRateConfigs>(/*refreshRateSwitching=*/false,
197 configs, /*currentConfig=*/0);
198 mFlinger->mRefreshRateStats =
199 std::make_unique<scheduler::RefreshRateStats>(*mFlinger->mRefreshRateConfigs,
200 *mFlinger->mTimeStats,
201 /*currentConfig=*/0,
202 /*powerMode=*/HWC_POWER_MODE_OFF);
203
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700204 mScheduler =
205 new TestableScheduler(std::move(primaryDispSync), std::move(eventControlThread),
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700206 *mFlinger->mRefreshRateConfigs);
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700207
Dominik Laskowski98041832019-08-01 18:35:59 -0700208 mFlinger->mAppConnectionHandle = mScheduler->createConnection(std::move(appEventThread));
209 mFlinger->mSfConnectionHandle = mScheduler->createConnection(std::move(sfEventThread));
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700210
211 mFlinger->mScheduler.reset(mScheduler);
212 mFlinger->mVSyncModulator.emplace(*mScheduler, mFlinger->mAppConnectionHandle,
213 mFlinger->mSfConnectionHandle,
214 mFlinger->mPhaseOffsets->getCurrentOffsets());
215 }
216
Lloyd Pique90c115d2018-09-18 21:39:42 -0700217 using CreateBufferQueueFunction = surfaceflinger::test::Factory::CreateBufferQueueFunction;
Lloyd Pique5b36f3f2018-01-17 11:57:07 -0800218 void setCreateBufferQueueFunction(CreateBufferQueueFunction f) {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700219 mFactory.mCreateBufferQueue = f;
Lloyd Pique5b36f3f2018-01-17 11:57:07 -0800220 }
221
Lloyd Pique90c115d2018-09-18 21:39:42 -0700222 using CreateNativeWindowSurfaceFunction =
223 surfaceflinger::test::Factory::CreateNativeWindowSurfaceFunction;
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800224 void setCreateNativeWindowSurface(CreateNativeWindowSurfaceFunction f) {
Lloyd Pique90c115d2018-09-18 21:39:42 -0700225 mFactory.mCreateNativeWindowSurface = f;
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800226 }
227
Daniel Solomon42d04562019-01-20 21:03:19 -0800228 void setInternalDisplayPrimaries(const ui::DisplayPrimaries& primaries) {
229 memcpy(&mFlinger->mInternalDisplayPrimaries, &primaries, sizeof(ui::DisplayPrimaries));
230 }
231
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800232 using HotplugEvent = SurfaceFlinger::HotplugEvent;
233
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800234 auto& mutableLayerCurrentState(sp<Layer> layer) { return layer->mCurrentState; }
235 auto& mutableLayerDrawingState(sp<Layer> layer) { return layer->mDrawingState; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700236
Valerie Haud251afb2019-03-29 14:19:02 -0700237 auto& mutableStateLock() { return mFlinger->mStateLock; }
238
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700239 void setLayerSidebandStream(sp<Layer> layer, sp<NativeHandle> sidebandStream) {
Lloyd Pique0449b0f2018-12-20 16:23:45 -0800240 layer->mDrawingState.sidebandStream = sidebandStream;
Lloyd Pique0b785d82018-12-04 17:25:27 -0800241 layer->mSidebandStream = sidebandStream;
Lloyd Pique9755fb72019-03-26 14:44:40 -0700242 layer->getCompositionLayer()->editFEState().sidebandStream = sidebandStream;
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700243 }
244
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800245 void setLayerCompositionType(sp<Layer> layer, HWC2::Composition type) {
246 auto outputLayer = layer->findOutputLayerForDisplay(mFlinger->getDefaultDisplayDevice());
247 LOG_ALWAYS_FATAL_IF(!outputLayer);
248 auto& state = outputLayer->editState();
249 LOG_ALWAYS_FATAL_IF(!outputLayer->getState().hwc);
250 (*state.hwc).hwcCompositionType = static_cast<Hwc2::IComposerClient::Composition>(type);
251 };
252
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700253 void setLayerPotentialCursor(sp<Layer> layer, bool potentialCursor) {
254 layer->mPotentialCursor = potentialCursor;
255 }
256
Lloyd Piquef58625d2017-12-19 13:22:33 -0800257 /* ------------------------------------------------------------------------
258 * Forwarding for functions being tested
259 */
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800260
Lloyd Piquea482f992018-01-22 19:00:34 -0800261 auto createDisplay(const String8& displayName, bool secure) {
262 return mFlinger->createDisplay(displayName, secure);
263 }
264
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700265 auto destroyDisplay(const sp<IBinder>& displayToken) {
266 return mFlinger->destroyDisplay(displayToken);
267 }
Lloyd Piquea482f992018-01-22 19:00:34 -0800268
Lloyd Piqued6fbb8a2018-01-22 19:08:36 -0800269 auto resetDisplayState() { return mFlinger->resetDisplayState(); }
270
Dominik Laskowski075d3172018-05-24 15:50:06 -0700271 auto setupNewDisplayDeviceInternal(const wp<IBinder>& displayToken,
272 const std::optional<DisplayId>& displayId,
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800273 const DisplayDeviceState& state,
Lloyd Pique542307f2018-10-19 13:24:08 -0700274 const sp<compositionengine::DisplaySurface>& dispSurface,
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800275 const sp<IGraphicBufferProducer>& producer) {
Dominik Laskowski7e045462018-05-30 13:02:02 -0700276 return mFlinger->setupNewDisplayDeviceInternal(displayToken, displayId, state, dispSurface,
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800277 producer);
278 }
279
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800280 auto handleTransactionLocked(uint32_t transactionFlags) {
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800281 Mutex::Autolock _l(mFlinger->mStateLock);
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800282 return mFlinger->handleTransactionLocked(transactionFlags);
283 }
Lloyd Piquef58625d2017-12-19 13:22:33 -0800284
Lloyd Pique6cf11032018-01-22 18:57:44 -0800285 auto onHotplugReceived(int32_t sequenceId, hwc2_display_t display,
286 HWC2::Connection connection) {
287 return mFlinger->onHotplugReceived(sequenceId, display, connection);
288 }
289
Vishnu Nairce5d0cc2019-02-28 14:38:41 -0800290 auto setDisplayStateLocked(const DisplayState& s) {
291 Mutex::Autolock _l(mFlinger->mStateLock);
292 return mFlinger->setDisplayStateLocked(s);
293 }
Lloyd Pique9d9cf402018-02-16 17:47:13 -0800294
Dominik Laskowski83b88212018-12-11 13:34:06 -0800295 // Allow reading display state without locking, as if called on the SF main thread.
296 auto onInitializeDisplays() NO_THREAD_SAFETY_ANALYSIS {
297 return mFlinger->onInitializeDisplays();
298 }
Lloyd Pique86016da2018-03-01 16:09:38 -0800299
Dominik Laskowski83b88212018-12-11 13:34:06 -0800300 // Allow reading display state without locking, as if called on the SF main thread.
301 auto setPowerModeInternal(const sp<DisplayDevice>& display,
302 int mode) NO_THREAD_SAFETY_ANALYSIS {
Dominik Laskowskie9774092018-12-11 10:04:24 -0800303 return mFlinger->setPowerModeInternal(display, mode);
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800304 }
305
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700306 auto onMessageReceived(int32_t what) { return mFlinger->onMessageReceived(what); }
307
Robert Carr108b2c72019-04-02 16:32:58 -0700308 auto captureScreenImplLocked(
309 const RenderArea& renderArea, SurfaceFlinger::TraverseLayersFunction traverseLayers,
310 ANativeWindowBuffer* buffer, bool useIdentityTransform, bool forSystem, int* outSyncFd) {
311 bool ignored;
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700312 return mFlinger->captureScreenImplLocked(renderArea, traverseLayers, buffer,
Robert Carr108b2c72019-04-02 16:32:58 -0700313 useIdentityTransform, forSystem, outSyncFd,
314 ignored);
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700315 }
316
chaviw0e3479f2018-09-10 16:49:30 -0700317 auto traverseLayersInDisplay(const sp<const DisplayDevice>& display,
318 const LayerVector::Visitor& visitor) {
319 return mFlinger->SurfaceFlinger::traverseLayersInDisplay(display, visitor);
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700320 }
321
Daniel Solomon42d04562019-01-20 21:03:19 -0800322 auto getDisplayNativePrimaries(const sp<IBinder>& displayToken,
323 ui::DisplayPrimaries &primaries) {
324 return mFlinger->SurfaceFlinger::getDisplayNativePrimaries(displayToken, primaries);
325 }
326
Valerie Haud251afb2019-03-29 14:19:02 -0700327 auto& getTransactionQueue() { return mFlinger->mTransactionQueues; }
328
329 auto setTransactionState(const Vector<ComposerState>& states,
330 const Vector<DisplayState>& displays, uint32_t flags,
331 const sp<IBinder>& applyToken,
332 const InputWindowCommands& inputWindowCommands,
333 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
334 bool hasListenerCallbacks,
335 std::vector<ListenerCallbacks>& listenerCallbacks) {
336 return mFlinger->setTransactionState(states, displays, flags, applyToken,
337 inputWindowCommands, desiredPresentTime, uncacheBuffer,
338 hasListenerCallbacks, listenerCallbacks);
339 }
340
341 auto flushTransactionQueues() { return mFlinger->flushTransactionQueues(); };
342
Lloyd Pique86016da2018-03-01 16:09:38 -0800343 /* ------------------------------------------------------------------------
344 * Read-only access to private data to assert post-conditions.
345 */
346
347 const auto& getAnimFrameTracker() const { return mFlinger->mAnimFrameTracker; }
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800348 const auto& getHasPoweredOff() const { return mFlinger->mHasPoweredOff; }
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800349 const auto& getVisibleRegionsDirty() const { return mFlinger->mVisibleRegionsDirty; }
Lloyd Pique441d5042018-10-18 16:49:51 -0700350 auto& getHwComposer() const {
351 return static_cast<impl::HWComposer&>(mFlinger->getHwComposer());
352 }
Lloyd Pique7d4aa6c2018-03-01 16:36:35 -0800353
Lloyd Pique86016da2018-03-01 16:09:38 -0800354 const auto& getCompositorTiming() const { return mFlinger->getBE().mCompositorTiming; }
355
Lloyd Piquef58625d2017-12-19 13:22:33 -0800356 /* ------------------------------------------------------------------------
357 * Read-write access to private data to set up preconditions and assert
358 * post-conditions.
359 */
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800360
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800361 auto& mutableHasWideColorDisplay() { return SurfaceFlinger::hasWideColorDisplay; }
Chia-I Wu304d9cd2018-08-27 14:38:14 -0700362 auto& mutablePrimaryDisplayOrientation() { return SurfaceFlinger::primaryDisplayOrientation; }
Peiyong Lin13effd12018-07-24 17:01:47 -0700363 auto& mutableUseColorManagement() { return SurfaceFlinger::useColorManagement; }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800364
Lloyd Piquee39cad22017-12-20 17:01:29 -0800365 auto& mutableCurrentState() { return mFlinger->mCurrentState; }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800366 auto& mutableDisplayColorSetting() { return mFlinger->mDisplayColorSetting; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700367 auto& mutableDisplays() { return mFlinger->mDisplays; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800368 auto& mutableDrawingState() { return mFlinger->mDrawingState; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800369 auto& mutableEventQueue() { return mFlinger->mEventQueue; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700370 auto& mutableGeometryInvalid() { return mFlinger->mGeometryInvalid; }
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800371 auto& mutableInterceptor() { return mFlinger->mInterceptor; }
Lloyd Pique6cf11032018-01-22 18:57:44 -0800372 auto& mutableMainThreadId() { return mFlinger->mMainThreadId; }
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800373 auto& mutablePendingHotplugEvents() { return mFlinger->mPendingHotplugEvents; }
Dominik Laskowski075d3172018-05-24 15:50:06 -0700374 auto& mutablePhysicalDisplayTokens() { return mFlinger->mPhysicalDisplayTokens; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700375 auto& mutableTexturePool() { return mFlinger->mTexturePool; }
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800376 auto& mutableTransactionFlags() { return mFlinger->mTransactionFlags; }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800377 auto& mutableUseHwcVirtualDisplays() { return mFlinger->mUseHwcVirtualDisplays; }
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800378 auto& mutablePowerAdvisor() { return mFlinger->mPowerAdvisor; }
Lloyd Pique4fe29402019-08-12 16:51:24 -0700379 auto& mutableDebugDisableHWC() { return mFlinger->mDebugDisableHWC; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800380
Lloyd Pique6cf11032018-01-22 18:57:44 -0800381 auto& mutableComposerSequenceId() { return mFlinger->getBE().mComposerSequenceId; }
Lloyd Pique441d5042018-10-18 16:49:51 -0700382 auto& mutableHwcDisplayData() { return getHwComposer().mDisplayData; }
383 auto& mutableHwcPhysicalDisplayIdMap() { return getHwComposer().mPhysicalDisplayIdMap; }
384 auto& mutableInternalHwcDisplayId() { return getHwComposer().mInternalHwcDisplayId; }
385 auto& mutableExternalHwcDisplayId() { return getHwComposer().mExternalHwcDisplayId; }
Lloyd Piquea618d852018-01-17 11:52:30 -0800386
Lloyd Piquee39cad22017-12-20 17:01:29 -0800387 ~TestableSurfaceFlinger() {
388 // All these pointer and container clears help ensure that GMock does
389 // not report a leaked object, since the SurfaceFlinger instance may
390 // still be referenced by something despite our best efforts to destroy
391 // it after each test is done.
392 mutableDisplays().clear();
Ady Abraham2939f092019-03-04 17:44:06 -0800393 mutableCurrentState().displays.clear();
394 mutableDrawingState().displays.clear();
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800395 mutableEventQueue().reset();
Lloyd Pique0b1fe702018-01-22 18:03:16 -0800396 mutableInterceptor().reset();
Lloyd Pique2eb71eb2019-08-13 13:23:03 -0700397 mFlinger->mScheduler.reset();
Lloyd Pique441d5042018-10-18 16:49:51 -0700398 mFlinger->mCompositionEngine->setHwComposer(std::unique_ptr<HWComposer>());
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700399 mFlinger->mCompositionEngine->setRenderEngine(
400 std::unique_ptr<renderengine::RenderEngine>());
Lloyd Piquee39cad22017-12-20 17:01:29 -0800401 }
Lloyd Piquef58625d2017-12-19 13:22:33 -0800402
Lloyd Piquea618d852018-01-17 11:52:30 -0800403 /* ------------------------------------------------------------------------
404 * Wrapper classes for Read-write access to private data to set up
405 * preconditions and assert post-conditions.
406 */
Ana Krulec4593b692019-01-11 22:07:25 -0800407 struct HWC2Display : public HWC2::impl::Display {
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800408 HWC2Display(Hwc2::Composer& composer,
Lloyd Piquea618d852018-01-17 11:52:30 -0800409 const std::unordered_set<HWC2::Capability>& capabilities, hwc2_display_t id,
410 HWC2::DisplayType type)
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800411 : HWC2::impl::Display(composer, capabilities, id, type) {}
Lloyd Piquea618d852018-01-17 11:52:30 -0800412 ~HWC2Display() {
413 // Prevents a call to disable vsyncs.
414 mType = HWC2::DisplayType::Invalid;
415 }
416
417 auto& mutableIsConnected() { return this->mIsConnected; }
418 auto& mutableConfigs() { return this->mConfigs; }
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700419 auto& mutableLayers() { return this->mLayers; }
Lloyd Piquea618d852018-01-17 11:52:30 -0800420 };
421
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800422 class FakeHwcDisplayInjector {
423 public:
424 static constexpr hwc2_display_t DEFAULT_HWC_DISPLAY_ID = 1000;
425 static constexpr int32_t DEFAULT_WIDTH = 1920;
426 static constexpr int32_t DEFAULT_HEIGHT = 1280;
427 static constexpr int32_t DEFAULT_REFRESH_RATE = 16'666'666;
428 static constexpr int32_t DEFAULT_DPI = 320;
429 static constexpr int32_t DEFAULT_ACTIVE_CONFIG = 0;
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700430 static constexpr int32_t DEFAULT_POWER_MODE = 2;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800431
Dominik Laskowski075d3172018-05-24 15:50:06 -0700432 FakeHwcDisplayInjector(DisplayId displayId, HWC2::DisplayType hwcDisplayType,
433 bool isPrimary)
434 : mDisplayId(displayId), mHwcDisplayType(hwcDisplayType), mIsPrimary(isPrimary) {}
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800435
436 auto& setHwcDisplayId(hwc2_display_t displayId) {
437 mHwcDisplayId = displayId;
438 return *this;
439 }
440
441 auto& setWidth(int32_t width) {
442 mWidth = width;
443 return *this;
444 }
445
446 auto& setHeight(int32_t height) {
447 mHeight = height;
448 return *this;
449 }
450
451 auto& setRefreshRate(int32_t refreshRate) {
452 mRefreshRate = refreshRate;
453 return *this;
454 }
455
456 auto& setDpiX(int32_t dpi) {
457 mDpiX = dpi;
458 return *this;
459 }
460
461 auto& setDpiY(int32_t dpi) {
462 mDpiY = dpi;
463 return *this;
464 }
465
466 auto& setActiveConfig(int32_t config) {
467 mActiveConfig = config;
468 return *this;
469 }
470
Lloyd Piquee22f0332018-07-16 16:35:56 -0700471 auto& setCapabilities(const std::unordered_set<HWC2::Capability>* capabilities) {
472 mCapabilities = capabilities;
473 return *this;
474 }
475
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700476 auto& setPowerMode(int mode) {
477 mPowerMode = mode;
478 return *this;
479 }
480
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800481 void inject(TestableSurfaceFlinger* flinger, Hwc2::Composer* composer) {
Lloyd Piquee22f0332018-07-16 16:35:56 -0700482 static const std::unordered_set<HWC2::Capability> defaultCapabilities;
483 if (mCapabilities == nullptr) mCapabilities = &defaultCapabilities;
484
485 // Caution - Make sure that any values passed by reference here do
486 // not refer to an instance owned by FakeHwcDisplayInjector. This
487 // class has temporary lifetime, while the constructed HWC2::Display
488 // is much longer lived.
Peiyong Lin74ca2f42019-01-14 19:36:57 -0800489 auto display = std::make_unique<HWC2Display>(*composer, *mCapabilities, mHwcDisplayId,
490 mHwcDisplayType);
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800491
492 auto config = HWC2::Display::Config::Builder(*display, mActiveConfig);
493 config.setWidth(mWidth);
494 config.setHeight(mHeight);
495 config.setVsyncPeriod(mRefreshRate);
496 config.setDpiX(mDpiX);
497 config.setDpiY(mDpiY);
498 display->mutableConfigs().emplace(mActiveConfig, config.build());
499 display->mutableIsConnected() = true;
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700500 display->setPowerMode(static_cast<HWC2::PowerMode>(mPowerMode));
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800501
Dominik Laskowski075d3172018-05-24 15:50:06 -0700502 flinger->mutableHwcDisplayData()[mDisplayId].hwcDisplay = display.get();
503
504 if (mHwcDisplayType == HWC2::DisplayType::Physical) {
505 flinger->mutableHwcPhysicalDisplayIdMap().emplace(mHwcDisplayId, mDisplayId);
506 (mIsPrimary ? flinger->mutableInternalHwcDisplayId()
507 : flinger->mutableExternalHwcDisplayId()) = mHwcDisplayId;
508 }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800509
510 flinger->mFakeHwcDisplays.push_back(std::move(display));
511 }
512
513 private:
Dominik Laskowski075d3172018-05-24 15:50:06 -0700514 const DisplayId mDisplayId;
515 const HWC2::DisplayType mHwcDisplayType;
516 const bool mIsPrimary;
517
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800518 hwc2_display_t mHwcDisplayId = DEFAULT_HWC_DISPLAY_ID;
519 int32_t mWidth = DEFAULT_WIDTH;
520 int32_t mHeight = DEFAULT_HEIGHT;
521 int32_t mRefreshRate = DEFAULT_REFRESH_RATE;
522 int32_t mDpiX = DEFAULT_DPI;
523 int32_t mDpiY = DEFAULT_DPI;
524 int32_t mActiveConfig = DEFAULT_ACTIVE_CONFIG;
Peiyong Lin1336e6e2019-05-28 09:23:50 -0700525 int32_t mPowerMode = DEFAULT_POWER_MODE;
Lloyd Piquee22f0332018-07-16 16:35:56 -0700526 const std::unordered_set<HWC2::Capability>* mCapabilities = nullptr;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800527 };
528
529 class FakeDisplayDeviceInjector {
530 public:
Dominik Laskowski075d3172018-05-24 15:50:06 -0700531 FakeDisplayDeviceInjector(TestableSurfaceFlinger& flinger,
532 const std::optional<DisplayId>& displayId, bool isVirtual,
533 bool isPrimary)
534 : mFlinger(flinger), mCreationArgs(flinger.mFlinger.get(), mDisplayToken, displayId) {
535 mCreationArgs.isVirtual = isVirtual;
536 mCreationArgs.isPrimary = isPrimary;
537 }
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800538
539 sp<IBinder> token() const { return mDisplayToken; }
540
541 DisplayDeviceState& mutableDrawingDisplayState() {
542 return mFlinger.mutableDrawingState().displays.editValueFor(mDisplayToken);
543 }
544
545 DisplayDeviceState& mutableCurrentDisplayState() {
546 return mFlinger.mutableCurrentState().displays.editValueFor(mDisplayToken);
547 }
548
Lloyd Pique9d9cf402018-02-16 17:47:13 -0800549 const auto& getDrawingDisplayState() {
550 return mFlinger.mutableDrawingState().displays.valueFor(mDisplayToken);
551 }
552
553 const auto& getCurrentDisplayState() {
554 return mFlinger.mutableCurrentState().displays.valueFor(mDisplayToken);
555 }
556
Dominik Laskowski9fae1022018-05-29 13:17:40 -0700557 auto& mutableDisplayDevice() { return mFlinger.mutableDisplays()[mDisplayToken]; }
Lloyd Pique9d9cf402018-02-16 17:47:13 -0800558
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800559 auto& setNativeWindow(const sp<ANativeWindow>& nativeWindow) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700560 mCreationArgs.nativeWindow = nativeWindow;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800561 return *this;
562 }
563
Lloyd Pique542307f2018-10-19 13:24:08 -0700564 auto& setDisplaySurface(const sp<compositionengine::DisplaySurface>& displaySurface) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700565 mCreationArgs.displaySurface = displaySurface;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800566 return *this;
567 }
568
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800569 auto& setSecure(bool secure) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700570 mCreationArgs.isSecure = secure;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800571 return *this;
572 }
573
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700574 auto& setPowerMode(int mode) {
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700575 mCreationArgs.initialPowerMode = mode;
Lloyd Piqued6b579f2018-04-06 15:29:10 -0700576 return *this;
577 }
578
Valerie Hau9758ae02018-10-09 16:05:09 -0700579 auto& setHwcColorModes(
580 const std::unordered_map<ui::ColorMode, std::vector<ui::RenderIntent>>
581 hwcColorModes) {
582 mCreationArgs.hwcColorModes = hwcColorModes;
583 return *this;
584 }
585
586 auto& setHasWideColorGamut(bool hasWideColorGamut) {
587 mCreationArgs.hasWideColorGamut = hasWideColorGamut;
588 return *this;
589 }
590
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800591 sp<DisplayDevice> inject() {
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800592 DisplayDeviceState state;
Dominik Laskowski075d3172018-05-24 15:50:06 -0700593 state.displayId = mCreationArgs.isVirtual ? std::nullopt : mCreationArgs.displayId;
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700594 state.isSecure = mCreationArgs.isSecure;
595
596 sp<DisplayDevice> device = new DisplayDevice(std::move(mCreationArgs));
597 mFlinger.mutableDisplays().emplace(mDisplayToken, device);
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800598 mFlinger.mutableCurrentState().displays.add(mDisplayToken, state);
599 mFlinger.mutableDrawingState().displays.add(mDisplayToken, state);
600
Dominik Laskowski075d3172018-05-24 15:50:06 -0700601 if (!mCreationArgs.isVirtual) {
602 LOG_ALWAYS_FATAL_IF(!state.displayId);
603 mFlinger.mutablePhysicalDisplayTokens()[*state.displayId] = mDisplayToken;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800604 }
605
606 return device;
607 }
608
609 private:
610 TestableSurfaceFlinger& mFlinger;
611 sp<BBinder> mDisplayToken = new BBinder();
Lloyd Pique2eef1d22018-09-18 21:30:04 -0700612 DisplayDeviceCreationArgs mCreationArgs;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800613 };
614
Lloyd Pique90c115d2018-09-18 21:39:42 -0700615 surfaceflinger::test::Factory mFactory;
616 sp<SurfaceFlinger> mFlinger = new SurfaceFlinger(mFactory, SurfaceFlinger::SkipInitialization);
Dominik Laskowski7c9dbf92019-08-01 17:57:31 -0700617 TestableScheduler* mScheduler = nullptr;
Lloyd Piquec11e0d32018-01-22 18:44:59 -0800618
619 // We need to keep a reference to these so they are properly destroyed.
620 std::vector<std::unique_ptr<HWC2Display>> mFakeHwcDisplays;
Lloyd Piquef58625d2017-12-19 13:22:33 -0800621};
622
623} // namespace android