blob: d9de07b3598052005f4fcd32f7dffdd0abdb7ac1 [file] [log] [blame]
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 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
Dominik Laskowski9dab3432019-03-27 13:21:10 -070017#pragma once
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080018
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080019#include <sys/types.h>
20
Mathias Agopian3f844832013-08-07 21:24:32 -070021/*
22 * NOTE: Make sure this file doesn't include anything from <gl/ > or <gl2/ >
23 */
Mathias Agopian921e6ac2012-07-23 23:11:29 -070024
Dominik Laskowski83b88212018-12-11 13:34:06 -080025#include <android-base/thread_annotations.h>
Steven Moreland2716e112018-02-23 14:57:20 -080026#include <cutils/atomic.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080027#include <cutils/compiler.h>
28#include <gui/BufferQueue.h>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080029#include <gui/FrameTimestamps.h>
Mathias Agopian90ac7992012-02-25 18:48:35 -080030#include <gui/ISurfaceComposer.h>
31#include <gui/ISurfaceComposerClient.h>
Robert Carr4cdc58f2017-08-23 14:22:20 -070032#include <gui/LayerState.h>
Dan Stozae77c7662016-05-13 11:37:28 -070033#include <gui/OccupancyTracker.h>
Mathias Agopian86303202012-07-24 22:46:10 -070034#include <hardware/hwcomposer_defs.h>
chaviw291d88a2019-02-14 10:33:58 -080035#include <input/ISetInputWindowsListener.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080036#include <layerproto/LayerProtoHeader.h>
37#include <math/mat4.h>
Vishnu Nair35798872017-10-06 16:00:36 -070038#include <serviceutils/PriorityDumper.h>
Michael Wright28f24d02016-07-12 13:30:53 -070039#include <system/graphics.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080040#include <ui/FenceTime.h>
41#include <ui/PixelFormat.h>
42#include <utils/Errors.h>
43#include <utils/KeyedVector.h>
44#include <utils/RefBase.h>
45#include <utils/SortedVector.h>
46#include <utils/Trace.h>
47#include <utils/threads.h>
Michael Wright28f24d02016-07-12 13:30:53 -070048
Marissa Wall947d34e2019-03-29 14:03:53 -070049#include "ClientCache.h"
Mathias Agopian92a979a2012-08-02 18:32:23 -070050#include "DisplayDevice.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080051#include "DisplayHardware/HWC2.h"
Peiyong Lin74ca2f42019-01-14 19:36:57 -080052#include "DisplayHardware/PowerAdvisor.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080053#include "Effects/Daltonizer.h"
Jamie Gennis4b0eba92013-02-05 13:30:24 -080054#include "FrameTracker.h"
Yiwei Zhang7124ad32018-02-21 13:02:45 -080055#include "LayerStats.h"
Robert Carr2047fae2016-11-28 14:09:09 -080056#include "LayerVector.h"
Dominik Laskowskiccf37d72019-02-01 16:47:58 -080057#include "Scheduler/RefreshRateConfigs.h"
Ana Krulecb43429d2019-01-09 14:28:51 -080058#include "Scheduler/RefreshRateStats.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070059#include "Scheduler/Scheduler.h"
Ana Krulecfefcb582018-08-07 14:22:37 -070060#include "Scheduler/VSyncModulator.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080061#include "SurfaceFlingerFactory.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080062#include "SurfaceTracing.h"
63#include "TransactionCompletedThread.h"
Mathias Agopian86303202012-07-24 22:46:10 -070064
Dominik Laskowski83b88212018-12-11 13:34:06 -080065#include <atomic>
66#include <cstdint>
Dominik Laskowskic2867142019-01-21 11:33:38 -080067#include <functional>
Dan Stozae77c7662016-05-13 11:37:28 -070068#include <map>
Dominik Laskowski83b88212018-12-11 13:34:06 -080069#include <memory>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080070#include <mutex>
71#include <queue>
Dominik Laskowski075d3172018-05-24 15:50:06 -070072#include <set>
Dan Stozae77c7662016-05-13 11:37:28 -070073#include <string>
Steven Thomasb02664d2017-07-26 18:48:28 -070074#include <thread>
Dominik Laskowskic2867142019-01-21 11:33:38 -080075#include <type_traits>
Dominik Laskowski075d3172018-05-24 15:50:06 -070076#include <unordered_map>
Dominik Laskowski22488f62019-03-28 09:53:04 -070077#include <unordered_set>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080078#include <utility>
Dan Stozae77c7662016-05-13 11:37:28 -070079
chaviw1d044282017-09-27 12:19:28 -070080using namespace android::surfaceflinger;
81
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080082namespace android {
83
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080084class Client;
Lloyd Pique144e1162017-12-20 16:44:52 -080085class EventThread;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070086class HWComposer;
Lloyd Pique12eb4232018-01-17 11:54:43 -080087class IGraphicBufferProducer;
Robert Carr720e5062018-07-30 17:45:14 -070088class IInputFlinger;
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -070089class InjectVSyncSource;
Lloyd Pique144e1162017-12-20 16:44:52 -080090class Layer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070091class MessageBase;
Ady Abraham03b02dd2019-03-21 15:40:11 -070092class RefreshRateOverlay;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070093class RegionSamplingThread;
Yiwei Zhang7e666a52018-11-15 13:33:42 -080094class TimeStats;
Lloyd Pique144e1162017-12-20 16:44:52 -080095
Lloyd Pique542307f2018-10-19 13:24:08 -070096namespace compositionengine {
97class DisplaySurface;
98} // namespace compositionengine
99
Peiyong Lin833074a2018-08-28 11:53:54 -0700100namespace renderengine {
Lloyd Pique144e1162017-12-20 16:44:52 -0800101class RenderEngine;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700102} // namespace renderengine
chaviwa76b2712017-09-20 12:02:26 -0700103
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800104namespace dvr {
105class VrFlinger;
106} // namespace dvr
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800107
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800108enum {
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700109 eTransactionNeeded = 0x01,
110 eTraversalNeeded = 0x02,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700111 eDisplayTransactionNeeded = 0x04,
Lloyd Piqued432a7c2018-03-23 16:05:31 -0700112 eDisplayLayerStackChanged = 0x08,
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700113 eTransactionFlushNeeded = 0x10,
114 eTransactionMask = 0x1f,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800115};
116
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800117enum class DisplayColorSetting : int32_t {
118 MANAGED = 0,
119 UNMANAGED = 1,
120 ENHANCED = 2,
121};
122
David Sodman105b7dc2017-11-04 20:28:14 -0700123class SurfaceFlingerBE
124{
125public:
126 SurfaceFlingerBE();
127
David Sodmanbc815282017-11-05 18:57:52 -0800128 const std::string mHwcServiceName; // "default" for real use, something else for testing.
129
David Sodman73beded2017-11-15 11:56:06 -0800130 FenceTimeline mGlCompositionDoneTimeline;
131 FenceTimeline mDisplayTimeline;
David Sodmanbc815282017-11-05 18:57:52 -0800132
David Sodman99974d22017-11-28 12:04:33 -0800133 // protected by mCompositorTimingLock;
134 mutable std::mutex mCompositorTimingLock;
135 CompositorTiming mCompositorTiming;
Lloyd Piquefcd86612017-12-14 17:15:36 -0800136
David Sodman99974d22017-11-28 12:04:33 -0800137 // Only accessed from the main thread.
138 struct CompositePresentTime {
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700139 nsecs_t composite = -1;
140 std::shared_ptr<FenceTime> display = FenceTime::NO_FENCE;
David Sodman99974d22017-11-28 12:04:33 -0800141 };
142 std::queue<CompositePresentTime> mCompositePresentTimes;
143
David Sodman4a36e932017-11-07 14:29:47 -0800144 static const size_t NUM_BUCKETS = 8; // < 1-7, 7+
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700145 nsecs_t mFrameBuckets[NUM_BUCKETS] = {};
146 nsecs_t mTotalTime = 0;
147 std::atomic<nsecs_t> mLastSwapTime = 0;
David Sodman4a36e932017-11-07 14:29:47 -0800148
David Sodmancbaf0832017-11-07 14:21:36 -0800149 // Double- vs. triple-buffering stats
150 struct BufferingStats {
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700151 size_t numSegments = 0;
152 nsecs_t totalTime = 0;
David Sodmancbaf0832017-11-07 14:21:36 -0800153
154 // "Two buffer" means that a third buffer was never used, whereas
155 // "double-buffered" means that on average the segment only used two
156 // buffers (though it may have used a third for some part of the
157 // segment)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700158 nsecs_t twoBufferTime = 0;
159 nsecs_t doubleBufferedTime = 0;
160 nsecs_t tripleBufferedTime = 0;
David Sodmancbaf0832017-11-07 14:21:36 -0800161 };
162 mutable Mutex mBufferingStatsMutex;
163 std::unordered_map<std::string, BufferingStats> mBufferingStats;
164
David Sodman105b7dc2017-11-04 20:28:14 -0700165 // The composer sequence id is a monotonically increasing integer that we
166 // use to differentiate callbacks from different hardware composer
167 // instances. Each hardware composer instance gets a different sequence id.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700168 int32_t mComposerSequenceId = 0;
chaviw291d88a2019-02-14 10:33:58 -0800169};
David Sodman105b7dc2017-11-04 20:28:14 -0700170
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700171class SurfaceFlinger : public BnSurfaceComposer,
Vishnu Nair35798872017-10-06 16:00:36 -0700172 public PriorityDumper,
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700173 private IBinder::DeathRecipient,
Steven Thomasb02664d2017-07-26 18:48:28 -0700174 private HWC2::ComposerCallback
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800175{
176public:
David Sodman105b7dc2017-11-04 20:28:14 -0700177 SurfaceFlingerBE& getBE() { return mBE; }
178 const SurfaceFlingerBE& getBE() const { return mBE; }
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800179
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800180 // This is the phase offset in nanoseconds of the software vsync event
181 // relative to the vsync event reported by HWComposer. The software vsync
182 // event is when SurfaceFlinger and Choreographer-based applications run each
183 // frame.
184 //
185 // This phase offset allows adjustment of the minimum latency from application
186 // wake-up time (by Choreographer) to the time at which the resulting window
187 // image is displayed. This value may be either positive (after the HW vsync)
188 // or negative (before the HW vsync). Setting it to 0 will result in a lower
189 // latency bound of two vsync periods because the app and SurfaceFlinger
190 // will run just after the HW vsync. Setting it to a positive number will
191 // result in the minimum latency being:
192 //
193 // (2 * VSYNC_PERIOD - (vsyncPhaseOffsetNs % VSYNC_PERIOD))
194 //
195 // Note that reducing this latency makes it more likely for the applications
196 // to not have their window content image ready in time. When this happens
197 // the latency will end up being an additional vsync period, and animations
198 // will hiccup. Therefore, this latency should be tuned somewhat
199 // conservatively (or at least with awareness of the trade-off being made).
200 static int64_t vsyncPhaseOffsetNs;
201 static int64_t sfVsyncPhaseOffsetNs;
202
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800203 // If fences from sync Framework are supported.
204 static bool hasSyncFramework;
205
Fabien Sanglardc45a7d92017-03-14 13:24:22 -0700206 // The offset in nanoseconds to use when DispSync timestamps present fence
207 // signaling time.
208 static int64_t dispSyncPresentTimeOffset;
209
Fabien Sanglarda34ed632017-03-14 11:43:52 -0700210 // Some hardware can do RGB->YUV conversion more efficiently in hardware
211 // controlled by HWC than in hardware controlled by the video encoder.
212 // This instruct VirtualDisplaySurface to use HWC for such conversion on
213 // GL composition.
214 static bool useHwcForRgbToYuv;
215
Fabien Sanglardc8e387e2017-03-10 10:30:28 -0800216 // Maximum dimension supported by HWC for virtual display.
217 // Equal to min(max_height, max_width).
218 static uint64_t maxVirtualDisplaySize;
219
Fabien Sanglard1971b632017-03-10 14:50:03 -0800220 // Controls the number of buffers SurfaceFlinger will allocate for use in
221 // FramebufferSurface
222 static int64_t maxFrameBufferAcquiredBuffers;
223
Peiyong Lin13effd12018-07-24 17:01:47 -0700224 // Indicate if a device has wide color gamut display. This is typically
225 // found on devices with wide color gamut (e.g. Display-P3) display.
Courtney Goeltzenleuchter5d943892017-03-22 13:46:46 -0600226 static bool hasWideColorDisplay;
227
Chia-I Wu304d9cd2018-08-27 14:38:14 -0700228 static int primaryDisplayOrientation;
229
Peiyong Lin13effd12018-07-24 17:01:47 -0700230 // Indicate if device wants color management on its display.
231 static bool useColorManagement;
232
Peiyong Linb3839ad2018-09-05 15:37:19 -0700233 static bool useContextPriority;
234
Peiyong Lin0256f722018-08-31 15:45:10 -0700235 // The data space and pixel format that SurfaceFlinger expects hardware composer
236 // to composite efficiently. Meaning under most scenarios, hardware composer
237 // will accept layers with the data space and pixel format.
Peiyong Linc6780972018-10-28 15:24:08 -0700238 static ui::Dataspace defaultCompositionDataspace;
239 static ui::PixelFormat defaultCompositionPixelFormat;
240
241 // The data space and pixel format that SurfaceFlinger expects hardware composer
242 // to composite efficiently for wide color gamut surfaces. Meaning under most scenarios,
243 // hardware composer will accept layers with the data space and pixel format.
244 static ui::Dataspace wideColorGamutCompositionDataspace;
245 static ui::PixelFormat wideColorGamutCompositionPixelFormat;
Peiyong Lin0256f722018-08-31 15:45:10 -0700246
Mathias Agopianb6df7d02013-05-09 14:53:35 -0700247 static char const* getServiceName() ANDROID_API {
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700248 return "SurfaceFlinger";
249 }
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800250
Lloyd Piqueac648ee2018-01-17 13:42:24 -0800251 struct SkipInitializationTag {};
252 static constexpr SkipInitializationTag SkipInitialization;
Lloyd Pique90c115d2018-09-18 21:39:42 -0700253 SurfaceFlinger(surfaceflinger::Factory&, SkipInitializationTag) ANDROID_API;
254 explicit SurfaceFlinger(surfaceflinger::Factory&) ANDROID_API;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800255
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700256 // must be called before clients can connect
257 void init() ANDROID_API;
258
259 // starts SurfaceFlinger main loop in the current thread
260 void run() ANDROID_API;
261
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700262 // post an asynchronous message to the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700263 status_t postMessageAsync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800264
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700265 // post a synchronous message to the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700266 status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800267
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700268 // force full composition on all displays
269 void repaintEverything();
Mathias Agopianbf2c6a62010-12-10 16:22:31 -0800270
Ana Krulec7d1d6832018-12-27 11:10:09 -0800271 // force full composition on all displays without resetting the scheduler idle timer.
272 void repaintEverythingForHWC();
273
Lloyd Pique90c115d2018-09-18 21:39:42 -0700274 surfaceflinger::Factory& getFactory() { return mFactory; }
275
Lloyd Pique70d91362018-10-18 16:02:55 -0700276 // The CompositionEngine encapsulates all composition related interfaces and actions.
277 compositionengine::CompositionEngine& getCompositionEngine() const;
278
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700279 // returns the default Display
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800280 sp<const DisplayDevice> getDefaultDisplayDevice() {
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700281 Mutex::Autolock _l(mStateLock);
282 return getDefaultDisplayDeviceLocked();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700283 }
Mathias Agopianb60314a2012-04-10 22:09:54 -0700284
Dan Stoza436ccf32018-06-21 12:10:12 -0700285 // Obtains a name from the texture pool, or, if the pool is empty, posts a
286 // synchronous message to the main thread to obtain one on the fly
287 uint32_t getNewTexture();
288
Mathias Agopian86303202012-07-24 22:46:10 -0700289 // utility function to delete a texture on the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700290 void deleteTextureAsync(uint32_t texture);
Mathias Agopian86303202012-07-24 22:46:10 -0700291
Mathias Agopian86303202012-07-24 22:46:10 -0700292 // enable/disable h/w composer event
293 // TODO: this should be made accessible only to EventThread
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800294 void setPrimaryVsyncEnabled(bool enabled);
Mathias Agopian86303202012-07-24 22:46:10 -0700295
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700296 // called on the main thread by MessageQueue when an internal message
297 // is received
298 // TODO: this should be made accessible only to MessageQueue
299 void onMessageReceived(int32_t what);
Mathias Agopian3094df32012-06-18 18:06:45 -0700300
Mathias Agopiancb558572012-10-04 15:58:54 -0700301 // for debugging only
302 // TODO: this should be made accessible only to HWComposer
Dominik Laskowski075d3172018-05-24 15:50:06 -0700303 const Vector<sp<Layer>>& getLayerSortedByZForHwcDisplay(DisplayId displayId);
Mathias Agopiancb558572012-10-04 15:58:54 -0700304
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700305 renderengine::RenderEngine& getRenderEngine() const;
Jesse Hall29c3f352013-05-21 15:36:55 -0700306
Robert Carr0d480722017-01-10 16:42:54 -0800307 bool authenticateSurfaceTextureLocked(
308 const sp<IGraphicBufferProducer>& bufferProducer) const;
309
Robert Carr2e102c92018-10-23 12:11:15 -0700310 inline void onLayerCreated() { mNumLayers++; }
chaviw74d90ad2019-04-26 14:45:26 -0700311 inline void onLayerDestroyed(Layer* layer) {
312 mNumLayers--;
313 mOffscreenLayers.erase(layer);
314 }
Robert Carr2e102c92018-10-23 12:11:15 -0700315
Marissa Walle2ffb422018-10-12 11:33:52 -0700316 TransactionCompletedThread& getTransactionCompletedThread() {
317 return mTransactionCompletedThread;
318 }
319
Robert Carrc0df3122019-04-11 13:18:21 -0700320 sp<Layer> fromHandle(const sp<IBinder>& handle) REQUIRES(mStateLock);
321
Mathias Agopian1f339ff2011-07-01 17:08:43 -0700322private:
David Sodman0c69cad2017-08-21 12:12:51 -0700323 friend class BufferLayer;
Marissa Wallfd668622018-05-10 10:21:13 -0700324 friend class BufferQueueLayer;
Marissa Wall61c58622018-07-18 10:12:20 -0700325 friend class BufferStateLayer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700326 friend class Client;
327 friend class Layer;
Dan Stozab9b08832014-03-13 11:55:57 -0700328 friend class MonitoredProducer;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700329 friend class RefreshRateOverlay;
Dan Stozaec460082018-12-17 15:35:09 -0800330 friend class RegionSamplingThread;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800331 friend class SurfaceTracing;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800332
Lloyd Piquef58625d2017-12-19 13:22:33 -0800333 // For unit tests
334 friend class TestableSurfaceFlinger;
335
Jamie Gennis6547ff42013-07-16 20:12:42 -0700336 // This value is specified in number of frames. Log frame stats at most
337 // every half hour.
338 enum { LOG_FRAME_STATS_PERIOD = 30*60*60 };
339
Dan Stoza7d89d062015-04-30 13:29:25 -0700340 static const size_t MAX_LAYERS = 4096;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800341 static const int MAX_TRACING_MEMORY = 100 * 1024 * 1024; // 100MB
Dan Stoza7d89d062015-04-30 13:29:25 -0700342
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700343 // We're reference counted, never destroy SurfaceFlinger directly
344 virtual ~SurfaceFlinger();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800345
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700346 /* ------------------------------------------------------------------------
347 * Internal data structures
348 */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800349
Robert Carr2047fae2016-11-28 14:09:09 -0800350 class State {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800351 public:
chaviwfd462612018-05-31 16:11:27 -0700352 explicit State(LayerVector::StateSet set) : stateSet(set), layersSortedByZ(set) {}
Dan Stoza412903f2017-04-27 13:42:17 -0700353 State& operator=(const State& other) {
354 // We explicitly don't copy stateSet so that, e.g., mDrawingState
355 // always uses the Drawing StateSet.
356 layersSortedByZ = other.layersSortedByZ;
357 displays = other.displays;
Chia-I Wu28f320b2018-05-03 11:02:56 -0700358 colorMatrixChanged = other.colorMatrixChanged;
359 if (colorMatrixChanged) {
360 colorMatrix = other.colorMatrix;
361 }
Dan Stoza412903f2017-04-27 13:42:17 -0700362 return *this;
363 }
364
365 const LayerVector::StateSet stateSet = LayerVector::StateSet::Invalid;
Mathias Agopian92a979a2012-08-02 18:32:23 -0700366 LayerVector layersSortedByZ;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700367 DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays;
Robert Carr2047fae2016-11-28 14:09:09 -0800368
Chia-I Wu28f320b2018-05-03 11:02:56 -0700369 bool colorMatrixChanged = true;
370 mat4 colorMatrix;
371
Dan Stoza412903f2017-04-27 13:42:17 -0700372 void traverseInZOrder(const LayerVector::Visitor& visitor) const;
373 void traverseInReverseZOrder(const LayerVector::Visitor& visitor) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800374 };
375
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700376 /* ------------------------------------------------------------------------
377 * IBinder interface
378 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800379 status_t onTransact(uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags) override;
380 status_t dump(int fd, const Vector<String16>& args) override { return priorityDump(fd, args); }
Robert Carr14167e02019-02-13 13:50:55 -0800381 bool callingThreadHasUnscopedSurfaceFlingerAccess() EXCLUDES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800382
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700383 /* ------------------------------------------------------------------------
384 * ISurfaceComposer interface
385 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800386 sp<ISurfaceComposerClient> createConnection() override;
387 sp<IBinder> createDisplay(const String8& displayName, bool secure) override;
388 void destroyDisplay(const sp<IBinder>& displayToken) override;
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800389 std::vector<PhysicalDisplayId> getPhysicalDisplayIds() const override;
390 sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800391 void setTransactionState(const Vector<ComposerState>& state,
392 const Vector<DisplayState>& displays, uint32_t flags,
393 const sp<IBinder>& applyToken,
Marissa Wall17b4e452018-12-26 16:32:34 -0800394 const InputWindowCommands& inputWindowCommands,
Marissa Wall947d34e2019-03-29 14:03:53 -0700395 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700396 const std::vector<ListenerCallbacks>& listenerCallbacks) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800397 void bootFinished() override;
398 bool authenticateSurfaceTexture(
399 const sp<IGraphicBufferProducer>& bufferProducer) const override;
400 status_t getSupportedFrameTimestamps(std::vector<FrameEvent>* outSupported) const override;
401 sp<IDisplayEventConnection> createDisplayEventConnection(
402 ISurfaceComposer::VsyncSource vsyncSource = eVsyncSourceApp) override;
403 status_t captureScreen(const sp<IBinder>& displayToken, sp<GraphicBuffer>* outBuffer,
Robert Carr108b2c72019-04-02 16:32:58 -0700404 bool& outCapturedSecureLayers, const ui::Dataspace reqDataspace,
405 const ui::PixelFormat reqPixelFormat, Rect sourceCrop,
406 uint32_t reqWidth, uint32_t reqHeight,
407 bool useIdentityTransform, ISurfaceComposer::Rotation rotation, bool captureSecureLayers) override;
chaviw93df2ea2019-04-30 16:45:12 -0700408 status_t captureScreen(uint64_t displayOrLayerStack, ui::Dataspace* outDataspace,
409 sp<GraphicBuffer>* outBuffer) override;
Robert Carr866455f2019-04-02 16:28:26 -0700410 status_t captureLayers(
411 const sp<IBinder>& parentHandle, sp<GraphicBuffer>* outBuffer,
412 const ui::Dataspace reqDataspace, const ui::PixelFormat reqPixelFormat,
413 const Rect& sourceCrop,
414 const std::unordered_set<sp<IBinder>, ISurfaceComposer::SpHash<IBinder>>& exclude,
415 float frameScale, bool childrenOnly) override;
Robert Carr108b2c72019-04-02 16:32:58 -0700416
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800417 status_t getDisplayStats(const sp<IBinder>& displayToken, DisplayStatInfo* stats) override;
418 status_t getDisplayConfigs(const sp<IBinder>& displayToken,
Dominik Laskowski22488f62019-03-28 09:53:04 -0700419 Vector<DisplayInfo>* configs) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800420 int getActiveConfig(const sp<IBinder>& displayToken) override;
421 status_t getDisplayColorModes(const sp<IBinder>& displayToken,
422 Vector<ui::ColorMode>* configs) override;
Daniel Solomon42d04562019-01-20 21:03:19 -0800423 status_t getDisplayNativePrimaries(const sp<IBinder>& displayToken,
424 ui::DisplayPrimaries &primaries);
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800425 ui::ColorMode getActiveColorMode(const sp<IBinder>& displayToken) override;
426 status_t setActiveColorMode(const sp<IBinder>& displayToken, ui::ColorMode colorMode) override;
427 void setPowerMode(const sp<IBinder>& displayToken, int mode) override;
428 status_t setActiveConfig(const sp<IBinder>& displayToken, int id) override;
429 status_t clearAnimationFrameStats() override;
430 status_t getAnimationFrameStats(FrameStats* outStats) const override;
431 status_t getHdrCapabilities(const sp<IBinder>& displayToken,
432 HdrCapabilities* outCapabilities) const override;
433 status_t enableVSyncInjections(bool enable) override;
434 status_t injectVSync(nsecs_t when) override;
435 status_t getLayerDebugInfo(std::vector<LayerDebugInfo>* outLayers) const override;
436 status_t getColorManagement(bool* outGetColorManagement) const override;
Peiyong Linc6780972018-10-28 15:24:08 -0700437 status_t getCompositionPreference(ui::Dataspace* outDataspace, ui::PixelFormat* outPixelFormat,
438 ui::Dataspace* outWideColorGamutDataspace,
439 ui::PixelFormat* outWideColorGamutPixelFormat) const override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800440 status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
441 ui::PixelFormat* outFormat,
442 ui::Dataspace* outDataspace,
443 uint8_t* outComponentMask) const override;
444 status_t setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
445 uint8_t componentMask,
446 uint64_t maxFrames) const override;
447 status_t getDisplayedContentSample(const sp<IBinder>& display, uint64_t maxFrames,
448 uint64_t timestamp,
449 DisplayedFrameStats* outStats) const override;
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800450 status_t getProtectedContentSupport(bool* outSupported) const override;
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800451 status_t isWideColorDisplay(const sp<IBinder>& displayToken,
452 bool* outIsWideColorDisplay) const override;
Dan Stoza84ab9372018-12-17 15:27:57 -0800453 status_t addRegionSamplingListener(const Rect& samplingArea, const sp<IBinder>& stopLayerHandle,
454 const sp<IRegionSamplingListener>& listener) override;
455 status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener) override;
Ady Abraham838de062019-02-04 10:24:03 -0800456 status_t setAllowedDisplayConfigs(const sp<IBinder>& displayToken,
457 const std::vector<int32_t>& allowedConfigs) override;
Ady Abrahamd9b3ea62019-02-26 14:08:03 -0800458 status_t getAllowedDisplayConfigs(const sp<IBinder>& displayToken,
459 std::vector<int32_t>* outAllowedConfigs) override;
Dan Gittik57e63c52019-01-18 16:37:54 +0000460 status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
461 bool* outSupport) const override;
462 status_t setDisplayBrightness(const sp<IBinder>& displayToken, float brightness) const override;
Ady Abraham838de062019-02-04 10:24:03 -0800463
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700464 /* ------------------------------------------------------------------------
465 * DeathRecipient interface
466 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800467 void binderDied(const wp<IBinder>& who) override;
Mathias Agopian99ce5cd2012-01-31 18:24:27 -0800468
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700469 /* ------------------------------------------------------------------------
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700470 * RefBase interface
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700471 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800472 void onFirstRef() override;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800473
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700474 /* ------------------------------------------------------------------------
Steven Thomasb02664d2017-07-26 18:48:28 -0700475 * HWC2::ComposerCallback / HWComposer::EventHandler interface
Mathias Agopian86303202012-07-24 22:46:10 -0700476 */
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700477 void onVsyncReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId,
Steven Thomasb02664d2017-07-26 18:48:28 -0700478 int64_t timestamp) override;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700479 void onHotplugReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId,
Lloyd Pique715a2c12017-12-14 17:18:08 -0800480 HWC2::Connection connection) override;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700481 void onRefreshReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId) override;
Mathias Agopian86303202012-07-24 22:46:10 -0700482
483 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700484 * Message handling
485 */
486 void waitForEvent();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700487 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700488 void signalTransaction();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700489 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700490 void signalLayerUpdate();
491 void signalRefresh();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800492
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700493 using RefreshRateType = scheduler::RefreshRateConfigs::RefreshRateType;
494
Ady Abraham03b02dd2019-03-21 15:40:11 -0700495 struct ActiveConfigInfo {
496 RefreshRateType type;
497 int configId;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700498 Scheduler::ConfigEvent event;
499
500 bool operator!=(const ActiveConfigInfo& other) const {
Dominik Laskowski22488f62019-03-28 09:53:04 -0700501 return type != other.type || configId != other.configId || event != other.event;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700502 }
503 };
504
Andy McFadden13a082e2012-08-24 10:16:42 -0700505 // called on the main thread in response to initializeDisplays()
Dominik Laskowski83b88212018-12-11 13:34:06 -0800506 void onInitializeDisplays() REQUIRES(mStateLock);
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800507 // Sets the desired active config bit. It obtains the lock, and sets mDesiredActiveConfig.
Ady Abraham03b02dd2019-03-21 15:40:11 -0700508 void setDesiredActiveConfig(const ActiveConfigInfo& info) REQUIRES(mStateLock);
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800509 // Once HWC has returned the present fence, this sets the active config and a new refresh
510 // rate in SF. It also triggers HWC vsync.
511 void setActiveConfigInternal() REQUIRES(mStateLock);
512 // Active config is updated on INVALIDATE call in a state machine-like manner. When the
Ady Abrahamb838aed2019-02-12 15:30:16 -0800513 // desired config was set, HWC needs to update the panel on the next refresh, and when
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800514 // we receive the fence back, we know that the process was complete. It returns whether
Ady Abrahamb838aed2019-02-12 15:30:16 -0800515 // we need to wait for the next invalidate
Dominik Laskowski22488f62019-03-28 09:53:04 -0700516 bool performSetActiveConfig() REQUIRES(mStateLock);
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700517 // called on the main thread in response to setPowerMode()
Dominik Laskowski83b88212018-12-11 13:34:06 -0800518 void setPowerModeInternal(const sp<DisplayDevice>& display, int mode) REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800519
Ady Abraham838de062019-02-04 10:24:03 -0800520 // called on the main thread in response to setAllowedDisplayConfigs()
Dominik Laskowski22488f62019-03-28 09:53:04 -0700521 void setAllowedDisplayConfigsInternal(const sp<DisplayDevice>& display,
522 const std::vector<int32_t>& allowedConfigs)
523 REQUIRES(mStateLock);
Ady Abraham838de062019-02-04 10:24:03 -0800524
Dan Stoza6b9454d2014-11-07 16:00:59 -0800525 // Returns whether the transaction actually modified any state
526 bool handleMessageTransaction();
527
528 // Returns whether a new buffer has been latched (see handlePageFlip())
529 bool handleMessageInvalidate();
530
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700531 void handleMessageRefresh();
Mathias Agopian4fec8732012-06-29 14:12:52 -0700532
Mathias Agopian87baae12012-07-31 12:38:26 -0700533 void handleTransaction(uint32_t transactionFlags);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800534 void handleTransactionLocked(uint32_t transactionFlags) REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800535
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800536 void updateInputFlinger();
537 void updateInputWindowInfo();
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800538 void commitInputWindowCommands() REQUIRES(mStateLock);
chaviwfbe5d9c2018-12-26 12:23:37 -0800539 void executeInputWindowCommands();
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700540 void setInputWindowsFinished();
Riley Andrews03414a12014-07-01 14:22:59 -0700541 void updateCursorAsync();
542
Dan Stoza6b9454d2014-11-07 16:00:59 -0800543 /* handlePageFlip - latch a new buffer if available and compute the dirty
544 * region. Returns whether a new buffer has been latched, i.e., whether it
545 * is necessary to perform a refresh during this vsync.
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700546 */
Dan Stoza6b9454d2014-11-07 16:00:59 -0800547 bool handlePageFlip();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800548
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700549 /* ------------------------------------------------------------------------
550 * Transactions
551 */
Marissa Wall713b63f2018-10-17 15:42:43 -0700552 void applyTransactionState(const Vector<ComposerState>& state,
chaviw273171b2018-12-26 11:46:30 -0800553 const Vector<DisplayState>& displays, uint32_t flags,
Robert Carr14167e02019-02-13 13:50:55 -0800554 const InputWindowCommands& inputWindowCommands,
Marissa Wall78b72202019-03-15 14:58:34 -0700555 const int64_t desiredPresentTime,
Marissa Wall947d34e2019-03-29 14:03:53 -0700556 const client_cache_t& uncacheBuffer,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700557 const std::vector<ListenerCallbacks>& listenerCallbacks,
558 const int64_t postTime, bool privileged, bool isMainThread = false)
559 REQUIRES(mStateLock);
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700560 // Returns true if at least one transaction was flushed
Marissa Wall713b63f2018-10-17 15:42:43 -0700561 bool flushTransactionQueues();
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700562 // Returns true if there is at least one transaction that needs to be flushed
563 bool transactionFlushNeeded();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700564 uint32_t getTransactionFlags(uint32_t flags);
Fabien Sanglardc8251eb2016-12-07 13:59:48 -0800565 uint32_t peekTransactionFlags();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700566 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700567 uint32_t setTransactionFlags(uint32_t flags);
Ana Krulec7ecce8c2018-10-12 13:44:41 -0700568 uint32_t setTransactionFlags(uint32_t flags, Scheduler::TransactionStart transactionStart);
chaviw61626f22018-11-15 16:26:27 -0800569 void latchAndReleaseBuffer(const sp<Layer>& layer);
Nataniel Borges2b796da2019-02-15 13:32:18 -0800570 void commitTransaction() REQUIRES(mStateLock);
chaviw74d90ad2019-04-26 14:45:26 -0700571 void commitOffscreenLayers();
chaviwca27f252018-02-06 16:46:39 -0800572 bool containsAnyInvalidClientState(const Vector<ComposerState>& states);
Marissa Wall17b4e452018-12-26 16:32:34 -0800573 bool transactionIsReadyToBeApplied(int64_t desiredPresentTime,
574 const Vector<ComposerState>& states);
Valerie Haubc6ddb12019-03-08 11:10:15 -0800575 uint32_t setClientStateLocked(const ComposerState& composerState, int64_t desiredPresentTime,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700576 const std::vector<ListenerCallbacks>& listenerCallbacks,
Valerie Haubc6ddb12019-03-08 11:10:15 -0800577 int64_t postTime, bool privileged) REQUIRES(mStateLock);
Vishnu Nairce5d0cc2019-02-28 14:38:41 -0800578 uint32_t setDisplayStateLocked(const DisplayState& s) REQUIRES(mStateLock);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800579 uint32_t addInputWindowCommands(const InputWindowCommands& inputWindowCommands)
580 REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800581
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700582 /* ------------------------------------------------------------------------
583 * Layer management
584 */
Marissa Wall2d814fb2019-04-09 18:52:57 +0000585 status_t createLayer(const String8& name, const sp<Client>& client, uint32_t w, uint32_t h,
586 PixelFormat format, uint32_t flags, LayerMetadata metadata,
Robert Carrc0df3122019-04-11 13:18:21 -0700587 sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp,
588 const sp<IBinder>& parentHandle, const sp<Layer>& parentLayer = nullptr);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800589
Marissa Wallfd668622018-05-10 10:21:13 -0700590 status_t createBufferQueueLayer(const sp<Client>& client, const String8& name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800591 uint32_t h, uint32_t flags, LayerMetadata metadata,
592 PixelFormat& format, sp<IBinder>* outHandle,
593 sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800594
Marissa Wall61c58622018-07-18 10:12:20 -0700595 status_t createBufferStateLayer(const sp<Client>& client, const String8& name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800596 uint32_t h, uint32_t flags, LayerMetadata metadata,
597 sp<IBinder>* outHandle, sp<Layer>* outLayer);
Marissa Wall61c58622018-07-18 10:12:20 -0700598
Evan Roskya1f1e152019-01-24 16:17:46 -0800599 status_t createColorLayer(const sp<Client>& client, const String8& name, uint32_t w, uint32_t h,
600 uint32_t flags, LayerMetadata metadata, sp<IBinder>* outHandle,
601 sp<Layer>* outLayer);
Mathias Agopian74c40c02010-09-29 13:02:36 -0700602
Evan Roskya1f1e152019-01-24 16:17:46 -0800603 status_t createContainerLayer(const sp<Client>& client, const String8& name, uint32_t w,
604 uint32_t h, uint32_t flags, LayerMetadata metadata,
605 sp<IBinder>* outHandle, sp<Layer>* outLayer);
Robert Carr6b3f6c52018-08-13 13:05:17 -0700606
Cody Northropbc755282017-03-31 12:00:08 -0600607 String8 getUniqueLayerName(const String8& name);
608
Rob Carr4bba3702018-10-08 21:53:30 +0000609 // called when all clients have released all their references to
610 // this layer meaning it is entirely safe to destroy all
611 // resources associated to this layer.
Robert Carr695d5282018-12-18 15:27:58 -0800612 void onHandleDestroyed(sp<Layer>& layer);
Robert Carr6fb1a7e2018-12-11 12:07:25 -0800613 void markLayerPendingRemovalLocked(const sp<Layer>& layer);
Mathias Agopiana4912602012-07-12 14:25:33 -0700614
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700615 // add a layer to SurfaceFlinger
Robert Carrc0df3122019-04-11 13:18:21 -0700616 status_t addClientLayer(const sp<Client>& client, const sp<IBinder>& handle,
617 const sp<IGraphicBufferProducer>& gbc, const sp<Layer>& lbc,
618 const sp<IBinder>& parentHandle, const sp<Layer>& parentLayer,
619 bool addToCurrentState);
Mathias Agopianf1d8e872009-04-20 19:39:12 -0700620
Vishnu Nair4351ad52019-02-11 14:13:02 -0800621 // Traverse through all the layers and compute and cache its bounds.
622 void computeLayerBounds();
623
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700624 /* ------------------------------------------------------------------------
625 * Boot animation, on/off animations and screen capture
626 */
Mathias Agopianbb641242010-05-18 17:06:55 -0700627
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700628 void startBootAnim();
Mathias Agopian96f08192010-06-02 23:28:45 -0700629
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700630 using TraverseLayersFunction = std::function<void(const LayerVector::Visitor&)>;
631
chaviwa76b2712017-09-20 12:02:26 -0700632 void renderScreenImplLocked(const RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000633 ANativeWindowBuffer* buffer, bool useIdentityTransform,
634 int* outSyncFd);
chaviwa76b2712017-09-20 12:02:26 -0700635 status_t captureScreenCommon(RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Peiyong Lin0e003c92018-09-17 11:09:51 -0700636 sp<GraphicBuffer>* outBuffer, const ui::PixelFormat reqPixelFormat,
Robert Carr108b2c72019-04-02 16:32:58 -0700637 bool useIdentityTransform, bool& outCapturedSecureLayers);
Kevin DuBois7cbcc372019-02-25 14:53:28 -0800638 status_t captureScreenCommon(RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Robert Carr108b2c72019-04-02 16:32:58 -0700639 const sp<GraphicBuffer>& buffer, bool useIdentityTransform,
640 bool& outCapturedSecureLayers);
chaviw93df2ea2019-04-30 16:45:12 -0700641 const sp<DisplayDevice> getDisplayByIdOrLayerStack(uint64_t displayOrLayerStack);
chaviwa76b2712017-09-20 12:02:26 -0700642 status_t captureScreenImplLocked(const RenderArea& renderArea,
643 TraverseLayersFunction traverseLayers,
644 ANativeWindowBuffer* buffer, bool useIdentityTransform,
Robert Carr108b2c72019-04-02 16:32:58 -0700645 bool forSystem, int* outSyncFd, bool& outCapturedSecureLayers);
chaviw0e3479f2018-09-10 16:49:30 -0700646 void traverseLayersInDisplay(const sp<const DisplayDevice>& display,
647 const LayerVector::Visitor& visitor);
Mathias Agopianabe815d2013-03-19 22:22:21 -0700648
Lloyd Pique90c115d2018-09-18 21:39:42 -0700649 sp<StartPropertySetThread> mStartPropertySetThread;
Wei Wangb254fa32017-01-31 17:43:23 -0800650
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700651 /* ------------------------------------------------------------------------
Romain Guy11d63f42017-07-20 12:47:14 -0700652 * Properties
653 */
654 void readPersistentProperties();
655
656 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700657 * EGL
658 */
Mathias Agopian875d8e12013-06-07 15:35:48 -0700659 size_t getMaxTextureSize() const;
660 size_t getMaxViewportDims() const;
Mathias Agopiana4912602012-07-12 14:25:33 -0700661
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700662 /* ------------------------------------------------------------------------
Mathias Agopian87baae12012-07-31 12:38:26 -0700663 * Display and layer stack management
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700664 */
Andy McFadden13a082e2012-08-24 10:16:42 -0700665 // called when starting, or restarting after system_server death
666 void initializeDisplays();
667
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700668 sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& displayToken) const {
669 Mutex::Autolock _l(mStateLock);
670 return getDisplayDeviceLocked(displayToken);
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700671 }
672
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700673 sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& displayToken) {
674 Mutex::Autolock _l(mStateLock);
675 return getDisplayDeviceLocked(displayToken);
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700676 }
677
678 // NOTE: can only be called from the main thread or with mStateLock held
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700679 sp<const DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) const {
680 return const_cast<SurfaceFlinger*>(this)->getDisplayDeviceLocked(displayToken);
Mathias Agopian92a979a2012-08-02 18:32:23 -0700681 }
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700682
683 // NOTE: can only be called from the main thread or with mStateLock held
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700684 sp<DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) {
Dominik Laskowski9fae1022018-05-29 13:17:40 -0700685 const auto it = mDisplays.find(displayToken);
686 return it == mDisplays.end() ? nullptr : it->second;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700687 }
Mathias Agopian99b49842011-06-27 16:05:52 -0700688
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700689 sp<const DisplayDevice> getDefaultDisplayDeviceLocked() const {
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700690 return const_cast<SurfaceFlinger*>(this)->getDefaultDisplayDeviceLocked();
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700691 }
692
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700693 sp<DisplayDevice> getDefaultDisplayDeviceLocked() {
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800694 if (const auto token = getInternalDisplayTokenLocked()) {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700695 return getDisplayDeviceLocked(token);
696 }
697 return nullptr;
Michael Wright28f24d02016-07-12 13:30:53 -0700698 }
699
Mathias Agopian87baae12012-07-31 12:38:26 -0700700 // mark a region of a layer stack dirty. this updates the dirty
701 // region of all screens presenting this layer stack.
Chia-I Wuab0c3192017-08-01 11:29:00 -0700702 void invalidateLayerStack(const sp<const Layer>& layer, const Region& dirty);
Mathias Agopian87baae12012-07-31 12:38:26 -0700703
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700704 /* ------------------------------------------------------------------------
Mathias Agopian86303202012-07-24 22:46:10 -0700705 * H/W composer
706 */
707
Lloyd Pique441d5042018-10-18 16:49:51 -0700708 // The current hardware composer interface.
709 //
710 // The following thread safety rules apply when accessing mHwc, either
711 // directly or via getHwComposer():
712 //
713 // 1. When recreating mHwc, acquire mStateLock. We currently recreate mHwc
714 // only when switching into and out of vr. Recreating mHwc must only be
715 // done on the main thread.
716 //
717 // 2. When accessing mHwc on the main thread, it's not necessary to acquire
718 // mStateLock.
719 //
720 // 3. When accessing mHwc on a thread other than the main thread, we always
721 // need to acquire mStateLock. This is because the main thread could be
722 // in the process of destroying the current mHwc instance.
723 //
724 // The above thread safety rules only apply to SurfaceFlinger.cpp. In
725 // SurfaceFlinger_hwc1.cpp we create mHwc at surface flinger init and never
726 // destroy it, so it's always safe to access mHwc from any thread without
727 // acquiring mStateLock.
728 HWComposer& getHwComposer() const;
Mathias Agopian86303202012-07-24 22:46:10 -0700729
Mathias Agopian888c8222012-08-04 21:10:38 -0700730 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700731 * Compositing
732 */
733 void invalidateHwcGeometry();
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700734 void computeVisibleRegions(const sp<const DisplayDevice>& display, Region& dirtyRegion,
735 Region& opaqueRegion);
Mathias Agopiancd60f992012-08-16 16:28:27 -0700736
David Sodman2b406362017-12-15 13:33:47 -0800737 void preComposition();
738 void postComposition();
Dominik Laskowskif654d572018-12-20 11:03:06 -0800739 void getCompositorTiming(CompositorTiming* compositorTiming);
Ana Krulece588e312018-09-18 12:32:24 -0700740 void updateCompositorTiming(const DisplayStatInfo& stats, nsecs_t compositeTime,
741 std::shared_ptr<FenceTime>& presentFenceTime);
742 void setCompositorTimingSnapped(const DisplayStatInfo& stats,
743 nsecs_t compositeToPresentLatency);
Mathias Agopiancd60f992012-08-16 16:28:27 -0700744 void rebuildLayerStacks();
Courtney Goeltzenleuchter5d943892017-03-22 13:46:46 -0600745
Peiyong Lin03912882019-04-16 15:34:46 -0700746 ui::Dataspace getBestDataspace(const sp<DisplayDevice>& display, ui::Dataspace* outHdrDataSpace,
747 bool* outIsHdrClientComposition) const;
Peiyong Lin136fbbc2018-04-17 15:09:44 -0700748
749 // Returns the appropriate ColorMode, Dataspace and RenderIntent for the
750 // DisplayDevice. The function only returns the supported ColorMode,
751 // Dataspace and RenderIntent.
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700752 void pickColorMode(const sp<DisplayDevice>& display, ui::ColorMode* outMode,
753 ui::Dataspace* outDataSpace, ui::RenderIntent* outRenderIntent) const;
Romain Guy0147a172017-06-01 13:53:56 -0700754
David Sodman79bba0e2018-08-05 18:07:49 -0700755 void calculateWorkingSet();
David Sodman2b406362017-12-15 13:33:47 -0800756 /*
757 * beginFrame - This function handles any pre-frame processing that needs to be
758 * prior to any CompositionInfo handling and is not dependent on data in
759 * CompositionInfo
760 */
David Sodmanfa9b2af2017-12-24 13:28:59 -0800761 void beginFrame(const sp<DisplayDevice>& display);
David Sodman2b406362017-12-15 13:33:47 -0800762 /* prepareFrame - This function will call into the DisplayDevice to prepare a
763 * frame after CompositionInfo has been programmed. This provides a mechanism
764 * to prepare the hardware composer
765 */
David Sodmanfa9b2af2017-12-24 13:28:59 -0800766 void prepareFrame(const sp<DisplayDevice>& display);
767 void doComposition(const sp<DisplayDevice>& display, bool repainEverything);
768 void doDebugFlashRegions(const sp<DisplayDevice>& display, bool repaintEverything);
Yiwei Zhang7124ad32018-02-21 13:02:45 -0800769 void logLayerStats();
Alec Mouri0a9c7b82018-11-16 13:05:25 -0800770 void doDisplayComposition(const sp<DisplayDevice>& display, const Region& dirtyRegion);
Michael Lentine3f121fc2014-10-01 11:17:28 -0700771
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000772 // This fails if using GL and the surface has been destroyed. readyFence
773 // will be populated if using GL and native fence sync is supported, to
774 // signal when drawing has completed.
775 bool doComposeSurfaces(const sp<DisplayDevice>& display, const Region& debugRegionm,
776 base::unique_fd* readyFence);
Mathias Agopiancd60f992012-08-16 16:28:27 -0700777
David Sodmanfa9b2af2017-12-24 13:28:59 -0800778 void postFramebuffer(const sp<DisplayDevice>& display);
779 void postFrame();
Chia-I Wu28e3a252018-09-07 12:05:02 -0700780 void drawWormhole(const Region& region) const;
Mathias Agopian4da75192010-08-10 17:19:56 -0700781
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700782 /* ------------------------------------------------------------------------
Jamie Gennis0bceb842012-08-23 20:19:38 -0700783 * Display management
784 */
Lloyd Pique542307f2018-10-19 13:24:08 -0700785 sp<DisplayDevice> setupNewDisplayDeviceInternal(
786 const wp<IBinder>& displayToken, const std::optional<DisplayId>& displayId,
787 const DisplayDeviceState& state,
788 const sp<compositionengine::DisplaySurface>& dispSurface,
789 const sp<IGraphicBufferProducer>& producer);
Lloyd Pique347200f2017-12-14 17:00:15 -0800790 void processDisplayChangesLocked();
Lloyd Piqueba04e622017-12-14 17:11:26 -0800791 void processDisplayHotplugEventsLocked();
Mathias Agopian3ee454a2012-08-27 16:28:24 -0700792
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800793 void dispatchDisplayHotplugEvent(PhysicalDisplayId displayId, bool connected);
Dominik Laskowski1eba0202019-01-24 09:14:40 -0800794
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700795 /* ------------------------------------------------------------------------
796 * VSync
797 */
Dominik Laskowski83b88212018-12-11 13:34:06 -0800798 nsecs_t getVsyncPeriod() const REQUIRES(mStateLock);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700799
Dominik Laskowskiccf37d72019-02-01 16:47:58 -0800800 // Sets the refresh rate by switching active configs, if they are available for
Ana Krulec7d1d6832018-12-27 11:10:09 -0800801 // the desired refresh rate.
Ady Abraham03b02dd2019-03-21 15:40:11 -0700802 void setRefreshRateTo(RefreshRateType, Scheduler::ConfigEvent event) REQUIRES(mStateLock);
Jamie Gennis0bceb842012-08-23 20:19:38 -0700803
Dominik Laskowski22488f62019-03-28 09:53:04 -0700804 bool isDisplayConfigAllowed(int32_t configId) REQUIRES(mStateLock);
Jamie Gennis0bceb842012-08-23 20:19:38 -0700805
Dominik Laskowskic2867142019-01-21 11:33:38 -0800806 /*
807 * Display identification
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700808 */
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800809 sp<IBinder> getPhysicalDisplayTokenLocked(DisplayId displayId) const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700810 const auto it = mPhysicalDisplayTokens.find(displayId);
811 return it != mPhysicalDisplayTokens.end() ? it->second : nullptr;
812 }
813
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800814 std::optional<DisplayId> getPhysicalDisplayIdLocked(const sp<IBinder>& displayToken) const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700815 for (const auto& [id, token] : mPhysicalDisplayTokens) {
816 if (token == displayToken) {
817 return id;
818 }
819 }
820 return {};
821 }
822
823 // TODO(b/74619554): Remove special cases for primary display.
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800824 sp<IBinder> getInternalDisplayTokenLocked() const {
825 const auto displayId = getInternalDisplayIdLocked();
826 return displayId ? getPhysicalDisplayTokenLocked(*displayId) : nullptr;
Dominik Laskowski075d3172018-05-24 15:50:06 -0700827 }
828
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800829 std::optional<DisplayId> getInternalDisplayIdLocked() const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700830 const auto hwcDisplayId = getHwComposer().getInternalHwcDisplayId();
831 return hwcDisplayId ? getHwComposer().toPhysicalDisplayId(*hwcDisplayId) : std::nullopt;
832 }
833
Ady Abrahambe0f9482019-04-24 15:41:53 -0700834 bool previousFrameMissed();
835
Dominik Laskowskic2867142019-01-21 11:33:38 -0800836 /*
837 * Debugging & dumpsys
838 */
Dominik Laskowskic2867142019-01-21 11:33:38 -0800839 using DumpArgs = Vector<String16>;
840 using Dumper = std::function<void(const DumpArgs&, bool asProto, std::string&)>;
841
842 template <typename F, std::enable_if_t<!std::is_member_function_pointer_v<F>>* = nullptr>
843 static Dumper dumper(F&& dump) {
844 using namespace std::placeholders;
845 return std::bind(std::forward<F>(dump), _3);
846 }
847
848 template <typename F, std::enable_if_t<std::is_member_function_pointer_v<F>>* = nullptr>
849 Dumper dumper(F dump) {
850 using namespace std::placeholders;
851 return std::bind(dump, this, _3);
852 }
853
854 template <typename F>
855 Dumper argsDumper(F dump) {
856 using namespace std::placeholders;
857 return std::bind(dump, this, _1, _3);
858 }
859
860 template <typename F>
861 Dumper protoDumper(F dump) {
862 using namespace std::placeholders;
863 return std::bind(dump, this, _1, _2, _3);
864 }
865
866 void dumpAllLocked(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
867
868 void appendSfConfigString(std::string& result) const;
869 void listLayersLocked(std::string& result) const;
870 void dumpStatsLocked(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
871 void clearStatsLocked(const DumpArgs& args, std::string& result);
872 void dumpTimeStats(const DumpArgs& args, bool asProto, std::string& result) const;
Jamie Gennis6547ff42013-07-16 20:12:42 -0700873 void logFrameStats();
874
Dominik Laskowskid9e4de62019-01-21 14:23:01 -0800875 void dumpVSync(std::string& result) const REQUIRES(mStateLock);
Yiwei Zhang5434a782018-12-05 18:06:32 -0800876 void dumpStaticScreenStats(std::string& result) const;
Brian Andersond6927fb2016-07-23 23:37:30 -0700877 // Not const because each Layer needs to query Fences and cache timestamps.
Yiwei Zhang5434a782018-12-05 18:06:32 -0800878 void dumpFrameEventsLocked(std::string& result);
Dan Stozab90cf072015-03-05 11:05:59 -0800879
Dan Stozae77c7662016-05-13 11:37:28 -0700880 void recordBufferingStats(const char* layerName,
881 std::vector<OccupancyTracker::Segment>&& history);
Yiwei Zhang5434a782018-12-05 18:06:32 -0800882 void dumpBufferingStats(std::string& result) const;
883 void dumpDisplayIdentificationData(std::string& result) const;
884 void dumpWideColorInfo(std::string& result) const;
Vishnu Nair9245d3b2019-03-22 13:38:56 -0700885 LayersProto dumpProtoInfo(LayerVector::StateSet stateSet,
886 uint32_t traceFlags = SurfaceTracing::TRACE_ALL) const;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800887 void withTracingLock(std::function<void()> operation) REQUIRES(mStateLock);
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800888 LayersProto dumpVisibleLayersProtoInfo(const sp<DisplayDevice>& display) const;
Dan Stozae77c7662016-05-13 11:37:28 -0700889
Fabien Sanglard63a5fcd2016-12-29 15:13:07 -0800890 bool isLayerTripleBufferingDisabled() const {
891 return this->mLayerTripleBufferingDisabled;
892 }
Dominik Laskowskic2867142019-01-21 11:33:38 -0800893
894 status_t doDump(int fd, const DumpArgs& args, bool asProto);
895
Nataniel Borges8e7dc722019-02-28 15:10:28 -0800896 status_t dumpCritical(int fd, const DumpArgs&, bool asProto);
Dominik Laskowskic2867142019-01-21 11:33:38 -0800897
898 status_t dumpAll(int fd, const DumpArgs& args, bool asProto) override {
899 return doDump(fd, args, asProto);
900 }
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800901
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800902 /* ------------------------------------------------------------------------
903 * VrFlinger
904 */
Steven Thomasb02664d2017-07-26 18:48:28 -0700905 void resetDisplayState();
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800906
Steven Thomas050b2c82017-03-06 11:45:16 -0800907 // Check to see if we should handoff to vr flinger.
908 void updateVrFlinger();
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800909
Chia-I Wu28f320b2018-05-03 11:02:56 -0700910 void updateColorMatrixLocked();
911
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700912 /* ------------------------------------------------------------------------
913 * Attributes
914 */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800915
Lloyd Pique90c115d2018-09-18 21:39:42 -0700916 surfaceflinger::Factory& mFactory;
917
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700918 // access must be protected by mStateLock
919 mutable Mutex mStateLock;
Dan Stoza412903f2017-04-27 13:42:17 -0700920 State mCurrentState{LayerVector::StateSet::Current};
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700921 std::atomic<int32_t> mTransactionFlags = 0;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700922 Condition mTransactionCV;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700923 bool mTransactionPending = false;
924 bool mAnimTransactionPending = false;
925 SortedVector<sp<Layer>> mLayersPendingRemoval;
926 bool mTraversalNeededMainThread = false;
Dan Stoza101d8dc2018-02-27 15:42:25 -0800927
Nataniel Borges2b796da2019-02-15 13:32:18 -0800928 // guards access to the mDrawing state if tracing is enabled.
929 mutable std::mutex mDrawingStateLock;
930
Chia-I Wu28f320b2018-05-03 11:02:56 -0700931 // global color transform states
932 Daltonizer mDaltonizer;
933 float mGlobalSaturationFactor = 1.0f;
934 mat4 mClientColorMatrix;
935
Dan Stoza101d8dc2018-02-27 15:42:25 -0800936 // Can't be unordered_set because wp<> isn't hashable
937 std::set<wp<IBinder>> mGraphicBufferProducerList;
Dan Stoza0a0158c2018-03-16 13:38:54 -0700938 size_t mMaxGraphicBufferProducerListSize = MAX_LAYERS;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800939
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700940 // protected by mStateLock (but we could use another lock)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700941 bool mLayersRemoved = false;
942 bool mLayersAdded = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -0700943
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700944 std::atomic<bool> mRepaintEverything = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -0700945
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800946 // constant members (no synchronization needed for access)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700947 const nsecs_t mBootTime = systemTime();
948 bool mGpuToCpuSupported = false;
Lloyd Piquee83f9312018-02-01 12:53:17 -0800949 std::unique_ptr<EventThread> mInjectorEventThread;
Lloyd Piquee83f9312018-02-01 12:53:17 -0800950 std::unique_ptr<InjectVSyncSource> mVSyncInjector;
Mathias Agopian3094df32012-06-18 18:06:45 -0700951
Ana Krulec757f63a2019-01-25 10:46:18 -0800952 // Calculates correct offsets.
Dan Stoza84d619e2018-03-28 17:07:36 -0700953 VSyncModulator mVsyncModulator;
Ana Krulec757f63a2019-01-25 10:46:18 -0800954 // Keeps track of all available phase offsets for different refresh types.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700955 const std::unique_ptr<scheduler::PhaseOffsets> mPhaseOffsets;
Dan Stoza84d619e2018-03-28 17:07:36 -0700956
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700957 // Can only accessed from the main thread, these members
958 // don't need synchronization
Dan Stoza412903f2017-04-27 13:42:17 -0700959 State mDrawingState{LayerVector::StateSet::Drawing};
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700960 bool mVisibleRegionsDirty = false;
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800961 // Set during transaction commit stage to track if the input info for a layer has changed.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700962 bool mInputInfoChanged = false;
963 bool mGeometryInvalid = false;
964 bool mAnimCompositionPending = false;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800965 std::vector<sp<Layer>> mLayersWithQueuedFrames;
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800966 // Tracks layers that need to update a display's dirty region.
967 std::vector<sp<Layer>> mLayersPendingRefresh;
Ady Abrahambe0f9482019-04-24 15:41:53 -0700968 std::array<sp<Fence>, 2> mPreviousPresentFences = {Fence::NO_FENCE, Fence::NO_FENCE};
Alec Mouricc0fc602019-02-26 21:45:19 -0800969 // True if in the previous frame at least one layer was composed via the GPU.
Dan Stoza05dacfb2016-07-01 13:33:38 -0700970 bool mHadClientComposition = false;
Alec Mouricc0fc602019-02-26 21:45:19 -0800971 // True if in the previous frame at least one layer was composed via HW Composer.
972 // Note that it is possible for a frame to be composed via both client and device
973 // composition, for example in the case of overlays.
974 bool mHadDeviceComposition = false;
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700975
Chia-I Wu14c9c7b2018-06-26 10:18:18 +0800976 enum class BootStage {
977 BOOTLOADER,
978 BOOTANIMATION,
979 FINISHED,
980 };
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700981 BootStage mBootStage = BootStage::BOOTLOADER;
Chia-I Wu14c9c7b2018-06-26 10:18:18 +0800982
Lloyd Piqueba04e622017-12-14 17:11:26 -0800983 struct HotplugEvent {
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700984 hwc2_display_t hwcDisplayId;
Lloyd Piqueba04e622017-12-14 17:11:26 -0800985 HWC2::Connection connection = HWC2::Connection::Invalid;
Lloyd Piqueba04e622017-12-14 17:11:26 -0800986 };
987 // protected by mStateLock
988 std::vector<HotplugEvent> mPendingHotplugEvents;
989
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700990 // this may only be written from the main thread with mStateLock held
991 // it may be read from other threads with mStateLock held
Dominik Laskowski9fae1022018-05-29 13:17:40 -0700992 std::map<wp<IBinder>, sp<DisplayDevice>> mDisplays;
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800993 std::unordered_map<DisplayId, sp<IBinder>> mPhysicalDisplayTokens;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700994
Robert Carrc0df3122019-04-11 13:18:21 -0700995 // protected by mStateLock
996 std::unordered_map<BBinder*, wp<Layer>> mLayersByLocalBinderToken;
997
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700998 // don't use a lock for these, we don't care
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700999 int mDebugRegion = 0;
1000 bool mDebugDisableHWC = false;
1001 bool mDebugDisableTransformHint = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001002 volatile nsecs_t mDebugInTransaction = 0;
1003 bool mForceFullDamage = false;
Dan Stozac5da2712016-07-20 15:38:12 -07001004 bool mPropagateBackpressure = true;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001005 std::unique_ptr<SurfaceInterceptor> mInterceptor;
1006 SurfaceTracing mTracing{*this};
Nataniel Borges2b796da2019-02-15 13:32:18 -08001007 bool mTracingEnabled = false;
1008 bool mTracingEnabledChanged GUARDED_BY(mStateLock) = false;
Yiwei Zhang7124ad32018-02-21 13:02:45 -08001009 LayerStats mLayerStats;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001010 const std::shared_ptr<TimeStats> mTimeStats;
Fabien Sanglard642b23d2017-02-09 12:29:39 -08001011 bool mUseHwcVirtualDisplays = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001012 std::atomic<uint32_t> mFrameMissedCount = 0;
1013 std::atomic<uint32_t> mHwcFrameMissedCount = 0;
1014 std::atomic<uint32_t> mGpuFrameMissedCount = 0;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001015
Marissa Walle2ffb422018-10-12 11:33:52 -07001016 TransactionCompletedThread mTransactionCompletedThread;
1017
Fabien Sanglard63a5fcd2016-12-29 15:13:07 -08001018 // Restrict layers to use two buffers in their bufferqueues.
1019 bool mLayerTripleBufferingDisabled = false;
1020
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001021 // these are thread safe
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001022 std::unique_ptr<MessageQueue> mEventQueue;
Jamie Gennis4b0eba92013-02-05 13:30:24 -08001023 FrameTracker mAnimFrameTracker;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001024
1025 // protected by mDestroyedLayerLock;
1026 mutable Mutex mDestroyedLayerLock;
Mathias Agopian13127d82013-03-05 17:47:11 -08001027 Vector<Layer const *> mDestroyedLayers;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001028
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001029 nsecs_t mRefreshStartTime = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -07001030
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001031 std::atomic<bool> mRefreshPending = false;
Dan Stoza2b6d38e2017-06-01 16:40:30 -07001032
Dan Stoza436ccf32018-06-21 12:10:12 -07001033 // We maintain a pool of pre-generated texture names to hand out to avoid
1034 // layer creation needing to run on the main thread (which it would
1035 // otherwise need to do to access RenderEngine).
1036 std::mutex mTexturePoolMutex;
1037 uint32_t mTexturePoolSize = 0;
1038 std::vector<uint32_t> mTexturePool;
1039
Marissa Wall713b63f2018-10-17 15:42:43 -07001040 struct IBinderHash {
1041 std::size_t operator()(const sp<IBinder>& strongPointer) const {
1042 return std::hash<IBinder*>{}(strongPointer.get());
1043 }
1044 };
1045 struct TransactionState {
1046 TransactionState(const Vector<ComposerState>& composerStates,
Marissa Wall17b4e452018-12-26 16:32:34 -08001047 const Vector<DisplayState>& displayStates, uint32_t transactionFlags,
Marissa Wall947d34e2019-03-29 14:03:53 -07001048 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
Marissa Wall3dad52d2019-03-22 14:03:19 -07001049 const std::vector<ListenerCallbacks>& listenerCallbacks, int64_t postTime,
1050 bool privileged)
Marissa Wall17b4e452018-12-26 16:32:34 -08001051 : states(composerStates),
1052 displays(displayStates),
1053 flags(transactionFlags),
Valerie Haubc6ddb12019-03-08 11:10:15 -08001054 desiredPresentTime(desiredPresentTime),
Marissa Wall78b72202019-03-15 14:58:34 -07001055 buffer(uncacheBuffer),
Marissa Wall3dad52d2019-03-22 14:03:19 -07001056 callback(listenerCallbacks),
Valerie Haubc6ddb12019-03-08 11:10:15 -08001057 postTime(postTime),
Robert Carr14167e02019-02-13 13:50:55 -08001058 privileged(privileged) {}
Marissa Wall713b63f2018-10-17 15:42:43 -07001059
1060 Vector<ComposerState> states;
1061 Vector<DisplayState> displays;
1062 uint32_t flags;
Valerie Haubc6ddb12019-03-08 11:10:15 -08001063 const int64_t desiredPresentTime;
Marissa Wall947d34e2019-03-29 14:03:53 -07001064 client_cache_t buffer;
Marissa Wall3dad52d2019-03-22 14:03:19 -07001065 std::vector<ListenerCallbacks> callback;
Valerie Haubc6ddb12019-03-08 11:10:15 -08001066 const int64_t postTime;
Robert Carr14167e02019-02-13 13:50:55 -08001067 bool privileged;
Marissa Wall713b63f2018-10-17 15:42:43 -07001068 };
1069 std::unordered_map<sp<IBinder>, std::queue<TransactionState>, IBinderHash> mTransactionQueues;
1070
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001071 /* ------------------------------------------------------------------------
1072 * Feature prototyping
1073 */
1074
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001075 bool mInjectVSyncs = false;
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -07001076
Dan Stozab90cf072015-03-05 11:05:59 -08001077 // Static screen stats
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001078 bool mHasPoweredOff = false;
Dan Stozae77c7662016-05-13 11:37:28 -07001079
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001080 size_t mNumLayers = 0;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001081
Fabien Sanglard6e8e98a2016-10-27 20:04:11 -07001082 // Verify that transaction is being called by an approved process:
1083 // either AID_GRAPHICS or AID_SYSTEM.
1084 status_t CheckTransactCodeCredentials(uint32_t code);
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -08001085
Steven Thomasb02664d2017-07-26 18:48:28 -07001086 std::unique_ptr<dvr::VrFlinger> mVrFlinger;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001087 std::atomic<bool> mVrFlingerRequestsDisplay = false;
Steven Thomas050b2c82017-03-06 11:45:16 -08001088 static bool useVrFlinger;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001089 std::thread::id mMainThreadId = std::this_thread::get_id();
Romain Guy0147a172017-06-01 13:53:56 -07001090
Chia-I Wue0ec4312018-07-03 01:17:18 +08001091 DisplayColorSetting mDisplayColorSetting = DisplayColorSetting::ENHANCED;
David Sodman105b7dc2017-11-04 20:28:14 -07001092
Peiyong Lina3ea5592019-02-10 14:45:00 -08001093 // Color mode forced by setting persist.sys.sf.color_mode, it must:
1094 // 1. not be NATIVE color mode, NATIVE color mode means no forced color mode;
1095 // 2. be one of the supported color modes returned by hardware composer, otherwise
1096 // it will not be respected.
1097 // persist.sys.sf.color_mode will only take effect when persist.sys.sf.native_mode
1098 // is not set to 1.
1099 // This property can be used to force SurfaceFlinger to always pick a certain color mode.
1100 ui::ColorMode mForceColorMode = ui::ColorMode::NATIVE;
1101
Peiyong Lin9d846a52018-11-05 13:18:20 -08001102 ui::Dataspace mDefaultCompositionDataspace;
1103 ui::Dataspace mWideColorGamutCompositionDataspace;
1104
David Sodman105b7dc2017-11-04 20:28:14 -07001105 SurfaceFlingerBE mBE;
Lloyd Pique70d91362018-10-18 16:02:55 -07001106 std::unique_ptr<compositionengine::CompositionEngine> mCompositionEngine;
Ana Krulec98b5b242018-08-10 15:03:23 -07001107
Ana Krulecb43429d2019-01-09 14:28:51 -08001108 /* ------------------------------------------------------------------------
1109 * Scheduler
1110 */
Ana Krulecba13ab32019-02-20 14:14:12 -08001111 bool mUseSmart90ForVideo = false;
Ana Krulec98b5b242018-08-10 15:03:23 -07001112 std::unique_ptr<Scheduler> mScheduler;
1113 sp<Scheduler::ConnectionHandle> mAppConnectionHandle;
1114 sp<Scheduler::ConnectionHandle> mSfConnectionHandle;
Robert Carr720e5062018-07-30 17:45:14 -07001115
Dominik Laskowski22488f62019-03-28 09:53:04 -07001116 scheduler::RefreshRateConfigs mRefreshRateConfigs;
1117 scheduler::RefreshRateStats mRefreshRateStats{mRefreshRateConfigs, *mTimeStats};
Ady Abraham1902d072019-03-01 17:18:59 -08001118
Dominik Laskowski22488f62019-03-28 09:53:04 -07001119 // All configs are allowed if the set is empty.
Ady Abraham3bb89732019-04-08 11:22:01 -07001120 using DisplayConfigs = std::set<int32_t>;
Dominik Laskowski22488f62019-03-28 09:53:04 -07001121 DisplayConfigs mAllowedDisplayConfigs GUARDED_BY(mStateLock);
Ady Abraham838de062019-02-04 10:24:03 -08001122
Ana Kruleca5bdd9d2019-01-29 19:00:58 -08001123 std::mutex mActiveConfigLock;
1124 // This bit is set once we start setting the config. We read from this bit during the
1125 // process. If at the end, this bit is different than mDesiredActiveConfig, we restart
1126 // the process.
1127 ActiveConfigInfo mUpcomingActiveConfig; // Always read and written on the main thread.
1128 // This bit can be set at any point in time when the system wants the new config.
1129 ActiveConfigInfo mDesiredActiveConfig GUARDED_BY(mActiveConfigLock);
1130
Ady Abrahamb838aed2019-02-12 15:30:16 -08001131 // below flags are set by main thread only
1132 bool mDesiredActiveConfigChanged GUARDED_BY(mActiveConfigLock) = false;
Ady Abrahamb838aed2019-02-12 15:30:16 -08001133 bool mCheckPendingFence = false;
1134
Kevin DuBois413287f2019-02-25 08:46:47 -08001135 bool mLumaSampling = true;
1136 sp<RegionSamplingThread> mRegionSamplingThread;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001137 ui::DisplayPrimaries mInternalDisplayPrimaries;
Kevin DuBois413287f2019-02-25 08:46:47 -08001138
Robert Carr720e5062018-07-30 17:45:14 -07001139 sp<IInputFlinger> mInputFlinger;
Vishnu Nairfa5f8df2019-02-13 17:02:51 -08001140 InputWindowCommands mPendingInputWindowCommands GUARDED_BY(mStateLock);
1141 // Should only be accessed by the main thread.
chaviw273171b2018-12-26 11:46:30 -08001142 InputWindowCommands mInputWindowCommands;
chaviw291d88a2019-02-14 10:33:58 -08001143
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001144 struct SetInputWindowsListener : BnSetInputWindowsListener {
1145 explicit SetInputWindowsListener(sp<SurfaceFlinger> flinger)
1146 : mFlinger(std::move(flinger)) {}
1147
1148 void onSetInputWindowsFinished() override;
1149
1150 const sp<SurfaceFlinger> mFlinger;
1151 };
1152
1153 const sp<SetInputWindowsListener> mSetInputWindowsListener = new SetInputWindowsListener(this);
1154
chaviw95ef3c42019-02-14 10:55:09 -08001155 bool mPendingSyncInputWindows GUARDED_BY(mStateLock);
Peiyong Lin74ca2f42019-01-14 19:36:57 -08001156 Hwc2::impl::PowerAdvisor mPowerAdvisor;
Ady Abraham03b02dd2019-03-21 15:40:11 -07001157
1158 std::unique_ptr<RefreshRateOverlay> mRefreshRateOverlay;
Ady Abraham34392f72019-04-10 11:29:27 -07001159
1160 // Flag used to set override allowed display configs from backdoor
1161 bool mDebugDisplayConfigSetByBackdoor = false;
chaviw74d90ad2019-04-26 14:45:26 -07001162
1163 // A set of layers that have no parent so they are not drawn on screen.
1164 // Should only be accessed by the main thread.
1165 // The Layer pointer is removed from the set when the destructor is called so there shouldn't
1166 // be any issues with a raw pointer referencing an invalid object.
1167 std::unordered_set<Layer*> mOffscreenLayers;
Romain Guy0147a172017-06-01 13:53:56 -07001168};
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001169
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001170} // namespace android