blob: a17f6c88673cdfac68b0a673646337df7919ea04 [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"
Ady Abraham50204dd2019-07-19 15:47:11 -070063#include "TracedOrdinal.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080064#include "TransactionCompletedThread.h"
Mathias Agopian86303202012-07-24 22:46:10 -070065
Dominik Laskowski83b88212018-12-11 13:34:06 -080066#include <atomic>
67#include <cstdint>
Dominik Laskowskic2867142019-01-21 11:33:38 -080068#include <functional>
Dan Stozae77c7662016-05-13 11:37:28 -070069#include <map>
Dominik Laskowski83b88212018-12-11 13:34:06 -080070#include <memory>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080071#include <mutex>
Dominik Laskowskieddeda12019-07-19 11:54:13 -070072#include <optional>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080073#include <queue>
Dominik Laskowski075d3172018-05-24 15:50:06 -070074#include <set>
Dan Stozae77c7662016-05-13 11:37:28 -070075#include <string>
Steven Thomasb02664d2017-07-26 18:48:28 -070076#include <thread>
Dominik Laskowskic2867142019-01-21 11:33:38 -080077#include <type_traits>
Dominik Laskowski075d3172018-05-24 15:50:06 -070078#include <unordered_map>
Dominik Laskowski22488f62019-03-28 09:53:04 -070079#include <unordered_set>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080080#include <utility>
Dan Stozae77c7662016-05-13 11:37:28 -070081
chaviw1d044282017-09-27 12:19:28 -070082using namespace android::surfaceflinger;
83
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080084namespace android {
85
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080086class Client;
Lloyd Pique144e1162017-12-20 16:44:52 -080087class EventThread;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070088class HWComposer;
Lloyd Pique12eb4232018-01-17 11:54:43 -080089class IGraphicBufferProducer;
Robert Carr720e5062018-07-30 17:45:14 -070090class IInputFlinger;
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -070091class InjectVSyncSource;
Lloyd Pique144e1162017-12-20 16:44:52 -080092class Layer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070093class MessageBase;
Ady Abraham03b02dd2019-03-21 15:40:11 -070094class RefreshRateOverlay;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070095class RegionSamplingThread;
Yiwei Zhang7e666a52018-11-15 13:33:42 -080096class TimeStats;
Lloyd Pique144e1162017-12-20 16:44:52 -080097
Lloyd Pique542307f2018-10-19 13:24:08 -070098namespace compositionengine {
99class DisplaySurface;
100} // namespace compositionengine
101
Peiyong Lin833074a2018-08-28 11:53:54 -0700102namespace renderengine {
Lloyd Pique144e1162017-12-20 16:44:52 -0800103class RenderEngine;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700104} // namespace renderengine
chaviwa76b2712017-09-20 12:02:26 -0700105
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800106namespace dvr {
107class VrFlinger;
108} // namespace dvr
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800109
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800110enum {
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700111 eTransactionNeeded = 0x01,
112 eTraversalNeeded = 0x02,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700113 eDisplayTransactionNeeded = 0x04,
Lloyd Piqued432a7c2018-03-23 16:05:31 -0700114 eDisplayLayerStackChanged = 0x08,
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700115 eTransactionFlushNeeded = 0x10,
116 eTransactionMask = 0x1f,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800117};
118
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800119enum class DisplayColorSetting : int32_t {
120 MANAGED = 0,
121 UNMANAGED = 1,
122 ENHANCED = 2,
123};
124
David Sodman105b7dc2017-11-04 20:28:14 -0700125class SurfaceFlingerBE
126{
127public:
128 SurfaceFlingerBE();
129
David Sodmanbc815282017-11-05 18:57:52 -0800130 const std::string mHwcServiceName; // "default" for real use, something else for testing.
131
David Sodman73beded2017-11-15 11:56:06 -0800132 FenceTimeline mGlCompositionDoneTimeline;
133 FenceTimeline mDisplayTimeline;
David Sodmanbc815282017-11-05 18:57:52 -0800134
David Sodman99974d22017-11-28 12:04:33 -0800135 // protected by mCompositorTimingLock;
136 mutable std::mutex mCompositorTimingLock;
137 CompositorTiming mCompositorTiming;
Lloyd Piquefcd86612017-12-14 17:15:36 -0800138
David Sodman99974d22017-11-28 12:04:33 -0800139 // Only accessed from the main thread.
140 struct CompositePresentTime {
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700141 nsecs_t composite = -1;
142 std::shared_ptr<FenceTime> display = FenceTime::NO_FENCE;
David Sodman99974d22017-11-28 12:04:33 -0800143 };
144 std::queue<CompositePresentTime> mCompositePresentTimes;
145
David Sodman4a36e932017-11-07 14:29:47 -0800146 static const size_t NUM_BUCKETS = 8; // < 1-7, 7+
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700147 nsecs_t mFrameBuckets[NUM_BUCKETS] = {};
148 nsecs_t mTotalTime = 0;
149 std::atomic<nsecs_t> mLastSwapTime = 0;
David Sodman4a36e932017-11-07 14:29:47 -0800150
David Sodmancbaf0832017-11-07 14:21:36 -0800151 // Double- vs. triple-buffering stats
152 struct BufferingStats {
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700153 size_t numSegments = 0;
154 nsecs_t totalTime = 0;
David Sodmancbaf0832017-11-07 14:21:36 -0800155
156 // "Two buffer" means that a third buffer was never used, whereas
157 // "double-buffered" means that on average the segment only used two
158 // buffers (though it may have used a third for some part of the
159 // segment)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700160 nsecs_t twoBufferTime = 0;
161 nsecs_t doubleBufferedTime = 0;
162 nsecs_t tripleBufferedTime = 0;
David Sodmancbaf0832017-11-07 14:21:36 -0800163 };
164 mutable Mutex mBufferingStatsMutex;
165 std::unordered_map<std::string, BufferingStats> mBufferingStats;
166
David Sodman105b7dc2017-11-04 20:28:14 -0700167 // The composer sequence id is a monotonically increasing integer that we
168 // use to differentiate callbacks from different hardware composer
169 // instances. Each hardware composer instance gets a different sequence id.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700170 int32_t mComposerSequenceId = 0;
chaviw291d88a2019-02-14 10:33:58 -0800171};
David Sodman105b7dc2017-11-04 20:28:14 -0700172
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700173class SurfaceFlinger : public BnSurfaceComposer,
Vishnu Nair35798872017-10-06 16:00:36 -0700174 public PriorityDumper,
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700175 private IBinder::DeathRecipient,
Steven Thomasb02664d2017-07-26 18:48:28 -0700176 private HWC2::ComposerCallback
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800177{
178public:
David Sodman105b7dc2017-11-04 20:28:14 -0700179 SurfaceFlingerBE& getBE() { return mBE; }
180 const SurfaceFlingerBE& getBE() const { return mBE; }
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800181
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800182 // This is the phase offset in nanoseconds of the software vsync event
183 // relative to the vsync event reported by HWComposer. The software vsync
184 // event is when SurfaceFlinger and Choreographer-based applications run each
185 // frame.
186 //
187 // This phase offset allows adjustment of the minimum latency from application
188 // wake-up time (by Choreographer) to the time at which the resulting window
189 // image is displayed. This value may be either positive (after the HW vsync)
190 // or negative (before the HW vsync). Setting it to 0 will result in a lower
191 // latency bound of two vsync periods because the app and SurfaceFlinger
192 // will run just after the HW vsync. Setting it to a positive number will
193 // result in the minimum latency being:
194 //
195 // (2 * VSYNC_PERIOD - (vsyncPhaseOffsetNs % VSYNC_PERIOD))
196 //
197 // Note that reducing this latency makes it more likely for the applications
198 // to not have their window content image ready in time. When this happens
199 // the latency will end up being an additional vsync period, and animations
200 // will hiccup. Therefore, this latency should be tuned somewhat
201 // conservatively (or at least with awareness of the trade-off being made).
202 static int64_t vsyncPhaseOffsetNs;
203 static int64_t sfVsyncPhaseOffsetNs;
204
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800205 // If fences from sync Framework are supported.
206 static bool hasSyncFramework;
207
Fabien Sanglardc45a7d92017-03-14 13:24:22 -0700208 // The offset in nanoseconds to use when DispSync timestamps present fence
209 // signaling time.
210 static int64_t dispSyncPresentTimeOffset;
211
Fabien Sanglarda34ed632017-03-14 11:43:52 -0700212 // Some hardware can do RGB->YUV conversion more efficiently in hardware
213 // controlled by HWC than in hardware controlled by the video encoder.
214 // This instruct VirtualDisplaySurface to use HWC for such conversion on
215 // GL composition.
216 static bool useHwcForRgbToYuv;
217
Fabien Sanglardc8e387e2017-03-10 10:30:28 -0800218 // Maximum dimension supported by HWC for virtual display.
219 // Equal to min(max_height, max_width).
220 static uint64_t maxVirtualDisplaySize;
221
Fabien Sanglard1971b632017-03-10 14:50:03 -0800222 // Controls the number of buffers SurfaceFlinger will allocate for use in
223 // FramebufferSurface
224 static int64_t maxFrameBufferAcquiredBuffers;
225
Peiyong Lin13effd12018-07-24 17:01:47 -0700226 // Indicate if a device has wide color gamut display. This is typically
227 // found on devices with wide color gamut (e.g. Display-P3) display.
Courtney Goeltzenleuchter5d943892017-03-22 13:46:46 -0600228 static bool hasWideColorDisplay;
229
Chia-I Wu304d9cd2018-08-27 14:38:14 -0700230 static int primaryDisplayOrientation;
231
Peiyong Lin13effd12018-07-24 17:01:47 -0700232 // Indicate if device wants color management on its display.
233 static bool useColorManagement;
234
Peiyong Linb3839ad2018-09-05 15:37:19 -0700235 static bool useContextPriority;
236
Peiyong Lin0256f722018-08-31 15:45:10 -0700237 // The data space and pixel format that SurfaceFlinger expects hardware composer
238 // to composite efficiently. Meaning under most scenarios, hardware composer
239 // will accept layers with the data space and pixel format.
Peiyong Linc6780972018-10-28 15:24:08 -0700240 static ui::Dataspace defaultCompositionDataspace;
241 static ui::PixelFormat defaultCompositionPixelFormat;
242
243 // The data space and pixel format that SurfaceFlinger expects hardware composer
244 // to composite efficiently for wide color gamut surfaces. Meaning under most scenarios,
245 // hardware composer will accept layers with the data space and pixel format.
246 static ui::Dataspace wideColorGamutCompositionDataspace;
247 static ui::PixelFormat wideColorGamutCompositionPixelFormat;
Peiyong Lin0256f722018-08-31 15:45:10 -0700248
Mathias Agopianb6df7d02013-05-09 14:53:35 -0700249 static char const* getServiceName() ANDROID_API {
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700250 return "SurfaceFlinger";
251 }
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800252
Lloyd Piqueac648ee2018-01-17 13:42:24 -0800253 struct SkipInitializationTag {};
254 static constexpr SkipInitializationTag SkipInitialization;
Lloyd Pique90c115d2018-09-18 21:39:42 -0700255 SurfaceFlinger(surfaceflinger::Factory&, SkipInitializationTag) ANDROID_API;
256 explicit SurfaceFlinger(surfaceflinger::Factory&) ANDROID_API;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800257
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700258 // must be called before clients can connect
259 void init() ANDROID_API;
260
261 // starts SurfaceFlinger main loop in the current thread
262 void run() ANDROID_API;
263
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700264 // post an asynchronous message to the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700265 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 -0800266
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700267 // post a synchronous message to the main thread
Vishnu Nair8406fd72019-07-30 11:29:31 -0700268 status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0)
269 EXCLUDES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800270
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700271 // force full composition on all displays
272 void repaintEverything();
Mathias Agopianbf2c6a62010-12-10 16:22:31 -0800273
Ana Krulec7d1d6832018-12-27 11:10:09 -0800274 // force full composition on all displays without resetting the scheduler idle timer.
275 void repaintEverythingForHWC();
276
Lloyd Pique90c115d2018-09-18 21:39:42 -0700277 surfaceflinger::Factory& getFactory() { return mFactory; }
278
Lloyd Pique70d91362018-10-18 16:02:55 -0700279 // The CompositionEngine encapsulates all composition related interfaces and actions.
280 compositionengine::CompositionEngine& getCompositionEngine() const;
281
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700282 // returns the default Display
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800283 sp<const DisplayDevice> getDefaultDisplayDevice() {
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700284 Mutex::Autolock _l(mStateLock);
285 return getDefaultDisplayDeviceLocked();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700286 }
Mathias Agopianb60314a2012-04-10 22:09:54 -0700287
Dan Stoza436ccf32018-06-21 12:10:12 -0700288 // Obtains a name from the texture pool, or, if the pool is empty, posts a
289 // synchronous message to the main thread to obtain one on the fly
290 uint32_t getNewTexture();
291
Mathias Agopian86303202012-07-24 22:46:10 -0700292 // utility function to delete a texture on the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700293 void deleteTextureAsync(uint32_t texture);
Mathias Agopian86303202012-07-24 22:46:10 -0700294
Mathias Agopian86303202012-07-24 22:46:10 -0700295 // enable/disable h/w composer event
296 // TODO: this should be made accessible only to EventThread
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800297 void setPrimaryVsyncEnabled(bool enabled);
Mathias Agopian86303202012-07-24 22:46:10 -0700298
Ady Abraham9ba25122019-06-03 17:10:55 -0700299 // main thread function to enable/disable h/w composer event
300 void setPrimaryVsyncEnabledInternal(bool enabled);
Dominik Laskowskia8955dd2019-07-10 10:19:09 -0700301 void setVsyncEnabledInHWC(DisplayId displayId, HWC2::Vsync enabled);
Ady Abraham9ba25122019-06-03 17:10:55 -0700302
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700303 // called on the main thread by MessageQueue when an internal message
304 // is received
305 // TODO: this should be made accessible only to MessageQueue
306 void onMessageReceived(int32_t what);
Mathias Agopian3094df32012-06-18 18:06:45 -0700307
Mathias Agopiancb558572012-10-04 15:58:54 -0700308 // for debugging only
309 // TODO: this should be made accessible only to HWComposer
Dominik Laskowski075d3172018-05-24 15:50:06 -0700310 const Vector<sp<Layer>>& getLayerSortedByZForHwcDisplay(DisplayId displayId);
Mathias Agopiancb558572012-10-04 15:58:54 -0700311
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700312 renderengine::RenderEngine& getRenderEngine() const;
Jesse Hall29c3f352013-05-21 15:36:55 -0700313
Robert Carr0d480722017-01-10 16:42:54 -0800314 bool authenticateSurfaceTextureLocked(
315 const sp<IGraphicBufferProducer>& bufferProducer) const;
316
Robert Carr2e102c92018-10-23 12:11:15 -0700317 inline void onLayerCreated() { mNumLayers++; }
chaviw74d90ad2019-04-26 14:45:26 -0700318 inline void onLayerDestroyed(Layer* layer) {
319 mNumLayers--;
320 mOffscreenLayers.erase(layer);
321 }
Robert Carr2e102c92018-10-23 12:11:15 -0700322
Marissa Walle2ffb422018-10-12 11:33:52 -0700323 TransactionCompletedThread& getTransactionCompletedThread() {
324 return mTransactionCompletedThread;
325 }
326
Robert Carrc0df3122019-04-11 13:18:21 -0700327 sp<Layer> fromHandle(const sp<IBinder>& handle) REQUIRES(mStateLock);
328
Mathias Agopian1f339ff2011-07-01 17:08:43 -0700329private:
David Sodman0c69cad2017-08-21 12:12:51 -0700330 friend class BufferLayer;
Marissa Wallfd668622018-05-10 10:21:13 -0700331 friend class BufferQueueLayer;
Marissa Wall61c58622018-07-18 10:12:20 -0700332 friend class BufferStateLayer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700333 friend class Client;
334 friend class Layer;
Dan Stozab9b08832014-03-13 11:55:57 -0700335 friend class MonitoredProducer;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700336 friend class RefreshRateOverlay;
Dan Stozaec460082018-12-17 15:35:09 -0800337 friend class RegionSamplingThread;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800338 friend class SurfaceTracing;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800339
Lloyd Piquef58625d2017-12-19 13:22:33 -0800340 // For unit tests
341 friend class TestableSurfaceFlinger;
342
Jamie Gennis6547ff42013-07-16 20:12:42 -0700343 // This value is specified in number of frames. Log frame stats at most
344 // every half hour.
345 enum { LOG_FRAME_STATS_PERIOD = 30*60*60 };
346
Dan Stoza7d89d062015-04-30 13:29:25 -0700347 static const size_t MAX_LAYERS = 4096;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800348 static const int MAX_TRACING_MEMORY = 100 * 1024 * 1024; // 100MB
Dan Stoza7d89d062015-04-30 13:29:25 -0700349
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700350 // We're reference counted, never destroy SurfaceFlinger directly
351 virtual ~SurfaceFlinger();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800352
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700353 /* ------------------------------------------------------------------------
354 * Internal data structures
355 */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800356
Robert Carr2047fae2016-11-28 14:09:09 -0800357 class State {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800358 public:
chaviwfd462612018-05-31 16:11:27 -0700359 explicit State(LayerVector::StateSet set) : stateSet(set), layersSortedByZ(set) {}
Dan Stoza412903f2017-04-27 13:42:17 -0700360 State& operator=(const State& other) {
361 // We explicitly don't copy stateSet so that, e.g., mDrawingState
362 // always uses the Drawing StateSet.
363 layersSortedByZ = other.layersSortedByZ;
364 displays = other.displays;
Chia-I Wu28f320b2018-05-03 11:02:56 -0700365 colorMatrixChanged = other.colorMatrixChanged;
366 if (colorMatrixChanged) {
367 colorMatrix = other.colorMatrix;
368 }
Dan Stoza412903f2017-04-27 13:42:17 -0700369 return *this;
370 }
371
372 const LayerVector::StateSet stateSet = LayerVector::StateSet::Invalid;
Mathias Agopian92a979a2012-08-02 18:32:23 -0700373 LayerVector layersSortedByZ;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700374 DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays;
Robert Carr2047fae2016-11-28 14:09:09 -0800375
Chia-I Wu28f320b2018-05-03 11:02:56 -0700376 bool colorMatrixChanged = true;
377 mat4 colorMatrix;
378
Dan Stoza412903f2017-04-27 13:42:17 -0700379 void traverseInZOrder(const LayerVector::Visitor& visitor) const;
380 void traverseInReverseZOrder(const LayerVector::Visitor& visitor) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800381 };
382
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700383 /* ------------------------------------------------------------------------
384 * IBinder interface
385 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800386 status_t onTransact(uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags) override;
387 status_t dump(int fd, const Vector<String16>& args) override { return priorityDump(fd, args); }
Robert Carr14167e02019-02-13 13:50:55 -0800388 bool callingThreadHasUnscopedSurfaceFlingerAccess() EXCLUDES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800389
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700390 /* ------------------------------------------------------------------------
391 * ISurfaceComposer interface
392 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800393 sp<ISurfaceComposerClient> createConnection() override;
394 sp<IBinder> createDisplay(const String8& displayName, bool secure) override;
395 void destroyDisplay(const sp<IBinder>& displayToken) override;
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800396 std::vector<PhysicalDisplayId> getPhysicalDisplayIds() const override;
397 sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800398 void setTransactionState(const Vector<ComposerState>& state,
399 const Vector<DisplayState>& displays, uint32_t flags,
400 const sp<IBinder>& applyToken,
Marissa Wall17b4e452018-12-26 16:32:34 -0800401 const InputWindowCommands& inputWindowCommands,
Marissa Wall947d34e2019-03-29 14:03:53 -0700402 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700403 const std::vector<ListenerCallbacks>& listenerCallbacks) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800404 void bootFinished() override;
405 bool authenticateSurfaceTexture(
406 const sp<IGraphicBufferProducer>& bufferProducer) const override;
407 status_t getSupportedFrameTimestamps(std::vector<FrameEvent>* outSupported) const override;
408 sp<IDisplayEventConnection> createDisplayEventConnection(
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700409 ISurfaceComposer::VsyncSource vsyncSource = eVsyncSourceApp,
410 ISurfaceComposer::ConfigChanged configChanged =
411 ISurfaceComposer::eConfigChangedSuppress) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800412 status_t captureScreen(const sp<IBinder>& displayToken, sp<GraphicBuffer>* outBuffer,
Robert Carr108b2c72019-04-02 16:32:58 -0700413 bool& outCapturedSecureLayers, const ui::Dataspace reqDataspace,
414 const ui::PixelFormat reqPixelFormat, Rect sourceCrop,
415 uint32_t reqWidth, uint32_t reqHeight,
416 bool useIdentityTransform, ISurfaceComposer::Rotation rotation, bool captureSecureLayers) override;
chaviw93df2ea2019-04-30 16:45:12 -0700417 status_t captureScreen(uint64_t displayOrLayerStack, ui::Dataspace* outDataspace,
418 sp<GraphicBuffer>* outBuffer) override;
Robert Carr866455f2019-04-02 16:28:26 -0700419 status_t captureLayers(
420 const sp<IBinder>& parentHandle, sp<GraphicBuffer>* outBuffer,
421 const ui::Dataspace reqDataspace, const ui::PixelFormat reqPixelFormat,
422 const Rect& sourceCrop,
423 const std::unordered_set<sp<IBinder>, ISurfaceComposer::SpHash<IBinder>>& exclude,
424 float frameScale, bool childrenOnly) override;
Robert Carr108b2c72019-04-02 16:32:58 -0700425
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800426 status_t getDisplayStats(const sp<IBinder>& displayToken, DisplayStatInfo* stats) override;
427 status_t getDisplayConfigs(const sp<IBinder>& displayToken,
Dominik Laskowski22488f62019-03-28 09:53:04 -0700428 Vector<DisplayInfo>* configs) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800429 int getActiveConfig(const sp<IBinder>& displayToken) override;
430 status_t getDisplayColorModes(const sp<IBinder>& displayToken,
431 Vector<ui::ColorMode>* configs) override;
Daniel Solomon42d04562019-01-20 21:03:19 -0800432 status_t getDisplayNativePrimaries(const sp<IBinder>& displayToken,
433 ui::DisplayPrimaries &primaries);
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800434 ui::ColorMode getActiveColorMode(const sp<IBinder>& displayToken) override;
435 status_t setActiveColorMode(const sp<IBinder>& displayToken, ui::ColorMode colorMode) override;
436 void setPowerMode(const sp<IBinder>& displayToken, int mode) override;
437 status_t setActiveConfig(const sp<IBinder>& displayToken, int id) override;
438 status_t clearAnimationFrameStats() override;
439 status_t getAnimationFrameStats(FrameStats* outStats) const override;
440 status_t getHdrCapabilities(const sp<IBinder>& displayToken,
441 HdrCapabilities* outCapabilities) const override;
442 status_t enableVSyncInjections(bool enable) override;
443 status_t injectVSync(nsecs_t when) override;
444 status_t getLayerDebugInfo(std::vector<LayerDebugInfo>* outLayers) const override;
445 status_t getColorManagement(bool* outGetColorManagement) const override;
Peiyong Linc6780972018-10-28 15:24:08 -0700446 status_t getCompositionPreference(ui::Dataspace* outDataspace, ui::PixelFormat* outPixelFormat,
447 ui::Dataspace* outWideColorGamutDataspace,
448 ui::PixelFormat* outWideColorGamutPixelFormat) const override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800449 status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
450 ui::PixelFormat* outFormat,
451 ui::Dataspace* outDataspace,
452 uint8_t* outComponentMask) const override;
453 status_t setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
454 uint8_t componentMask,
455 uint64_t maxFrames) const override;
456 status_t getDisplayedContentSample(const sp<IBinder>& display, uint64_t maxFrames,
457 uint64_t timestamp,
458 DisplayedFrameStats* outStats) const override;
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800459 status_t getProtectedContentSupport(bool* outSupported) const override;
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800460 status_t isWideColorDisplay(const sp<IBinder>& displayToken,
461 bool* outIsWideColorDisplay) const override;
Dan Stoza84ab9372018-12-17 15:27:57 -0800462 status_t addRegionSamplingListener(const Rect& samplingArea, const sp<IBinder>& stopLayerHandle,
463 const sp<IRegionSamplingListener>& listener) override;
464 status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener) override;
Ady Abraham838de062019-02-04 10:24:03 -0800465 status_t setAllowedDisplayConfigs(const sp<IBinder>& displayToken,
466 const std::vector<int32_t>& allowedConfigs) override;
Ady Abrahamd9b3ea62019-02-26 14:08:03 -0800467 status_t getAllowedDisplayConfigs(const sp<IBinder>& displayToken,
468 std::vector<int32_t>* outAllowedConfigs) override;
Dan Gittik57e63c52019-01-18 16:37:54 +0000469 status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
470 bool* outSupport) const override;
471 status_t setDisplayBrightness(const sp<IBinder>& displayToken, float brightness) const override;
Ady Abraham8532d012019-05-08 14:50:56 -0700472 status_t notifyPowerHint(int32_t hintId) override;
Ady Abraham838de062019-02-04 10:24:03 -0800473
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700474 /* ------------------------------------------------------------------------
475 * DeathRecipient interface
476 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800477 void binderDied(const wp<IBinder>& who) override;
Mathias Agopian99ce5cd2012-01-31 18:24:27 -0800478
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700479 /* ------------------------------------------------------------------------
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700480 * RefBase interface
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700481 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800482 void onFirstRef() override;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800483
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700484 /* ------------------------------------------------------------------------
Steven Thomasb02664d2017-07-26 18:48:28 -0700485 * HWC2::ComposerCallback / HWComposer::EventHandler interface
Mathias Agopian86303202012-07-24 22:46:10 -0700486 */
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700487 void onVsyncReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId,
Steven Thomasb02664d2017-07-26 18:48:28 -0700488 int64_t timestamp) override;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700489 void onHotplugReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId,
Lloyd Pique715a2c12017-12-14 17:18:08 -0800490 HWC2::Connection connection) override;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700491 void onRefreshReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId) override;
Mathias Agopian86303202012-07-24 22:46:10 -0700492
493 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700494 * Message handling
495 */
496 void waitForEvent();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700497 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700498 void signalTransaction();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700499 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700500 void signalLayerUpdate();
501 void signalRefresh();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800502
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700503 using RefreshRateType = scheduler::RefreshRateConfigs::RefreshRateType;
504
Ady Abraham03b02dd2019-03-21 15:40:11 -0700505 struct ActiveConfigInfo {
506 RefreshRateType type;
507 int configId;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700508 Scheduler::ConfigEvent event;
509
510 bool operator!=(const ActiveConfigInfo& other) const {
Dominik Laskowski22488f62019-03-28 09:53:04 -0700511 return type != other.type || configId != other.configId || event != other.event;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700512 }
513 };
514
Andy McFadden13a082e2012-08-24 10:16:42 -0700515 // called on the main thread in response to initializeDisplays()
Dominik Laskowski83b88212018-12-11 13:34:06 -0800516 void onInitializeDisplays() REQUIRES(mStateLock);
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800517 // Sets the desired active config bit. It obtains the lock, and sets mDesiredActiveConfig.
Ady Abraham03b02dd2019-03-21 15:40:11 -0700518 void setDesiredActiveConfig(const ActiveConfigInfo& info) REQUIRES(mStateLock);
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800519 // Once HWC has returned the present fence, this sets the active config and a new refresh
Ady Abraham53852a52019-05-28 18:07:44 -0700520 // rate in SF.
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800521 void setActiveConfigInternal() REQUIRES(mStateLock);
522 // Active config is updated on INVALIDATE call in a state machine-like manner. When the
Ady Abrahamb838aed2019-02-12 15:30:16 -0800523 // desired config was set, HWC needs to update the panel on the next refresh, and when
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800524 // we receive the fence back, we know that the process was complete. It returns whether
Ady Abrahamb838aed2019-02-12 15:30:16 -0800525 // we need to wait for the next invalidate
Dominik Laskowski22488f62019-03-28 09:53:04 -0700526 bool performSetActiveConfig() REQUIRES(mStateLock);
Ady Abraham53852a52019-05-28 18:07:44 -0700527 // Called when active config is no longer is progress
528 void desiredActiveConfigChangeDone() REQUIRES(mStateLock);
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700529 // called on the main thread in response to setPowerMode()
Dominik Laskowski83b88212018-12-11 13:34:06 -0800530 void setPowerModeInternal(const sp<DisplayDevice>& display, int mode) REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800531
Ady Abraham838de062019-02-04 10:24:03 -0800532 // called on the main thread in response to setAllowedDisplayConfigs()
Dominik Laskowski22488f62019-03-28 09:53:04 -0700533 void setAllowedDisplayConfigsInternal(const sp<DisplayDevice>& display,
534 const std::vector<int32_t>& allowedConfigs)
535 REQUIRES(mStateLock);
Ady Abraham838de062019-02-04 10:24:03 -0800536
Dan Stoza6b9454d2014-11-07 16:00:59 -0800537 // Returns whether the transaction actually modified any state
538 bool handleMessageTransaction();
539
540 // Returns whether a new buffer has been latched (see handlePageFlip())
541 bool handleMessageInvalidate();
542
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700543 void handleMessageRefresh();
Mathias Agopian4fec8732012-06-29 14:12:52 -0700544
Mathias Agopian87baae12012-07-31 12:38:26 -0700545 void handleTransaction(uint32_t transactionFlags);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800546 void handleTransactionLocked(uint32_t transactionFlags) REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800547
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800548 void updateInputFlinger();
549 void updateInputWindowInfo();
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800550 void commitInputWindowCommands() REQUIRES(mStateLock);
chaviwfbe5d9c2018-12-26 12:23:37 -0800551 void executeInputWindowCommands();
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700552 void setInputWindowsFinished();
Riley Andrews03414a12014-07-01 14:22:59 -0700553 void updateCursorAsync();
554
Dan Stoza6b9454d2014-11-07 16:00:59 -0800555 /* handlePageFlip - latch a new buffer if available and compute the dirty
556 * region. Returns whether a new buffer has been latched, i.e., whether it
557 * is necessary to perform a refresh during this vsync.
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700558 */
Dan Stoza6b9454d2014-11-07 16:00:59 -0800559 bool handlePageFlip();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800560
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700561 /* ------------------------------------------------------------------------
562 * Transactions
563 */
Marissa Wall713b63f2018-10-17 15:42:43 -0700564 void applyTransactionState(const Vector<ComposerState>& state,
chaviw273171b2018-12-26 11:46:30 -0800565 const Vector<DisplayState>& displays, uint32_t flags,
Robert Carr14167e02019-02-13 13:50:55 -0800566 const InputWindowCommands& inputWindowCommands,
Marissa Wall78b72202019-03-15 14:58:34 -0700567 const int64_t desiredPresentTime,
Marissa Wall947d34e2019-03-29 14:03:53 -0700568 const client_cache_t& uncacheBuffer,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700569 const std::vector<ListenerCallbacks>& listenerCallbacks,
570 const int64_t postTime, bool privileged, bool isMainThread = false)
571 REQUIRES(mStateLock);
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700572 // Returns true if at least one transaction was flushed
Marissa Wall713b63f2018-10-17 15:42:43 -0700573 bool flushTransactionQueues();
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700574 // Returns true if there is at least one transaction that needs to be flushed
575 bool transactionFlushNeeded();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700576 uint32_t getTransactionFlags(uint32_t flags);
Fabien Sanglardc8251eb2016-12-07 13:59:48 -0800577 uint32_t peekTransactionFlags();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700578 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700579 uint32_t setTransactionFlags(uint32_t flags);
Ana Krulec7ecce8c2018-10-12 13:44:41 -0700580 uint32_t setTransactionFlags(uint32_t flags, Scheduler::TransactionStart transactionStart);
chaviw61626f22018-11-15 16:26:27 -0800581 void latchAndReleaseBuffer(const sp<Layer>& layer);
Nataniel Borges2b796da2019-02-15 13:32:18 -0800582 void commitTransaction() REQUIRES(mStateLock);
chaviw74d90ad2019-04-26 14:45:26 -0700583 void commitOffscreenLayers();
Marissa Wall17b4e452018-12-26 16:32:34 -0800584 bool transactionIsReadyToBeApplied(int64_t desiredPresentTime,
Dominik Laskowskia8955dd2019-07-10 10:19:09 -0700585 bool useCachedExpectedPresentTime,
Marissa Wall17b4e452018-12-26 16:32:34 -0800586 const Vector<ComposerState>& states);
Valerie Haubc6ddb12019-03-08 11:10:15 -0800587 uint32_t setClientStateLocked(const ComposerState& composerState, int64_t desiredPresentTime,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700588 const std::vector<ListenerCallbacks>& listenerCallbacks,
Valerie Haubc6ddb12019-03-08 11:10:15 -0800589 int64_t postTime, bool privileged) REQUIRES(mStateLock);
Vishnu Nairce5d0cc2019-02-28 14:38:41 -0800590 uint32_t setDisplayStateLocked(const DisplayState& s) REQUIRES(mStateLock);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800591 uint32_t addInputWindowCommands(const InputWindowCommands& inputWindowCommands)
592 REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800593
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700594 /* ------------------------------------------------------------------------
595 * Layer management
596 */
Marissa Wall2d814fb2019-04-09 18:52:57 +0000597 status_t createLayer(const String8& name, const sp<Client>& client, uint32_t w, uint32_t h,
598 PixelFormat format, uint32_t flags, LayerMetadata metadata,
Robert Carrc0df3122019-04-11 13:18:21 -0700599 sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp,
600 const sp<IBinder>& parentHandle, const sp<Layer>& parentLayer = nullptr);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800601
Marissa Wallfd668622018-05-10 10:21:13 -0700602 status_t createBufferQueueLayer(const sp<Client>& client, const String8& name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800603 uint32_t h, uint32_t flags, LayerMetadata metadata,
604 PixelFormat& format, sp<IBinder>* outHandle,
605 sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800606
Marissa Wall61c58622018-07-18 10:12:20 -0700607 status_t createBufferStateLayer(const sp<Client>& client, const String8& name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800608 uint32_t h, uint32_t flags, LayerMetadata metadata,
609 sp<IBinder>* outHandle, sp<Layer>* outLayer);
Marissa Wall61c58622018-07-18 10:12:20 -0700610
Evan Roskya1f1e152019-01-24 16:17:46 -0800611 status_t createColorLayer(const sp<Client>& client, const String8& name, uint32_t w, uint32_t h,
612 uint32_t flags, LayerMetadata metadata, sp<IBinder>* outHandle,
613 sp<Layer>* outLayer);
Mathias Agopian74c40c02010-09-29 13:02:36 -0700614
Evan Roskya1f1e152019-01-24 16:17:46 -0800615 status_t createContainerLayer(const sp<Client>& client, const String8& name, uint32_t w,
616 uint32_t h, uint32_t flags, LayerMetadata metadata,
617 sp<IBinder>* outHandle, sp<Layer>* outLayer);
Robert Carr6b3f6c52018-08-13 13:05:17 -0700618
Cody Northropbc755282017-03-31 12:00:08 -0600619 String8 getUniqueLayerName(const String8& name);
620
Rob Carr4bba3702018-10-08 21:53:30 +0000621 // called when all clients have released all their references to
622 // this layer meaning it is entirely safe to destroy all
623 // resources associated to this layer.
Robert Carr695d5282018-12-18 15:27:58 -0800624 void onHandleDestroyed(sp<Layer>& layer);
Robert Carr6fb1a7e2018-12-11 12:07:25 -0800625 void markLayerPendingRemovalLocked(const sp<Layer>& layer);
Mathias Agopiana4912602012-07-12 14:25:33 -0700626
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700627 // add a layer to SurfaceFlinger
Robert Carrc0df3122019-04-11 13:18:21 -0700628 status_t addClientLayer(const sp<Client>& client, const sp<IBinder>& handle,
629 const sp<IGraphicBufferProducer>& gbc, const sp<Layer>& lbc,
630 const sp<IBinder>& parentHandle, const sp<Layer>& parentLayer,
631 bool addToCurrentState);
Mathias Agopianf1d8e872009-04-20 19:39:12 -0700632
Vishnu Nair4351ad52019-02-11 14:13:02 -0800633 // Traverse through all the layers and compute and cache its bounds.
634 void computeLayerBounds();
635
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700636 /* ------------------------------------------------------------------------
637 * Boot animation, on/off animations and screen capture
638 */
Mathias Agopianbb641242010-05-18 17:06:55 -0700639
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700640 void startBootAnim();
Mathias Agopian96f08192010-06-02 23:28:45 -0700641
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700642 using TraverseLayersFunction = std::function<void(const LayerVector::Visitor&)>;
643
chaviwa76b2712017-09-20 12:02:26 -0700644 void renderScreenImplLocked(const RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000645 ANativeWindowBuffer* buffer, bool useIdentityTransform,
646 int* outSyncFd);
chaviwa76b2712017-09-20 12:02:26 -0700647 status_t captureScreenCommon(RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Peiyong Lin0e003c92018-09-17 11:09:51 -0700648 sp<GraphicBuffer>* outBuffer, const ui::PixelFormat reqPixelFormat,
Robert Carr108b2c72019-04-02 16:32:58 -0700649 bool useIdentityTransform, bool& outCapturedSecureLayers);
Kevin DuBois7cbcc372019-02-25 14:53:28 -0800650 status_t captureScreenCommon(RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Robert Carr108b2c72019-04-02 16:32:58 -0700651 const sp<GraphicBuffer>& buffer, bool useIdentityTransform,
652 bool& outCapturedSecureLayers);
chaviw93df2ea2019-04-30 16:45:12 -0700653 const sp<DisplayDevice> getDisplayByIdOrLayerStack(uint64_t displayOrLayerStack);
chaviwa76b2712017-09-20 12:02:26 -0700654 status_t captureScreenImplLocked(const RenderArea& renderArea,
655 TraverseLayersFunction traverseLayers,
656 ANativeWindowBuffer* buffer, bool useIdentityTransform,
Robert Carr108b2c72019-04-02 16:32:58 -0700657 bool forSystem, int* outSyncFd, bool& outCapturedSecureLayers);
chaviw0e3479f2018-09-10 16:49:30 -0700658 void traverseLayersInDisplay(const sp<const DisplayDevice>& display,
659 const LayerVector::Visitor& visitor);
Mathias Agopianabe815d2013-03-19 22:22:21 -0700660
Lloyd Pique90c115d2018-09-18 21:39:42 -0700661 sp<StartPropertySetThread> mStartPropertySetThread;
Wei Wangb254fa32017-01-31 17:43:23 -0800662
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700663 /* ------------------------------------------------------------------------
Romain Guy11d63f42017-07-20 12:47:14 -0700664 * Properties
665 */
666 void readPersistentProperties();
667
668 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700669 * EGL
670 */
Mathias Agopian875d8e12013-06-07 15:35:48 -0700671 size_t getMaxTextureSize() const;
672 size_t getMaxViewportDims() const;
Mathias Agopiana4912602012-07-12 14:25:33 -0700673
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700674 /* ------------------------------------------------------------------------
Mathias Agopian87baae12012-07-31 12:38:26 -0700675 * Display and layer stack management
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700676 */
Andy McFadden13a082e2012-08-24 10:16:42 -0700677 // called when starting, or restarting after system_server death
678 void initializeDisplays();
679
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700680 sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& displayToken) const {
681 Mutex::Autolock _l(mStateLock);
682 return getDisplayDeviceLocked(displayToken);
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700683 }
684
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700685 sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& displayToken) {
686 Mutex::Autolock _l(mStateLock);
687 return getDisplayDeviceLocked(displayToken);
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700688 }
689
690 // NOTE: can only be called from the main thread or with mStateLock held
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700691 sp<const DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) const {
692 return const_cast<SurfaceFlinger*>(this)->getDisplayDeviceLocked(displayToken);
Mathias Agopian92a979a2012-08-02 18:32:23 -0700693 }
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700694
695 // NOTE: can only be called from the main thread or with mStateLock held
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700696 sp<DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) {
Dominik Laskowski9fae1022018-05-29 13:17:40 -0700697 const auto it = mDisplays.find(displayToken);
698 return it == mDisplays.end() ? nullptr : it->second;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700699 }
Mathias Agopian99b49842011-06-27 16:05:52 -0700700
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700701 sp<const DisplayDevice> getDefaultDisplayDeviceLocked() const {
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700702 return const_cast<SurfaceFlinger*>(this)->getDefaultDisplayDeviceLocked();
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700703 }
704
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700705 sp<DisplayDevice> getDefaultDisplayDeviceLocked() {
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800706 if (const auto token = getInternalDisplayTokenLocked()) {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700707 return getDisplayDeviceLocked(token);
708 }
709 return nullptr;
Michael Wright28f24d02016-07-12 13:30:53 -0700710 }
711
Mathias Agopian87baae12012-07-31 12:38:26 -0700712 // mark a region of a layer stack dirty. this updates the dirty
713 // region of all screens presenting this layer stack.
Chia-I Wuab0c3192017-08-01 11:29:00 -0700714 void invalidateLayerStack(const sp<const Layer>& layer, const Region& dirty);
Mathias Agopian87baae12012-07-31 12:38:26 -0700715
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700716 /* ------------------------------------------------------------------------
Mathias Agopian86303202012-07-24 22:46:10 -0700717 * H/W composer
718 */
719
Lloyd Pique441d5042018-10-18 16:49:51 -0700720 // The current hardware composer interface.
721 //
722 // The following thread safety rules apply when accessing mHwc, either
723 // directly or via getHwComposer():
724 //
725 // 1. When recreating mHwc, acquire mStateLock. We currently recreate mHwc
726 // only when switching into and out of vr. Recreating mHwc must only be
727 // done on the main thread.
728 //
729 // 2. When accessing mHwc on the main thread, it's not necessary to acquire
730 // mStateLock.
731 //
732 // 3. When accessing mHwc on a thread other than the main thread, we always
733 // need to acquire mStateLock. This is because the main thread could be
734 // in the process of destroying the current mHwc instance.
735 //
736 // The above thread safety rules only apply to SurfaceFlinger.cpp. In
737 // SurfaceFlinger_hwc1.cpp we create mHwc at surface flinger init and never
738 // destroy it, so it's always safe to access mHwc from any thread without
739 // acquiring mStateLock.
740 HWComposer& getHwComposer() const;
Mathias Agopian86303202012-07-24 22:46:10 -0700741
Mathias Agopian888c8222012-08-04 21:10:38 -0700742 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700743 * Compositing
744 */
745 void invalidateHwcGeometry();
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700746 void computeVisibleRegions(const sp<const DisplayDevice>& display, Region& dirtyRegion,
747 Region& opaqueRegion);
Mathias Agopiancd60f992012-08-16 16:28:27 -0700748
David Sodman2b406362017-12-15 13:33:47 -0800749 void preComposition();
750 void postComposition();
Dominik Laskowskif654d572018-12-20 11:03:06 -0800751 void getCompositorTiming(CompositorTiming* compositorTiming);
Ana Krulece588e312018-09-18 12:32:24 -0700752 void updateCompositorTiming(const DisplayStatInfo& stats, nsecs_t compositeTime,
753 std::shared_ptr<FenceTime>& presentFenceTime);
754 void setCompositorTimingSnapped(const DisplayStatInfo& stats,
755 nsecs_t compositeToPresentLatency);
Mathias Agopiancd60f992012-08-16 16:28:27 -0700756 void rebuildLayerStacks();
Courtney Goeltzenleuchter5d943892017-03-22 13:46:46 -0600757
Peiyong Lin03912882019-04-16 15:34:46 -0700758 ui::Dataspace getBestDataspace(const sp<DisplayDevice>& display, ui::Dataspace* outHdrDataSpace,
759 bool* outIsHdrClientComposition) const;
Peiyong Lin136fbbc2018-04-17 15:09:44 -0700760
761 // Returns the appropriate ColorMode, Dataspace and RenderIntent for the
762 // DisplayDevice. The function only returns the supported ColorMode,
763 // Dataspace and RenderIntent.
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700764 void pickColorMode(const sp<DisplayDevice>& display, ui::ColorMode* outMode,
765 ui::Dataspace* outDataSpace, ui::RenderIntent* outRenderIntent) const;
Romain Guy0147a172017-06-01 13:53:56 -0700766
David Sodman79bba0e2018-08-05 18:07:49 -0700767 void calculateWorkingSet();
David Sodman2b406362017-12-15 13:33:47 -0800768 /*
769 * beginFrame - This function handles any pre-frame processing that needs to be
770 * prior to any CompositionInfo handling and is not dependent on data in
771 * CompositionInfo
772 */
David Sodmanfa9b2af2017-12-24 13:28:59 -0800773 void beginFrame(const sp<DisplayDevice>& display);
David Sodman2b406362017-12-15 13:33:47 -0800774 /* prepareFrame - This function will call into the DisplayDevice to prepare a
775 * frame after CompositionInfo has been programmed. This provides a mechanism
776 * to prepare the hardware composer
777 */
David Sodmanfa9b2af2017-12-24 13:28:59 -0800778 void prepareFrame(const sp<DisplayDevice>& display);
779 void doComposition(const sp<DisplayDevice>& display, bool repainEverything);
780 void doDebugFlashRegions(const sp<DisplayDevice>& display, bool repaintEverything);
Yiwei Zhang7124ad32018-02-21 13:02:45 -0800781 void logLayerStats();
Alec Mouri0a9c7b82018-11-16 13:05:25 -0800782 void doDisplayComposition(const sp<DisplayDevice>& display, const Region& dirtyRegion);
Michael Lentine3f121fc2014-10-01 11:17:28 -0700783
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000784 // This fails if using GL and the surface has been destroyed. readyFence
785 // will be populated if using GL and native fence sync is supported, to
786 // signal when drawing has completed.
787 bool doComposeSurfaces(const sp<DisplayDevice>& display, const Region& debugRegionm,
788 base::unique_fd* readyFence);
Mathias Agopiancd60f992012-08-16 16:28:27 -0700789
David Sodmanfa9b2af2017-12-24 13:28:59 -0800790 void postFramebuffer(const sp<DisplayDevice>& display);
791 void postFrame();
Mathias Agopian4da75192010-08-10 17:19:56 -0700792
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700793 /* ------------------------------------------------------------------------
Jamie Gennis0bceb842012-08-23 20:19:38 -0700794 * Display management
795 */
Lloyd Pique542307f2018-10-19 13:24:08 -0700796 sp<DisplayDevice> setupNewDisplayDeviceInternal(
797 const wp<IBinder>& displayToken, const std::optional<DisplayId>& displayId,
798 const DisplayDeviceState& state,
799 const sp<compositionengine::DisplaySurface>& dispSurface,
800 const sp<IGraphicBufferProducer>& producer);
Lloyd Pique347200f2017-12-14 17:00:15 -0800801 void processDisplayChangesLocked();
Lloyd Piqueba04e622017-12-14 17:11:26 -0800802 void processDisplayHotplugEventsLocked();
Mathias Agopian3ee454a2012-08-27 16:28:24 -0700803
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800804 void dispatchDisplayHotplugEvent(PhysicalDisplayId displayId, bool connected);
Dominik Laskowski1eba0202019-01-24 09:14:40 -0800805
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700806 /* ------------------------------------------------------------------------
807 * VSync
808 */
Dominik Laskowski83b88212018-12-11 13:34:06 -0800809 nsecs_t getVsyncPeriod() const REQUIRES(mStateLock);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700810
Dominik Laskowskiccf37d72019-02-01 16:47:58 -0800811 // Sets the refresh rate by switching active configs, if they are available for
Ana Krulec7d1d6832018-12-27 11:10:09 -0800812 // the desired refresh rate.
Ady Abraham03b02dd2019-03-21 15:40:11 -0700813 void setRefreshRateTo(RefreshRateType, Scheduler::ConfigEvent event) REQUIRES(mStateLock);
Jamie Gennis0bceb842012-08-23 20:19:38 -0700814
Ady Abraham261614e2019-07-10 17:53:12 -0700815 bool isDisplayConfigAllowed(int32_t configId) const REQUIRES(mStateLock);
Jamie Gennis0bceb842012-08-23 20:19:38 -0700816
Dominik Laskowskia8955dd2019-07-10 10:19:09 -0700817 bool previousFrameMissed();
818
819 // Populates the expected present time for this frame. For negative offsets, performs a
820 // correction using the predicted vsync for the next frame instead.
821 void populateExpectedPresentTime();
822
Dominik Laskowskic2867142019-01-21 11:33:38 -0800823 /*
824 * Display identification
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700825 */
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800826 sp<IBinder> getPhysicalDisplayTokenLocked(DisplayId displayId) const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700827 const auto it = mPhysicalDisplayTokens.find(displayId);
828 return it != mPhysicalDisplayTokens.end() ? it->second : nullptr;
829 }
830
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800831 std::optional<DisplayId> getPhysicalDisplayIdLocked(const sp<IBinder>& displayToken) const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700832 for (const auto& [id, token] : mPhysicalDisplayTokens) {
833 if (token == displayToken) {
834 return id;
835 }
836 }
837 return {};
838 }
839
840 // TODO(b/74619554): Remove special cases for primary display.
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800841 sp<IBinder> getInternalDisplayTokenLocked() const {
842 const auto displayId = getInternalDisplayIdLocked();
843 return displayId ? getPhysicalDisplayTokenLocked(*displayId) : nullptr;
Dominik Laskowski075d3172018-05-24 15:50:06 -0700844 }
845
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800846 std::optional<DisplayId> getInternalDisplayIdLocked() const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700847 const auto hwcDisplayId = getHwComposer().getInternalHwcDisplayId();
848 return hwcDisplayId ? getHwComposer().toPhysicalDisplayId(*hwcDisplayId) : std::nullopt;
849 }
850
Dominik Laskowskic2867142019-01-21 11:33:38 -0800851 /*
852 * Debugging & dumpsys
853 */
Dominik Laskowskic2867142019-01-21 11:33:38 -0800854 using DumpArgs = Vector<String16>;
855 using Dumper = std::function<void(const DumpArgs&, bool asProto, std::string&)>;
856
857 template <typename F, std::enable_if_t<!std::is_member_function_pointer_v<F>>* = nullptr>
858 static Dumper dumper(F&& dump) {
859 using namespace std::placeholders;
860 return std::bind(std::forward<F>(dump), _3);
861 }
862
863 template <typename F, std::enable_if_t<std::is_member_function_pointer_v<F>>* = nullptr>
864 Dumper dumper(F dump) {
865 using namespace std::placeholders;
866 return std::bind(dump, this, _3);
867 }
868
869 template <typename F>
870 Dumper argsDumper(F dump) {
871 using namespace std::placeholders;
872 return std::bind(dump, this, _1, _3);
873 }
874
875 template <typename F>
876 Dumper protoDumper(F dump) {
877 using namespace std::placeholders;
878 return std::bind(dump, this, _1, _2, _3);
879 }
880
881 void dumpAllLocked(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
882
883 void appendSfConfigString(std::string& result) const;
884 void listLayersLocked(std::string& result) const;
885 void dumpStatsLocked(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
886 void clearStatsLocked(const DumpArgs& args, std::string& result);
887 void dumpTimeStats(const DumpArgs& args, bool asProto, std::string& result) const;
Jamie Gennis6547ff42013-07-16 20:12:42 -0700888 void logFrameStats();
889
Dominik Laskowskid9e4de62019-01-21 14:23:01 -0800890 void dumpVSync(std::string& result) const REQUIRES(mStateLock);
Yiwei Zhang5434a782018-12-05 18:06:32 -0800891 void dumpStaticScreenStats(std::string& result) const;
Brian Andersond6927fb2016-07-23 23:37:30 -0700892 // Not const because each Layer needs to query Fences and cache timestamps.
Yiwei Zhang5434a782018-12-05 18:06:32 -0800893 void dumpFrameEventsLocked(std::string& result);
Dan Stozab90cf072015-03-05 11:05:59 -0800894
Dan Stozae77c7662016-05-13 11:37:28 -0700895 void recordBufferingStats(const char* layerName,
896 std::vector<OccupancyTracker::Segment>&& history);
Yiwei Zhang5434a782018-12-05 18:06:32 -0800897 void dumpBufferingStats(std::string& result) const;
898 void dumpDisplayIdentificationData(std::string& result) const;
899 void dumpWideColorInfo(std::string& result) const;
Vishnu Nair8406fd72019-07-30 11:29:31 -0700900 LayersProto dumpDrawingStateProto(uint32_t traceFlags = SurfaceTracing::TRACE_ALL) const;
901 LayersProto dumpProtoFromMainThread(uint32_t traceFlags = SurfaceTracing::TRACE_ALL)
902 EXCLUDES(mStateLock);
Nataniel Borges2b796da2019-02-15 13:32:18 -0800903 void withTracingLock(std::function<void()> operation) REQUIRES(mStateLock);
Lloyd Pique37c2c9b2018-12-04 17:25:10 -0800904 LayersProto dumpVisibleLayersProtoInfo(const sp<DisplayDevice>& display) const;
Dan Stozae77c7662016-05-13 11:37:28 -0700905
Fabien Sanglard63a5fcd2016-12-29 15:13:07 -0800906 bool isLayerTripleBufferingDisabled() const {
907 return this->mLayerTripleBufferingDisabled;
908 }
Dominik Laskowskic2867142019-01-21 11:33:38 -0800909
910 status_t doDump(int fd, const DumpArgs& args, bool asProto);
911
Nataniel Borges8e7dc722019-02-28 15:10:28 -0800912 status_t dumpCritical(int fd, const DumpArgs&, bool asProto);
Dominik Laskowskic2867142019-01-21 11:33:38 -0800913
914 status_t dumpAll(int fd, const DumpArgs& args, bool asProto) override {
915 return doDump(fd, args, asProto);
916 }
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800917
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800918 /* ------------------------------------------------------------------------
919 * VrFlinger
920 */
Steven Thomasb02664d2017-07-26 18:48:28 -0700921 void resetDisplayState();
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800922
Steven Thomas050b2c82017-03-06 11:45:16 -0800923 // Check to see if we should handoff to vr flinger.
924 void updateVrFlinger();
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800925
Chia-I Wu28f320b2018-05-03 11:02:56 -0700926 void updateColorMatrixLocked();
927
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700928 /* ------------------------------------------------------------------------
929 * Attributes
930 */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800931
Lloyd Pique90c115d2018-09-18 21:39:42 -0700932 surfaceflinger::Factory& mFactory;
933
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700934 // access must be protected by mStateLock
935 mutable Mutex mStateLock;
Dan Stoza412903f2017-04-27 13:42:17 -0700936 State mCurrentState{LayerVector::StateSet::Current};
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700937 std::atomic<int32_t> mTransactionFlags = 0;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700938 Condition mTransactionCV;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700939 bool mTransactionPending = false;
940 bool mAnimTransactionPending = false;
941 SortedVector<sp<Layer>> mLayersPendingRemoval;
942 bool mTraversalNeededMainThread = false;
Dan Stoza101d8dc2018-02-27 15:42:25 -0800943
Nataniel Borges2b796da2019-02-15 13:32:18 -0800944 // guards access to the mDrawing state if tracing is enabled.
945 mutable std::mutex mDrawingStateLock;
946
Chia-I Wu28f320b2018-05-03 11:02:56 -0700947 // global color transform states
948 Daltonizer mDaltonizer;
949 float mGlobalSaturationFactor = 1.0f;
950 mat4 mClientColorMatrix;
951
Dan Stoza101d8dc2018-02-27 15:42:25 -0800952 // Can't be unordered_set because wp<> isn't hashable
953 std::set<wp<IBinder>> mGraphicBufferProducerList;
Dan Stoza0a0158c2018-03-16 13:38:54 -0700954 size_t mMaxGraphicBufferProducerListSize = MAX_LAYERS;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800955
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700956 // protected by mStateLock (but we could use another lock)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700957 bool mLayersRemoved = false;
958 bool mLayersAdded = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -0700959
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700960 std::atomic<bool> mRepaintEverything = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -0700961
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800962 // constant members (no synchronization needed for access)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700963 const nsecs_t mBootTime = systemTime();
964 bool mGpuToCpuSupported = false;
Lloyd Piquee83f9312018-02-01 12:53:17 -0800965 std::unique_ptr<EventThread> mInjectorEventThread;
Lloyd Piquee83f9312018-02-01 12:53:17 -0800966 std::unique_ptr<InjectVSyncSource> mVSyncInjector;
Mathias Agopian3094df32012-06-18 18:06:45 -0700967
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700968 // Can only accessed from the main thread, these members
969 // don't need synchronization
Dan Stoza412903f2017-04-27 13:42:17 -0700970 State mDrawingState{LayerVector::StateSet::Drawing};
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700971 bool mVisibleRegionsDirty = false;
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800972 // Set during transaction commit stage to track if the input info for a layer has changed.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700973 bool mInputInfoChanged = false;
974 bool mGeometryInvalid = false;
975 bool mAnimCompositionPending = false;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800976 std::vector<sp<Layer>> mLayersWithQueuedFrames;
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800977 // Tracks layers that need to update a display's dirty region.
978 std::vector<sp<Layer>> mLayersPendingRefresh;
Ady Abrahambe0f9482019-04-24 15:41:53 -0700979 std::array<sp<Fence>, 2> mPreviousPresentFences = {Fence::NO_FENCE, Fence::NO_FENCE};
Alec Mouricc0fc602019-02-26 21:45:19 -0800980 // True if in the previous frame at least one layer was composed via the GPU.
Dan Stoza05dacfb2016-07-01 13:33:38 -0700981 bool mHadClientComposition = false;
Alec Mouricc0fc602019-02-26 21:45:19 -0800982 // True if in the previous frame at least one layer was composed via HW Composer.
983 // Note that it is possible for a frame to be composed via both client and device
984 // composition, for example in the case of overlays.
985 bool mHadDeviceComposition = false;
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700986
Chia-I Wu14c9c7b2018-06-26 10:18:18 +0800987 enum class BootStage {
988 BOOTLOADER,
989 BOOTANIMATION,
990 FINISHED,
991 };
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700992 BootStage mBootStage = BootStage::BOOTLOADER;
Chia-I Wu14c9c7b2018-06-26 10:18:18 +0800993
Lloyd Piqueba04e622017-12-14 17:11:26 -0800994 struct HotplugEvent {
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700995 hwc2_display_t hwcDisplayId;
Lloyd Piqueba04e622017-12-14 17:11:26 -0800996 HWC2::Connection connection = HWC2::Connection::Invalid;
Lloyd Piqueba04e622017-12-14 17:11:26 -0800997 };
998 // protected by mStateLock
999 std::vector<HotplugEvent> mPendingHotplugEvents;
1000
Mathias Agopiandb9b41f2012-10-15 16:51:41 -07001001 // this may only be written from the main thread with mStateLock held
1002 // it may be read from other threads with mStateLock held
Dominik Laskowski9fae1022018-05-29 13:17:40 -07001003 std::map<wp<IBinder>, sp<DisplayDevice>> mDisplays;
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -08001004 std::unordered_map<DisplayId, sp<IBinder>> mPhysicalDisplayTokens;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001005
Robert Carrc0df3122019-04-11 13:18:21 -07001006 // protected by mStateLock
1007 std::unordered_map<BBinder*, wp<Layer>> mLayersByLocalBinderToken;
1008
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001009 // don't use a lock for these, we don't care
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001010 int mDebugRegion = 0;
1011 bool mDebugDisableHWC = false;
1012 bool mDebugDisableTransformHint = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001013 volatile nsecs_t mDebugInTransaction = 0;
1014 bool mForceFullDamage = false;
Dan Stozac5da2712016-07-20 15:38:12 -07001015 bool mPropagateBackpressure = true;
Ady Abraham4658e112019-07-22 13:07:26 -07001016 bool mPropagateBackpressureClientComposition = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001017 std::unique_ptr<SurfaceInterceptor> mInterceptor;
1018 SurfaceTracing mTracing{*this};
Nataniel Borges2b796da2019-02-15 13:32:18 -08001019 bool mTracingEnabled = false;
1020 bool mTracingEnabledChanged GUARDED_BY(mStateLock) = false;
Yiwei Zhang7124ad32018-02-21 13:02:45 -08001021 LayerStats mLayerStats;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001022 const std::shared_ptr<TimeStats> mTimeStats;
Fabien Sanglard642b23d2017-02-09 12:29:39 -08001023 bool mUseHwcVirtualDisplays = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001024 std::atomic<uint32_t> mFrameMissedCount = 0;
1025 std::atomic<uint32_t> mHwcFrameMissedCount = 0;
1026 std::atomic<uint32_t> mGpuFrameMissedCount = 0;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001027
Marissa Walle2ffb422018-10-12 11:33:52 -07001028 TransactionCompletedThread mTransactionCompletedThread;
1029
Fabien Sanglard63a5fcd2016-12-29 15:13:07 -08001030 // Restrict layers to use two buffers in their bufferqueues.
1031 bool mLayerTripleBufferingDisabled = false;
1032
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001033 // these are thread safe
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001034 std::unique_ptr<MessageQueue> mEventQueue;
Jamie Gennis4b0eba92013-02-05 13:30:24 -08001035 FrameTracker mAnimFrameTracker;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001036
1037 // protected by mDestroyedLayerLock;
1038 mutable Mutex mDestroyedLayerLock;
Mathias Agopian13127d82013-03-05 17:47:11 -08001039 Vector<Layer const *> mDestroyedLayers;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001040
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001041 nsecs_t mRefreshStartTime = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -07001042
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001043 std::atomic<bool> mRefreshPending = false;
Dan Stoza2b6d38e2017-06-01 16:40:30 -07001044
Dan Stoza436ccf32018-06-21 12:10:12 -07001045 // We maintain a pool of pre-generated texture names to hand out to avoid
1046 // layer creation needing to run on the main thread (which it would
1047 // otherwise need to do to access RenderEngine).
1048 std::mutex mTexturePoolMutex;
1049 uint32_t mTexturePoolSize = 0;
1050 std::vector<uint32_t> mTexturePool;
1051
Marissa Wall713b63f2018-10-17 15:42:43 -07001052 struct IBinderHash {
1053 std::size_t operator()(const sp<IBinder>& strongPointer) const {
1054 return std::hash<IBinder*>{}(strongPointer.get());
1055 }
1056 };
1057 struct TransactionState {
1058 TransactionState(const Vector<ComposerState>& composerStates,
Marissa Wall17b4e452018-12-26 16:32:34 -08001059 const Vector<DisplayState>& displayStates, uint32_t transactionFlags,
Marissa Wall947d34e2019-03-29 14:03:53 -07001060 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
Marissa Wall3dad52d2019-03-22 14:03:19 -07001061 const std::vector<ListenerCallbacks>& listenerCallbacks, int64_t postTime,
1062 bool privileged)
Marissa Wall17b4e452018-12-26 16:32:34 -08001063 : states(composerStates),
1064 displays(displayStates),
1065 flags(transactionFlags),
Valerie Haubc6ddb12019-03-08 11:10:15 -08001066 desiredPresentTime(desiredPresentTime),
Marissa Wall78b72202019-03-15 14:58:34 -07001067 buffer(uncacheBuffer),
Marissa Wall3dad52d2019-03-22 14:03:19 -07001068 callback(listenerCallbacks),
Valerie Haubc6ddb12019-03-08 11:10:15 -08001069 postTime(postTime),
Robert Carr14167e02019-02-13 13:50:55 -08001070 privileged(privileged) {}
Marissa Wall713b63f2018-10-17 15:42:43 -07001071
1072 Vector<ComposerState> states;
1073 Vector<DisplayState> displays;
1074 uint32_t flags;
Valerie Haubc6ddb12019-03-08 11:10:15 -08001075 const int64_t desiredPresentTime;
Marissa Wall947d34e2019-03-29 14:03:53 -07001076 client_cache_t buffer;
Marissa Wall3dad52d2019-03-22 14:03:19 -07001077 std::vector<ListenerCallbacks> callback;
Valerie Haubc6ddb12019-03-08 11:10:15 -08001078 const int64_t postTime;
Robert Carr14167e02019-02-13 13:50:55 -08001079 bool privileged;
Marissa Wall713b63f2018-10-17 15:42:43 -07001080 };
1081 std::unordered_map<sp<IBinder>, std::queue<TransactionState>, IBinderHash> mTransactionQueues;
1082
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001083 /* ------------------------------------------------------------------------
1084 * Feature prototyping
1085 */
1086
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001087 bool mInjectVSyncs = false;
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -07001088
Dan Stozab90cf072015-03-05 11:05:59 -08001089 // Static screen stats
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001090 bool mHasPoweredOff = false;
Dan Stozae77c7662016-05-13 11:37:28 -07001091
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001092 size_t mNumLayers = 0;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001093
Fabien Sanglard6e8e98a2016-10-27 20:04:11 -07001094 // Verify that transaction is being called by an approved process:
1095 // either AID_GRAPHICS or AID_SYSTEM.
1096 status_t CheckTransactCodeCredentials(uint32_t code);
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -08001097
Steven Morelanda904bb92019-07-02 17:37:23 -07001098 // to linkToDeath
1099 sp<IBinder> mWindowManager;
1100
Steven Thomasb02664d2017-07-26 18:48:28 -07001101 std::unique_ptr<dvr::VrFlinger> mVrFlinger;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001102 std::atomic<bool> mVrFlingerRequestsDisplay = false;
Steven Thomas050b2c82017-03-06 11:45:16 -08001103 static bool useVrFlinger;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001104 std::thread::id mMainThreadId = std::this_thread::get_id();
Romain Guy0147a172017-06-01 13:53:56 -07001105
Chia-I Wue0ec4312018-07-03 01:17:18 +08001106 DisplayColorSetting mDisplayColorSetting = DisplayColorSetting::ENHANCED;
David Sodman105b7dc2017-11-04 20:28:14 -07001107
Peiyong Lina3ea5592019-02-10 14:45:00 -08001108 // Color mode forced by setting persist.sys.sf.color_mode, it must:
1109 // 1. not be NATIVE color mode, NATIVE color mode means no forced color mode;
1110 // 2. be one of the supported color modes returned by hardware composer, otherwise
1111 // it will not be respected.
1112 // persist.sys.sf.color_mode will only take effect when persist.sys.sf.native_mode
1113 // is not set to 1.
1114 // This property can be used to force SurfaceFlinger to always pick a certain color mode.
1115 ui::ColorMode mForceColorMode = ui::ColorMode::NATIVE;
1116
Peiyong Lin9d846a52018-11-05 13:18:20 -08001117 ui::Dataspace mDefaultCompositionDataspace;
1118 ui::Dataspace mWideColorGamutCompositionDataspace;
Yichi Chenda901bf2019-06-28 14:58:27 +08001119 ui::Dataspace mColorSpaceAgnosticDataspace;
Peiyong Lin9d846a52018-11-05 13:18:20 -08001120
David Sodman105b7dc2017-11-04 20:28:14 -07001121 SurfaceFlingerBE mBE;
Lloyd Pique70d91362018-10-18 16:02:55 -07001122 std::unique_ptr<compositionengine::CompositionEngine> mCompositionEngine;
Ana Krulec98b5b242018-08-10 15:03:23 -07001123
Ana Krulecb43429d2019-01-09 14:28:51 -08001124 /* ------------------------------------------------------------------------
1125 * Scheduler
1126 */
Ana Krulecba13ab32019-02-20 14:14:12 -08001127 bool mUseSmart90ForVideo = false;
Ana Krulec98b5b242018-08-10 15:03:23 -07001128 std::unique_ptr<Scheduler> mScheduler;
1129 sp<Scheduler::ConnectionHandle> mAppConnectionHandle;
1130 sp<Scheduler::ConnectionHandle> mSfConnectionHandle;
Robert Carr720e5062018-07-30 17:45:14 -07001131
Dominik Laskowskieddeda12019-07-19 11:54:13 -07001132 // Stores phase offsets configured per refresh rate.
1133 const std::unique_ptr<scheduler::PhaseOffsets> mPhaseOffsets;
1134
1135 // Optional to defer construction until scheduler connections are created.
1136 std::optional<scheduler::VSyncModulator> mVSyncModulator;
1137
Dominik Laskowski22488f62019-03-28 09:53:04 -07001138 scheduler::RefreshRateConfigs mRefreshRateConfigs;
1139 scheduler::RefreshRateStats mRefreshRateStats{mRefreshRateConfigs, *mTimeStats};
Ady Abraham1902d072019-03-01 17:18:59 -08001140
Dominik Laskowskia8955dd2019-07-10 10:19:09 -07001141 std::atomic<nsecs_t> mExpectedPresentTime = 0;
1142
Dominik Laskowski22488f62019-03-28 09:53:04 -07001143 // All configs are allowed if the set is empty.
Ady Abraham3bb89732019-04-08 11:22:01 -07001144 using DisplayConfigs = std::set<int32_t>;
Dominik Laskowski22488f62019-03-28 09:53:04 -07001145 DisplayConfigs mAllowedDisplayConfigs GUARDED_BY(mStateLock);
Ady Abraham838de062019-02-04 10:24:03 -08001146
Ana Kruleca5bdd9d2019-01-29 19:00:58 -08001147 std::mutex mActiveConfigLock;
1148 // This bit is set once we start setting the config. We read from this bit during the
1149 // process. If at the end, this bit is different than mDesiredActiveConfig, we restart
1150 // the process.
1151 ActiveConfigInfo mUpcomingActiveConfig; // Always read and written on the main thread.
1152 // This bit can be set at any point in time when the system wants the new config.
1153 ActiveConfigInfo mDesiredActiveConfig GUARDED_BY(mActiveConfigLock);
1154
Ady Abrahamb838aed2019-02-12 15:30:16 -08001155 // below flags are set by main thread only
Ady Abraham50204dd2019-07-19 15:47:11 -07001156 TracedOrdinal<bool> mDesiredActiveConfigChanged
1157 GUARDED_BY(mActiveConfigLock) = {"DesiredActiveConfigChanged", false};
Ady Abrahamb838aed2019-02-12 15:30:16 -08001158 bool mCheckPendingFence = false;
1159
Kevin DuBois413287f2019-02-25 08:46:47 -08001160 bool mLumaSampling = true;
1161 sp<RegionSamplingThread> mRegionSamplingThread;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001162 ui::DisplayPrimaries mInternalDisplayPrimaries;
Kevin DuBois413287f2019-02-25 08:46:47 -08001163
Robert Carr720e5062018-07-30 17:45:14 -07001164 sp<IInputFlinger> mInputFlinger;
Vishnu Nairfa5f8df2019-02-13 17:02:51 -08001165 InputWindowCommands mPendingInputWindowCommands GUARDED_BY(mStateLock);
1166 // Should only be accessed by the main thread.
chaviw273171b2018-12-26 11:46:30 -08001167 InputWindowCommands mInputWindowCommands;
chaviw291d88a2019-02-14 10:33:58 -08001168
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001169 struct SetInputWindowsListener : BnSetInputWindowsListener {
1170 explicit SetInputWindowsListener(sp<SurfaceFlinger> flinger)
1171 : mFlinger(std::move(flinger)) {}
1172
1173 void onSetInputWindowsFinished() override;
1174
1175 const sp<SurfaceFlinger> mFlinger;
1176 };
1177
1178 const sp<SetInputWindowsListener> mSetInputWindowsListener = new SetInputWindowsListener(this);
1179
chaviw95ef3c42019-02-14 10:55:09 -08001180 bool mPendingSyncInputWindows GUARDED_BY(mStateLock);
Peiyong Lin74ca2f42019-01-14 19:36:57 -08001181 Hwc2::impl::PowerAdvisor mPowerAdvisor;
Ady Abraham03b02dd2019-03-21 15:40:11 -07001182
1183 std::unique_ptr<RefreshRateOverlay> mRefreshRateOverlay;
Ady Abraham34392f72019-04-10 11:29:27 -07001184
1185 // Flag used to set override allowed display configs from backdoor
1186 bool mDebugDisplayConfigSetByBackdoor = false;
chaviw74d90ad2019-04-26 14:45:26 -07001187
1188 // A set of layers that have no parent so they are not drawn on screen.
1189 // Should only be accessed by the main thread.
1190 // The Layer pointer is removed from the set when the destructor is called so there shouldn't
1191 // be any issues with a raw pointer referencing an invalid object.
1192 std::unordered_set<Layer*> mOffscreenLayers;
Ady Abraham9ba25122019-06-03 17:10:55 -07001193
Ady Abraham27c70212019-06-11 10:52:26 -07001194 // Flags to capture the state of Vsync in HWC
1195 HWC2::Vsync mHWCVsyncState = HWC2::Vsync::Disable;
1196 HWC2::Vsync mHWCVsyncPendingState = HWC2::Vsync::Disable;
Romain Guy0147a172017-06-01 13:53:56 -07001197};
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001198
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001199} // namespace android