blob: b8a3baf6041cbef6b21262a95f55ba87936f7653 [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
19#include "DisplayDevice.h"
20#include "SurfaceFlinger.h"
21
22namespace android {
23
Lloyd Piquee39cad22017-12-20 17:01:29 -080024class EventThread;
25
26namespace RE {
27class RenderEngine;
28}
29
30namespace Hwc2 {
31class Composer;
32}
33
Lloyd Piquef58625d2017-12-19 13:22:33 -080034class TestableSurfaceFlinger {
35public:
36 // Extend this as needed for accessing SurfaceFlinger private (and public)
37 // functions.
38
Lloyd Piquee39cad22017-12-20 17:01:29 -080039 void setupRenderEngine(std::unique_ptr<RE::RenderEngine> renderEngine) {
40 mFlinger->getBE().mRenderEngine = std::move(renderEngine);
41 }
42
43 void setupComposer(std::unique_ptr<Hwc2::Composer> composer) {
44 mFlinger->getBE().mHwc.reset(new HWComposer(std::move(composer)));
45 }
46
Lloyd Pique5b36f3f2018-01-17 11:57:07 -080047 using CreateBufferQueueFunction = SurfaceFlinger::CreateBufferQueueFunction;
Lloyd Pique5b36f3f2018-01-17 11:57:07 -080048 void setCreateBufferQueueFunction(CreateBufferQueueFunction f) {
49 mFlinger->mCreateBufferQueue = f;
50 }
51
Lloyd Pique1fa4d462018-01-22 18:03:16 -080052 using CreateNativeWindowSurfaceFunction = SurfaceFlinger::CreateNativeWindowSurfaceFunction;
53 void setCreateNativeWindowSurface(CreateNativeWindowSurfaceFunction f) {
54 mFlinger->mCreateNativeWindowSurface = f;
55 }
56
57 using HotplugEvent = SurfaceFlinger::HotplugEvent;
58
Lloyd Piquef58625d2017-12-19 13:22:33 -080059 /* ------------------------------------------------------------------------
60 * Forwarding for functions being tested
61 */
Lloyd Pique1fa4d462018-01-22 18:03:16 -080062
Lloyd Piquea482f992018-01-22 19:00:34 -080063 auto createDisplay(const String8& displayName, bool secure) {
64 return mFlinger->createDisplay(displayName, secure);
65 }
66
67 auto destroyDisplay(const sp<IBinder>& display) { return mFlinger->destroyDisplay(display); }
68
Lloyd Piqued6fbb8a2018-01-22 19:08:36 -080069 auto resetDisplayState() { return mFlinger->resetDisplayState(); }
70
Lloyd Piquefc12f562018-01-22 18:44:59 -080071 auto setupNewDisplayDeviceInternal(const wp<IBinder>& display, int hwcId,
72 const DisplayDeviceState& state,
73 const sp<DisplaySurface>& dispSurface,
74 const sp<IGraphicBufferProducer>& producer) {
75 return mFlinger->setupNewDisplayDeviceInternal(display, hwcId, state, dispSurface,
76 producer);
77 }
78
Lloyd Pique1fa4d462018-01-22 18:03:16 -080079 auto handleTransactionLocked(uint32_t transactionFlags) {
80 return mFlinger->handleTransactionLocked(transactionFlags);
81 }
Lloyd Piquef58625d2017-12-19 13:22:33 -080082
Lloyd Pique6cf11032018-01-22 18:57:44 -080083 auto onHotplugReceived(int32_t sequenceId, hwc2_display_t display,
84 HWC2::Connection connection) {
85 return mFlinger->onHotplugReceived(sequenceId, display, connection);
86 }
87
Lloyd Piquef58625d2017-12-19 13:22:33 -080088 /* ------------------------------------------------------------------------
89 * Read-write access to private data to set up preconditions and assert
90 * post-conditions.
91 */
Lloyd Pique1fa4d462018-01-22 18:03:16 -080092
Lloyd Piquefc12f562018-01-22 18:44:59 -080093 auto& mutableHasWideColorDisplay() { return SurfaceFlinger::hasWideColorDisplay; }
94
Lloyd Piquef58625d2017-12-19 13:22:33 -080095 auto& mutableBuiltinDisplays() { return mFlinger->mBuiltinDisplays; }
Lloyd Piquee39cad22017-12-20 17:01:29 -080096 auto& mutableCurrentState() { return mFlinger->mCurrentState; }
Lloyd Pique1fa4d462018-01-22 18:03:16 -080097 auto& mutableDisplays() { return mFlinger->mDisplays; }
Lloyd Piquefc12f562018-01-22 18:44:59 -080098 auto& mutableDisplayColorSetting() { return mFlinger->mDisplayColorSetting; }
Lloyd Piquee39cad22017-12-20 17:01:29 -080099 auto& mutableDrawingState() { return mFlinger->mDrawingState; }
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800100 auto& mutableEventControlThread() { return mFlinger->mEventControlThread; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800101 auto& mutableEventQueue() { return mFlinger->mEventQueue; }
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800102 auto& mutableEventThread() { return mFlinger->mEventThread; }
Lloyd Piqued6fbb8a2018-01-22 19:08:36 -0800103 auto& mutableHWVsyncAvailable() { return mFlinger->mHWVsyncAvailable; }
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800104 auto& mutableInterceptor() { return mFlinger->mInterceptor; }
Lloyd Pique6cf11032018-01-22 18:57:44 -0800105 auto& mutableMainThreadId() { return mFlinger->mMainThreadId; }
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800106 auto& mutablePendingHotplugEvents() { return mFlinger->mPendingHotplugEvents; }
Lloyd Piqued6fbb8a2018-01-22 19:08:36 -0800107 auto& mutablePrimaryHWVsyncEnabled() { return mFlinger->mPrimaryHWVsyncEnabled; }
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800108 auto& mutableTransactionFlags() { return mFlinger->mTransactionFlags; }
Lloyd Piquefc12f562018-01-22 18:44:59 -0800109 auto& mutableUseHwcVirtualDisplays() { return mFlinger->mUseHwcVirtualDisplays; }
Lloyd Piquee39cad22017-12-20 17:01:29 -0800110
Lloyd Pique6cf11032018-01-22 18:57:44 -0800111 auto& mutableComposerSequenceId() { return mFlinger->getBE().mComposerSequenceId; }
Lloyd Piquebc792092018-01-17 11:52:30 -0800112 auto& mutableHwcDisplayData() { return mFlinger->getBE().mHwc->mDisplayData; }
113 auto& mutableHwcDisplaySlots() { return mFlinger->getBE().mHwc->mHwcDisplaySlots; }
114
Lloyd Piquee39cad22017-12-20 17:01:29 -0800115 ~TestableSurfaceFlinger() {
116 // All these pointer and container clears help ensure that GMock does
117 // not report a leaked object, since the SurfaceFlinger instance may
118 // still be referenced by something despite our best efforts to destroy
119 // it after each test is done.
120 mutableDisplays().clear();
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800121 mutableEventControlThread().reset();
122 mutableEventQueue().reset();
Lloyd Piquee39cad22017-12-20 17:01:29 -0800123 mutableEventThread().reset();
Lloyd Pique1fa4d462018-01-22 18:03:16 -0800124 mutableInterceptor().reset();
Lloyd Piquee39cad22017-12-20 17:01:29 -0800125 mFlinger->getBE().mHwc.reset();
126 mFlinger->getBE().mRenderEngine.reset();
127 }
Lloyd Piquef58625d2017-12-19 13:22:33 -0800128
Lloyd Piquebc792092018-01-17 11:52:30 -0800129 /* ------------------------------------------------------------------------
130 * Wrapper classes for Read-write access to private data to set up
131 * preconditions and assert post-conditions.
132 */
Lloyd Piquefc12f562018-01-22 18:44:59 -0800133
Lloyd Piquebc792092018-01-17 11:52:30 -0800134 struct HWC2Display : public HWC2::Display {
135 HWC2Display(Hwc2::Composer& composer,
136 const std::unordered_set<HWC2::Capability>& capabilities, hwc2_display_t id,
137 HWC2::DisplayType type)
138 : HWC2::Display(composer, capabilities, id, type) {}
139 ~HWC2Display() {
140 // Prevents a call to disable vsyncs.
141 mType = HWC2::DisplayType::Invalid;
142 }
143
144 auto& mutableIsConnected() { return this->mIsConnected; }
145 auto& mutableConfigs() { return this->mConfigs; }
146 };
147
Lloyd Piquefc12f562018-01-22 18:44:59 -0800148 class FakeHwcDisplayInjector {
149 public:
150 static constexpr hwc2_display_t DEFAULT_HWC_DISPLAY_ID = 1000;
151 static constexpr int32_t DEFAULT_WIDTH = 1920;
152 static constexpr int32_t DEFAULT_HEIGHT = 1280;
153 static constexpr int32_t DEFAULT_REFRESH_RATE = 16'666'666;
154 static constexpr int32_t DEFAULT_DPI = 320;
155 static constexpr int32_t DEFAULT_ACTIVE_CONFIG = 0;
156
157 FakeHwcDisplayInjector(DisplayDevice::DisplayType type, HWC2::DisplayType hwcDisplayType)
158 : mType(type), mHwcDisplayType(hwcDisplayType) {}
159
160 auto& setHwcDisplayId(hwc2_display_t displayId) {
161 mHwcDisplayId = displayId;
162 return *this;
163 }
164
165 auto& setWidth(int32_t width) {
166 mWidth = width;
167 return *this;
168 }
169
170 auto& setHeight(int32_t height) {
171 mHeight = height;
172 return *this;
173 }
174
175 auto& setRefreshRate(int32_t refreshRate) {
176 mRefreshRate = refreshRate;
177 return *this;
178 }
179
180 auto& setDpiX(int32_t dpi) {
181 mDpiX = dpi;
182 return *this;
183 }
184
185 auto& setDpiY(int32_t dpi) {
186 mDpiY = dpi;
187 return *this;
188 }
189
190 auto& setActiveConfig(int32_t config) {
191 mActiveConfig = config;
192 return *this;
193 }
194
195 auto& addCapability(HWC2::Capability cap) {
196 mCapabilities.emplace(cap);
197 return *this;
198 }
199
200 void inject(TestableSurfaceFlinger* flinger, Hwc2::Composer* composer) {
201 auto display = std::make_unique<HWC2Display>(*composer, mCapabilities, mHwcDisplayId,
202 mHwcDisplayType);
203
204 auto config = HWC2::Display::Config::Builder(*display, mActiveConfig);
205 config.setWidth(mWidth);
206 config.setHeight(mHeight);
207 config.setVsyncPeriod(mRefreshRate);
208 config.setDpiX(mDpiX);
209 config.setDpiY(mDpiY);
210 display->mutableConfigs().emplace(mActiveConfig, config.build());
211 display->mutableIsConnected() = true;
212
213 ASSERT_TRUE(flinger->mutableHwcDisplayData().size() > static_cast<size_t>(mType));
214 flinger->mutableHwcDisplayData()[mType].reset();
215 flinger->mutableHwcDisplayData()[mType].hwcDisplay = display.get();
216 flinger->mutableHwcDisplaySlots().emplace(mHwcDisplayId, mType);
217
218 flinger->mFakeHwcDisplays.push_back(std::move(display));
219 }
220
221 private:
222 DisplayDevice::DisplayType mType;
223 HWC2::DisplayType mHwcDisplayType;
224 hwc2_display_t mHwcDisplayId = DEFAULT_HWC_DISPLAY_ID;
225 int32_t mWidth = DEFAULT_WIDTH;
226 int32_t mHeight = DEFAULT_HEIGHT;
227 int32_t mRefreshRate = DEFAULT_REFRESH_RATE;
228 int32_t mDpiX = DEFAULT_DPI;
229 int32_t mDpiY = DEFAULT_DPI;
230 int32_t mActiveConfig = DEFAULT_ACTIVE_CONFIG;
231 std::unordered_set<HWC2::Capability> mCapabilities;
232 };
233
234 class FakeDisplayDeviceInjector {
235 public:
236 FakeDisplayDeviceInjector(TestableSurfaceFlinger& flinger, DisplayDevice::DisplayType type,
237 int hwcId)
238 : mFlinger(flinger), mType(type), mHwcId(hwcId) {}
239
240 sp<IBinder> token() const { return mDisplayToken; }
241
242 DisplayDeviceState& mutableDrawingDisplayState() {
243 return mFlinger.mutableDrawingState().displays.editValueFor(mDisplayToken);
244 }
245
246 DisplayDeviceState& mutableCurrentDisplayState() {
247 return mFlinger.mutableCurrentState().displays.editValueFor(mDisplayToken);
248 }
249
250 auto& setNativeWindow(const sp<ANativeWindow>& nativeWindow) {
251 mNativeWindow = nativeWindow;
252 return *this;
253 }
254
255 auto& setDisplaySurface(const sp<DisplaySurface>& displaySurface) {
256 mDisplaySurface = displaySurface;
257 return *this;
258 }
259
260 auto& setRenderSurface(std::unique_ptr<RE::Surface> renderSurface) {
261 mRenderSurface = std::move(renderSurface);
262 return *this;
263 }
264
265 auto& setSecure(bool secure) {
266 mSecure = secure;
267 return *this;
268 }
269
270 sp<DisplayDevice> inject() {
271 sp<DisplayDevice> device =
272 new DisplayDevice(mFlinger.mFlinger.get(), mType, mHwcId, mSecure, mDisplayToken,
273 mNativeWindow, mDisplaySurface, std::move(mRenderSurface), 0,
274 0, false, HdrCapabilities(), 0, HWC_POWER_MODE_NORMAL);
275 mFlinger.mutableDisplays().add(mDisplayToken, device);
276
277 DisplayDeviceState state(mType, mSecure);
278 mFlinger.mutableCurrentState().displays.add(mDisplayToken, state);
279 mFlinger.mutableDrawingState().displays.add(mDisplayToken, state);
280
281 if (mType < DisplayDevice::DISPLAY_VIRTUAL) {
282 mFlinger.mutableBuiltinDisplays()[mType] = mDisplayToken;
283 }
284
285 return device;
286 }
287
288 private:
289 TestableSurfaceFlinger& mFlinger;
290 sp<BBinder> mDisplayToken = new BBinder();
291 DisplayDevice::DisplayType mType;
292 int mHwcId;
293 sp<ANativeWindow> mNativeWindow;
294 sp<DisplaySurface> mDisplaySurface;
295 std::unique_ptr<RE::Surface> mRenderSurface;
296 bool mSecure = false;
297 };
298
Lloyd Pique2d3ee6d2018-01-17 13:42:24 -0800299 sp<SurfaceFlinger> mFlinger = new SurfaceFlinger(SurfaceFlinger::SkipInitialization);
Lloyd Piquefc12f562018-01-22 18:44:59 -0800300
301 // We need to keep a reference to these so they are properly destroyed.
302 std::vector<std::unique_ptr<HWC2Display>> mFakeHwcDisplays;
Lloyd Piquef58625d2017-12-19 13:22:33 -0800303};
304
305} // namespace android