blob: f8980a513fb4b0fd72379f85990b2ce2fb0de82b [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>
Lloyd Pique6a3b4462019-03-07 20:58:12 -080026#include <compositionengine/OutputColorSetting.h>
Steven Moreland2716e112018-02-23 14:57:20 -080027#include <cutils/atomic.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080028#include <cutils/compiler.h>
29#include <gui/BufferQueue.h>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080030#include <gui/FrameTimestamps.h>
Mathias Agopian90ac7992012-02-25 18:48:35 -080031#include <gui/ISurfaceComposer.h>
32#include <gui/ISurfaceComposerClient.h>
Valerie Hau5de3ad22019-08-20 07:47:43 -070033#include <gui/ITransactionCompletedListener.h>
Robert Carr4cdc58f2017-08-23 14:22:20 -070034#include <gui/LayerState.h>
Dan Stozae77c7662016-05-13 11:37:28 -070035#include <gui/OccupancyTracker.h>
Mathias Agopian86303202012-07-24 22:46:10 -070036#include <hardware/hwcomposer_defs.h>
chaviw291d88a2019-02-14 10:33:58 -080037#include <input/ISetInputWindowsListener.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080038#include <layerproto/LayerProtoHeader.h>
39#include <math/mat4.h>
Vishnu Nair08f6eae2019-11-26 14:01:39 -080040#include <renderengine/LayerSettings.h>
Vishnu Nair35798872017-10-06 16:00:36 -070041#include <serviceutils/PriorityDumper.h>
Michael Wright28f24d02016-07-12 13:30:53 -070042#include <system/graphics.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080043#include <ui/FenceTime.h>
44#include <ui/PixelFormat.h>
45#include <utils/Errors.h>
46#include <utils/KeyedVector.h>
47#include <utils/RefBase.h>
48#include <utils/SortedVector.h>
49#include <utils/Trace.h>
50#include <utils/threads.h>
Michael Wright28f24d02016-07-12 13:30:53 -070051
Marissa Wall947d34e2019-03-29 14:03:53 -070052#include "ClientCache.h"
Mathias Agopian92a979a2012-08-02 18:32:23 -070053#include "DisplayDevice.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080054#include "DisplayHardware/HWC2.h"
Peiyong Lin74ca2f42019-01-14 19:36:57 -080055#include "DisplayHardware/PowerAdvisor.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080056#include "Effects/Daltonizer.h"
Jamie Gennis4b0eba92013-02-05 13:30:24 -080057#include "FrameTracker.h"
Robert Carr2047fae2016-11-28 14:09:09 -080058#include "LayerVector.h"
Dominik Laskowskiccf37d72019-02-01 16:47:58 -080059#include "Scheduler/RefreshRateConfigs.h"
Ana Krulecb43429d2019-01-09 14:28:51 -080060#include "Scheduler/RefreshRateStats.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070061#include "Scheduler/Scheduler.h"
Ana Krulecfefcb582018-08-07 14:22:37 -070062#include "Scheduler/VSyncModulator.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080063#include "SurfaceFlingerFactory.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080064#include "SurfaceTracing.h"
Ady Abraham50204dd2019-07-19 15:47:11 -070065#include "TracedOrdinal.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080066#include "TransactionCompletedThread.h"
Mathias Agopian86303202012-07-24 22:46:10 -070067
Dominik Laskowski83b88212018-12-11 13:34:06 -080068#include <atomic>
69#include <cstdint>
Dominik Laskowskic2867142019-01-21 11:33:38 -080070#include <functional>
Dan Stozae77c7662016-05-13 11:37:28 -070071#include <map>
Dominik Laskowski83b88212018-12-11 13:34:06 -080072#include <memory>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080073#include <mutex>
Dominik Laskowskieddeda12019-07-19 11:54:13 -070074#include <optional>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080075#include <queue>
Dominik Laskowski075d3172018-05-24 15:50:06 -070076#include <set>
Dan Stozae77c7662016-05-13 11:37:28 -070077#include <string>
Steven Thomasb02664d2017-07-26 18:48:28 -070078#include <thread>
Dominik Laskowskic2867142019-01-21 11:33:38 -080079#include <type_traits>
Dominik Laskowski075d3172018-05-24 15:50:06 -070080#include <unordered_map>
Dominik Laskowski22488f62019-03-28 09:53:04 -070081#include <unordered_set>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080082#include <utility>
Dan Stozae77c7662016-05-13 11:37:28 -070083
chaviw1d044282017-09-27 12:19:28 -070084using namespace android::surfaceflinger;
85
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080086namespace android {
87
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080088class Client;
Lloyd Pique144e1162017-12-20 16:44:52 -080089class EventThread;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070090class HWComposer;
Lloyd Pique12eb4232018-01-17 11:54:43 -080091class IGraphicBufferProducer;
Robert Carr720e5062018-07-30 17:45:14 -070092class IInputFlinger;
Lloyd Pique144e1162017-12-20 16:44:52 -080093class Layer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070094class MessageBase;
Ady Abraham03b02dd2019-03-21 15:40:11 -070095class RefreshRateOverlay;
Dominik Laskowski9dab3432019-03-27 13:21:10 -070096class RegionSamplingThread;
Yiwei Zhang7e666a52018-11-15 13:33:42 -080097class TimeStats;
Mikael Pessa90092f42019-08-26 17:22:04 -070098class FrameTracer;
Lloyd Pique144e1162017-12-20 16:44:52 -080099
Lloyd Pique542307f2018-10-19 13:24:08 -0700100namespace compositionengine {
101class DisplaySurface;
Lloyd Pique26d03fd2019-03-07 21:23:23 -0800102class OutputLayer;
Lloyd Pique6a3b4462019-03-07 20:58:12 -0800103
104struct CompositionRefreshArgs;
Lloyd Pique542307f2018-10-19 13:24:08 -0700105} // namespace compositionengine
106
Peiyong Lin833074a2018-08-28 11:53:54 -0700107namespace renderengine {
Lloyd Pique144e1162017-12-20 16:44:52 -0800108class RenderEngine;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700109} // namespace renderengine
chaviwa76b2712017-09-20 12:02:26 -0700110
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800111namespace dvr {
112class VrFlinger;
113} // namespace dvr
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800114
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800115enum {
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700116 eTransactionNeeded = 0x01,
117 eTraversalNeeded = 0x02,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700118 eDisplayTransactionNeeded = 0x04,
Lloyd Piqued432a7c2018-03-23 16:05:31 -0700119 eDisplayLayerStackChanged = 0x08,
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700120 eTransactionFlushNeeded = 0x10,
121 eTransactionMask = 0x1f,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800122};
123
Lloyd Pique6a3b4462019-03-07 20:58:12 -0800124using DisplayColorSetting = compositionengine::OutputColorSetting;
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800125
David Sodman105b7dc2017-11-04 20:28:14 -0700126class SurfaceFlingerBE
127{
128public:
129 SurfaceFlingerBE();
130
David Sodmanbc815282017-11-05 18:57:52 -0800131 const std::string mHwcServiceName; // "default" for real use, something else for testing.
132
David Sodman73beded2017-11-15 11:56:06 -0800133 FenceTimeline mGlCompositionDoneTimeline;
134 FenceTimeline mDisplayTimeline;
David Sodmanbc815282017-11-05 18:57:52 -0800135
David Sodman99974d22017-11-28 12:04:33 -0800136 // protected by mCompositorTimingLock;
137 mutable std::mutex mCompositorTimingLock;
138 CompositorTiming mCompositorTiming;
Lloyd Piquefcd86612017-12-14 17:15:36 -0800139
David Sodman99974d22017-11-28 12:04:33 -0800140 // Only accessed from the main thread.
141 struct CompositePresentTime {
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700142 nsecs_t composite = -1;
143 std::shared_ptr<FenceTime> display = FenceTime::NO_FENCE;
David Sodman99974d22017-11-28 12:04:33 -0800144 };
145 std::queue<CompositePresentTime> mCompositePresentTimes;
146
David Sodman4a36e932017-11-07 14:29:47 -0800147 static const size_t NUM_BUCKETS = 8; // < 1-7, 7+
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700148 nsecs_t mFrameBuckets[NUM_BUCKETS] = {};
149 nsecs_t mTotalTime = 0;
150 std::atomic<nsecs_t> mLastSwapTime = 0;
David Sodman4a36e932017-11-07 14:29:47 -0800151
David Sodmancbaf0832017-11-07 14:21:36 -0800152 // Double- vs. triple-buffering stats
153 struct BufferingStats {
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700154 size_t numSegments = 0;
155 nsecs_t totalTime = 0;
David Sodmancbaf0832017-11-07 14:21:36 -0800156
157 // "Two buffer" means that a third buffer was never used, whereas
158 // "double-buffered" means that on average the segment only used two
159 // buffers (though it may have used a third for some part of the
160 // segment)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700161 nsecs_t twoBufferTime = 0;
162 nsecs_t doubleBufferedTime = 0;
163 nsecs_t tripleBufferedTime = 0;
David Sodmancbaf0832017-11-07 14:21:36 -0800164 };
165 mutable Mutex mBufferingStatsMutex;
166 std::unordered_map<std::string, BufferingStats> mBufferingStats;
167
David Sodman105b7dc2017-11-04 20:28:14 -0700168 // The composer sequence id is a monotonically increasing integer that we
169 // use to differentiate callbacks from different hardware composer
170 // instances. Each hardware composer instance gets a different sequence id.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700171 int32_t mComposerSequenceId = 0;
chaviw291d88a2019-02-14 10:33:58 -0800172};
David Sodman105b7dc2017-11-04 20:28:14 -0700173
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700174class SurfaceFlinger : public BnSurfaceComposer,
Vishnu Nair35798872017-10-06 16:00:36 -0700175 public PriorityDumper,
Alec Mouri4545a8a2019-08-08 20:05:32 -0700176 public ClientCache::ErasedRecipient,
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700177 private IBinder::DeathRecipient,
Ady Abraham2139f732019-11-13 18:56:40 -0800178 private HWC2::ComposerCallback,
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800179 private ISchedulerCallback {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800180public:
David Sodman105b7dc2017-11-04 20:28:14 -0700181 SurfaceFlingerBE& getBE() { return mBE; }
182 const SurfaceFlingerBE& getBE() const { return mBE; }
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800183
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800184 // This is the phase offset in nanoseconds of the software vsync event
185 // relative to the vsync event reported by HWComposer. The software vsync
186 // event is when SurfaceFlinger and Choreographer-based applications run each
187 // frame.
188 //
189 // This phase offset allows adjustment of the minimum latency from application
190 // wake-up time (by Choreographer) to the time at which the resulting window
191 // image is displayed. This value may be either positive (after the HW vsync)
192 // or negative (before the HW vsync). Setting it to 0 will result in a lower
193 // latency bound of two vsync periods because the app and SurfaceFlinger
194 // will run just after the HW vsync. Setting it to a positive number will
195 // result in the minimum latency being:
196 //
197 // (2 * VSYNC_PERIOD - (vsyncPhaseOffsetNs % VSYNC_PERIOD))
198 //
199 // Note that reducing this latency makes it more likely for the applications
200 // to not have their window content image ready in time. When this happens
201 // the latency will end up being an additional vsync period, and animations
202 // will hiccup. Therefore, this latency should be tuned somewhat
203 // conservatively (or at least with awareness of the trade-off being made).
204 static int64_t vsyncPhaseOffsetNs;
205 static int64_t sfVsyncPhaseOffsetNs;
206
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800207 // If fences from sync Framework are supported.
208 static bool hasSyncFramework;
209
Fabien Sanglardc45a7d92017-03-14 13:24:22 -0700210 // The offset in nanoseconds to use when DispSync timestamps present fence
211 // signaling time.
212 static int64_t dispSyncPresentTimeOffset;
213
Fabien Sanglarda34ed632017-03-14 11:43:52 -0700214 // Some hardware can do RGB->YUV conversion more efficiently in hardware
215 // controlled by HWC than in hardware controlled by the video encoder.
216 // This instruct VirtualDisplaySurface to use HWC for such conversion on
217 // GL composition.
218 static bool useHwcForRgbToYuv;
219
Fabien Sanglardc8e387e2017-03-10 10:30:28 -0800220 // Maximum dimension supported by HWC for virtual display.
221 // Equal to min(max_height, max_width).
222 static uint64_t maxVirtualDisplaySize;
223
Fabien Sanglard1971b632017-03-10 14:50:03 -0800224 // Controls the number of buffers SurfaceFlinger will allocate for use in
225 // FramebufferSurface
226 static int64_t maxFrameBufferAcquiredBuffers;
227
Peiyong Lin13effd12018-07-24 17:01:47 -0700228 // Indicate if a device has wide color gamut display. This is typically
229 // found on devices with wide color gamut (e.g. Display-P3) display.
Courtney Goeltzenleuchter5d943892017-03-22 13:46:46 -0600230 static bool hasWideColorDisplay;
231
Dominik Laskowski718f9602019-11-09 20:01:35 -0800232 static ui::Rotation internalDisplayOrientation;
Chia-I Wu304d9cd2018-08-27 14:38:14 -0700233
Peiyong Lin13effd12018-07-24 17:01:47 -0700234 // Indicate if device wants color management on its display.
235 static bool useColorManagement;
236
Peiyong Linb3839ad2018-09-05 15:37:19 -0700237 static bool useContextPriority;
238
Peiyong Lin0256f722018-08-31 15:45:10 -0700239 // The data space and pixel format that SurfaceFlinger expects hardware composer
240 // to composite efficiently. Meaning under most scenarios, hardware composer
241 // will accept layers with the data space and pixel format.
Peiyong Linc6780972018-10-28 15:24:08 -0700242 static ui::Dataspace defaultCompositionDataspace;
243 static ui::PixelFormat defaultCompositionPixelFormat;
244
245 // The data space and pixel format that SurfaceFlinger expects hardware composer
246 // to composite efficiently for wide color gamut surfaces. Meaning under most scenarios,
247 // hardware composer will accept layers with the data space and pixel format.
248 static ui::Dataspace wideColorGamutCompositionDataspace;
249 static ui::PixelFormat wideColorGamutCompositionPixelFormat;
Peiyong Lin0256f722018-08-31 15:45:10 -0700250
Mathias Agopianb6df7d02013-05-09 14:53:35 -0700251 static char const* getServiceName() ANDROID_API {
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700252 return "SurfaceFlinger";
253 }
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800254
Lloyd Piqueac648ee2018-01-17 13:42:24 -0800255 struct SkipInitializationTag {};
256 static constexpr SkipInitializationTag SkipInitialization;
Lloyd Pique90c115d2018-09-18 21:39:42 -0700257 SurfaceFlinger(surfaceflinger::Factory&, SkipInitializationTag) ANDROID_API;
258 explicit SurfaceFlinger(surfaceflinger::Factory&) ANDROID_API;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800259
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700260 // must be called before clients can connect
261 void init() ANDROID_API;
262
263 // starts SurfaceFlinger main loop in the current thread
264 void run() ANDROID_API;
265
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700266 // post an asynchronous message to the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700267 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 -0800268
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700269 // post a synchronous message to the main thread
Vishnu Nair8406fd72019-07-30 11:29:31 -0700270 status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0)
271 EXCLUDES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800272
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700273 // force full composition on all displays
274 void repaintEverything();
Mathias Agopianbf2c6a62010-12-10 16:22:31 -0800275
Lloyd Pique90c115d2018-09-18 21:39:42 -0700276 surfaceflinger::Factory& getFactory() { return mFactory; }
277
Lloyd Pique70d91362018-10-18 16:02:55 -0700278 // The CompositionEngine encapsulates all composition related interfaces and actions.
279 compositionengine::CompositionEngine& getCompositionEngine() const;
280
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700281 // returns the default Display
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800282 sp<const DisplayDevice> getDefaultDisplayDevice() {
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700283 Mutex::Autolock _l(mStateLock);
284 return getDefaultDisplayDeviceLocked();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700285 }
Mathias Agopianb60314a2012-04-10 22:09:54 -0700286
Dan Stoza436ccf32018-06-21 12:10:12 -0700287 // Obtains a name from the texture pool, or, if the pool is empty, posts a
288 // synchronous message to the main thread to obtain one on the fly
289 uint32_t getNewTexture();
290
Mathias Agopian86303202012-07-24 22:46:10 -0700291 // utility function to delete a texture on the main thread
Mathias Agopian3f844832013-08-07 21:24:32 -0700292 void deleteTextureAsync(uint32_t texture);
Mathias Agopian86303202012-07-24 22:46:10 -0700293
Mathias Agopian86303202012-07-24 22:46:10 -0700294 // enable/disable h/w composer event
295 // TODO: this should be made accessible only to EventThread
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800296 void setPrimaryVsyncEnabled(bool enabled);
Mathias Agopian86303202012-07-24 22:46:10 -0700297
Ady Abraham9ba25122019-06-03 17:10:55 -0700298 // main thread function to enable/disable h/w composer event
299 void setPrimaryVsyncEnabledInternal(bool enabled);
Dominik Laskowskia8955dd2019-07-10 10:19:09 -0700300 void setVsyncEnabledInHWC(DisplayId displayId, HWC2::Vsync enabled);
Ady Abraham9ba25122019-06-03 17:10:55 -0700301
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700302 // called on the main thread by MessageQueue when an internal message
303 // is received
304 // TODO: this should be made accessible only to MessageQueue
305 void onMessageReceived(int32_t what);
Mathias Agopian3094df32012-06-18 18:06:45 -0700306
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700307 renderengine::RenderEngine& getRenderEngine() const;
Jesse Hall29c3f352013-05-21 15:36:55 -0700308
Robert Carr0d480722017-01-10 16:42:54 -0800309 bool authenticateSurfaceTextureLocked(
310 const sp<IGraphicBufferProducer>& bufferProducer) const;
311
Dominik Laskowski75848362019-11-11 17:57:20 -0800312 void onLayerFirstRef(Layer*);
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700313 void onLayerDestroyed(Layer*);
Robert Carr2e102c92018-10-23 12:11:15 -0700314
Valerie Hauc5686802019-11-22 14:18:09 -0800315 void removeFromOffscreenLayers(Layer* layer);
316
Marissa Walle2ffb422018-10-12 11:33:52 -0700317 TransactionCompletedThread& getTransactionCompletedThread() {
318 return mTransactionCompletedThread;
319 }
320
Robert Carrc0df3122019-04-11 13:18:21 -0700321 sp<Layer> fromHandle(const sp<IBinder>& handle) REQUIRES(mStateLock);
322
Alec Mouri4545a8a2019-08-08 20:05:32 -0700323 // Inherit from ClientCache::ErasedRecipient
324 void bufferErased(const client_cache_t& clientCacheId) override;
325
Vishnu Nair9b079a22020-01-21 14:36:08 -0800326 // If set, disables reusing client composition buffers. This can be set by
327 // debug.sf.disable_client_composition_cache
328 bool mDisableClientCompositionCache = false;
329
Mathias Agopian1f339ff2011-07-01 17:08:43 -0700330private:
David Sodman0c69cad2017-08-21 12:12:51 -0700331 friend class BufferLayer;
Marissa Wallfd668622018-05-10 10:21:13 -0700332 friend class BufferQueueLayer;
Marissa Wall61c58622018-07-18 10:12:20 -0700333 friend class BufferStateLayer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700334 friend class Client;
335 friend class Layer;
Dan Stozab9b08832014-03-13 11:55:57 -0700336 friend class MonitoredProducer;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700337 friend class RefreshRateOverlay;
Dan Stozaec460082018-12-17 15:35:09 -0800338 friend class RegionSamplingThread;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800339 friend class SurfaceTracing;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800340
Lloyd Piquef58625d2017-12-19 13:22:33 -0800341 // For unit tests
342 friend class TestableSurfaceFlinger;
Valerie Haud251afb2019-03-29 14:19:02 -0700343 friend class TransactionApplicationTest;
Lloyd Piquef58625d2017-12-19 13:22:33 -0800344
Jamie Gennis6547ff42013-07-16 20:12:42 -0700345 // This value is specified in number of frames. Log frame stats at most
346 // every half hour.
347 enum { LOG_FRAME_STATS_PERIOD = 30*60*60 };
348
Dan Stoza7d89d062015-04-30 13:29:25 -0700349 static const size_t MAX_LAYERS = 4096;
Nataniel Borges2b796da2019-02-15 13:32:18 -0800350 static const int MAX_TRACING_MEMORY = 100 * 1024 * 1024; // 100MB
Dan Stoza7d89d062015-04-30 13:29:25 -0700351
Lloyd Pique58e24a32019-08-01 15:50:14 -0700352protected:
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700353 // We're reference counted, never destroy SurfaceFlinger directly
354 virtual ~SurfaceFlinger();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800355
Lloyd Pique58e24a32019-08-01 15:50:14 -0700356private:
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700357 /* ------------------------------------------------------------------------
358 * Internal data structures
359 */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800360
Robert Carr2047fae2016-11-28 14:09:09 -0800361 class State {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800362 public:
chaviwfd462612018-05-31 16:11:27 -0700363 explicit State(LayerVector::StateSet set) : stateSet(set), layersSortedByZ(set) {}
Dan Stoza412903f2017-04-27 13:42:17 -0700364 State& operator=(const State& other) {
365 // We explicitly don't copy stateSet so that, e.g., mDrawingState
366 // always uses the Drawing StateSet.
367 layersSortedByZ = other.layersSortedByZ;
368 displays = other.displays;
Chia-I Wu28f320b2018-05-03 11:02:56 -0700369 colorMatrixChanged = other.colorMatrixChanged;
370 if (colorMatrixChanged) {
371 colorMatrix = other.colorMatrix;
372 }
Vishnu Nair08f6eae2019-11-26 14:01:39 -0800373 globalShadowSettings = other.globalShadowSettings;
374
Dan Stoza412903f2017-04-27 13:42:17 -0700375 return *this;
376 }
377
378 const LayerVector::StateSet stateSet = LayerVector::StateSet::Invalid;
Mathias Agopian92a979a2012-08-02 18:32:23 -0700379 LayerVector layersSortedByZ;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700380 DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays;
Robert Carr2047fae2016-11-28 14:09:09 -0800381
Chia-I Wu28f320b2018-05-03 11:02:56 -0700382 bool colorMatrixChanged = true;
383 mat4 colorMatrix;
384
Vishnu Nair08f6eae2019-11-26 14:01:39 -0800385 renderengine::ShadowSettings globalShadowSettings;
386
Dan Stoza412903f2017-04-27 13:42:17 -0700387 void traverseInZOrder(const LayerVector::Visitor& visitor) const;
388 void traverseInReverseZOrder(const LayerVector::Visitor& visitor) const;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800389 };
390
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700391 /* ------------------------------------------------------------------------
392 * IBinder interface
393 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800394 status_t onTransact(uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags) override;
395 status_t dump(int fd, const Vector<String16>& args) override { return priorityDump(fd, args); }
Robert Carr14167e02019-02-13 13:50:55 -0800396 bool callingThreadHasUnscopedSurfaceFlingerAccess() EXCLUDES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800397
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700398 /* ------------------------------------------------------------------------
399 * ISurfaceComposer interface
400 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800401 sp<ISurfaceComposerClient> createConnection() override;
402 sp<IBinder> createDisplay(const String8& displayName, bool secure) override;
403 void destroyDisplay(const sp<IBinder>& displayToken) override;
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800404 std::vector<PhysicalDisplayId> getPhysicalDisplayIds() const override;
405 sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800406 void setTransactionState(const Vector<ComposerState>& state,
407 const Vector<DisplayState>& displays, uint32_t flags,
408 const sp<IBinder>& applyToken,
Marissa Wall17b4e452018-12-26 16:32:34 -0800409 const InputWindowCommands& inputWindowCommands,
Marissa Wall947d34e2019-03-29 14:03:53 -0700410 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
Valerie Hau9dab9732019-08-20 09:29:25 -0700411 bool hasListenerCallbacks,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700412 const std::vector<ListenerCallbacks>& listenerCallbacks) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800413 void bootFinished() override;
414 bool authenticateSurfaceTexture(
415 const sp<IGraphicBufferProducer>& bufferProducer) const override;
416 status_t getSupportedFrameTimestamps(std::vector<FrameEvent>* outSupported) const override;
417 sp<IDisplayEventConnection> createDisplayEventConnection(
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700418 ISurfaceComposer::VsyncSource vsyncSource = eVsyncSourceApp,
419 ISurfaceComposer::ConfigChanged configChanged =
420 ISurfaceComposer::eConfigChangedSuppress) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800421 status_t captureScreen(const sp<IBinder>& displayToken, sp<GraphicBuffer>* outBuffer,
Dominik Laskowski718f9602019-11-09 20:01:35 -0800422 bool& outCapturedSecureLayers, ui::Dataspace reqDataspace,
423 ui::PixelFormat reqPixelFormat, const Rect& sourceCrop,
424 uint32_t reqWidth, uint32_t reqHeight, bool useIdentityTransform,
425 ui::Rotation rotation, bool captureSecureLayers) override;
chaviw93df2ea2019-04-30 16:45:12 -0700426 status_t captureScreen(uint64_t displayOrLayerStack, ui::Dataspace* outDataspace,
427 sp<GraphicBuffer>* outBuffer) override;
Robert Carr866455f2019-04-02 16:28:26 -0700428 status_t captureLayers(
429 const sp<IBinder>& parentHandle, sp<GraphicBuffer>* outBuffer,
430 const ui::Dataspace reqDataspace, const ui::PixelFormat reqPixelFormat,
431 const Rect& sourceCrop,
432 const std::unordered_set<sp<IBinder>, ISurfaceComposer::SpHash<IBinder>>& exclude,
433 float frameScale, bool childrenOnly) override;
Robert Carr108b2c72019-04-02 16:32:58 -0700434
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800435 status_t getDisplayStats(const sp<IBinder>& displayToken, DisplayStatInfo* stats) override;
436 status_t getDisplayConfigs(const sp<IBinder>& displayToken,
Dominik Laskowski22488f62019-03-28 09:53:04 -0700437 Vector<DisplayInfo>* configs) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800438 int getActiveConfig(const sp<IBinder>& displayToken) override;
439 status_t getDisplayColorModes(const sp<IBinder>& displayToken,
440 Vector<ui::ColorMode>* configs) override;
Daniel Solomon42d04562019-01-20 21:03:19 -0800441 status_t getDisplayNativePrimaries(const sp<IBinder>& displayToken,
442 ui::DisplayPrimaries &primaries);
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800443 ui::ColorMode getActiveColorMode(const sp<IBinder>& displayToken) override;
444 status_t setActiveColorMode(const sp<IBinder>& displayToken, ui::ColorMode colorMode) override;
Galia Peycheva5492cb52019-10-30 14:13:16 +0100445 status_t getAutoLowLatencyModeSupport(const sp<IBinder>& displayToken,
446 bool* outSupported) const override;
447 void setAutoLowLatencyMode(const sp<IBinder>& displayToken, bool on) override;
448 status_t getGameContentTypeSupport(const sp<IBinder>& displayToken,
449 bool* outSupported) const override;
450 void setGameContentType(const sp<IBinder>& displayToken, bool on) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800451 void setPowerMode(const sp<IBinder>& displayToken, int mode) override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800452 status_t clearAnimationFrameStats() override;
453 status_t getAnimationFrameStats(FrameStats* outStats) const override;
454 status_t getHdrCapabilities(const sp<IBinder>& displayToken,
455 HdrCapabilities* outCapabilities) const override;
456 status_t enableVSyncInjections(bool enable) override;
457 status_t injectVSync(nsecs_t when) override;
458 status_t getLayerDebugInfo(std::vector<LayerDebugInfo>* outLayers) const override;
459 status_t getColorManagement(bool* outGetColorManagement) const override;
Peiyong Linc6780972018-10-28 15:24:08 -0700460 status_t getCompositionPreference(ui::Dataspace* outDataspace, ui::PixelFormat* outPixelFormat,
461 ui::Dataspace* outWideColorGamutDataspace,
462 ui::PixelFormat* outWideColorGamutPixelFormat) const override;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800463 status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
464 ui::PixelFormat* outFormat,
465 ui::Dataspace* outDataspace,
466 uint8_t* outComponentMask) const override;
467 status_t setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
468 uint8_t componentMask,
469 uint64_t maxFrames) const override;
470 status_t getDisplayedContentSample(const sp<IBinder>& display, uint64_t maxFrames,
471 uint64_t timestamp,
472 DisplayedFrameStats* outStats) const override;
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800473 status_t getProtectedContentSupport(bool* outSupported) const override;
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800474 status_t isWideColorDisplay(const sp<IBinder>& displayToken,
475 bool* outIsWideColorDisplay) const override;
Dan Stoza84ab9372018-12-17 15:27:57 -0800476 status_t addRegionSamplingListener(const Rect& samplingArea, const sp<IBinder>& stopLayerHandle,
477 const sp<IRegionSamplingListener>& listener) override;
478 status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener) override;
Ana Krulec0782b882019-10-15 17:34:54 -0700479 status_t setDesiredDisplayConfigSpecs(const sp<IBinder>& displayToken, int32_t displayModeId,
480 float minRefreshRate, float maxRefreshRate) override;
Ana Krulec234bb162019-11-10 22:55:55 +0100481 status_t getDesiredDisplayConfigSpecs(const sp<IBinder>& displayToken,
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100482 int32_t* outDefaultConfig, float* outMinRefreshRate,
Ana Krulec234bb162019-11-10 22:55:55 +0100483 float* outMaxRefreshRate) override;
Dan Gittik57e63c52019-01-18 16:37:54 +0000484 status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
485 bool* outSupport) const override;
486 status_t setDisplayBrightness(const sp<IBinder>& displayToken, float brightness) const override;
Ady Abraham8532d012019-05-08 14:50:56 -0700487 status_t notifyPowerHint(int32_t hintId) override;
Vishnu Nairb13bb952019-11-15 10:24:08 -0800488 status_t setGlobalShadowSettings(const half4& ambientColor, const half4& spotColor,
489 float lightPosY, float lightPosZ, float lightRadius) override;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700490 /* ------------------------------------------------------------------------
491 * DeathRecipient interface
492 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800493 void binderDied(const wp<IBinder>& who) override;
Mathias Agopian99ce5cd2012-01-31 18:24:27 -0800494
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700495 /* ------------------------------------------------------------------------
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700496 * RefBase interface
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700497 */
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800498 void onFirstRef() override;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800499
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700500 /* ------------------------------------------------------------------------
Steven Thomasb02664d2017-07-26 18:48:28 -0700501 * HWC2::ComposerCallback / HWComposer::EventHandler interface
Mathias Agopian86303202012-07-24 22:46:10 -0700502 */
Ady Abraham7159f572019-10-11 11:10:18 -0700503 void onVsyncReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId, int64_t timestamp,
504 std::optional<hwc2_vsync_period_t> vsyncPeriod) override;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700505 void onHotplugReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId,
Lloyd Pique715a2c12017-12-14 17:18:08 -0800506 HWC2::Connection connection) override;
Dominik Laskowskia2edf612018-06-01 13:15:16 -0700507 void onRefreshReceived(int32_t sequenceId, hwc2_display_t hwcDisplayId) override;
Ady Abraham7159f572019-10-11 11:10:18 -0700508 void onVsyncPeriodTimingChangedReceived(
509 int32_t sequenceId, hwc2_display_t display,
510 const hwc_vsync_period_change_timeline_t& updatedTimeline) override;
Ady Abrahamb0433bc2020-01-08 17:31:06 -0800511 void onSeamlessPossible(int32_t sequenceId, hwc2_display_t display) override;
Mathias Agopian86303202012-07-24 22:46:10 -0700512
513 /* ------------------------------------------------------------------------
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800514 * ISchedulerCallback
Ady Abraham2139f732019-11-13 18:56:40 -0800515 */
516 void changeRefreshRate(const Scheduler::RefreshRate&, Scheduler::ConfigEvent) override;
Ady Abraham3a77a7b2019-12-02 18:46:59 -0800517 // force full composition on all displays without resetting the scheduler idle timer.
518 void repaintEverythingForHWC() override;
Ady Abraham2139f732019-11-13 18:56:40 -0800519 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700520 * Message handling
521 */
522 void waitForEvent();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700523 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700524 void signalTransaction();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700525 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700526 void signalLayerUpdate();
527 void signalRefresh();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800528
Ady Abraham2139f732019-11-13 18:56:40 -0800529 using RefreshRate = scheduler::RefreshRateConfigs::RefreshRate;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700530
Ady Abraham03b02dd2019-03-21 15:40:11 -0700531 struct ActiveConfigInfo {
Ady Abraham2139f732019-11-13 18:56:40 -0800532 HwcConfigIndexType configId;
Josh Gaoa0520712019-11-14 15:38:04 -0800533 Scheduler::ConfigEvent event = Scheduler::ConfigEvent::None;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700534
535 bool operator!=(const ActiveConfigInfo& other) const {
Ady Abraham2139f732019-11-13 18:56:40 -0800536 return configId != other.configId || event != other.event;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700537 }
538 };
539
Andy McFadden13a082e2012-08-24 10:16:42 -0700540 // called on the main thread in response to initializeDisplays()
Dominik Laskowski83b88212018-12-11 13:34:06 -0800541 void onInitializeDisplays() REQUIRES(mStateLock);
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800542 // Sets the desired active config bit. It obtains the lock, and sets mDesiredActiveConfig.
Ady Abraham03b02dd2019-03-21 15:40:11 -0700543 void setDesiredActiveConfig(const ActiveConfigInfo& info) REQUIRES(mStateLock);
Steven Thomasa87ed452020-01-03 16:10:05 -0800544 status_t setActiveConfig(const sp<IBinder>& displayToken, int id);
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800545 // Once HWC has returned the present fence, this sets the active config and a new refresh
Ady Abraham53852a52019-05-28 18:07:44 -0700546 // rate in SF.
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800547 void setActiveConfigInternal() REQUIRES(mStateLock);
548 // Active config is updated on INVALIDATE call in a state machine-like manner. When the
Ady Abrahamb838aed2019-02-12 15:30:16 -0800549 // desired config was set, HWC needs to update the panel on the next refresh, and when
Ana Kruleca5bdd9d2019-01-29 19:00:58 -0800550 // we receive the fence back, we know that the process was complete. It returns whether
Ady Abrahamb838aed2019-02-12 15:30:16 -0800551 // we need to wait for the next invalidate
Dominik Laskowski22488f62019-03-28 09:53:04 -0700552 bool performSetActiveConfig() REQUIRES(mStateLock);
Ady Abraham53852a52019-05-28 18:07:44 -0700553 // Called when active config is no longer is progress
554 void desiredActiveConfigChangeDone() REQUIRES(mStateLock);
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700555 // called on the main thread in response to setPowerMode()
Dominik Laskowski83b88212018-12-11 13:34:06 -0800556 void setPowerModeInternal(const sp<DisplayDevice>& display, int mode) REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800557
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100558 // Sets the desired display configs.
559 status_t setDesiredDisplayConfigSpecsInternal(const sp<DisplayDevice>& display,
560 HwcConfigIndexType defaultConfig,
561 float minRefreshRate, float maxRefreshRate)
562 EXCLUDES(mStateLock);
Ady Abraham838de062019-02-04 10:24:03 -0800563
Galia Peycheva5492cb52019-10-30 14:13:16 +0100564 // called on the main thread in response to setAutoLowLatencyMode()
565 void setAutoLowLatencyModeInternal(const sp<IBinder>& displayToken, bool on);
566 // called on the main thread in response to setGameContentType()
567 void setGameContentTypeInternal(const sp<IBinder>& displayToken, bool on);
568
Dan Stoza6b9454d2014-11-07 16:00:59 -0800569 // Returns whether the transaction actually modified any state
570 bool handleMessageTransaction();
571
572 // Returns whether a new buffer has been latched (see handlePageFlip())
573 bool handleMessageInvalidate();
574
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700575 void handleMessageRefresh();
Mathias Agopian4fec8732012-06-29 14:12:52 -0700576
Mathias Agopian87baae12012-07-31 12:38:26 -0700577 void handleTransaction(uint32_t transactionFlags);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800578 void handleTransactionLocked(uint32_t transactionFlags) REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800579
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800580 void updateInputFlinger();
581 void updateInputWindowInfo();
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800582 void commitInputWindowCommands() REQUIRES(mStateLock);
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700583 void setInputWindowsFinished();
Riley Andrews03414a12014-07-01 14:22:59 -0700584 void updateCursorAsync();
Steven Thomas2bbaabe2019-08-28 16:08:35 -0700585 void initScheduler(DisplayId primaryDisplayId);
Riley Andrews03414a12014-07-01 14:22:59 -0700586
Dan Stoza6b9454d2014-11-07 16:00:59 -0800587 /* handlePageFlip - latch a new buffer if available and compute the dirty
588 * region. Returns whether a new buffer has been latched, i.e., whether it
589 * is necessary to perform a refresh during this vsync.
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700590 */
Dan Stoza6b9454d2014-11-07 16:00:59 -0800591 bool handlePageFlip();
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800592
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700593 /* ------------------------------------------------------------------------
594 * Transactions
595 */
Marissa Wall713b63f2018-10-17 15:42:43 -0700596 void applyTransactionState(const Vector<ComposerState>& state,
chaviw273171b2018-12-26 11:46:30 -0800597 const Vector<DisplayState>& displays, uint32_t flags,
Robert Carr14167e02019-02-13 13:50:55 -0800598 const InputWindowCommands& inputWindowCommands,
Marissa Wall78b72202019-03-15 14:58:34 -0700599 const int64_t desiredPresentTime,
Valerie Hau9dab9732019-08-20 09:29:25 -0700600 const client_cache_t& uncacheBuffer, const int64_t postTime,
601 bool privileged, bool hasListenerCallbacks,
Marissa Wall3dad52d2019-03-22 14:03:19 -0700602 const std::vector<ListenerCallbacks>& listenerCallbacks,
Valerie Hau9dab9732019-08-20 09:29:25 -0700603 bool isMainThread = false) REQUIRES(mStateLock);
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700604 // Returns true if at least one transaction was flushed
Marissa Wall713b63f2018-10-17 15:42:43 -0700605 bool flushTransactionQueues();
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700606 // Returns true if there is at least one transaction that needs to be flushed
607 bool transactionFlushNeeded();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700608 uint32_t getTransactionFlags(uint32_t flags);
Fabien Sanglardc8251eb2016-12-07 13:59:48 -0800609 uint32_t peekTransactionFlags();
Steven Thomas6d8110b2017-08-31 18:24:21 -0700610 // Can only be called from the main thread or with mStateLock held
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700611 uint32_t setTransactionFlags(uint32_t flags);
Ana Krulec7ecce8c2018-10-12 13:44:41 -0700612 uint32_t setTransactionFlags(uint32_t flags, Scheduler::TransactionStart transactionStart);
Nataniel Borges2b796da2019-02-15 13:32:18 -0800613 void commitTransaction() REQUIRES(mStateLock);
chaviw74d90ad2019-04-26 14:45:26 -0700614 void commitOffscreenLayers();
Marissa Wall17b4e452018-12-26 16:32:34 -0800615 bool transactionIsReadyToBeApplied(int64_t desiredPresentTime,
Dominik Laskowskia8955dd2019-07-10 10:19:09 -0700616 bool useCachedExpectedPresentTime,
Marissa Wall17b4e452018-12-26 16:32:34 -0800617 const Vector<ComposerState>& states);
Vishnu Nairce5d0cc2019-02-28 14:38:41 -0800618 uint32_t setDisplayStateLocked(const DisplayState& s) REQUIRES(mStateLock);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800619 uint32_t addInputWindowCommands(const InputWindowCommands& inputWindowCommands)
620 REQUIRES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800621
Lloyd Pique58e24a32019-08-01 15:50:14 -0700622protected:
623 virtual uint32_t setClientStateLocked(
624 const ComposerState& composerState, int64_t desiredPresentTime, int64_t postTime,
625 bool privileged,
626 std::unordered_set<ListenerCallbacks, ListenerCallbacksHash>& listenerCallbacks)
627 REQUIRES(mStateLock);
628 virtual void commitTransactionLocked();
629
630private:
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700631 /* ------------------------------------------------------------------------
632 * Layer management
633 */
Marissa Wall2d814fb2019-04-09 18:52:57 +0000634 status_t createLayer(const String8& name, const sp<Client>& client, uint32_t w, uint32_t h,
635 PixelFormat format, uint32_t flags, LayerMetadata metadata,
Robert Carrc0df3122019-04-11 13:18:21 -0700636 sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp,
Valerie Hau1acd6962019-10-28 16:35:48 -0700637 const sp<IBinder>& parentHandle, const sp<Layer>& parentLayer = nullptr,
638 uint32_t* outTransformHint = nullptr);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800639
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700640 status_t createBufferQueueLayer(const sp<Client>& client, std::string name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800641 uint32_t h, uint32_t flags, LayerMetadata metadata,
642 PixelFormat& format, sp<IBinder>* outHandle,
643 sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800644
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700645 status_t createBufferStateLayer(const sp<Client>& client, std::string name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800646 uint32_t h, uint32_t flags, LayerMetadata metadata,
Valerie Hau1acd6962019-10-28 16:35:48 -0700647 sp<IBinder>* outHandle, uint32_t* outTransformHint,
648 sp<Layer>* outLayer);
Marissa Wall61c58622018-07-18 10:12:20 -0700649
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700650 status_t createColorLayer(const sp<Client>& client, std::string name, uint32_t w, uint32_t h,
Evan Roskya1f1e152019-01-24 16:17:46 -0800651 uint32_t flags, LayerMetadata metadata, sp<IBinder>* outHandle,
652 sp<Layer>* outLayer);
Mathias Agopian74c40c02010-09-29 13:02:36 -0700653
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700654 status_t createContainerLayer(const sp<Client>& client, std::string name, uint32_t w,
Evan Roskya1f1e152019-01-24 16:17:46 -0800655 uint32_t h, uint32_t flags, LayerMetadata metadata,
656 sp<IBinder>* outHandle, sp<Layer>* outLayer);
Robert Carr6b3f6c52018-08-13 13:05:17 -0700657
chaviwfe94a222019-08-21 13:52:59 -0700658 status_t mirrorLayer(const sp<Client>& client, const sp<IBinder>& mirrorFromHandle,
659 sp<IBinder>* outHandle);
660
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700661 std::string getUniqueLayerName(const char* name);
Cody Northropbc755282017-03-31 12:00:08 -0600662
Rob Carr4bba3702018-10-08 21:53:30 +0000663 // called when all clients have released all their references to
664 // this layer meaning it is entirely safe to destroy all
665 // resources associated to this layer.
Robert Carr695d5282018-12-18 15:27:58 -0800666 void onHandleDestroyed(sp<Layer>& layer);
Robert Carr6fb1a7e2018-12-11 12:07:25 -0800667 void markLayerPendingRemovalLocked(const sp<Layer>& layer);
Mathias Agopiana4912602012-07-12 14:25:33 -0700668
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700669 // add a layer to SurfaceFlinger
Robert Carrc0df3122019-04-11 13:18:21 -0700670 status_t addClientLayer(const sp<Client>& client, const sp<IBinder>& handle,
671 const sp<IGraphicBufferProducer>& gbc, const sp<Layer>& lbc,
672 const sp<IBinder>& parentHandle, const sp<Layer>& parentLayer,
673 bool addToCurrentState);
Mathias Agopianf1d8e872009-04-20 19:39:12 -0700674
Vishnu Nair4351ad52019-02-11 14:13:02 -0800675 // Traverse through all the layers and compute and cache its bounds.
676 void computeLayerBounds();
677
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700678 /* ------------------------------------------------------------------------
679 * Boot animation, on/off animations and screen capture
680 */
Mathias Agopianbb641242010-05-18 17:06:55 -0700681
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700682 void startBootAnim();
Mathias Agopian96f08192010-06-02 23:28:45 -0700683
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700684 using TraverseLayersFunction = std::function<void(const LayerVector::Visitor&)>;
685
chaviwa76b2712017-09-20 12:02:26 -0700686 void renderScreenImplLocked(const RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Alec Mourie7d1d4a2019-02-05 01:13:46 +0000687 ANativeWindowBuffer* buffer, bool useIdentityTransform,
688 int* outSyncFd);
chaviwa76b2712017-09-20 12:02:26 -0700689 status_t captureScreenCommon(RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Peiyong Lin0e003c92018-09-17 11:09:51 -0700690 sp<GraphicBuffer>* outBuffer, const ui::PixelFormat reqPixelFormat,
Robert Carr108b2c72019-04-02 16:32:58 -0700691 bool useIdentityTransform, bool& outCapturedSecureLayers);
Kevin DuBois7cbcc372019-02-25 14:53:28 -0800692 status_t captureScreenCommon(RenderArea& renderArea, TraverseLayersFunction traverseLayers,
Robert Carr108b2c72019-04-02 16:32:58 -0700693 const sp<GraphicBuffer>& buffer, bool useIdentityTransform,
694 bool& outCapturedSecureLayers);
chaviw93df2ea2019-04-30 16:45:12 -0700695 const sp<DisplayDevice> getDisplayByIdOrLayerStack(uint64_t displayOrLayerStack);
Vishnu Nair3a7346c2019-12-04 08:09:09 -0800696 const sp<DisplayDevice> getDisplayByLayerStack(uint64_t layerStack);
chaviwa76b2712017-09-20 12:02:26 -0700697 status_t captureScreenImplLocked(const RenderArea& renderArea,
698 TraverseLayersFunction traverseLayers,
699 ANativeWindowBuffer* buffer, bool useIdentityTransform,
Robert Carr108b2c72019-04-02 16:32:58 -0700700 bool forSystem, int* outSyncFd, bool& outCapturedSecureLayers);
chaviw0e3479f2018-09-10 16:49:30 -0700701 void traverseLayersInDisplay(const sp<const DisplayDevice>& display,
702 const LayerVector::Visitor& visitor);
Mathias Agopianabe815d2013-03-19 22:22:21 -0700703
Lloyd Pique90c115d2018-09-18 21:39:42 -0700704 sp<StartPropertySetThread> mStartPropertySetThread;
Wei Wangb254fa32017-01-31 17:43:23 -0800705
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700706 /* ------------------------------------------------------------------------
Romain Guy11d63f42017-07-20 12:47:14 -0700707 * Properties
708 */
709 void readPersistentProperties();
710
711 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700712 * EGL
713 */
Mathias Agopian875d8e12013-06-07 15:35:48 -0700714 size_t getMaxTextureSize() const;
715 size_t getMaxViewportDims() const;
Mathias Agopiana4912602012-07-12 14:25:33 -0700716
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700717 /* ------------------------------------------------------------------------
Mathias Agopian87baae12012-07-31 12:38:26 -0700718 * Display and layer stack management
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700719 */
Andy McFadden13a082e2012-08-24 10:16:42 -0700720 // called when starting, or restarting after system_server death
721 void initializeDisplays();
722
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700723 sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& displayToken) const {
724 Mutex::Autolock _l(mStateLock);
725 return getDisplayDeviceLocked(displayToken);
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700726 }
727
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700728 sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& displayToken) {
729 Mutex::Autolock _l(mStateLock);
730 return getDisplayDeviceLocked(displayToken);
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700731 }
732
733 // NOTE: can only be called from the main thread or with mStateLock held
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700734 sp<const DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) const {
735 return const_cast<SurfaceFlinger*>(this)->getDisplayDeviceLocked(displayToken);
Mathias Agopian92a979a2012-08-02 18:32:23 -0700736 }
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700737
738 // NOTE: can only be called from the main thread or with mStateLock held
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700739 sp<DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) {
Dominik Laskowski9fae1022018-05-29 13:17:40 -0700740 const auto it = mDisplays.find(displayToken);
741 return it == mDisplays.end() ? nullptr : it->second;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700742 }
Mathias Agopian99b49842011-06-27 16:05:52 -0700743
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700744 sp<const DisplayDevice> getDefaultDisplayDeviceLocked() const {
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700745 return const_cast<SurfaceFlinger*>(this)->getDefaultDisplayDeviceLocked();
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700746 }
747
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700748 sp<DisplayDevice> getDefaultDisplayDeviceLocked() {
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800749 if (const auto token = getInternalDisplayTokenLocked()) {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700750 return getDisplayDeviceLocked(token);
751 }
752 return nullptr;
Michael Wright28f24d02016-07-12 13:30:53 -0700753 }
754
Mathias Agopian87baae12012-07-31 12:38:26 -0700755 // mark a region of a layer stack dirty. this updates the dirty
756 // region of all screens presenting this layer stack.
Chia-I Wuab0c3192017-08-01 11:29:00 -0700757 void invalidateLayerStack(const sp<const Layer>& layer, const Region& dirty);
Mathias Agopian87baae12012-07-31 12:38:26 -0700758
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700759 /* ------------------------------------------------------------------------
Mathias Agopian86303202012-07-24 22:46:10 -0700760 * H/W composer
761 */
762
Lloyd Pique441d5042018-10-18 16:49:51 -0700763 // The current hardware composer interface.
764 //
765 // The following thread safety rules apply when accessing mHwc, either
766 // directly or via getHwComposer():
767 //
768 // 1. When recreating mHwc, acquire mStateLock. We currently recreate mHwc
769 // only when switching into and out of vr. Recreating mHwc must only be
770 // done on the main thread.
771 //
772 // 2. When accessing mHwc on the main thread, it's not necessary to acquire
773 // mStateLock.
774 //
775 // 3. When accessing mHwc on a thread other than the main thread, we always
776 // need to acquire mStateLock. This is because the main thread could be
777 // in the process of destroying the current mHwc instance.
778 //
779 // The above thread safety rules only apply to SurfaceFlinger.cpp. In
780 // SurfaceFlinger_hwc1.cpp we create mHwc at surface flinger init and never
781 // destroy it, so it's always safe to access mHwc from any thread without
782 // acquiring mStateLock.
783 HWComposer& getHwComposer() const;
Mathias Agopian86303202012-07-24 22:46:10 -0700784
Mathias Agopian888c8222012-08-04 21:10:38 -0700785 /* ------------------------------------------------------------------------
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700786 * Compositing
787 */
788 void invalidateHwcGeometry();
Mathias Agopiancd60f992012-08-16 16:28:27 -0700789
David Sodman2b406362017-12-15 13:33:47 -0800790 void postComposition();
Dominik Laskowskif654d572018-12-20 11:03:06 -0800791 void getCompositorTiming(CompositorTiming* compositorTiming);
Ana Krulece588e312018-09-18 12:32:24 -0700792 void updateCompositorTiming(const DisplayStatInfo& stats, nsecs_t compositeTime,
793 std::shared_ptr<FenceTime>& presentFenceTime);
794 void setCompositorTimingSnapped(const DisplayStatInfo& stats,
795 nsecs_t compositeToPresentLatency);
Courtney Goeltzenleuchter5d943892017-03-22 13:46:46 -0600796
David Sodmanfa9b2af2017-12-24 13:28:59 -0800797 void postFrame();
Mathias Agopian4da75192010-08-10 17:19:56 -0700798
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700799 /* ------------------------------------------------------------------------
Jamie Gennis0bceb842012-08-23 20:19:38 -0700800 * Display management
801 */
Lloyd Pique542307f2018-10-19 13:24:08 -0700802 sp<DisplayDevice> setupNewDisplayDeviceInternal(
803 const wp<IBinder>& displayToken, const std::optional<DisplayId>& displayId,
804 const DisplayDeviceState& state,
805 const sp<compositionengine::DisplaySurface>& dispSurface,
806 const sp<IGraphicBufferProducer>& producer);
Lloyd Pique347200f2017-12-14 17:00:15 -0800807 void processDisplayChangesLocked();
Lloyd Piqueba04e622017-12-14 17:11:26 -0800808 void processDisplayHotplugEventsLocked();
Mathias Agopian3ee454a2012-08-27 16:28:24 -0700809
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800810 void dispatchDisplayHotplugEvent(PhysicalDisplayId displayId, bool connected);
Dominik Laskowski1eba0202019-01-24 09:14:40 -0800811
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700812 /* ------------------------------------------------------------------------
813 * VSync
814 */
Dominik Laskowski83b88212018-12-11 13:34:06 -0800815 nsecs_t getVsyncPeriod() const REQUIRES(mStateLock);
Robert Carr1f0a16a2016-10-24 16:27:39 -0700816
Dominik Laskowskiccf37d72019-02-01 16:47:58 -0800817 // Sets the refresh rate by switching active configs, if they are available for
Ana Krulec7d1d6832018-12-27 11:10:09 -0800818 // the desired refresh rate.
Ady Abraham2139f732019-11-13 18:56:40 -0800819 void changeRefreshRateLocked(const RefreshRate&, Scheduler::ConfigEvent event)
820 REQUIRES(mStateLock);
Jamie Gennis0bceb842012-08-23 20:19:38 -0700821
Ady Abraham2139f732019-11-13 18:56:40 -0800822 bool isDisplayConfigAllowed(HwcConfigIndexType configId) const REQUIRES(mStateLock);
Jamie Gennis0bceb842012-08-23 20:19:38 -0700823
Ady Abraham11579302019-09-19 12:35:58 -0700824 bool previousFrameMissed(int graceTimeMs = 0);
Dominik Laskowskia8955dd2019-07-10 10:19:09 -0700825
826 // Populates the expected present time for this frame. For negative offsets, performs a
827 // correction using the predicted vsync for the next frame instead.
828 void populateExpectedPresentTime();
829
Dominik Laskowskic2867142019-01-21 11:33:38 -0800830 /*
831 * Display identification
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700832 */
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800833 sp<IBinder> getPhysicalDisplayTokenLocked(DisplayId displayId) const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700834 const auto it = mPhysicalDisplayTokens.find(displayId);
835 return it != mPhysicalDisplayTokens.end() ? it->second : nullptr;
836 }
837
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800838 std::optional<DisplayId> getPhysicalDisplayIdLocked(const sp<IBinder>& displayToken) const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700839 for (const auto& [id, token] : mPhysicalDisplayTokens) {
840 if (token == displayToken) {
841 return id;
842 }
843 }
844 return {};
845 }
846
847 // TODO(b/74619554): Remove special cases for primary display.
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800848 sp<IBinder> getInternalDisplayTokenLocked() const {
849 const auto displayId = getInternalDisplayIdLocked();
850 return displayId ? getPhysicalDisplayTokenLocked(*displayId) : nullptr;
Dominik Laskowski075d3172018-05-24 15:50:06 -0700851 }
852
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800853 std::optional<DisplayId> getInternalDisplayIdLocked() const {
Dominik Laskowski075d3172018-05-24 15:50:06 -0700854 const auto hwcDisplayId = getHwComposer().getInternalHwcDisplayId();
855 return hwcDisplayId ? getHwComposer().toPhysicalDisplayId(*hwcDisplayId) : std::nullopt;
856 }
857
Dominik Laskowskic2867142019-01-21 11:33:38 -0800858 /*
859 * Debugging & dumpsys
860 */
Dominik Laskowskic2867142019-01-21 11:33:38 -0800861 using DumpArgs = Vector<String16>;
862 using Dumper = std::function<void(const DumpArgs&, bool asProto, std::string&)>;
863
864 template <typename F, std::enable_if_t<!std::is_member_function_pointer_v<F>>* = nullptr>
865 static Dumper dumper(F&& dump) {
866 using namespace std::placeholders;
867 return std::bind(std::forward<F>(dump), _3);
868 }
869
870 template <typename F, std::enable_if_t<std::is_member_function_pointer_v<F>>* = nullptr>
871 Dumper dumper(F dump) {
872 using namespace std::placeholders;
873 return std::bind(dump, this, _3);
874 }
875
876 template <typename F>
877 Dumper argsDumper(F dump) {
878 using namespace std::placeholders;
879 return std::bind(dump, this, _1, _3);
880 }
881
882 template <typename F>
883 Dumper protoDumper(F dump) {
884 using namespace std::placeholders;
885 return std::bind(dump, this, _1, _2, _3);
886 }
887
888 void dumpAllLocked(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
889
890 void appendSfConfigString(std::string& result) const;
891 void listLayersLocked(std::string& result) const;
892 void dumpStatsLocked(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
893 void clearStatsLocked(const DumpArgs& args, std::string& result);
894 void dumpTimeStats(const DumpArgs& args, bool asProto, std::string& result) const;
Jamie Gennis6547ff42013-07-16 20:12:42 -0700895 void logFrameStats();
896
Dominik Laskowskid9e4de62019-01-21 14:23:01 -0800897 void dumpVSync(std::string& result) const REQUIRES(mStateLock);
Yiwei Zhang5434a782018-12-05 18:06:32 -0800898 void dumpStaticScreenStats(std::string& result) const;
Brian Andersond6927fb2016-07-23 23:37:30 -0700899 // Not const because each Layer needs to query Fences and cache timestamps.
Yiwei Zhang5434a782018-12-05 18:06:32 -0800900 void dumpFrameEventsLocked(std::string& result);
Dan Stozab90cf072015-03-05 11:05:59 -0800901
Dominik Laskowski87a07e42019-10-10 20:38:02 -0700902 void recordBufferingStats(const std::string& layerName,
903 std::vector<OccupancyTracker::Segment>&& history);
Yiwei Zhang5434a782018-12-05 18:06:32 -0800904 void dumpBufferingStats(std::string& result) const;
905 void dumpDisplayIdentificationData(std::string& result) const;
Dominik Laskowskib6e54372019-09-04 14:06:28 -0700906 void dumpRawDisplayIdentificationData(const DumpArgs&, std::string& result) const;
Yiwei Zhang5434a782018-12-05 18:06:32 -0800907 void dumpWideColorInfo(std::string& result) const;
Vishnu Nair8406fd72019-07-30 11:29:31 -0700908 LayersProto dumpDrawingStateProto(uint32_t traceFlags = SurfaceTracing::TRACE_ALL) const;
Vishnu Nair0f085c62019-08-30 08:49:12 -0700909 void dumpOffscreenLayersProto(LayersProto& layersProto,
910 uint32_t traceFlags = SurfaceTracing::TRACE_ALL) const;
Vishnu Nair8406fd72019-07-30 11:29:31 -0700911 LayersProto dumpProtoFromMainThread(uint32_t traceFlags = SurfaceTracing::TRACE_ALL)
912 EXCLUDES(mStateLock);
Vishnu Nair0f085c62019-08-30 08:49:12 -0700913 void dumpOffscreenLayers(std::string& result) EXCLUDES(mStateLock);
Nataniel Borges2b796da2019-02-15 13:32:18 -0800914 void withTracingLock(std::function<void()> operation) REQUIRES(mStateLock);
Dan Stozae77c7662016-05-13 11:37:28 -0700915
Fabien Sanglard63a5fcd2016-12-29 15:13:07 -0800916 bool isLayerTripleBufferingDisabled() const {
917 return this->mLayerTripleBufferingDisabled;
918 }
Dominik Laskowskic2867142019-01-21 11:33:38 -0800919
920 status_t doDump(int fd, const DumpArgs& args, bool asProto);
921
Nataniel Borges8e7dc722019-02-28 15:10:28 -0800922 status_t dumpCritical(int fd, const DumpArgs&, bool asProto);
Dominik Laskowskic2867142019-01-21 11:33:38 -0800923
924 status_t dumpAll(int fd, const DumpArgs& args, bool asProto) override {
925 return doDump(fd, args, asProto);
926 }
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800927
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800928 /* ------------------------------------------------------------------------
929 * VrFlinger
930 */
Steven Thomasb02664d2017-07-26 18:48:28 -0700931 void resetDisplayState();
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800932
Steven Thomas050b2c82017-03-06 11:45:16 -0800933 // Check to see if we should handoff to vr flinger.
934 void updateVrFlinger();
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800935
Chia-I Wu28f320b2018-05-03 11:02:56 -0700936 void updateColorMatrixLocked();
937
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700938 /* ------------------------------------------------------------------------
939 * Attributes
940 */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800941
Lloyd Pique90c115d2018-09-18 21:39:42 -0700942 surfaceflinger::Factory& mFactory;
943
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700944 // access must be protected by mStateLock
945 mutable Mutex mStateLock;
Dan Stoza412903f2017-04-27 13:42:17 -0700946 State mCurrentState{LayerVector::StateSet::Current};
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700947 std::atomic<int32_t> mTransactionFlags = 0;
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700948 Condition mTransactionCV;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700949 bool mTransactionPending = false;
950 bool mAnimTransactionPending = false;
951 SortedVector<sp<Layer>> mLayersPendingRemoval;
952 bool mTraversalNeededMainThread = false;
Dan Stoza101d8dc2018-02-27 15:42:25 -0800953
Nataniel Borges2b796da2019-02-15 13:32:18 -0800954 // guards access to the mDrawing state if tracing is enabled.
955 mutable std::mutex mDrawingStateLock;
956
Chia-I Wu28f320b2018-05-03 11:02:56 -0700957 // global color transform states
958 Daltonizer mDaltonizer;
959 float mGlobalSaturationFactor = 1.0f;
960 mat4 mClientColorMatrix;
961
Dan Stoza101d8dc2018-02-27 15:42:25 -0800962 // Can't be unordered_set because wp<> isn't hashable
963 std::set<wp<IBinder>> mGraphicBufferProducerList;
Dan Stoza0a0158c2018-03-16 13:38:54 -0700964 size_t mMaxGraphicBufferProducerListSize = MAX_LAYERS;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800965
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700966 // protected by mStateLock (but we could use another lock)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700967 bool mLayersRemoved = false;
968 bool mLayersAdded = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -0700969
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700970 std::atomic<bool> mRepaintEverything = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -0700971
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800972 // constant members (no synchronization needed for access)
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700973 const nsecs_t mBootTime = systemTime();
974 bool mGpuToCpuSupported = false;
Mathias Agopian3094df32012-06-18 18:06:45 -0700975
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700976 // Can only accessed from the main thread, these members
977 // don't need synchronization
Dan Stoza412903f2017-04-27 13:42:17 -0700978 State mDrawingState{LayerVector::StateSet::Drawing};
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700979 bool mVisibleRegionsDirty = false;
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800980 // Set during transaction commit stage to track if the input info for a layer has changed.
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700981 bool mInputInfoChanged = false;
982 bool mGeometryInvalid = false;
983 bool mAnimCompositionPending = false;
Dan Stoza9e56aa02015-11-02 13:00:03 -0800984 std::vector<sp<Layer>> mLayersWithQueuedFrames;
Vishnu Nair6194e2e2019-02-06 12:58:39 -0800985 // Tracks layers that need to update a display's dirty region.
986 std::vector<sp<Layer>> mLayersPendingRefresh;
Ady Abrahambe0f9482019-04-24 15:41:53 -0700987 std::array<sp<Fence>, 2> mPreviousPresentFences = {Fence::NO_FENCE, Fence::NO_FENCE};
Alec Mouricc0fc602019-02-26 21:45:19 -0800988 // True if in the previous frame at least one layer was composed via the GPU.
Dan Stoza05dacfb2016-07-01 13:33:38 -0700989 bool mHadClientComposition = false;
Alec Mouricc0fc602019-02-26 21:45:19 -0800990 // True if in the previous frame at least one layer was composed via HW Composer.
991 // Note that it is possible for a frame to be composed via both client and device
992 // composition, for example in the case of overlays.
993 bool mHadDeviceComposition = false;
Vishnu Nair9b079a22020-01-21 14:36:08 -0800994 // True if in the previous frame, the client composition was skipped by reusing the buffer
995 // used in a previous composition. This can happed if the client composition requests
996 // did not change.
997 bool mReusedClientComposition = false;
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700998
Chia-I Wu14c9c7b2018-06-26 10:18:18 +0800999 enum class BootStage {
1000 BOOTLOADER,
1001 BOOTANIMATION,
1002 FINISHED,
1003 };
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001004 BootStage mBootStage = BootStage::BOOTLOADER;
Chia-I Wu14c9c7b2018-06-26 10:18:18 +08001005
Lloyd Piqueba04e622017-12-14 17:11:26 -08001006 struct HotplugEvent {
Dominik Laskowskia2edf612018-06-01 13:15:16 -07001007 hwc2_display_t hwcDisplayId;
Lloyd Piqueba04e622017-12-14 17:11:26 -08001008 HWC2::Connection connection = HWC2::Connection::Invalid;
Lloyd Piqueba04e622017-12-14 17:11:26 -08001009 };
1010 // protected by mStateLock
1011 std::vector<HotplugEvent> mPendingHotplugEvents;
1012
Mathias Agopiandb9b41f2012-10-15 16:51:41 -07001013 // this may only be written from the main thread with mStateLock held
1014 // it may be read from other threads with mStateLock held
Dominik Laskowski9fae1022018-05-29 13:17:40 -07001015 std::map<wp<IBinder>, sp<DisplayDevice>> mDisplays;
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -08001016 std::unordered_map<DisplayId, sp<IBinder>> mPhysicalDisplayTokens;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001017
Robert Carrc0df3122019-04-11 13:18:21 -07001018 // protected by mStateLock
1019 std::unordered_map<BBinder*, wp<Layer>> mLayersByLocalBinderToken;
1020
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001021 // don't use a lock for these, we don't care
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001022 int mDebugRegion = 0;
1023 bool mDebugDisableHWC = false;
1024 bool mDebugDisableTransformHint = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001025 volatile nsecs_t mDebugInTransaction = 0;
1026 bool mForceFullDamage = false;
Dan Stozac5da2712016-07-20 15:38:12 -07001027 bool mPropagateBackpressure = true;
Ady Abrahamadb9a992019-09-19 21:21:55 +00001028 bool mPropagateBackpressureClientComposition = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001029 std::unique_ptr<SurfaceInterceptor> mInterceptor;
1030 SurfaceTracing mTracing{*this};
Nataniel Borges2b796da2019-02-15 13:32:18 -08001031 bool mTracingEnabled = false;
1032 bool mTracingEnabledChanged GUARDED_BY(mStateLock) = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001033 const std::shared_ptr<TimeStats> mTimeStats;
Mikael Pessa90092f42019-08-26 17:22:04 -07001034 const std::unique_ptr<FrameTracer> mFrameTracer;
Fabien Sanglard642b23d2017-02-09 12:29:39 -08001035 bool mUseHwcVirtualDisplays = false;
Lucas Dupin19c8f0e2019-11-25 17:55:44 -08001036 bool mEnableBlurs = false;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001037 std::atomic<uint32_t> mFrameMissedCount = 0;
1038 std::atomic<uint32_t> mHwcFrameMissedCount = 0;
1039 std::atomic<uint32_t> mGpuFrameMissedCount = 0;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001040
Marissa Walle2ffb422018-10-12 11:33:52 -07001041 TransactionCompletedThread mTransactionCompletedThread;
1042
Fabien Sanglard63a5fcd2016-12-29 15:13:07 -08001043 // Restrict layers to use two buffers in their bufferqueues.
1044 bool mLayerTripleBufferingDisabled = false;
1045
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001046 // these are thread safe
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001047 std::unique_ptr<MessageQueue> mEventQueue;
Jamie Gennis4b0eba92013-02-05 13:30:24 -08001048 FrameTracker mAnimFrameTracker;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001049
1050 // protected by mDestroyedLayerLock;
1051 mutable Mutex mDestroyedLayerLock;
Mathias Agopian13127d82013-03-05 17:47:11 -08001052 Vector<Layer const *> mDestroyedLayers;
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001053
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001054 nsecs_t mRefreshStartTime = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -07001055
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001056 std::atomic<bool> mRefreshPending = false;
Dan Stoza2b6d38e2017-06-01 16:40:30 -07001057
Dan Stoza436ccf32018-06-21 12:10:12 -07001058 // We maintain a pool of pre-generated texture names to hand out to avoid
1059 // layer creation needing to run on the main thread (which it would
1060 // otherwise need to do to access RenderEngine).
1061 std::mutex mTexturePoolMutex;
1062 uint32_t mTexturePoolSize = 0;
1063 std::vector<uint32_t> mTexturePool;
1064
Marissa Wall713b63f2018-10-17 15:42:43 -07001065 struct TransactionState {
1066 TransactionState(const Vector<ComposerState>& composerStates,
Marissa Wall17b4e452018-12-26 16:32:34 -08001067 const Vector<DisplayState>& displayStates, uint32_t transactionFlags,
Marissa Wall947d34e2019-03-29 14:03:53 -07001068 int64_t desiredPresentTime, const client_cache_t& uncacheBuffer,
Valerie Hau9dab9732019-08-20 09:29:25 -07001069 int64_t postTime, bool privileged, bool hasListenerCallbacks,
1070 std::vector<ListenerCallbacks> listenerCallbacks)
Marissa Wall17b4e452018-12-26 16:32:34 -08001071 : states(composerStates),
1072 displays(displayStates),
1073 flags(transactionFlags),
Valerie Haubc6ddb12019-03-08 11:10:15 -08001074 desiredPresentTime(desiredPresentTime),
Marissa Wall78b72202019-03-15 14:58:34 -07001075 buffer(uncacheBuffer),
Valerie Haubc6ddb12019-03-08 11:10:15 -08001076 postTime(postTime),
Valerie Hau9dab9732019-08-20 09:29:25 -07001077 privileged(privileged),
1078 hasListenerCallbacks(hasListenerCallbacks),
1079 listenerCallbacks(listenerCallbacks) {}
Marissa Wall713b63f2018-10-17 15:42:43 -07001080
1081 Vector<ComposerState> states;
1082 Vector<DisplayState> displays;
1083 uint32_t flags;
Valerie Haubc6ddb12019-03-08 11:10:15 -08001084 const int64_t desiredPresentTime;
Marissa Wall947d34e2019-03-29 14:03:53 -07001085 client_cache_t buffer;
Valerie Haubc6ddb12019-03-08 11:10:15 -08001086 const int64_t postTime;
Robert Carr14167e02019-02-13 13:50:55 -08001087 bool privileged;
Valerie Hau9dab9732019-08-20 09:29:25 -07001088 bool hasListenerCallbacks;
1089 std::vector<ListenerCallbacks> listenerCallbacks;
Marissa Wall713b63f2018-10-17 15:42:43 -07001090 };
Valerie Hau5de3ad22019-08-20 07:47:43 -07001091 std::unordered_map<sp<IBinder>, std::queue<TransactionState>, IListenerHash> mTransactionQueues;
Marissa Wall713b63f2018-10-17 15:42:43 -07001092
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001093 /* ------------------------------------------------------------------------
1094 * Feature prototyping
1095 */
1096
Dan Stozab90cf072015-03-05 11:05:59 -08001097 // Static screen stats
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001098 bool mHasPoweredOff = false;
Dan Stozae77c7662016-05-13 11:37:28 -07001099
chaviweadf0d42019-08-12 13:28:29 -07001100 std::atomic<size_t> mNumLayers = 0;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001101
Fabien Sanglard6e8e98a2016-10-27 20:04:11 -07001102 // Verify that transaction is being called by an approved process:
1103 // either AID_GRAPHICS or AID_SYSTEM.
1104 status_t CheckTransactCodeCredentials(uint32_t code);
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -08001105
Steven Morelanda904bb92019-07-02 17:37:23 -07001106 // to linkToDeath
1107 sp<IBinder> mWindowManager;
1108
Steven Thomasb02664d2017-07-26 18:48:28 -07001109 std::unique_ptr<dvr::VrFlinger> mVrFlinger;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001110 std::atomic<bool> mVrFlingerRequestsDisplay = false;
Steven Thomas050b2c82017-03-06 11:45:16 -08001111 static bool useVrFlinger;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001112 std::thread::id mMainThreadId = std::this_thread::get_id();
Romain Guy0147a172017-06-01 13:53:56 -07001113
Lloyd Pique6a3b4462019-03-07 20:58:12 -08001114 DisplayColorSetting mDisplayColorSetting = DisplayColorSetting::kEnhanced;
David Sodman105b7dc2017-11-04 20:28:14 -07001115
Peiyong Lina3ea5592019-02-10 14:45:00 -08001116 // Color mode forced by setting persist.sys.sf.color_mode, it must:
1117 // 1. not be NATIVE color mode, NATIVE color mode means no forced color mode;
1118 // 2. be one of the supported color modes returned by hardware composer, otherwise
1119 // it will not be respected.
1120 // persist.sys.sf.color_mode will only take effect when persist.sys.sf.native_mode
1121 // is not set to 1.
1122 // This property can be used to force SurfaceFlinger to always pick a certain color mode.
1123 ui::ColorMode mForceColorMode = ui::ColorMode::NATIVE;
1124
Peiyong Lin9d846a52018-11-05 13:18:20 -08001125 ui::Dataspace mDefaultCompositionDataspace;
1126 ui::Dataspace mWideColorGamutCompositionDataspace;
Yichi Chenda901bf2019-06-28 14:58:27 +08001127 ui::Dataspace mColorSpaceAgnosticDataspace;
Peiyong Lin9d846a52018-11-05 13:18:20 -08001128
David Sodman105b7dc2017-11-04 20:28:14 -07001129 SurfaceFlingerBE mBE;
Lloyd Pique70d91362018-10-18 16:02:55 -07001130 std::unique_ptr<compositionengine::CompositionEngine> mCompositionEngine;
Ana Krulec98b5b242018-08-10 15:03:23 -07001131
Ana Krulecb43429d2019-01-09 14:28:51 -08001132 /* ------------------------------------------------------------------------
1133 * Scheduler
1134 */
Ana Krulec98b5b242018-08-10 15:03:23 -07001135 std::unique_ptr<Scheduler> mScheduler;
Dominik Laskowski98041832019-08-01 18:35:59 -07001136 scheduler::ConnectionHandle mAppConnectionHandle;
1137 scheduler::ConnectionHandle mSfConnectionHandle;
Robert Carr720e5062018-07-30 17:45:14 -07001138
Dominik Laskowskieddeda12019-07-19 11:54:13 -07001139 // Stores phase offsets configured per refresh rate.
Ady Abraham9e16a482019-12-03 17:19:41 -08001140 std::unique_ptr<scheduler::PhaseConfiguration> mPhaseConfiguration;
Dominik Laskowskieddeda12019-07-19 11:54:13 -07001141
1142 // Optional to defer construction until scheduler connections are created.
1143 std::optional<scheduler::VSyncModulator> mVSyncModulator;
1144
Steven Thomas2bbaabe2019-08-28 16:08:35 -07001145 std::unique_ptr<scheduler::RefreshRateConfigs> mRefreshRateConfigs;
1146 std::unique_ptr<scheduler::RefreshRateStats> mRefreshRateStats;
Ady Abraham1902d072019-03-01 17:18:59 -08001147
Dominik Laskowskia8955dd2019-07-10 10:19:09 -07001148 std::atomic<nsecs_t> mExpectedPresentTime = 0;
1149
Ana Kruleca5bdd9d2019-01-29 19:00:58 -08001150 std::mutex mActiveConfigLock;
1151 // This bit is set once we start setting the config. We read from this bit during the
1152 // process. If at the end, this bit is different than mDesiredActiveConfig, we restart
1153 // the process.
1154 ActiveConfigInfo mUpcomingActiveConfig; // Always read and written on the main thread.
1155 // This bit can be set at any point in time when the system wants the new config.
1156 ActiveConfigInfo mDesiredActiveConfig GUARDED_BY(mActiveConfigLock);
1157
Ady Abrahamb838aed2019-02-12 15:30:16 -08001158 // below flags are set by main thread only
Ady Abraham50204dd2019-07-19 15:47:11 -07001159 TracedOrdinal<bool> mDesiredActiveConfigChanged
1160 GUARDED_BY(mActiveConfigLock) = {"DesiredActiveConfigChanged", false};
Ady Abrahamb838aed2019-02-12 15:30:16 -08001161 bool mCheckPendingFence = false;
1162
Kevin DuBois413287f2019-02-25 08:46:47 -08001163 bool mLumaSampling = true;
1164 sp<RegionSamplingThread> mRegionSamplingThread;
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001165 ui::DisplayPrimaries mInternalDisplayPrimaries;
Kevin DuBois413287f2019-02-25 08:46:47 -08001166
Robert Carr720e5062018-07-30 17:45:14 -07001167 sp<IInputFlinger> mInputFlinger;
Vishnu Nairfa5f8df2019-02-13 17:02:51 -08001168 InputWindowCommands mPendingInputWindowCommands GUARDED_BY(mStateLock);
1169 // Should only be accessed by the main thread.
chaviw273171b2018-12-26 11:46:30 -08001170 InputWindowCommands mInputWindowCommands;
chaviw291d88a2019-02-14 10:33:58 -08001171
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001172 struct SetInputWindowsListener : BnSetInputWindowsListener {
1173 explicit SetInputWindowsListener(sp<SurfaceFlinger> flinger)
1174 : mFlinger(std::move(flinger)) {}
1175
1176 void onSetInputWindowsFinished() override;
1177
1178 const sp<SurfaceFlinger> mFlinger;
1179 };
1180
1181 const sp<SetInputWindowsListener> mSetInputWindowsListener = new SetInputWindowsListener(this);
1182
chaviw95ef3c42019-02-14 10:55:09 -08001183 bool mPendingSyncInputWindows GUARDED_BY(mStateLock);
Peiyong Lin74ca2f42019-01-14 19:36:57 -08001184 Hwc2::impl::PowerAdvisor mPowerAdvisor;
Ady Abraham03b02dd2019-03-21 15:40:11 -07001185
Alec Mouri9519bf12019-11-15 16:54:44 -08001186 // This should only be accessed on the main thread.
1187 nsecs_t mFrameStartTime = 0;
1188
Ady Abraham03b02dd2019-03-21 15:40:11 -07001189 std::unique_ptr<RefreshRateOverlay> mRefreshRateOverlay;
Ady Abraham34392f72019-04-10 11:29:27 -07001190
1191 // Flag used to set override allowed display configs from backdoor
1192 bool mDebugDisplayConfigSetByBackdoor = false;
chaviw74d90ad2019-04-26 14:45:26 -07001193
1194 // A set of layers that have no parent so they are not drawn on screen.
1195 // Should only be accessed by the main thread.
1196 // The Layer pointer is removed from the set when the destructor is called so there shouldn't
1197 // be any issues with a raw pointer referencing an invalid object.
1198 std::unordered_set<Layer*> mOffscreenLayers;
Ady Abraham9ba25122019-06-03 17:10:55 -07001199
Ady Abraham27c70212019-06-11 10:52:26 -07001200 // Flags to capture the state of Vsync in HWC
1201 HWC2::Vsync mHWCVsyncState = HWC2::Vsync::Disable;
1202 HWC2::Vsync mHWCVsyncPendingState = HWC2::Vsync::Disable;
Romain Guy0147a172017-06-01 13:53:56 -07001203};
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001204
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001205} // namespace android