blob: 114a09b52121b106c5a173ee1a8500aede971490 [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 *
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080010 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
Dominik Laskowski9dab3432019-03-27 13:21:10 -070016#pragma once
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080017
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080018#include <sys/types.h>
19
Mathias Agopian3f844832013-08-07 21:24:32 -070020/*
21 * NOTE: Make sure this file doesn't include anything from <gl/ > or <gl2/ >
22 */
Mathias Agopian921e6ac2012-07-23 23:11:29 -070023
Vishnu Naird7ff85f2023-12-08 09:51:31 -080024#include <android-base/stringprintf.h>
25#include <android-base/strings.h>
Dominik Laskowski83b88212018-12-11 13:34:06 -080026#include <android-base/thread_annotations.h>
Huihong Luof5029222021-12-16 14:33:46 -080027#include <android/gui/BnSurfaceComposer.h>
Huihong Luoaa7fc2e2022-02-15 10:43:00 -080028#include <android/gui/DisplayStatInfo.h>
29#include <android/gui/DisplayState.h>
Pascal Mütschardd56514e2024-05-24 17:37:13 +020030#include <android/gui/IJankListener.h>
Huihong Luod3d8f8e2022-03-08 14:48:46 -080031#include <android/gui/ISurfaceComposerClient.h>
Vishnu Nairbe0ad902024-06-27 23:38:43 +000032#include <common/trace.h>
Steven Moreland2716e112018-02-23 14:57:20 -080033#include <cutils/atomic.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080034#include <cutils/compiler.h>
Dominik Laskowski80872bd2022-11-15 11:34:33 -050035#include <ftl/algorithm.h>
Dominik Laskowskib17c6212022-05-09 09:36:19 -070036#include <ftl/future.h>
Dominik Laskowski530d6bd2022-10-10 16:55:54 -040037#include <ftl/non_null.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080038#include <gui/BufferQueue.h>
Dominik Laskowski5a5e01e2022-07-08 07:52:44 -070039#include <gui/CompositorTiming.h>
Brian Anderson0a61b0c2016-12-07 14:55:56 -080040#include <gui/FrameTimestamps.h>
Mathias Agopian90ac7992012-02-25 18:48:35 -080041#include <gui/ISurfaceComposer.h>
Huihong Luoffee3bc2023-01-17 16:14:35 +000042#include <gui/ITransactionCompletedListener.h>
Robert Carr4cdc58f2017-08-23 14:22:20 -070043#include <gui/LayerState.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080044#include <layerproto/LayerProtoHeader.h>
45#include <math/mat4.h>
Vishnu Nair08f6eae2019-11-26 14:01:39 -080046#include <renderengine/LayerSettings.h>
Vishnu Nair35798872017-10-06 16:00:36 -070047#include <serviceutils/PriorityDumper.h>
Michael Wright28f24d02016-07-12 13:30:53 -070048#include <system/graphics.h>
Dominik Laskowski6b049ff2023-01-29 15:46:45 -050049#include <ui/DisplayMap.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080050#include <ui/FenceTime.h>
51#include <ui/PixelFormat.h>
Brian Lindahla13f2d52020-03-05 11:54:17 +010052#include <ui/Size.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080053#include <utils/Errors.h>
54#include <utils/KeyedVector.h>
55#include <utils/RefBase.h>
56#include <utils/SortedVector.h>
Peiyong Lin2acb7d42019-01-14 17:22:27 -080057#include <utils/threads.h>
Michael Wright28f24d02016-07-12 13:30:53 -070058
Dominik Laskowskif6b4ba62021-11-09 12:46:10 -080059#include <compositionengine/OutputColorSetting.h>
60#include <scheduler/Fps.h>
Dominik Laskowski80c77272022-07-08 12:47:29 -070061#include <scheduler/PresentLatencyTracker.h>
Dominik Laskowski8792c112022-07-12 09:03:39 -070062#include <scheduler/Time.h>
Dominik Laskowski1c99a002023-01-20 17:10:36 -050063#include <scheduler/TransactionSchedule.h>
Dominik Laskowski63f12792023-01-21 16:58:22 -050064#include <scheduler/interface/CompositionCoverage.h>
65#include <scheduler/interface/ICompositor.h>
Patrick Williams2e9748f2022-08-09 22:48:18 +000066#include <ui/FenceResult.h>
Dominik Laskowskif6b4ba62021-11-09 12:46:10 -080067
Alec Mouri9b133ca2023-11-14 19:00:01 +000068#include <common/FlagManager.h>
Dominik Laskowski6e465152022-09-28 11:00:25 -040069#include "Display/DisplayModeController.h"
Dominik Laskowskib363c4c2022-08-02 14:03:41 -070070#include "Display/PhysicalDisplay.h"
Mathias Agopian92a979a2012-08-02 18:32:23 -070071#include "DisplayDevice.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080072#include "DisplayHardware/HWC2.h"
Peiyong Lin74ca2f42019-01-14 19:36:57 -080073#include "DisplayHardware/PowerAdvisor.h"
Marin Shalamanov0f10d0d2020-08-06 20:04:06 +020074#include "DisplayIdGenerator.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080075#include "Effects/Daltonizer.h"
Vishnu Nairaf6d2972022-11-18 06:26:38 +000076#include "FrontEnd/DisplayInfo.h"
Vishnu Naircb8be502022-10-12 19:03:23 +000077#include "FrontEnd/LayerCreationArgs.h"
Vishnu Nair3af0ec02023-02-10 04:13:48 +000078#include "FrontEnd/LayerLifecycleManager.h"
Vishnu Nair7aa0eb72023-01-24 03:59:27 +000079#include "FrontEnd/LayerSnapshot.h"
Vishnu Nair3af0ec02023-02-10 04:13:48 +000080#include "FrontEnd/LayerSnapshotBuilder.h"
Vishnu Naira61e4fb2022-10-18 18:29:37 +000081#include "FrontEnd/TransactionHandler.h"
Robert Carr2047fae2016-11-28 14:09:09 -080082#include "LayerVector.h"
Vishnu Naird7ff85f2023-12-08 09:51:31 -080083#include "MutexUtils.h"
Leon Scroggins IIIc275df42023-02-07 16:40:21 -050084#include "Scheduler/ISchedulerCallback.h"
Dominik Laskowskid82e0f02022-10-26 15:23:04 -040085#include "Scheduler/RefreshRateSelector.h"
Ana Krulec98b5b242018-08-10 15:03:23 -070086#include "Scheduler/Scheduler.h"
Peiyong Lin2acb7d42019-01-14 17:22:27 -080087#include "SurfaceFlingerFactory.h"
Dominik Laskowski298b08e2022-02-15 13:45:02 -080088#include "ThreadContext.h"
Vishnu Nair00b90132021-11-05 14:03:40 -070089#include "Tracing/LayerTracing.h"
Vishnu Nair7891e962021-11-11 12:07:21 -080090#include "Tracing/TransactionTracing.h"
Robert Carr9a803c32021-01-14 16:57:58 -080091#include "TransactionCallbackInvoker.h"
Vishnu Nair6b591152021-10-08 11:45:14 -070092#include "TransactionState.h"
Dominik Laskowskid4a22752024-03-08 17:39:04 -050093#include "Utils/OnceFuture.h"
Mathias Agopian86303202012-07-24 22:46:10 -070094
Dominik Laskowski83b88212018-12-11 13:34:06 -080095#include <atomic>
96#include <cstdint>
Dominik Laskowskic2867142019-01-21 11:33:38 -080097#include <functional>
Dan Stozae77c7662016-05-13 11:37:28 -070098#include <map>
Dominik Laskowski83b88212018-12-11 13:34:06 -080099#include <memory>
Brian Anderson0a61b0c2016-12-07 14:55:56 -0800100#include <mutex>
Dominik Laskowskieddeda12019-07-19 11:54:13 -0700101#include <optional>
Brian Anderson0a61b0c2016-12-07 14:55:56 -0800102#include <queue>
Dominik Laskowski075d3172018-05-24 15:50:06 -0700103#include <set>
Dan Stozae77c7662016-05-13 11:37:28 -0700104#include <string>
Steven Thomasb02664d2017-07-26 18:48:28 -0700105#include <thread>
Dominik Laskowskic2867142019-01-21 11:33:38 -0800106#include <type_traits>
Dominik Laskowski075d3172018-05-24 15:50:06 -0700107#include <unordered_map>
Dominik Laskowski22488f62019-03-28 09:53:04 -0700108#include <unordered_set>
Brian Anderson0a61b0c2016-12-07 14:55:56 -0800109#include <utility>
Brian Lindahl439afad2022-11-14 11:16:55 -0700110#include <vector>
Dan Stozae77c7662016-05-13 11:37:28 -0700111
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -0500112#include <aidl/android/hardware/graphics/common/DisplayDecorationSupport.h>
Huihong Luo791bef92023-09-19 21:18:45 -0700113#include <aidl/android/hardware/graphics/common/DisplayHotplugEvent.h>
ramindani12bfe6b2023-02-03 13:29:19 -0800114#include <aidl/android/hardware/graphics/composer3/RefreshRateChangedDebugData.h>
Lloyd Pique30db6402023-06-26 18:56:51 +0000115#include "Client.h"
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -0500116
chaviw1d044282017-09-27 12:19:28 -0700117using namespace android::surfaceflinger;
118
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800119namespace android {
120
Lloyd Pique144e1162017-12-20 16:44:52 -0800121class EventThread;
rnleea2ecd832021-07-29 13:58:30 -0700122class FlagManager;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800123class FpsReporter;
Galia Peycheva8f04b302021-04-27 13:25:38 +0200124class TunnelModeEnabledReporter;
John Reck88270902021-03-18 11:27:35 -0400125class HdrLayerInfoReporter;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700126class HWComposer;
Lloyd Pique12eb4232018-01-17 11:54:43 -0800127class IGraphicBufferProducer;
Lloyd Pique144e1162017-12-20 16:44:52 -0800128class Layer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700129class MessageBase;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700130class RefreshRateOverlay;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700131class RegionSamplingThread;
Marin Shalamanovf6b5d182020-06-12 02:08:51 +0200132class RenderArea;
Yiwei Zhang7e666a52018-11-15 13:33:42 -0800133class TimeStats;
Mikael Pessa90092f42019-08-26 17:22:04 -0700134class FrameTracer;
Huihong Luof5029222021-12-16 14:33:46 -0800135class ScreenCapturer;
chaviw60c9d3e2021-06-04 12:52:17 -0500136class WindowInfosListenerInvoker;
Lloyd Pique144e1162017-12-20 16:44:52 -0800137
Huihong Luo817ebb82023-12-13 12:54:24 -0800138using ::aidl::android::hardware::drm::HdcpLevels;
Huihong Luo791bef92023-09-19 21:18:45 -0700139using ::aidl::android::hardware::graphics::common::DisplayHotplugEvent;
ramindani12bfe6b2023-02-03 13:29:19 -0800140using ::aidl::android::hardware::graphics::composer3::RefreshRateChangedDebugData;
Vishnu Nairaf6d2972022-11-18 06:26:38 +0000141using frontend::TransactionHandler;
Huihong Luof5029222021-12-16 14:33:46 -0800142using gui::CaptureArgs;
143using gui::DisplayCaptureArgs;
Huihong Luoecc1f902021-11-20 11:55:05 -0800144using gui::IRegionSamplingListener;
Huihong Luof5029222021-12-16 14:33:46 -0800145using gui::LayerCaptureArgs;
chaviw0ef7caa2021-01-05 11:04:50 -0800146using gui::ScreenCaptureResults;
147
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700148namespace frametimeline {
149class FrameTimeline;
150}
151
Chris Ye0783e992020-06-02 21:34:49 -0700152namespace os {
153 class IInputFlinger;
154}
155
Lloyd Pique542307f2018-10-19 13:24:08 -0700156namespace compositionengine {
157class DisplaySurface;
Lloyd Pique26d03fd2019-03-07 21:23:23 -0800158class OutputLayer;
Lloyd Pique6a3b4462019-03-07 20:58:12 -0800159
160struct CompositionRefreshArgs;
Lloyd Pique542307f2018-10-19 13:24:08 -0700161} // namespace compositionengine
162
Peiyong Lin833074a2018-08-28 11:53:54 -0700163namespace renderengine {
Lloyd Pique144e1162017-12-20 16:44:52 -0800164class RenderEngine;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700165} // namespace renderengine
chaviwa76b2712017-09-20 12:02:26 -0700166
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800167enum {
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700168 eTransactionNeeded = 0x01,
169 eTraversalNeeded = 0x02,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700170 eDisplayTransactionNeeded = 0x04,
Vishnu Nair6213bd92020-05-08 17:42:25 -0700171 eTransformHintUpdateNeeded = 0x08,
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700172 eTransactionFlushNeeded = 0x10,
Patrick Williamsaf06b792023-02-16 17:46:22 -0600173 eInputInfoUpdateNeeded = 0x20,
174 eTransactionMask = 0x3f,
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800175};
176
Ady Abraham9dada822022-02-03 10:26:59 -0800177// Latch Unsignaled buffer behaviours
178enum class LatchUnsignaledConfig {
179 // All buffers are latched signaled.
180 Disabled,
181
182 // Latch unsignaled is permitted when a single layer is updated in a frame,
183 // and the update includes just a buffer update (i.e. no sync transactions
184 // or geometry changes).
Vishnu Nairf01a6f12023-04-03 22:34:17 +0000185 // Latch unsignaled is also only permitted when a single transaction is ready
186 // to be applied. If we pass an unsignaled fence to HWC, HWC might miss presenting
187 // the frame if the fence does not fire in time. If we apply another transaction,
188 // we may penalize the other transaction unfairly.
Ady Abraham9dada822022-02-03 10:26:59 -0800189 AutoSingleLayer,
190
191 // All buffers are latched unsignaled. This behaviour is discouraged as it
192 // can break sync transactions, stall the display and cause undesired side effects.
Vishnu Nairf01a6f12023-04-03 22:34:17 +0000193 // This is equivalent to ignoring the acquire fence when applying transactions.
Ady Abraham9dada822022-02-03 10:26:59 -0800194 Always,
195};
ramindani4d48f902021-09-20 21:07:45 +0000196
Melody Hsu2ffa36b2024-05-08 03:51:46 +0000197struct DisplayRenderAreaBuilder;
198struct LayerRenderAreaBuilder;
199
Lloyd Pique6a3b4462019-03-07 20:58:12 -0800200using DisplayColorSetting = compositionengine::OutputColorSetting;
Peiyong Lindd9b2ae2018-03-01 16:22:45 -0800201
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700202class SurfaceFlinger : public BnSurfaceComposer,
Vishnu Nair35798872017-10-06 16:00:36 -0700203 public PriorityDumper,
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700204 private IBinder::DeathRecipient,
Ady Abraham2139f732019-11-13 18:56:40 -0800205 private HWC2::ComposerCallback,
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -0700206 private ICompositor,
jimmyshiu4e211772023-06-15 15:18:38 +0000207 private scheduler::ISchedulerCallback,
ramindaniae645822024-01-11 10:57:29 -0800208 private compositionengine::ICEPowerCallback {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800209public:
Lloyd Pique30db6402023-06-26 18:56:51 +0000210 struct SkipInitializationTag {};
211
212 SurfaceFlinger(surfaceflinger::Factory&, SkipInitializationTag) ANDROID_API;
213 explicit SurfaceFlinger(surfaceflinger::Factory&) ANDROID_API;
Peiyong Linf243e5e2020-08-22 17:40:59 -0700214
215 // set main thread scheduling policy
216 static status_t setSchedFifo(bool enabled) ANDROID_API;
217
Wei Wang23aa5a62021-06-04 15:56:57 -0700218 // set main thread scheduling attributes
219 static status_t setSchedAttr(bool enabled);
220
Peiyong Linf243e5e2020-08-22 17:40:59 -0700221 static char const* getServiceName() ANDROID_API { return "SurfaceFlinger"; }
Fabien Sanglard0cc19382017-03-06 11:54:40 -0800222
Lloyd Pique30db6402023-06-26 18:56:51 +0000223 // If fences from sync Framework are supported.
224 static bool hasSyncFramework;
225
226 // The offset in nanoseconds to use when VsyncController timestamps present fence
227 // signaling time.
228 static int64_t dispSyncPresentTimeOffset;
229
230 // Some hardware can do RGB->YUV conversion more efficiently in hardware
231 // controlled by HWC than in hardware controlled by the video encoder.
232 // This instruct VirtualDisplaySurface to use HWC for such conversion on
233 // GL composition.
234 static bool useHwcForRgbToYuv;
235
236 // Controls the number of buffers SurfaceFlinger will allocate for use in
237 // FramebufferSurface
238 static int64_t maxFrameBufferAcquiredBuffers;
239
240 // Controls the minimum acquired buffers SurfaceFlinger will suggest via
241 // ISurfaceComposer.getMaxAcquiredBufferCount().
242 static int64_t minAcquiredBuffers;
243
244 // Controls the maximum width and height in pixels that the graphics pipeline can support for
245 // GPU fallback composition. For example, 8k devices with 4k GPUs, or 4k devices with 2k GPUs.
246 static uint32_t maxGraphicsWidth;
247 static uint32_t maxGraphicsHeight;
248
Lloyd Pique30db6402023-06-26 18:56:51 +0000249 static bool useContextPriority;
250
251 // The data space and pixel format that SurfaceFlinger expects hardware composer
252 // to composite efficiently. Meaning under most scenarios, hardware composer
253 // will accept layers with the data space and pixel format.
254 static ui::Dataspace defaultCompositionDataspace;
255 static ui::PixelFormat defaultCompositionPixelFormat;
256
257 // The data space and pixel format that SurfaceFlinger expects hardware composer
258 // to composite efficiently for wide color gamut surfaces. Meaning under most scenarios,
259 // hardware composer will accept layers with the data space and pixel format.
260 static ui::Dataspace wideColorGamutCompositionDataspace;
261 static ui::PixelFormat wideColorGamutCompositionPixelFormat;
262
263 static constexpr SkipInitializationTag SkipInitialization;
264
ramindani4d48f902021-09-20 21:07:45 +0000265 static LatchUnsignaledConfig enableLatchUnsignaledConfig;
Huihong Luof3441822021-06-16 15:41:07 -0700266
Mathias Agopian4f4f0942013-08-19 17:26:18 -0700267 // must be called before clients can connect
268 void init() ANDROID_API;
269
270 // starts SurfaceFlinger main loop in the current thread
271 void run() ANDROID_API;
272
Dominik Laskowskidd5827a2022-03-17 12:44:23 -0700273 // Indicates frame activity, i.e. whether commit and/or composite is taking place.
274 enum class FrameHint { kNone, kActive };
275
Dominik Laskowski8da6b0e2021-05-12 15:34:13 -0700276 // Schedule commit of transactions on the main thread ahead of the next VSYNC.
Ady Abraham9953e062024-07-24 22:56:22 -0700277 void scheduleCommit(FrameHint, Duration workDurationSlack = Duration::fromNs(0));
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -0700278 // As above, but also force composite regardless if transactions were committed.
Dominik Laskowskidd5827a2022-03-17 12:44:23 -0700279 void scheduleComposite(FrameHint);
Dominik Laskowski8da6b0e2021-05-12 15:34:13 -0700280 // As above, but also force dirty geometry to repaint.
281 void scheduleRepaint();
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -0700282 // Schedule sampling independently from commit or composite.
283 void scheduleSample();
Mathias Agopianbf2c6a62010-12-10 16:22:31 -0800284
Lloyd Pique30db6402023-06-26 18:56:51 +0000285 surfaceflinger::Factory& getFactory() { return mFactory; }
Lloyd Pique90c115d2018-09-18 21:39:42 -0700286
Lloyd Pique70d91362018-10-18 16:02:55 -0700287 // The CompositionEngine encapsulates all composition related interfaces and actions.
288 compositionengine::CompositionEngine& getCompositionEngine() const;
289
Lloyd Piqueb97e04f2018-10-18 17:07:05 -0700290 renderengine::RenderEngine& getRenderEngine() const;
Jesse Hall29c3f352013-05-21 15:36:55 -0700291
Dominik Laskowski75848362019-11-11 17:57:20 -0800292 void onLayerFirstRef(Layer*);
Dominik Laskowskif7a09ed2019-10-07 13:54:18 -0700293 void onLayerDestroyed(Layer*);
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -0700294 void onLayerUpdate();
Robert Carr2e102c92018-10-23 12:11:15 -0700295
Vishnu Nair07e2a482022-10-18 19:18:16 +0000296 // Called when all clients have released all their references to
297 // this layer. The layer may still be kept alive by its parents but
298 // the client can no longer modify this layer directly.
Melody Hsucd391bc2024-09-24 23:46:53 +0000299 void onHandleDestroyed(sp<Layer>& layer, uint32_t layerId);
Vishnu Nair07e2a482022-10-18 19:18:16 +0000300
Robert Carr9a803c32021-01-14 16:57:58 -0800301 TransactionCallbackInvoker& getTransactionCallbackInvoker() {
302 return mTransactionCallbackInvoker;
Marissa Walle2ffb422018-10-12 11:33:52 -0700303 }
304
Lloyd Pique30db6402023-06-26 18:56:51 +0000305 // If set, disables reusing client composition buffers. This can be set by
306 // debug.sf.disable_client_composition_cache
307 bool mDisableClientCompositionCache = false;
308
Alec Mouridea1ac52021-06-23 18:12:18 -0700309 // Disables expensive rendering for all displays
310 // This is scheduled on the main thread
311 void disableExpensiveRendering();
312
Vishnu Naira3140382022-02-24 14:07:11 -0800313 // If set, composition engine tries to predict the composition strategy provided by HWC
314 // based on the previous frame. If the strategy can be predicted, gpu composition will
315 // run parallel to the hwc validateDisplay call and re-run if the predition is incorrect.
316 bool mPredictCompositionStrategy = false;
317
Lloyd Pique30db6402023-06-26 18:56:51 +0000318 // If true, then any layer with a SMPTE 170M transfer function is decoded using the sRGB
319 // transfer instead. This is mainly to preserve legacy behavior, where implementations treated
320 // SMPTE 170M as sRGB prior to color management being implemented, and now implementations rely
321 // on this behavior to increase contrast for some media sources.
322 bool mTreat170mAsSrgb = false;
323
Alec Mouri9af38ba2023-08-16 22:41:14 +0000324 // If true, then screenshots with an enhanced render intent will dim in gamma space.
325 // The purpose is to ensure that screenshots appear correct during system animations for devices
326 // that require that dimming must occur in gamma space.
327 bool mDimInGammaSpaceForEnhancedScreenshots = false;
328
Lloyd Pique30db6402023-06-26 18:56:51 +0000329 // Allows to ignore physical orientation provided through hwc API in favour of
330 // 'ro.surface_flinger.primary_display_orientation'.
331 // TODO(b/246793311): Clean up a temporary property
332 bool mIgnoreHwcPhysicalDisplayOrientation = false;
333
Chavi Weingarten076acac2023-01-19 17:20:43 +0000334 void forceFutureUpdate(int delayInMs);
Vishnu Nair2f65e972023-04-04 16:36:28 +0000335 const DisplayDevice* getDisplayFromLayerStack(ui::LayerStack)
336 REQUIRES(mStateLock, kMainThreadContext);
Chavi Weingarten076acac2023-01-19 17:20:43 +0000337
Leon Scroggins III85d4b222023-05-09 13:58:18 -0400338 // TODO (b/259407931): Remove.
339 // TODO (b/281857977): This should be annotated with REQUIRES(kMainThreadContext), but this
340 // would require thread safety annotations throughout the frontend (in particular Layer and
341 // LayerFE).
342 static ui::Transform::RotationFlags getActiveDisplayRotationFlags() {
343 return sActiveDisplayRotationFlags;
344 }
345
Peiyong Linf243e5e2020-08-22 17:40:59 -0700346protected:
347 // We're reference counted, never destroy SurfaceFlinger directly
348 virtual ~SurfaceFlinger();
349
Dominik Laskowski263eec42021-07-21 23:13:24 -0700350 virtual void processDisplayAdded(const wp<IBinder>& displayToken, const DisplayDeviceState&)
351 REQUIRES(mStateLock);
352
Vishnu Nairdbbe3852022-01-12 20:22:11 -0800353 virtual std::shared_ptr<renderengine::ExternalTexture> getExternalTextureFromBufferData(
Patrick Williamsf1e5df12022-10-17 21:37:42 +0000354 BufferData& bufferData, const char* layerName, uint64_t transactionId);
Vishnu Nairdbbe3852022-01-12 20:22:11 -0800355
Dominik Laskowski263eec42021-07-21 23:13:24 -0700356 // Returns true if any display matches a `bool(const DisplayDevice&)` predicate.
357 template <typename Predicate>
358 bool hasDisplay(Predicate p) const REQUIRES(mStateLock) {
359 return static_cast<bool>(findDisplay(p));
360 }
361
chaviwba4320c2021-09-15 15:20:53 -0500362 bool exceedsMaxRenderTargetSize(uint32_t width, uint32_t height) const {
363 return width > mMaxRenderTargetSize || height > mMaxRenderTargetSize;
364 }
365
Mathias Agopian1f339ff2011-07-01 17:08:43 -0700366private:
David Sodman0c69cad2017-08-21 12:12:51 -0700367 friend class BufferLayer;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700368 friend class Client;
Alec Mouria9a68a62021-03-04 19:14:50 -0800369 friend class FpsReporter;
Galia Peycheva8f04b302021-04-27 13:25:38 +0200370 friend class TunnelModeEnabledReporter;
Dominik Laskowski9dab3432019-03-27 13:21:10 -0700371 friend class Layer;
Ady Abraham03b02dd2019-03-21 15:40:11 -0700372 friend class RefreshRateOverlay;
Dan Stozaec460082018-12-17 15:35:09 -0800373 friend class RegionSamplingThread;
Robert Carr22ceeaa2022-03-08 13:13:22 -0800374 friend class LayerRenderArea;
Vishnu Nair59f6d2d2022-10-05 16:59:56 -0700375 friend class SurfaceComposerAIDL;
Vishnu Nair7aa0eb72023-01-24 03:59:27 +0000376 friend class DisplayRenderArea;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800377
Lloyd Piquef58625d2017-12-19 13:22:33 -0800378 // For unit tests
379 friend class TestableSurfaceFlinger;
Valerie Haud251afb2019-03-29 14:19:02 -0700380 friend class TransactionApplicationTest;
Robert Carr3e2a2992021-06-11 13:42:55 -0700381 friend class TunnelModeEnabledReporterTest;
Lloyd Piquef58625d2017-12-19 13:22:33 -0800382
Peiyong Linf243e5e2020-08-22 17:40:59 -0700383 using TransactionSchedule = scheduler::TransactionSchedule;
Vishnu Nair7aa0eb72023-01-24 03:59:27 +0000384 using GetLayerSnapshotsFunction = std::function<std::vector<std::pair<Layer*, sp<LayerFE>>>()>;
Melody Hsu2ffa36b2024-05-08 03:51:46 +0000385 using RenderAreaBuilderVariant = std::variant<DisplayRenderAreaBuilder, LayerRenderAreaBuilder>;
Peiyong Linf243e5e2020-08-22 17:40:59 -0700386 using DumpArgs = Vector<String16>;
387 using Dumper = std::function<void(const DumpArgs&, bool asProto, std::string&)>;
388
Robert Carr2047fae2016-11-28 14:09:09 -0800389 class State {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800390 public:
Vishnu Naira12c5c72024-08-28 15:42:17 -0700391 explicit State(LayerVector::StateSet set) : stateSet(set) {}
Dan Stoza412903f2017-04-27 13:42:17 -0700392 State& operator=(const State& other) {
393 // We explicitly don't copy stateSet so that, e.g., mDrawingState
394 // always uses the Drawing StateSet.
Dan Stoza412903f2017-04-27 13:42:17 -0700395 displays = other.displays;
Chia-I Wu28f320b2018-05-03 11:02:56 -0700396 colorMatrixChanged = other.colorMatrixChanged;
397 if (colorMatrixChanged) {
398 colorMatrix = other.colorMatrix;
399 }
Vishnu Nair08f6eae2019-11-26 14:01:39 -0800400 globalShadowSettings = other.globalShadowSettings;
401
Dan Stoza412903f2017-04-27 13:42:17 -0700402 return *this;
403 }
404
405 const LayerVector::StateSet stateSet = LayerVector::StateSet::Invalid;
Dominik Laskowski68399272022-09-15 07:54:46 -0700406
407 // TODO(b/241285876): Replace deprecated DefaultKeyedVector with ftl::SmallMap.
408 DefaultKeyedVector<wp<IBinder>, DisplayDeviceState> displays;
409
410 std::optional<size_t> getDisplayIndex(PhysicalDisplayId displayId) const {
411 for (size_t i = 0; i < displays.size(); i++) {
412 const auto& state = displays.valueAt(i);
413 if (state.physical && state.physical->id == displayId) {
414 return i;
415 }
416 }
417
418 return {};
419 }
Robert Carr2047fae2016-11-28 14:09:09 -0800420
Chia-I Wu28f320b2018-05-03 11:02:56 -0700421 bool colorMatrixChanged = true;
422 mat4 colorMatrix;
423
Vishnu Naird9e4f462023-10-06 04:05:45 +0000424 ShadowSettings globalShadowSettings;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800425 };
426
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800427 // Keeps track of pending buffers per layer handle in the transaction queue or current/drawing
428 // state before the buffers are latched. The layer owns the atomic counters and decrements the
429 // count in the main thread when dropping or latching a buffer.
430 //
431 // The binder threads increment the same counter when a new transaction containing a buffer is
432 // added to the transaction queue. The map is updated with the layer handle lifecycle updates.
433 // This is done to avoid lock contention with the main thread.
434 class BufferCountTracker {
435 public:
Melody Hsucd391bc2024-09-24 23:46:53 +0000436 void increment(uint32_t layerId) {
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800437 std::lock_guard<std::mutex> lock(mLock);
Melody Hsucd391bc2024-09-24 23:46:53 +0000438 auto it = mCounterByLayerId.find(layerId);
439 if (it != mCounterByLayerId.end()) {
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800440 auto [name, pendingBuffers] = it->second;
441 int32_t count = ++(*pendingBuffers);
Vishnu Nairbe0ad902024-06-27 23:38:43 +0000442 SFTRACE_INT(name.c_str(), count);
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800443 } else {
Melody Hsucd391bc2024-09-24 23:46:53 +0000444 ALOGW("Layer ID not found! %d", layerId);
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800445 }
446 }
447
Melody Hsucd391bc2024-09-24 23:46:53 +0000448 void add(uint32_t layerId, const std::string& name, std::atomic<int32_t>* counter) {
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800449 std::lock_guard<std::mutex> lock(mLock);
Melody Hsucd391bc2024-09-24 23:46:53 +0000450 mCounterByLayerId[layerId] = std::make_pair(name, counter);
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800451 }
452
Melody Hsucd391bc2024-09-24 23:46:53 +0000453 void remove(uint32_t layerId) {
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800454 std::lock_guard<std::mutex> lock(mLock);
Melody Hsucd391bc2024-09-24 23:46:53 +0000455 mCounterByLayerId.erase(layerId);
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800456 }
457
458 private:
459 std::mutex mLock;
Melody Hsucd391bc2024-09-24 23:46:53 +0000460 std::unordered_map<uint32_t, std::pair<std::string, std::atomic<int32_t>*>>
461 mCounterByLayerId GUARDED_BY(mLock);
Vishnu Nair8eda69e2021-02-26 10:42:10 -0800462 };
463
Peiyong Linf243e5e2020-08-22 17:40:59 -0700464 enum class BootStage {
465 BOOTLOADER,
466 BOOTANIMATION,
467 FINISHED,
468 };
469
Peiyong Linf243e5e2020-08-22 17:40:59 -0700470 template <typename F, std::enable_if_t<!std::is_member_function_pointer_v<F>>* = nullptr>
471 static Dumper dumper(F&& dump) {
472 using namespace std::placeholders;
473 return std::bind(std::forward<F>(dump), _3);
474 }
475
Vishnu Naird7ff85f2023-12-08 09:51:31 -0800476 Dumper lockedDumper(Dumper dump) {
477 return [this, dump](const DumpArgs& args, bool asProto, std::string& result) -> void {
478 TimedLock lock(mStateLock, s2ns(1), __func__);
479 if (!lock.locked()) {
480 base::StringAppendF(&result, "Dumping without lock after timeout: %s (%d)\n",
481 strerror(-lock.status), lock.status);
482 }
483 dump(args, asProto, result);
484 };
485 }
486
Peiyong Linf243e5e2020-08-22 17:40:59 -0700487 template <typename F, std::enable_if_t<std::is_member_function_pointer_v<F>>* = nullptr>
488 Dumper dumper(F dump) {
489 using namespace std::placeholders;
Vishnu Naird7ff85f2023-12-08 09:51:31 -0800490 return lockedDumper(std::bind(dump, this, _3));
Peiyong Linf243e5e2020-08-22 17:40:59 -0700491 }
492
493 template <typename F>
494 Dumper argsDumper(F dump) {
495 using namespace std::placeholders;
Vishnu Naird7ff85f2023-12-08 09:51:31 -0800496 return lockedDumper(std::bind(dump, this, _1, _3));
Peiyong Linf243e5e2020-08-22 17:40:59 -0700497 }
498
499 template <typename F>
500 Dumper protoDumper(F dump) {
501 using namespace std::placeholders;
Vishnu Naird7ff85f2023-12-08 09:51:31 -0800502 return lockedDumper(std::bind(dump, this, _1, _2, _3));
503 }
504
Vishnu Naird1a05782024-03-19 04:37:38 +0000505 Dumper mainThreadDumperImpl(Dumper dumper) {
Vishnu Naird7ff85f2023-12-08 09:51:31 -0800506 return [this, dumper](const DumpArgs& args, bool asProto, std::string& result) -> void {
507 mScheduler
508 ->schedule(
509 [&args, asProto, &result, dumper]() FTL_FAKE_GUARD(kMainThreadContext)
510 FTL_FAKE_GUARD(mStateLock) { dumper(args, asProto, result); })
511 .get();
512 };
Peiyong Linf243e5e2020-08-22 17:40:59 -0700513 }
514
Vishnu Naird1a05782024-03-19 04:37:38 +0000515 template <typename F, std::enable_if_t<std::is_member_function_pointer_v<F>>* = nullptr>
516 Dumper mainThreadDumper(F dump) {
517 using namespace std::placeholders;
518 return mainThreadDumperImpl(std::bind(dump, this, _3));
519 }
520
521 template <typename F, std::enable_if_t<std::is_member_function_pointer_v<F>>* = nullptr>
522 Dumper argsMainThreadDumper(F dump) {
523 using namespace std::placeholders;
524 return mainThreadDumperImpl(std::bind(dump, this, _1, _3));
525 }
526
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700527 // Maximum allowed number of display frames that can be set through backdoor
528 static const int MAX_ALLOWED_DISPLAY_FRAMES = 2048;
Peiyong Linf243e5e2020-08-22 17:40:59 -0700529
Huihong Luo1b0c49f2022-03-15 19:18:21 -0700530 static const size_t MAX_LAYERS = 4096;
531
Alan Dingfc6eab52024-05-02 18:28:45 -0700532 static bool callingThreadHasUnscopedSurfaceFlingerAccess(bool usePermissionCache = true)
Steven Thomasd4071902020-03-24 16:02:53 -0700533 EXCLUDES(mStateLock);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800534
Alan Dingfc6eab52024-05-02 18:28:45 -0700535 // IBinder overrides:
536 status_t onTransact(uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags) override;
537 status_t dump(int fd, const Vector<String16>& args) override { return priorityDump(fd, args); }
538
539 // ISurfaceComposer implementation:
Alan Dingd53801c2024-05-08 16:45:29 -0700540 sp<IBinder> createVirtualDisplay(const std::string& displayName, bool isSecure,
541 const std::string& uniqueId,
542 float requestedRefreshRate = 0.0f);
543 status_t destroyVirtualDisplay(const sp<IBinder>& displayToken);
Huihong Luo07e72362022-02-14 14:26:04 -0800544 std::vector<PhysicalDisplayId> getPhysicalDisplayIds() const EXCLUDES(mStateLock) {
Ady Abrahamed3290f2021-05-17 15:12:14 -0700545 Mutex::Autolock lock(mStateLock);
546 return getPhysicalDisplayIdsLocked();
547 }
Vishnu Nair8c8db542021-09-17 19:51:45 -0700548
Huihong Luo07e72362022-02-14 14:26:04 -0800549 sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const;
Pablo Gamito23780be2023-04-18 08:30:00 +0000550 status_t setTransactionState(
551 const FrameTimelineInfo& frameTimelineInfo, Vector<ComposerState>& state,
Patrick Williamsf65da8a2024-07-24 17:11:19 +0000552 Vector<DisplayState>& displays, uint32_t flags, const sp<IBinder>& applyToken,
Pablo Gamito23780be2023-04-18 08:30:00 +0000553 InputWindowCommands inputWindowCommands, int64_t desiredPresentTime,
554 bool isAutoTimestamp, const std::vector<client_cache_t>& uncacheBuffers,
555 bool hasListenerCallbacks, const std::vector<ListenerCallbacks>& listenerCallbacks,
556 uint64_t transactionId, const std::vector<uint64_t>& mergedTransactionIds) override;
Huihong Luo1b0c49f2022-03-15 19:18:21 -0700557 void bootFinished();
Dominik Laskowskiefb131e2024-02-16 10:57:40 -0500558 status_t getSupportedFrameTimestamps(std::vector<FrameEvent>* outSupported) const;
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800559 sp<IDisplayEventConnection> createDisplayEventConnection(
Huihong Luo1b0c49f2022-03-15 19:18:21 -0700560 gui::ISurfaceComposer::VsyncSource vsyncSource =
561 gui::ISurfaceComposer::VsyncSource::eVsyncSourceApp,
Rachel Lee2248f522023-01-27 16:45:23 -0800562 EventRegistrationFlags eventRegistration = {},
563 const sp<IBinder>& layerHandle = nullptr);
Dominik Laskowskif1833852021-03-23 15:06:50 -0700564
jeimysantiago9be7d0c2023-07-12 18:37:06 +0000565 void captureDisplay(const DisplayCaptureArgs&, const sp<IScreenCaptureListener>&);
John Reck7e4c4872023-11-14 18:31:03 -0500566 void captureDisplay(DisplayId, const CaptureArgs&, const sp<IScreenCaptureListener>&);
Chavi Weingartenf6fb4452024-01-23 21:10:30 +0000567 ScreenCaptureResults captureLayersSync(const LayerCaptureArgs&);
jeimysantiago9be7d0c2023-07-12 18:37:06 +0000568 void captureLayers(const LayerCaptureArgs&, const sp<IScreenCaptureListener>&);
Robert Carr108b2c72019-04-02 16:32:58 -0700569
Huihong Luoaa7fc2e2022-02-15 10:43:00 -0800570 status_t getDisplayStats(const sp<IBinder>& displayToken, DisplayStatInfo* stats);
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100571 status_t getDisplayState(const sp<IBinder>& displayToken, ui::DisplayState*)
Huihong Luoaa7fc2e2022-02-15 10:43:00 -0800572 EXCLUDES(mStateLock);
Sally Qi6bb12822022-10-05 11:42:30 -0700573 status_t getStaticDisplayInfo(int64_t displayId, ui::StaticDisplayInfo*) EXCLUDES(mStateLock);
574 status_t getDynamicDisplayInfoFromId(int64_t displayId, ui::DynamicDisplayInfo*)
Huihong Luoa79ddf42022-02-17 00:01:38 -0800575 EXCLUDES(mStateLock);
Sally Qi6bb12822022-10-05 11:42:30 -0700576 status_t getDynamicDisplayInfoFromToken(const sp<IBinder>& displayToken,
577 ui::DynamicDisplayInfo*) EXCLUDES(mStateLock);
578 void getDynamicDisplayInfoInternal(ui::DynamicDisplayInfo*&, const sp<DisplayDevice>&,
579 const display::DisplaySnapshot&);
Huihong Luoca3d9a42022-02-22 11:07:34 -0800580 status_t getDisplayNativePrimaries(const sp<IBinder>& displayToken, ui::DisplayPrimaries&);
581 status_t setActiveColorMode(const sp<IBinder>& displayToken, ui::ColorMode colorMode);
Huihong Luo37396db2022-02-15 10:43:00 -0800582 status_t getBootDisplayModeSupport(bool* outSupport) const;
Dominik Laskowskib363c4c2022-08-02 14:03:41 -0700583 status_t setBootDisplayMode(const sp<display::DisplayToken>&, DisplayModeId);
Sally Qi0cbd08b2022-08-17 12:12:28 -0700584 status_t getOverlaySupport(gui::OverlayProperties* outProperties) const;
Huihong Luo37396db2022-02-15 10:43:00 -0800585 status_t clearBootDisplayMode(const sp<IBinder>& displayToken);
Kriti Dang674b9372022-11-18 10:58:44 +0100586 status_t getHdrConversionCapabilities(
587 std::vector<gui::HdrConversionCapability>* hdrConversionCapaabilities) const;
Kriti Dangd432bb52023-02-09 18:21:04 +0100588 status_t setHdrConversionStrategy(const gui::HdrConversionStrategy& hdrConversionStrategy,
589 int32_t*);
Kriti Dang674b9372022-11-18 10:58:44 +0100590 status_t getHdrOutputConversionSupport(bool* outSupport) const;
Huihong Luo37396db2022-02-15 10:43:00 -0800591 void setAutoLowLatencyMode(const sp<IBinder>& displayToken, bool on);
592 void setGameContentType(const sp<IBinder>& displayToken, bool on);
593 void setPowerMode(const sp<IBinder>& displayToken, int mode);
Kriti Dang49ad4132021-01-08 11:49:56 +0100594 status_t overrideHdrTypes(const sp<IBinder>& displayToken,
Huihong Luo05539a12022-02-23 10:29:40 -0800595 const std::vector<ui::Hdr>& hdrTypes);
Huihong Luo30aa4372022-10-03 14:54:12 -0700596 status_t onPullAtom(const int32_t atomId, std::vector<uint8_t>* pulledData, bool* success);
Peiyong Linc6780972018-10-28 15:24:08 -0700597 status_t getCompositionPreference(ui::Dataspace* outDataspace, ui::PixelFormat* outPixelFormat,
598 ui::Dataspace* outWideColorGamutDataspace,
Huihong Luo05539a12022-02-23 10:29:40 -0800599 ui::PixelFormat* outWideColorGamutPixelFormat) const;
Dominik Laskowski470df5f2020-04-02 22:27:42 -0700600 status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& displayToken,
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800601 ui::PixelFormat* outFormat,
602 ui::Dataspace* outDataspace,
Huihong Luo05539a12022-02-23 10:29:40 -0800603 uint8_t* outComponentMask) const;
Dominik Laskowski470df5f2020-04-02 22:27:42 -0700604 status_t setDisplayContentSamplingEnabled(const sp<IBinder>& displayToken, bool enable,
Huihong Luo05539a12022-02-23 10:29:40 -0800605 uint8_t componentMask, uint64_t maxFrames);
Dominik Laskowski470df5f2020-04-02 22:27:42 -0700606 status_t getDisplayedContentSample(const sp<IBinder>& displayToken, uint64_t maxFrames,
Huihong Luo05539a12022-02-23 10:29:40 -0800607 uint64_t timestamp, DisplayedFrameStats* outStats) const;
608 status_t getProtectedContentSupport(bool* outSupported) const;
Huihong Luo37396db2022-02-15 10:43:00 -0800609 status_t isWideColorDisplay(const sp<IBinder>& displayToken, bool* outIsWideColorDisplay) const;
Dan Stoza84ab9372018-12-17 15:27:57 -0800610 status_t addRegionSamplingListener(const Rect& samplingArea, const sp<IBinder>& stopLayerHandle,
Huihong Luo02186fb2022-02-23 14:21:54 -0800611 const sp<IRegionSamplingListener>& listener);
612 status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener);
613 status_t addFpsListener(int32_t taskId, const sp<gui::IFpsListener>& listener);
614 status_t removeFpsListener(const sp<gui::IFpsListener>& listener);
615 status_t addTunnelModeEnabledListener(const sp<gui::ITunnelModeEnabledListener>& listener);
616 status_t removeTunnelModeEnabledListener(const sp<gui::ITunnelModeEnabledListener>& listener);
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100617 status_t setDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
Ady Abraham285f8c12022-10-11 17:12:14 -0700618 const gui::DisplayModeSpecs&);
619 status_t getDesiredDisplayModeSpecs(const sp<IBinder>& displayToken, gui::DisplayModeSpecs*);
Huihong Luo37396db2022-02-15 10:43:00 -0800620 status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken, bool* outSupport) const;
John Reck22be6962021-03-10 12:59:54 -0500621 status_t setDisplayBrightness(const sp<IBinder>& displayToken,
Huihong Luo37396db2022-02-15 10:43:00 -0800622 const gui::DisplayBrightness& brightness);
John Reck88270902021-03-18 11:27:35 -0400623 status_t addHdrLayerInfoListener(const sp<IBinder>& displayToken,
Huihong Luo37396db2022-02-15 10:43:00 -0800624 const sp<gui::IHdrLayerInfoListener>& listener);
John Reck88270902021-03-18 11:27:35 -0400625 status_t removeHdrLayerInfoListener(const sp<IBinder>& displayToken,
Huihong Luo37396db2022-02-15 10:43:00 -0800626 const sp<gui::IHdrLayerInfoListener>& listener);
627 status_t notifyPowerBoost(int32_t boostId);
Vishnu Nairb13bb952019-11-15 10:24:08 -0800628 status_t setGlobalShadowSettings(const half4& ambientColor, const half4& spotColor,
Huihong Luo3bdef862022-03-03 11:57:19 -0800629 float lightPosY, float lightPosZ, float lightRadius);
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -0500630 status_t getDisplayDecorationSupport(
631 const sp<IBinder>& displayToken,
632 std::optional<aidl::android::hardware::graphics::common::DisplayDecorationSupport>*
Huihong Luo3bdef862022-03-03 11:57:19 -0800633 outSupport) const;
Steven Thomas62a4cf82020-01-31 12:04:03 -0800634 status_t setFrameRate(const sp<IGraphicBufferProducer>& surface, float frameRate,
Huihong Luo3bdef862022-03-03 11:57:19 -0800635 int8_t compatibility, int8_t changeFrameRateStrategy);
Peiyong Linf243e5e2020-08-22 17:40:59 -0700636
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000637 status_t setFrameTimelineInfo(const sp<IGraphicBufferProducer>& surface,
Huihong Luo3bdef862022-03-03 11:57:19 -0800638 const gui::FrameTimelineInfo& frameTimelineInfo);
Ady Abraham74e17562020-08-24 18:18:19 -0700639
Andy Yu8c2703d2023-11-03 11:22:46 -0700640 status_t setGameModeFrameRateOverride(uid_t uid, float frameRate);
641
642 status_t setGameDefaultFrameRateOverride(uid_t uid, float frameRate);
Andy Yu2ae6b6b2021-11-18 14:51:06 -0800643
Tony Huangf3621102023-09-04 17:14:22 +0800644 status_t updateSmallAreaDetection(std::vector<std::pair<int32_t, float>>& uidThresholdMappings);
Tony Huang9ac5e6e2023-08-24 09:01:44 +0000645
Tony Huangf3621102023-09-04 17:14:22 +0800646 status_t setSmallAreaDetectionThreshold(int32_t appId, float threshold);
Tony Huang9ac5e6e2023-08-24 09:01:44 +0000647
Huihong Luo02186fb2022-02-23 14:21:54 -0800648 int getGpuContextPriority();
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800649
Huihong Luo02186fb2022-02-23 14:21:54 -0800650 status_t getMaxAcquiredBufferCount(int* buffers) const;
Ady Abraham564f9de2021-02-03 18:34:33 -0800651
Patrick Williamsacd22582023-07-12 13:47:28 -0500652 status_t addWindowInfosListener(const sp<gui::IWindowInfosListener>& windowInfosListener,
653 gui::WindowInfosListenerInfo* outResult);
chaviw60c9d3e2021-06-04 12:52:17 -0500654 status_t removeWindowInfosListener(
Huihong Luo02186fb2022-02-23 14:21:54 -0800655 const sp<gui::IWindowInfosListener>& windowInfosListener) const;
chaviw60c9d3e2021-06-04 12:52:17 -0500656
Patrick Williams090ad062023-08-08 12:30:10 -0500657 status_t getStalledTransactionInfo(
658 int pid, std::optional<TransactionHandler::StalledTransactionInfo>& result);
659
Huihong Luo9ebb7a72023-06-27 17:01:50 -0700660 void updateHdcpLevels(hal::HWDisplayId hwcDisplayId, int32_t connectedLevel, int32_t maxLevel);
661
Alan Dingfc6eab52024-05-02 18:28:45 -0700662 // IBinder::DeathRecipient overrides:
Peiyong Lin2acb7d42019-01-14 17:22:27 -0800663 void binderDied(const wp<IBinder>& who) override;
Mathias Agopian99ce5cd2012-01-31 18:24:27 -0800664
Dominik Laskowski0deb06e2021-04-16 23:18:31 -0700665 // HWC2::ComposerCallback overrides:
Dominik Laskowskidc2bb802022-09-28 16:02:59 -0400666 void onComposerHalVsync(hal::HWDisplayId, nsecs_t timestamp,
Dominik Laskowski0deb06e2021-04-16 23:18:31 -0700667 std::optional<hal::VsyncPeriodNanos>) override;
Huihong Luo791bef92023-09-19 21:18:45 -0700668 void onComposerHalHotplugEvent(hal::HWDisplayId, DisplayHotplugEvent) override;
Dominik Laskowski0deb06e2021-04-16 23:18:31 -0700669 void onComposerHalRefresh(hal::HWDisplayId) override;
670 void onComposerHalVsyncPeriodTimingChanged(hal::HWDisplayId,
671 const hal::VsyncPeriodChangeTimeline&) override;
672 void onComposerHalSeamlessPossible(hal::HWDisplayId) override;
Yichi Chen3401b562022-01-17 15:42:35 +0800673 void onComposerHalVsyncIdle(hal::HWDisplayId) override;
ramindani12bfe6b2023-02-03 13:29:19 -0800674 void onRefreshRateChangedDebug(const RefreshRateChangedDebugData&) override;
Huihong Luo817ebb82023-12-13 12:54:24 -0800675 void onComposerHalHdcpLevelsChanged(hal::HWDisplayId, const HdcpLevels& levels) override;
Mathias Agopian86303202012-07-24 22:46:10 -0700676
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -0700677 // ICompositor overrides:
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500678 void configure() override REQUIRES(kMainThreadContext);
Dominik Laskowskifdac5652023-06-29 12:01:13 -0400679 bool commit(PhysicalDisplayId pacesetterId, const scheduler::FrameTargets&) override
680 REQUIRES(kMainThreadContext);
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500681 CompositeResultsPerDisplay composite(PhysicalDisplayId pacesetterId,
682 const scheduler::FrameTargeters&) override
683 REQUIRES(kMainThreadContext);
684
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -0700685 void sample() override;
686
Dominik Laskowskif11728a2022-07-28 13:07:42 -0700687 // ISchedulerCallback overrides:
Dominik Laskowski66295432023-03-14 12:25:36 -0400688 void requestHardwareVsync(PhysicalDisplayId, bool) override;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400689 void requestDisplayModes(std::vector<display::DisplayModeRequest>) override;
Ady Abrahama09852a2020-02-20 14:23:42 -0800690 void kernelTimerChanged(bool expired) override;
Ady Abraham822ecbd2023-07-07 16:16:09 -0700691 void onChoreographerAttached() override;
ramindaniae645822024-01-11 10:57:29 -0800692 void onExpectedPresentTimePosted(TimePoint expectedPresentTime, ftl::NonNull<DisplayModePtr>,
693 Fps renderRate) override;
Ady Abraham14beed72024-05-15 17:16:45 -0700694 void onCommitNotComposited(PhysicalDisplayId pacesetterDisplayId) override
695 REQUIRES(kMainThreadContext);
Ady Abrahameba039c2024-07-10 17:45:29 -0700696 void vrrDisplayIdle(bool idle) override;
Dominik Laskowskif11728a2022-07-28 13:07:42 -0700697
jimmyshiu4e211772023-06-15 15:18:38 +0000698 // ICEPowerCallback overrides:
699 void notifyCpuLoadUp() override;
700
Dominik Laskowskid82e0f02022-10-26 15:23:04 -0400701 using KernelIdleTimerController = scheduler::RefreshRateSelector::KernelIdleTimerController;
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400702
ramindani32cf0602022-03-02 02:30:29 +0000703 // Get the controller and timeout that will help decide how the kernel idle timer will be
704 // configured and what value to use as the timeout.
705 std::pair<std::optional<KernelIdleTimerController>, std::chrono::milliseconds>
Dominik Laskowski6e465152022-09-28 11:00:25 -0400706 getKernelIdleTimerProperties(PhysicalDisplayId) REQUIRES(mStateLock);
Dominik Laskowski43839672024-08-04 02:01:48 -0400707
Lloyd Pique30db6402023-06-26 18:56:51 +0000708 // Show spinner with refresh rate overlay
709 bool mRefreshRateOverlaySpinner = false;
710 // Show render rate with refresh rate overlay
711 bool mRefreshRateOverlayRenderRate = false;
712 // Show render rate overlay offseted to the middle of the screen (e.g. for circular displays)
713 bool mRefreshRateOverlayShowInMiddle = false;
Sally Qi147581b2023-06-27 11:55:34 -0700714 // Show hdr sdr ratio overlay
715 bool mHdrSdrRatioOverlay = false;
Dominik Laskowski8b01cc02020-07-14 19:02:41 -0700716
Bart Sears2d7e7f82024-07-13 19:42:29 +0000717 void setDesiredMode(display::DisplayModeRequest&&) REQUIRES(mStateLock);
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400718
Ady Abraham38027262023-10-17 16:58:25 -0700719 status_t setActiveModeFromBackdoor(const sp<display::DisplayToken>&, DisplayModeId, Fps minFps,
720 Fps maxFps);
Dominik Laskowskifdac5652023-06-29 12:01:13 -0400721
Dominik Laskowskib2fc4232024-07-15 08:24:49 -0400722 void initiateDisplayModeChanges() REQUIRES(kMainThreadContext) REQUIRES(mStateLock);
Dominik Laskowski5c989f52024-04-11 13:57:14 -0400723 void finalizeDisplayModeChange(PhysicalDisplayId) REQUIRES(kMainThreadContext)
Dominik Laskowskib2fc4232024-07-15 08:24:49 -0400724 REQUIRES(mStateLock);
Dominik Laskowskifdac5652023-06-29 12:01:13 -0400725
Dominik Laskowski5c989f52024-04-11 13:57:14 -0400726 void dropModeRequest(PhysicalDisplayId) REQUIRES(kMainThreadContext);
727 void applyActiveMode(PhysicalDisplayId) REQUIRES(kMainThreadContext);
Dominik Laskowski59746512023-11-19 09:30:24 -0500728
Marin Shalamanov5801c942020-12-17 17:00:13 +0100729 // Called on the main thread in response to setPowerMode()
Peiyong Lin65248e02020-04-18 21:15:07 -0700730 void setPowerModeInternal(const sp<DisplayDevice>& display, hal::PowerMode mode)
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700731 REQUIRES(mStateLock, kMainThreadContext);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800732
Dominik Laskowskif2595442022-08-29 13:51:57 -0700733 // Returns the preferred mode for PhysicalDisplayId if the Scheduler has selected one for that
734 // display. Falls back to the display's defaultModeId otherwise.
Ady Abrahamace3d052022-11-17 16:25:05 -0800735 ftl::Optional<scheduler::FrameRateMode> getPreferredDisplayMode(
Dominik Laskowski530d6bd2022-10-10 16:55:54 -0400736 PhysicalDisplayId, DisplayModeId defaultModeId) const REQUIRES(mStateLock);
Dominik Laskowskif2595442022-08-29 13:51:57 -0700737
Dominik Laskowskid82e0f02022-10-26 15:23:04 -0400738 status_t setDesiredDisplayModeSpecsInternal(
739 const sp<DisplayDevice>&, const scheduler::RefreshRateSelector::PolicyVariant&)
Dominik Laskowski36dced82022-09-02 09:24:00 -0700740 EXCLUDES(mStateLock) REQUIRES(kMainThreadContext);
Ady Abraham838de062019-02-04 10:24:03 -0800741
Dominik Laskowski3f726402022-11-21 17:21:22 -0500742 // TODO(b/241285191): Look up RefreshRateSelector on Scheduler to remove redundant parameter.
743 status_t applyRefreshRateSelectorPolicy(PhysicalDisplayId,
Dominik Laskowski1746afd2024-04-10 19:21:37 -0400744 const scheduler::RefreshRateSelector&)
Dominik Laskowski3f726402022-11-21 17:21:22 -0500745 REQUIRES(mStateLock, kMainThreadContext);
746
Vishnu Nair878911f2024-03-27 22:20:24 -0700747 void commitTransactions() REQUIRES(kMainThreadContext, mStateLock);
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700748 void commitTransactionsLocked(uint32_t transactionFlags)
749 REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700750 void doCommitTransactions() REQUIRES(mStateLock);
Dan Stoza6b9454d2014-11-07 16:00:59 -0800751
Vishnu Nair3af0ec02023-02-10 04:13:48 +0000752 std::vector<std::pair<Layer*, LayerFE*>> moveSnapshotsToCompositionArgs(
Vishnu Nair7be27602024-03-28 20:27:09 -0700753 compositionengine::CompositionRefreshArgs& refreshArgs, bool cursorOnly)
754 REQUIRES(kMainThreadContext);
Vishnu Nair3af0ec02023-02-10 04:13:48 +0000755 void moveSnapshotsFromCompositionArgs(compositionengine::CompositionRefreshArgs& refreshArgs,
Vishnu Nair7be27602024-03-28 20:27:09 -0700756 const std::vector<std::pair<Layer*, LayerFE*>>& layers)
757 REQUIRES(kMainThreadContext);
Vishnu Nair8134c1a2023-10-17 22:55:49 -0700758 // Return true if we must composite this frame
Vishnu Nair4d9cef92023-06-24 22:34:41 +0000759 bool updateLayerSnapshots(VsyncId vsyncId, nsecs_t frameTimeNs, bool transactionsFlushed,
Vishnu Nair3af0ec02023-02-10 04:13:48 +0000760 bool& out) REQUIRES(kMainThreadContext);
Vishnu Nair7be27602024-03-28 20:27:09 -0700761 void updateLayerHistory(nsecs_t now) REQUIRES(kMainThreadContext);
Dan Stoza6b9454d2014-11-07 16:00:59 -0800762
Vishnu Nair7be27602024-03-28 20:27:09 -0700763 void updateInputFlinger(VsyncId vsyncId, TimePoint frameTime) REQUIRES(kMainThreadContext);
Dominik Laskowski298b08e2022-02-15 13:45:02 -0800764 void persistDisplayBrightness(bool needsComposite) REQUIRES(kMainThreadContext);
Vishnu Nair03ccbd62021-12-01 17:21:16 -0800765 void buildWindowInfos(std::vector<gui::WindowInfo>& outWindowInfos,
Vishnu Nair7be27602024-03-28 20:27:09 -0700766 std::vector<gui::DisplayInfo>& outDisplayInfos)
767 REQUIRES(kMainThreadContext);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800768 void commitInputWindowCommands() REQUIRES(mStateLock);
Vishnu Nair7be27602024-03-28 20:27:09 -0700769 void updateCursorAsync() REQUIRES(kMainThreadContext);
Dominik Laskowski08d05c22020-07-22 00:05:08 -0700770
Dominik Laskowski59db9562022-10-27 16:18:53 -0400771 void initScheduler(const sp<const DisplayDevice>&) REQUIRES(kMainThreadContext, mStateLock);
Dominik Laskowski14956dc2023-02-22 13:43:57 -0500772
Peiyong Linf243e5e2020-08-22 17:40:59 -0700773 /*
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700774 * Transactions
775 */
Chavi Weingartenc78f53c2023-04-14 18:50:53 +0000776 bool applyTransactionState(const FrameTimelineInfo& info,
777 std::vector<ResolvedComposerState>& state,
778 Vector<DisplayState>& displays, uint32_t flags,
779 const InputWindowCommands& inputWindowCommands,
780 const int64_t desiredPresentTime, bool isAutoTimestamp,
781 const std::vector<uint64_t>& uncacheBufferIds,
782 const int64_t postTime, bool hasListenerCallbacks,
783 const std::vector<ListenerCallbacks>& listenerCallbacks,
784 int originPid, int originUid, uint64_t transactionId)
Vishnu Nair7be27602024-03-28 20:27:09 -0700785 REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowski08fbd852022-07-14 08:53:42 -0700786 // Flush pending transactions that were presented after desiredPresentTime.
Vishnu Nair42ad3192023-01-24 19:17:59 -0800787 // For test only
Shuangxi Xianga97d59d2024-08-27 07:28:20 +0000788 bool flushTransactionQueues() REQUIRES(kMainThreadContext);
Vishnu Nair42ad3192023-01-24 19:17:59 -0800789
Shuangxi Xianga97d59d2024-08-27 07:28:20 +0000790 bool applyTransactions(std::vector<TransactionState>&) REQUIRES(kMainThreadContext);
Vishnu Nair878911f2024-03-27 22:20:24 -0700791 bool applyAndCommitDisplayTransactionStatesLocked(std::vector<TransactionState>& transactions)
792 REQUIRES(kMainThreadContext, mStateLock);
Vishnu Nair42ad3192023-01-24 19:17:59 -0800793
Marissa Walle6e3c0d2019-03-29 10:28:30 -0700794 // Returns true if there is at least one transaction that needs to be flushed
Vishnu Nair7be27602024-03-28 20:27:09 -0700795 bool transactionFlushNeeded() REQUIRES(kMainThreadContext);
796 void addTransactionReadyFilters() REQUIRES(kMainThreadContext);
Vishnu Nair59f6d2d2022-10-05 16:59:56 -0700797 TransactionHandler::TransactionReadiness transactionReadyTimelineCheck(
798 const TransactionHandler::TransactionFlushState& flushState)
799 REQUIRES(kMainThreadContext);
800 TransactionHandler::TransactionReadiness transactionReadyBufferCheck(
801 const TransactionHandler::TransactionFlushState& flushState)
802 REQUIRES(kMainThreadContext);
Ady Abrahame1bfaac2022-02-22 21:32:08 -0800803
Vishnu Nair3af0ec02023-02-10 04:13:48 +0000804 uint32_t updateLayerCallbacksAndStats(const FrameTimelineInfo&, ResolvedComposerState&,
805 int64_t desiredPresentTime, bool isAutoTimestamp,
Chavi Weingartenc78f53c2023-04-14 18:50:53 +0000806 int64_t postTime, uint64_t transactionId)
Vishnu Nair7be27602024-03-28 20:27:09 -0700807 REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700808 uint32_t getTransactionFlags() const;
809
Dominik Laskowski94000c42022-03-17 12:55:14 -0700810 // Sets the masked bits, and schedules a commit if needed.
811 void setTransactionFlags(uint32_t mask, TransactionSchedule = TransactionSchedule::Late,
Dominik Laskowski1f6fc702022-03-21 08:34:50 -0700812 const sp<IBinder>& applyToken = nullptr,
813 FrameHint = FrameHint::kActive);
Dominik Laskowski9e168db2021-05-27 16:05:12 -0700814
815 // Clears and returns the masked bits.
816 uint32_t clearTransactionFlags(uint32_t mask);
817
ramindani4d48f902021-09-20 21:07:45 +0000818 static LatchUnsignaledConfig getLatchUnsignaledConfig();
Vishnu Nair4d9cef92023-06-24 22:34:41 +0000819 bool shouldLatchUnsignaled(const layer_state_t&, size_t numStates, bool firstTransaction) const;
Shuangxi Xianga97d59d2024-08-27 07:28:20 +0000820 bool applyTransactionsLocked(std::vector<TransactionState>& transactions)
Vishnu Nair7be27602024-03-28 20:27:09 -0700821 REQUIRES(mStateLock, kMainThreadContext);
Vishnu Nairce5d0cc2019-02-28 14:38:41 -0800822 uint32_t setDisplayStateLocked(const DisplayState& s) REQUIRES(mStateLock);
Vishnu Nairfa5f8df2019-02-13 17:02:51 -0800823 uint32_t addInputWindowCommands(const InputWindowCommands& inputWindowCommands)
824 REQUIRES(mStateLock);
Dominik Laskowski08fbd852022-07-14 08:53:42 -0700825 bool frameIsEarly(TimePoint expectedPresentTime, VsyncId) const;
826
Peiyong Linf243e5e2020-08-22 17:40:59 -0700827 /*
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700828 * Layer management
829 */
Vishnu Naircb8be502022-10-12 19:03:23 +0000830 status_t createLayer(LayerCreationArgs& args, gui::CreateSurfaceResult& outResult);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800831
Vishnu Nair7fb9e5a2021-11-08 12:44:05 -0800832 status_t createBufferStateLayer(LayerCreationArgs& args, sp<IBinder>* outHandle,
833 sp<Layer>* outLayer);
Marissa Wall61c58622018-07-18 10:12:20 -0700834
Vishnu Nair84125ac2021-12-02 08:47:48 -0800835 status_t createEffectLayer(const LayerCreationArgs& args, sp<IBinder>* outHandle,
Vishnu Nairfa247b12020-02-11 08:58:26 -0800836 sp<Layer>* outLayer);
Mathias Agopian74c40c02010-09-29 13:02:36 -0700837
Vishnu Nair84125ac2021-12-02 08:47:48 -0800838 status_t mirrorLayer(const LayerCreationArgs& args, const sp<IBinder>& mirrorFromHandle,
Patrick Williamsa361de62022-10-06 20:34:10 +0000839 gui::CreateSurfaceResult& outResult);
chaviwfe94a222019-08-21 13:52:59 -0700840
Chavi Weingarten7043a7d2022-07-19 23:40:35 +0000841 status_t mirrorDisplay(DisplayId displayId, const LayerCreationArgs& args,
Patrick Williamsa361de62022-10-06 20:34:10 +0000842 gui::CreateSurfaceResult& outResult);
Chavi Weingarten7043a7d2022-07-19 23:40:35 +0000843
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700844 // add a layer to SurfaceFlinger
Vishnu Nair1391de22023-03-05 19:56:14 -0800845 status_t addClientLayer(LayerCreationArgs& args, const sp<IBinder>& handle,
Vishnu Naircb8be502022-10-12 19:03:23 +0000846 const sp<Layer>& layer, const wp<Layer>& parentLayer,
Garfield Tandbc93d72021-10-26 18:28:57 -0700847 uint32_t* outTransformHint);
Mathias Agopianf1d8e872009-04-20 19:39:12 -0700848
Melody Hsu793f8362024-01-08 20:00:35 +0000849 // Creates a promise for a future release fence for a layer. This allows for
850 // the layer to keep track of when its buffer can be released.
851 void attachReleaseFenceFutureToLayer(Layer* layer, LayerFE* layerFE, ui::LayerStack layerStack);
852
853 // Checks if a protected layer exists in a list of layers.
Melody Hsu0b80c742024-10-29 07:24:29 +0000854 bool layersHasProtectedLayer(const std::vector<std::pair<Layer*, sp<LayerFE>>>& layers) const;
Melody Hsu8c42cf12024-06-05 00:07:03 +0000855
856 using OutputCompositionState = compositionengine::impl::OutputCompositionState;
857
Vishnu Nair5a93ccb2024-06-26 00:38:32 +0000858 std::optional<OutputCompositionState> getSnapshotsFromMainThread(
Melody Hsu8c42cf12024-06-05 00:07:03 +0000859 RenderAreaBuilderVariant& renderAreaBuilder,
Melody Hsu0b80c742024-10-29 07:24:29 +0000860 GetLayerSnapshotsFunction getLayerSnapshotsFn,
861 std::vector<std::pair<Layer*, sp<LayerFE>>>& layers);
Melody Hsu82d524e2024-02-23 02:37:38 +0000862
Melody Hsu2ffa36b2024-05-08 03:51:46 +0000863 void captureScreenCommon(RenderAreaBuilderVariant, GetLayerSnapshotsFunction,
864 ui::Size bufferSize, ui::PixelFormat, bool allowProtected,
Alec Mouri1b1853f2024-07-15 22:46:58 +0000865 bool grayscale, bool attachGainmap, const sp<IScreenCaptureListener>&);
Melody Hsu82d524e2024-02-23 02:37:38 +0000866
Melody Hsu8c42cf12024-06-05 00:07:03 +0000867 std::optional<OutputCompositionState> getDisplayStateFromRenderAreaBuilder(
868 RenderAreaBuilderVariant& renderAreaBuilder) REQUIRES(kMainThreadContext);
Melody Hsu335ef3e2024-05-31 22:58:40 +0000869
Melody Hsu82d524e2024-02-23 02:37:38 +0000870 ftl::SharedFuture<FenceResult> captureScreenshot(
Melody Hsu8c42cf12024-06-05 00:07:03 +0000871 const RenderAreaBuilderVariant& renderAreaBuilder,
872 const std::shared_ptr<renderengine::ExternalTexture>& buffer, bool regionSampling,
Alec Mouri1b1853f2024-07-15 22:46:58 +0000873 bool grayscale, bool isProtected, bool attachGainmap,
874 const sp<IScreenCaptureListener>& captureListener,
Melody Hsu8c42cf12024-06-05 00:07:03 +0000875 std::optional<OutputCompositionState>& displayState,
Melody Hsu0b80c742024-10-29 07:24:29 +0000876 std::vector<std::pair<Layer*, sp<LayerFE>>>& layers);
Melody Hsu8c42cf12024-06-05 00:07:03 +0000877
878 ftl::SharedFuture<FenceResult> captureScreenshotLegacy(
Melody Hsu2ffa36b2024-05-08 03:51:46 +0000879 RenderAreaBuilderVariant, GetLayerSnapshotsFunction,
Sally Qi59a9f502021-10-12 18:53:23 +0000880 const std::shared_ptr<renderengine::ExternalTexture>&, bool regionSampling,
Alec Mouri1b1853f2024-07-15 22:46:58 +0000881 bool grayscale, bool isProtected, bool attachGainmap,
882 const sp<IScreenCaptureListener>&);
Melody Hsu82d524e2024-02-23 02:37:38 +0000883
Melody Hsu793f8362024-01-08 20:00:35 +0000884 ftl::SharedFuture<FenceResult> renderScreenImpl(
Alec Mouri1b1853f2024-07-15 22:46:58 +0000885 const RenderArea*, const std::shared_ptr<renderengine::ExternalTexture>&,
886 bool regionSampling, bool grayscale, bool isProtected, bool attachGainmap,
887 ScreenCaptureResults&, std::optional<OutputCompositionState>& displayState,
Melody Hsu0b80c742024-10-29 07:24:29 +0000888 std::vector<std::pair<Layer*, sp<LayerFE>>>& layers);
Melody Hsu793f8362024-01-08 20:00:35 +0000889
Romain Guy11d63f42017-07-20 12:47:14 -0700890 void readPersistentProperties();
891
rnleeed20fa42021-08-10 18:00:03 -0700892 uint32_t getMaxAcquiredBufferCountForCurrentRefreshRate(uid_t uid) const;
Ady Abraham899dcdb2021-06-15 16:56:21 -0700893
Peiyong Linf243e5e2020-08-22 17:40:59 -0700894 /*
Mathias Agopian87baae12012-07-31 12:38:26 -0700895 * Display and layer stack management
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700896 */
Dominik Laskowskif8734e02022-08-26 09:06:59 -0700897
Dominik Laskowskia42d5392022-09-29 14:26:53 -0400898 // Called during boot and restart after system_server death, setting the stage for bootanimation
899 // before DisplayManager takes over.
Dominik Laskowskib5f40e52022-09-29 13:25:05 -0400900 void initializeDisplays() REQUIRES(kMainThreadContext);
Andy McFadden13a082e2012-08-24 10:16:42 -0700901
Dominik Laskowski0a1435d2020-04-21 00:27:31 -0700902 sp<const DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) const
903 REQUIRES(mStateLock) {
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700904 return const_cast<SurfaceFlinger*>(this)->getDisplayDeviceLocked(displayToken);
Mathias Agopian92a979a2012-08-02 18:32:23 -0700905 }
Mathias Agopiandb9b41f2012-10-15 16:51:41 -0700906
Dominik Laskowski0a1435d2020-04-21 00:27:31 -0700907 sp<DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& displayToken) REQUIRES(mStateLock) {
Dominik Laskowski80872bd2022-11-15 11:34:33 -0500908 return mDisplays.get(displayToken)
909 .or_else(ftl::static_ref<sp<DisplayDevice>>([] { return nullptr; }))
910 .value();
Mathias Agopian921e6ac2012-07-23 23:11:29 -0700911 }
Mathias Agopian99b49842011-06-27 16:05:52 -0700912
Ady Abraham690f4612021-07-01 23:24:03 -0700913 sp<const DisplayDevice> getDisplayDeviceLocked(PhysicalDisplayId id) const
914 REQUIRES(mStateLock) {
915 return const_cast<SurfaceFlinger*>(this)->getDisplayDeviceLocked(id);
916 }
917
918 sp<DisplayDevice> getDisplayDeviceLocked(PhysicalDisplayId id) REQUIRES(mStateLock) {
919 if (const auto token = getPhysicalDisplayTokenLocked(id)) {
920 return getDisplayDeviceLocked(token);
921 }
922 return nullptr;
923 }
924
Dominik Laskowski3c363242022-04-07 10:44:12 -0700925 sp<const DisplayDevice> getDisplayDeviceLocked(DisplayId id) const REQUIRES(mStateLock) {
926 // TODO(b/182939859): Replace tokens with IDs for display lookup.
927 return findDisplay([id](const auto& display) { return display.getId() == id; });
928 }
929
Dominik Laskowskiec0eac22023-01-28 16:16:19 -0500930 std::shared_ptr<compositionengine::Display> getCompositionDisplayLocked(DisplayId id) const
931 REQUIRES(mStateLock) {
932 if (const auto display = getDisplayDeviceLocked(id)) {
933 return display->getCompositionDisplay();
934 }
935 return nullptr;
936 }
937
Dominik Laskowskia0858db2024-07-23 16:45:11 -0400938 // Returns the primary display or (for foldables) the active display.
Dominik Laskowski0a1435d2020-04-21 00:27:31 -0700939 sp<const DisplayDevice> getDefaultDisplayDeviceLocked() const REQUIRES(mStateLock) {
Dominik Laskowskieecd6592018-05-29 10:25:41 -0700940 return const_cast<SurfaceFlinger*>(this)->getDefaultDisplayDeviceLocked();
Stephen Kiazyk7d3dcb92017-04-05 16:46:49 -0700941 }
942
Dominik Laskowski0a1435d2020-04-21 00:27:31 -0700943 sp<DisplayDevice> getDefaultDisplayDeviceLocked() REQUIRES(mStateLock) {
Dominik Laskowskie591b552022-09-09 10:44:56 -0700944 return getDisplayDeviceLocked(mActiveDisplayId);
Michael Wright28f24d02016-07-12 13:30:53 -0700945 }
946
Ady Abraham3efa3942021-06-24 19:01:25 -0700947 sp<const DisplayDevice> getDefaultDisplayDevice() const EXCLUDES(mStateLock) {
Dominik Laskowski0a1435d2020-04-21 00:27:31 -0700948 Mutex::Autolock lock(mStateLock);
949 return getDefaultDisplayDeviceLocked();
950 }
Marin Shalamanovf5de90d2019-10-08 10:57:25 +0200951
Dominik Laskowski6e465152022-09-28 11:00:25 -0400952 using DisplayDeviceAndSnapshot = std::pair<sp<DisplayDevice>, display::DisplaySnapshotRef>;
Dominik Laskowskib363c4c2022-08-02 14:03:41 -0700953
954 // Combinator for ftl::Optional<PhysicalDisplay>::and_then.
955 auto getDisplayDeviceAndSnapshot() REQUIRES(mStateLock) {
956 return [this](const display::PhysicalDisplay& display) REQUIRES(
957 mStateLock) -> ftl::Optional<DisplayDeviceAndSnapshot> {
958 if (auto device = getDisplayDeviceLocked(display.snapshot().displayId())) {
959 return std::make_pair(std::move(device), display.snapshotRef());
960 }
961
962 return {};
963 };
964 }
965
Dominik Laskowski7b9bf4c2021-03-18 12:21:29 -0700966 // Returns the first display that matches a `bool(const DisplayDevice&)` predicate.
967 template <typename Predicate>
968 sp<DisplayDevice> findDisplay(Predicate p) const REQUIRES(mStateLock) {
969 const auto it = std::find_if(mDisplays.begin(), mDisplays.end(),
Dominik Laskowski3de67272023-08-09 13:15:31 -0400970 [&](const auto& pair)
971 REQUIRES(mStateLock) { return p(*pair.second); });
Dominik Laskowski7b9bf4c2021-03-18 12:21:29 -0700972
973 return it == mDisplays.end() ? nullptr : it->second;
974 }
975
Ady Abrahamed3290f2021-05-17 15:12:14 -0700976 std::vector<PhysicalDisplayId> getPhysicalDisplayIdsLocked() const REQUIRES(mStateLock);
977
Mathias Agopian87baae12012-07-31 12:38:26 -0700978 // mark a region of a layer stack dirty. this updates the dirty
979 // region of all screens presenting this layer stack.
Vishnu Nair3af0ec02023-02-10 04:13:48 +0000980 void invalidateLayerStack(const ui::LayerFilter& layerFilter, const Region& dirty);
Mathias Agopian87baae12012-07-31 12:38:26 -0700981
Dominik Laskowskib363c4c2022-08-02 14:03:41 -0700982 ui::LayerFilter makeLayerFilterForDisplay(DisplayId displayId, ui::LayerStack layerStack)
983 REQUIRES(mStateLock) {
984 return {layerStack,
985 PhysicalDisplayId::tryCast(displayId)
986 .and_then(display::getPhysicalDisplay(mPhysicalDisplays))
987 .transform(&display::PhysicalDisplay::isInternal)
988 .value_or(false)};
Ady Abrahamed3290f2021-05-17 15:12:14 -0700989 }
990
Peiyong Linf243e5e2020-08-22 17:40:59 -0700991 /*
Mathias Agopian86303202012-07-24 22:46:10 -0700992 * H/W composer
993 */
Marin Shalamanov6e840172020-12-14 22:13:28 +0100994 // The following thread safety rules apply when accessing HWComposer:
995 // 1. When reading display state from HWComposer on the main thread, it's not necessary to
996 // acquire mStateLock.
997 // 2. When accessing HWComposer on a thread other than the main thread, we always
Lloyd Pique441d5042018-10-18 16:49:51 -0700998 // need to acquire mStateLock. This is because the main thread could be
Marin Shalamanov6e840172020-12-14 22:13:28 +0100999 // in the process of writing display state, e.g. creating or destroying a display.
Lloyd Pique441d5042018-10-18 16:49:51 -07001000 HWComposer& getHwComposer() const;
Mathias Agopian86303202012-07-24 22:46:10 -07001001
Peiyong Linf243e5e2020-08-22 17:40:59 -07001002 /*
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001003 * Compositing
1004 */
Leon Scroggins III5b581492023-10-31 14:29:41 -04001005 void onCompositionPresented(PhysicalDisplayId pacesetterId, const scheduler::FrameTargeters&,
1006 nsecs_t presentStartTime) REQUIRES(kMainThreadContext);
Mathias Agopian4da75192010-08-10 17:19:56 -07001007
Peiyong Linf243e5e2020-08-22 17:40:59 -07001008 /*
Jamie Gennis0bceb842012-08-23 20:19:38 -07001009 * Display management
1010 */
Dominik Laskowskib0054a22022-03-03 09:03:06 -08001011 std::pair<DisplayModes, DisplayModePtr> loadDisplayModes(PhysicalDisplayId) const
1012 REQUIRES(mStateLock);
1013
Dominik Laskowskif11728a2022-07-28 13:07:42 -07001014 // TODO(b/241285876): Move to DisplayConfigurator.
1015 //
1016 // Returns whether displays have been added/changed/removed, i.e. whether ICompositor should
1017 // commit display transactions.
1018 bool configureLocked() REQUIRES(mStateLock) REQUIRES(kMainThreadContext)
1019 EXCLUDES(mHotplugMutex);
1020
Dominik Laskowski6e465152022-09-28 11:00:25 -04001021 // Returns the active mode ID, or nullopt on hotplug failure.
1022 std::optional<DisplayModeId> processHotplugConnect(PhysicalDisplayId, hal::HWDisplayId,
1023 DisplayIdentificationInfo&&,
1024 const char* displayString)
1025 REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowskibb8267b2024-04-26 16:23:07 -04001026 void processHotplugDisconnect(PhysicalDisplayId, const char* displayString)
1027 REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowskibb66e632022-08-17 08:00:25 -07001028
Lloyd Pique542307f2018-10-19 13:24:08 -07001029 sp<DisplayDevice> setupNewDisplayDeviceInternal(
Lloyd Pique9370a482019-10-03 17:58:30 -07001030 const wp<IBinder>& displayToken,
1031 std::shared_ptr<compositionengine::Display> compositionDisplay,
Lloyd Pique542307f2018-10-19 13:24:08 -07001032 const DisplayDeviceState& state,
Marin Shalamanovae685592020-02-12 17:12:22 +01001033 const sp<compositionengine::DisplaySurface>& displaySurface,
Dominik Laskowski0a1435d2020-04-21 00:27:31 -07001034 const sp<IGraphicBufferProducer>& producer) REQUIRES(mStateLock);
Dominik Laskowskif8734e02022-08-26 09:06:59 -07001035 void processDisplayChangesLocked() REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowski596a2562022-10-28 11:26:12 -04001036 void processDisplayRemoved(const wp<IBinder>& displayToken)
1037 REQUIRES(mStateLock, kMainThreadContext);
Marin Shalamanovae685592020-02-12 17:12:22 +01001038 void processDisplayChanged(const wp<IBinder>& displayToken,
1039 const DisplayDeviceState& currentState,
Dominik Laskowskif8734e02022-08-26 09:06:59 -07001040 const DisplayDeviceState& drawingState)
1041 REQUIRES(mStateLock, kMainThreadContext);
Mathias Agopian3ee454a2012-08-27 16:28:24 -07001042
Peiyong Linf243e5e2020-08-22 17:40:59 -07001043 /*
Dominik Laskowskic2867142019-01-21 11:33:38 -08001044 * Display identification
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001045 */
Dominik Laskowskib363c4c2022-08-02 14:03:41 -07001046 sp<display::DisplayToken> getPhysicalDisplayTokenLocked(PhysicalDisplayId displayId) const
Marin Shalamanova524a092020-07-27 21:39:55 +02001047 REQUIRES(mStateLock) {
Dominik Laskowskib363c4c2022-08-02 14:03:41 -07001048 return mPhysicalDisplays.get(displayId)
1049 .transform([](const display::PhysicalDisplay& display) { return display.token(); })
Dominik Laskowski80872bd2022-11-15 11:34:33 -05001050 .or_else([] { return std::optional<sp<display::DisplayToken>>(nullptr); })
1051 .value();
Dominik Laskowski075d3172018-05-24 15:50:06 -07001052 }
1053
Marin Shalamanov0f10d0d2020-08-06 20:04:06 +02001054 std::optional<PhysicalDisplayId> getPhysicalDisplayIdLocked(
Dominik Laskowskib363c4c2022-08-02 14:03:41 -07001055 const sp<display::DisplayToken>&) const REQUIRES(mStateLock);
Dominik Laskowski075d3172018-05-24 15:50:06 -07001056
Dominik Laskowski3c363242022-04-07 10:44:12 -07001057 // Returns the first display connected at boot.
Dominik Laskowskif8db0f02021-04-19 11:05:25 -07001058 //
Dominik Laskowski3c363242022-04-07 10:44:12 -07001059 // TODO(b/229851933): SF conflates the primary display with the first display connected at boot,
1060 // which typically has DisplayConnectionType::Internal. (Theoretically, it must be an internal
1061 // display because SF does not support disconnecting it, though in practice HWC may circumvent
1062 // this limitation.)
1063 sp<IBinder> getPrimaryDisplayTokenLocked() const REQUIRES(mStateLock) {
1064 return getPhysicalDisplayTokenLocked(getPrimaryDisplayIdLocked());
Dominik Laskowski075d3172018-05-24 15:50:06 -07001065 }
1066
Dominik Laskowski3c363242022-04-07 10:44:12 -07001067 PhysicalDisplayId getPrimaryDisplayIdLocked() const REQUIRES(mStateLock) {
Dominik Laskowskif8db0f02021-04-19 11:05:25 -07001068 return getHwComposer().getPrimaryDisplayId();
Dominik Laskowski075d3172018-05-24 15:50:06 -07001069 }
1070
Dominik Laskowski3dce4f42021-03-08 20:48:28 -08001071 // Toggles use of HAL/GPU virtual displays.
1072 void enableHalVirtualDisplays(bool);
1073
1074 // Virtual display lifecycle for ID generation and HAL allocation.
Dominik Laskowski263eec42021-07-21 23:13:24 -07001075 VirtualDisplayId acquireVirtualDisplay(ui::Size, ui::PixelFormat) REQUIRES(mStateLock);
Dominik Laskowski3dce4f42021-03-08 20:48:28 -08001076 void releaseVirtualDisplay(VirtualDisplayId);
1077
Dominik Laskowski3de67272023-08-09 13:15:31 -04001078 // Returns a display other than `mActiveDisplayId` that can be activated, if any.
1079 sp<DisplayDevice> getActivatableDisplay() const REQUIRES(mStateLock, kMainThreadContext);
1080
Dominik Laskowski39dfc942023-02-08 16:27:05 -05001081 void onActiveDisplayChangedLocked(const DisplayDevice* inactiveDisplayPtr,
1082 const DisplayDevice& activeDisplay)
Dominik Laskowskif8734e02022-08-26 09:06:59 -07001083 REQUIRES(mStateLock, kMainThreadContext);
Ady Abrahamed3290f2021-05-17 15:12:14 -07001084
Dominik Laskowski39dfc942023-02-08 16:27:05 -05001085 void onActiveDisplaySizeChanged(const DisplayDevice&);
Ady Abrahamed3290f2021-05-17 15:12:14 -07001086
Dominik Laskowskic2867142019-01-21 11:33:38 -08001087 /*
1088 * Debugging & dumpsys
1089 */
Vishnu Naird7ff85f2023-12-08 09:51:31 -08001090 void dumpAll(const DumpArgs& args, const std::string& compositionLayers,
1091 std::string& result) const EXCLUDES(mStateLock);
Vishnu Nair3cc15a42023-06-30 06:20:22 +00001092 void dumpHwcLayersMinidump(std::string& result) const REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowskic2867142019-01-21 11:33:38 -08001093
1094 void appendSfConfigString(std::string& result) const;
Vishnu Nair7be27602024-03-28 20:27:09 -07001095 void listLayers(std::string& result) const REQUIRES(kMainThreadContext);
1096 void dumpStats(const DumpArgs& args, std::string& result) const
1097 REQUIRES(mStateLock, kMainThreadContext);
1098 void clearStats(const DumpArgs& args, std::string& result) REQUIRES(kMainThreadContext);
Dominik Laskowskic2867142019-01-21 11:33:38 -08001099 void dumpTimeStats(const DumpArgs& args, bool asProto, std::string& result) const;
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -07001100 void dumpFrameTimeline(const DumpArgs& args, std::string& result) const;
Dominik Laskowski8792c112022-07-12 09:03:39 -07001101 void logFrameStats(TimePoint now) REQUIRES(kMainThreadContext);
Jamie Gennis6547ff42013-07-16 20:12:42 -07001102
Dominik Laskowski03cfce82022-11-02 12:13:29 -04001103 void dumpScheduler(std::string& result) const REQUIRES(mStateLock);
1104 void dumpEvents(std::string& result) const REQUIRES(mStateLock);
1105 void dumpVsync(std::string& result) const REQUIRES(mStateLock);
Dominik Laskowski0acc3842022-04-07 11:23:42 -07001106
1107 void dumpCompositionDisplays(std::string& result) const REQUIRES(mStateLock);
1108 void dumpDisplays(std::string& result) const REQUIRES(mStateLock);
Dominik Laskowski0a1435d2020-04-21 00:27:31 -07001109 void dumpDisplayIdentificationData(std::string& result) const REQUIRES(mStateLock);
Dominik Laskowskib6e54372019-09-04 14:06:28 -07001110 void dumpRawDisplayIdentificationData(const DumpArgs&, std::string& result) const;
Dominik Laskowski0a1435d2020-04-21 00:27:31 -07001111 void dumpWideColorInfo(std::string& result) const REQUIRES(mStateLock);
John Reck2a3d29d2023-08-17 17:45:01 -04001112 void dumpHdrInfo(std::string& result) const REQUIRES(mStateLock);
Vishnu Naird7ff85f2023-12-08 09:51:31 -08001113 void dumpFrontEnd(std::string& result) REQUIRES(kMainThreadContext);
1114 void dumpVisibleFrontEnd(std::string& result) REQUIRES(mStateLock, kMainThreadContext);
Dominik Laskowski0acc3842022-04-07 11:23:42 -07001115
Vishnu Nair7be27602024-03-28 20:27:09 -07001116 perfetto::protos::LayersProto dumpDrawingStateProto(uint32_t traceFlags) const
1117 REQUIRES(kMainThreadContext);
Kean Mariotti4ba343c2023-04-19 13:31:02 +00001118 google::protobuf::RepeatedPtrField<perfetto::protos::DisplayProto> dumpDisplayProto() const;
Kean Mariotti639b54f2023-04-20 12:06:29 +00001119 void doActiveLayersTracingIfNeeded(bool isCompositionComputed, bool visibleRegionDirty,
1120 TimePoint, VsyncId) REQUIRES(kMainThreadContext);
1121 perfetto::protos::LayersSnapshotProto takeLayersSnapshotProto(uint32_t flags, TimePoint,
1122 VsyncId, bool visibleRegionDirty)
Vishnu Nair81750622023-03-08 15:02:06 -08001123 REQUIRES(kMainThreadContext);
chaviw0a398992021-08-13 10:13:01 -05001124
Alec Mouri6b9e9912020-01-21 10:50:24 -08001125 // Dumps state from HW Composer
1126 void dumpHwc(std::string& result) const;
Kean Mariotti4ba343c2023-04-19 13:31:02 +00001127 perfetto::protos::LayersProto dumpProtoFromMainThread(
1128 uint32_t traceFlags = LayerTracing::TRACE_ALL) EXCLUDES(mStateLock);
Dan Stoza269dc4d2021-01-15 15:07:43 -08001129 void dumpPlannerInfo(const DumpArgs& args, std::string& result) const REQUIRES(mStateLock);
Dan Stozae77c7662016-05-13 11:37:28 -07001130
Dominik Laskowskic2867142019-01-21 11:33:38 -08001131 status_t doDump(int fd, const DumpArgs& args, bool asProto);
1132
Nataniel Borges8e7dc722019-02-28 15:10:28 -08001133 status_t dumpCritical(int fd, const DumpArgs&, bool asProto);
Dominik Laskowskic2867142019-01-21 11:33:38 -08001134
1135 status_t dumpAll(int fd, const DumpArgs& args, bool asProto) override {
1136 return doDump(fd, args, asProto);
1137 }
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -08001138
chaviw17ac24b2021-01-28 18:50:05 -08001139 static mat4 calculateColorMatrix(float saturation);
1140
Chia-I Wu28f320b2018-05-03 11:02:56 -07001141 void updateColorMatrixLocked();
1142
Peiyong Linf243e5e2020-08-22 17:40:59 -07001143 // Verify that transaction is being called by an approved process:
1144 // either AID_GRAPHICS or AID_SYSTEM.
1145 status_t CheckTransactCodeCredentials(uint32_t code);
1146
Ady Abrahame46243a2021-02-23 19:33:49 -08001147 // Add transaction to the Transaction Queue
Ady Abrahame46243a2021-02-23 19:33:49 -08001148
Peiyong Linf243e5e2020-08-22 17:40:59 -07001149 /*
1150 * Generic Layer Metadata
1151 */
1152 const std::unordered_map<std::string, uint32_t>& getGenericLayerMetadataKeyMap() const;
1153
Lloyd Pique30db6402023-06-26 18:56:51 +00001154 static int calculateMaxAcquiredBufferCount(Fps refreshRate,
1155 std::chrono::nanoseconds presentLatency);
Ady Abraham899dcdb2021-06-15 16:56:21 -07001156 int getMaxAcquiredBufferCountForRefreshRate(Fps refreshRate) const;
Ady Abraham564f9de2021-02-03 18:34:33 -08001157
Vishnu Nair7aa0eb72023-01-24 03:59:27 +00001158 bool isHdrLayer(const frontend::LayerSnapshot& snapshot) const;
John Reck49d9ad32022-02-23 19:03:31 -05001159
ramindani06e518e2022-03-14 18:47:53 +00001160 ui::Rotation getPhysicalDisplayOrientation(DisplayId, bool isPrimary) const
1161 REQUIRES(mStateLock);
Vishnu Nair7be27602024-03-28 20:27:09 -07001162 void traverseLegacyLayers(const LayerVector::Visitor& visitor) const
1163 REQUIRES(kMainThreadContext);
Dominik Laskowskiefb131e2024-02-16 10:57:40 -05001164
1165 void initBootProperties();
Vishnu Nair8c5b7002023-08-17 21:03:57 -07001166 void initTransactionTraceWriter();
Dominik Laskowskiefb131e2024-02-16 10:57:40 -05001167
Lloyd Pique30db6402023-06-26 18:56:51 +00001168 surfaceflinger::Factory& mFactory;
1169 pid_t mPid;
Dominik Laskowskiefb131e2024-02-16 10:57:40 -05001170
1171 // TODO: b/328459745 - Encapsulate in a SystemProperties object.
Dominik Laskowskid4a22752024-03-08 17:39:04 -05001172 utils::OnceFuture mInitBootPropsFuture;
Dominik Laskowskiefb131e2024-02-16 10:57:40 -05001173
Dominik Laskowskid4a22752024-03-08 17:39:04 -05001174 utils::OnceFuture mRenderEnginePrimeCacheFuture;
Ady Abrahamfe2a6db2021-06-09 15:41:37 -07001175
Leon Scroggins III67388622023-02-06 20:36:20 -05001176 // mStateLock has conventions related to the current thread, because only
1177 // the main thread should modify variables protected by mStateLock.
1178 // - read access from a non-main thread must lock mStateLock, since the main
1179 // thread may modify these variables.
1180 // - write access from a non-main thread is not permitted.
1181 // - read access from the main thread can use an ftl::FakeGuard, since other
1182 // threads must not modify these variables.
1183 // - write access from the main thread must lock mStateLock, since another
1184 // thread may be reading these variables.
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001185 mutable Mutex mStateLock;
Dan Stoza412903f2017-04-27 13:42:17 -07001186 State mCurrentState{LayerVector::StateSet::Current};
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001187 std::atomic<int32_t> mTransactionFlags = 0;
Vishnu Nair7891e962021-11-11 12:07:21 -08001188 std::atomic<uint32_t> mUniqueTransactionId = 1;
Dan Stoza101d8dc2018-02-27 15:42:25 -08001189
Brian Lindahl439afad2022-11-14 11:16:55 -07001190 // Buffers that have been discarded by clients and need to be evicted from per-layer caches so
1191 // the graphics memory can be immediately freed.
1192 std::vector<uint64_t> mBufferIdsToUncache;
1193
Chia-I Wu28f320b2018-05-03 11:02:56 -07001194 // global color transform states
1195 Daltonizer mDaltonizer;
1196 float mGlobalSaturationFactor = 1.0f;
1197 mat4 mClientColorMatrix;
1198
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001199 // protected by mStateLock (but we could use another lock)
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001200 bool mLayersRemoved = false;
1201 bool mLayersAdded = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -07001202
Dominik Laskowskie0e0cde2021-07-30 10:42:05 -07001203 std::atomic_bool mMustComposite = false;
Dominik Laskowski8da6b0e2021-05-12 15:34:13 -07001204 std::atomic_bool mGeometryDirty = false;
Mathias Agopianca4d3602011-05-19 15:38:14 -07001205
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -08001206 // constant members (no synchronization needed for access)
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001207 const nsecs_t mBootTime = systemTime();
Lloyd Pique30db6402023-06-26 18:56:51 +00001208 bool mIsUserBuild = true;
Dominik Laskowskie62606d2024-02-22 11:42:13 -05001209 bool mHasReliablePresentFences = false;
Mathias Agopian3094df32012-06-18 18:06:45 -07001210
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001211 // Can only accessed from the main thread, these members
1212 // don't need synchronization
Dan Stoza412903f2017-04-27 13:42:17 -07001213 State mDrawingState{LayerVector::StateSet::Drawing};
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001214 bool mVisibleRegionsDirty = false;
Robert Carre450fb52021-06-11 13:21:09 -07001215
John Reck68796592023-01-25 13:47:12 -05001216 bool mHdrLayerInfoChanged = false;
1217
Alec Mourid05a7452024-09-20 13:44:02 +00001218 struct LayerEvent {
1219 uid_t uid;
1220 int32_t layerId;
1221 ui::Dataspace dataspace;
1222 std::chrono::milliseconds timeSinceLastEvent;
1223 };
1224 std::vector<LayerEvent> mLayerEvents;
1225
Robert Carr167bdde2021-07-28 11:26:51 -07001226 // Used to ensure we omit a callback when HDR layer info listener is newly added but the
1227 // scene hasn't changed
1228 bool mAddingHDRLayerInfoListener = false;
Lloyd Pique30db6402023-06-26 18:56:51 +00001229 bool mIgnoreHdrCameraLayers = false;
Robert Carr167bdde2021-07-28 11:26:51 -07001230
Robert Carre450fb52021-06-11 13:21:09 -07001231 // Set during transaction application stage to track if the input info or children
1232 // for a layer has changed.
1233 // TODO: Also move visibleRegions over to a boolean system.
Arthur Hung9ed43392022-05-27 06:31:57 +00001234 bool mUpdateInputInfo = false;
Robert Carre450fb52021-06-11 13:21:09 -07001235 bool mSomeChildrenChanged;
Ady Abraham822ecbd2023-07-07 16:16:09 -07001236 bool mUpdateAttachedChoreographer = false;
Robert Carre450fb52021-06-11 13:21:09 -07001237
Vishnu Nair39a74a92024-07-29 19:01:50 +00001238 struct LayerIntHash {
1239 size_t operator()(const std::pair<sp<Layer>, gui::GameMode>& k) const {
1240 return std::hash<Layer*>()(k.first.get()) ^
1241 std::hash<int32_t>()(static_cast<int32_t>(k.second));
1242 }
1243 };
1244
Vishnu Nair3af0ec02023-02-10 04:13:48 +00001245 // TODO(b/238781169) validate these on composition
Alec Mouri5c9c9602020-09-01 15:10:40 -07001246 // Tracks layers that have pending frames which are candidates for being
Alec Mouri2f7d9ae2020-11-30 19:32:33 -08001247 // latched.
Vishnu Nair39a74a92024-07-29 19:01:50 +00001248 std::unordered_set<std::pair<sp<Layer>, gui::GameMode>, LayerIntHash> mLayersWithQueuedFrames;
Vishnu Nair7ee4f462023-04-19 09:54:09 -07001249 std::unordered_set<sp<Layer>, SpHash<Layer>> mLayersWithBuffersRemoved;
Vishnu Nair6f209e22023-08-04 16:33:23 +00001250 std::unordered_set<uint32_t> mLayersIdsWithQueuedFrames;
1251
Vishnu Nair802ac4f2023-05-10 13:55:22 -07001252 // Sorted list of layers that were composed during previous frame. This is used to
1253 // avoid an expensive traversal of the layer hierarchy when there are no
1254 // visible region changes. Because this is a list of strong pointers, this will
1255 // extend the life of the layer but this list is only updated in the main thread.
1256 std::vector<sp<Layer>> mPreviouslyComposedLayers;
Dominik Laskowski5d164f22022-07-07 07:56:07 -07001257
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001258 BootStage mBootStage = BootStage::BOOTLOADER;
Chia-I Wu14c9c7b2018-06-26 10:18:18 +08001259
Dominik Laskowskif11728a2022-07-28 13:07:42 -07001260 struct HotplugEvent {
1261 hal::HWDisplayId hwcDisplayId;
1262 hal::Connection connection = hal::Connection::INVALID;
1263 };
1264
Huihong Luo9ebb7a72023-06-27 17:01:50 -07001265 bool mIsHdcpViaNegVsync = false;
Huihong Luoaac3a772023-09-19 20:51:59 -07001266
Dominik Laskowskif11728a2022-07-28 13:07:42 -07001267 std::mutex mHotplugMutex;
1268 std::vector<HotplugEvent> mPendingHotplugEvents GUARDED_BY(mHotplugMutex);
Lloyd Piqueba04e622017-12-14 17:11:26 -08001269
Dominik Laskowskieb627312022-04-07 09:13:16 -07001270 // Displays are composited in `mDisplays` order. Internal displays are inserted at boot and
1271 // never removed, so take precedence over external and virtual displays.
1272 //
Dominik Laskowskieb627312022-04-07 09:13:16 -07001273 // May be read from any thread, but must only be written from the main thread.
Dominik Laskowski6b049ff2023-01-29 15:46:45 -05001274 ui::DisplayMap<wp<IBinder>, const sp<DisplayDevice>> mDisplays GUARDED_BY(mStateLock);
Dominik Laskowskib363c4c2022-08-02 14:03:41 -07001275
1276 display::PhysicalDisplays mPhysicalDisplays GUARDED_BY(mStateLock);
Mathias Agopian921e6ac2012-07-23 23:11:29 -07001277
Dominik Laskowskia0858db2024-07-23 16:45:11 -04001278 // The inner or outer display for foldables, while unfolded or folded, respectively.
Dominik Laskowski5c989f52024-04-11 13:57:14 -04001279 std::atomic<PhysicalDisplayId> mActiveDisplayId;
Dominik Laskowskie591b552022-09-09 10:44:56 -07001280
Dominik Laskowski6e465152022-09-28 11:00:25 -04001281 display::DisplayModeController mDisplayModeController;
1282
Dominik Laskowski3dce4f42021-03-08 20:48:28 -08001283 struct {
1284 DisplayIdGenerator<GpuVirtualDisplayId> gpu;
1285 std::optional<DisplayIdGenerator<HalVirtualDisplayId>> hal;
1286 } mVirtualDisplayIdGenerators;
Marin Shalamanov0f10d0d2020-08-06 20:04:06 +02001287
Dominik Laskowski8da6b0e2021-05-12 15:34:13 -07001288 std::atomic_uint mDebugFlashDelay = 0;
1289 std::atomic_bool mDebugDisableHWC = false;
1290 std::atomic_bool mDebugDisableTransformHint = false;
1291 std::atomic<nsecs_t> mDebugInTransaction = 0;
1292 std::atomic_bool mForceFullDamage = false;
1293
Lloyd Pique30db6402023-06-26 18:56:51 +00001294 bool mLayerCachingEnabled = false;
1295 bool mBackpressureGpuComposition = false;
1296
Vishnu Nair81750622023-03-08 15:02:06 -08001297 LayerTracing mLayerTracing;
Dominik Laskowski46471e62022-01-14 15:34:03 -08001298 std::optional<TransactionTracing> mTransactionTracing;
Dominik Laskowski542c9dc2020-04-10 12:42:02 -07001299
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001300 const std::shared_ptr<TimeStats> mTimeStats;
Mikael Pessa90092f42019-08-26 17:22:04 -07001301 const std::unique_ptr<FrameTracer> mFrameTracer;
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -07001302 const std::unique_ptr<frametimeline::FrameTimeline> mFrameTimeline;
Dominik Laskowski3dce4f42021-03-08 20:48:28 -08001303
Dominik Laskowski08fbd852022-07-14 08:53:42 -07001304 VsyncId mLastCommittedVsyncId;
Pablo Gamito6be82442022-06-13 11:04:34 +00001305
Lloyd Pique30db6402023-06-26 18:56:51 +00001306 // If blurs should be enabled on this device.
1307 bool mSupportsBlur = false;
1308
Robert Carr9a803c32021-01-14 16:57:58 -08001309 TransactionCallbackInvoker mTransactionCallbackInvoker;
Marissa Walle2ffb422018-10-12 11:33:52 -07001310
chaviweadf0d42019-08-12 13:28:29 -07001311 std::atomic<size_t> mNumLayers = 0;
Robert Carr1f0a16a2016-10-24 16:27:39 -07001312
Steven Morelanda904bb92019-07-02 17:37:23 -07001313 // to linkToDeath
1314 sp<IBinder> mWindowManager;
Rob Carr2aa78cb2020-03-10 14:27:49 -07001315 // We want to avoid multiple calls to BOOT_FINISHED as they come in on
1316 // different threads without a lock and could trigger unsynchronized writes to
1317 // to mWindowManager or mInputFlinger
1318 std::atomic<bool> mBootFinished = false;
Steven Morelanda904bb92019-07-02 17:37:23 -07001319
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001320 std::thread::id mMainThreadId = std::this_thread::get_id();
Romain Guy0147a172017-06-01 13:53:56 -07001321
Lloyd Pique6a3b4462019-03-07 20:58:12 -08001322 DisplayColorSetting mDisplayColorSetting = DisplayColorSetting::kEnhanced;
David Sodman105b7dc2017-11-04 20:28:14 -07001323
Peiyong Lina3ea5592019-02-10 14:45:00 -08001324 // Color mode forced by setting persist.sys.sf.color_mode, it must:
1325 // 1. not be NATIVE color mode, NATIVE color mode means no forced color mode;
1326 // 2. be one of the supported color modes returned by hardware composer, otherwise
1327 // it will not be respected.
1328 // persist.sys.sf.color_mode will only take effect when persist.sys.sf.native_mode
1329 // is not set to 1.
1330 // This property can be used to force SurfaceFlinger to always pick a certain color mode.
1331 ui::ColorMode mForceColorMode = ui::ColorMode::NATIVE;
1332
Lloyd Pique30db6402023-06-26 18:56:51 +00001333 // Whether to enable wide color gamut (e.g. Display P3) for internal displays that support it.
1334 // If false, wide color modes are filtered out for all internal displays.
1335 bool mSupportsWideColor = false;
Dominik Laskowski788945b2022-08-30 12:10:56 -07001336
Lloyd Pique30db6402023-06-26 18:56:51 +00001337 ui::Dataspace mDefaultCompositionDataspace;
1338 ui::Dataspace mWideColorGamutCompositionDataspace;
Peiyong Lin9d846a52018-11-05 13:18:20 -08001339
Patrick Williams0a525a42022-10-26 20:20:50 +00001340 std::unique_ptr<renderengine::RenderEngine> mRenderEngine;
Chavi Weingarten076acac2023-01-19 17:20:43 +00001341 std::atomic<int> mNumTrustedPresentationListeners = 0;
1342
Lloyd Pique70d91362018-10-18 16:02:55 -07001343 std::unique_ptr<compositionengine::CompositionEngine> mCompositionEngine;
Dominik Laskowski63f12792023-01-21 16:58:22 -05001344
Dominik Laskowskiec0eac22023-01-28 16:16:19 -05001345 CompositionCoveragePerDisplay mCompositionCoverage;
Dominik Laskowski63f12792023-01-21 16:58:22 -05001346
Garfield Tan9c9c1912021-07-19 12:02:16 -07001347 // mMaxRenderTargetSize is only set once in init() so it doesn't need to be protected by
1348 // any mutex.
1349 size_t mMaxRenderTargetSize{1};
Ana Krulec98b5b242018-08-10 15:03:23 -07001350
Lloyd Pique30db6402023-06-26 18:56:51 +00001351 const std::string mHwcServiceName;
1352
Dominik Laskowski068173d2021-08-11 17:22:59 -07001353 std::unique_ptr<scheduler::Scheduler> mScheduler;
Robert Carr720e5062018-07-30 17:45:14 -07001354
Dominik Laskowski80c77272022-07-08 12:47:29 -07001355 scheduler::PresentLatencyTracker mPresentLatencyTracker GUARDED_BY(kMainThreadContext);
Ady Abraham1902d072019-03-01 17:18:59 -08001356
Lloyd Pique30db6402023-06-26 18:56:51 +00001357 bool mLumaSampling = true;
Kevin DuBois413287f2019-02-25 08:46:47 -08001358 sp<RegionSamplingThread> mRegionSamplingThread;
Alec Mouriadebf5c2021-01-05 12:57:36 -08001359 sp<FpsReporter> mFpsReporter;
Galia Peycheva8f04b302021-04-27 13:25:38 +02001360 sp<TunnelModeEnabledReporter> mTunnelModeEnabledReporter;
Lloyd Pique30db6402023-06-26 18:56:51 +00001361 ui::DisplayPrimaries mInternalDisplayPrimaries;
1362
1363 const float mEmulatedDisplayDensity;
1364 const float mInternalDisplayDensity;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -08001365
Vishnu Nairfa5f8df2019-02-13 17:02:51 -08001366 // Should only be accessed by the main thread.
Vishnu Nair03ccbd62021-12-01 17:21:16 -08001367 sp<os::IInputFlinger> mInputFlinger;
chaviw273171b2018-12-26 11:46:30 -08001368 InputWindowCommands mInputWindowCommands;
chaviw291d88a2019-02-14 10:33:58 -08001369
Xiang Wang839fe5b2022-04-04 17:39:38 +00001370 std::unique_ptr<Hwc2::PowerAdvisor> mPowerAdvisor;
Ady Abraham03b02dd2019-03-21 15:40:11 -07001371
Dominik Laskowski02bb2072022-08-26 15:02:52 -07001372 void enableRefreshRateOverlay(bool enable) REQUIRES(mStateLock, kMainThreadContext);
Ady Abraham34392f72019-04-10 11:29:27 -07001373
Sally Qi147581b2023-06-27 11:55:34 -07001374 void enableHdrSdrRatioOverlay(bool enable) REQUIRES(mStateLock, kMainThreadContext);
1375
Marin Shalamanova7fe3042021-01-29 21:02:08 +01001376 // Flag used to set override desired display mode from backdoor
1377 bool mDebugDisplayModeSetByBackdoor = false;
chaviw74d90ad2019-04-26 14:45:26 -07001378
Vishnu Nair8eda69e2021-02-26 10:42:10 -08001379 BufferCountTracker mBufferCountTracker;
John Reck88270902021-03-18 11:27:35 -04001380
1381 std::unordered_map<DisplayId, sp<HdrLayerInfoReporter>> mHdrLayerInfoListeners
1382 GUARDED_BY(mStateLock);
John Reck68796592023-01-25 13:47:12 -05001383
Ady Abraham1273ac12021-08-26 17:31:53 -07001384 std::atomic<ui::Transform::RotationFlags> mActiveDisplayTransformHint;
Ady Abraham562c2712021-05-07 15:10:42 -07001385
Leon Scroggins III85d4b222023-05-09 13:58:18 -04001386 // Must only be accessed on the main thread.
1387 // TODO (b/259407931): Remove.
1388 static ui::Transform::RotationFlags sActiveDisplayRotationFlags;
1389
Ady Abraham1b11bc62021-06-03 19:51:19 -07001390 bool isRefreshRateOverlayEnabled() const REQUIRES(mStateLock) {
Dominik Laskowskieb627312022-04-07 09:13:16 -07001391 return hasDisplay(
1392 [](const auto& display) { return display.isRefreshRateOverlayEnabled(); });
Ady Abraham1b11bc62021-06-03 19:51:19 -07001393 }
Sally Qi147581b2023-06-27 11:55:34 -07001394 bool isHdrSdrRatioOverlayEnabled() const REQUIRES(mStateLock) {
1395 return hasDisplay(
1396 [](const auto& display) { return display.isHdrSdrRatioOverlayEnabled(); });
1397 }
Vishnu Nair3af0ec02023-02-10 04:13:48 +00001398 std::function<std::vector<std::pair<Layer*, sp<LayerFE>>>()> getLayerSnapshotsForScreenshots(
Vishnu Nairc5a5b6e2023-02-28 00:19:07 +00001399 std::optional<ui::LayerStack> layerStack, uint32_t uid,
1400 std::function<bool(const frontend::LayerSnapshot&, bool& outStopTraversal)>
1401 snapshotFilterFn);
Vishnu Nair3af0ec02023-02-10 04:13:48 +00001402 std::function<std::vector<std::pair<Layer*, sp<LayerFE>>>()> getLayerSnapshotsForScreenshots(
Ajinkya Chalke02844632023-03-01 12:10:14 +00001403 std::optional<ui::LayerStack> layerStack, uint32_t uid,
1404 std::unordered_set<uint32_t> excludeLayerIds);
1405 std::function<std::vector<std::pair<Layer*, sp<LayerFE>>>()> getLayerSnapshotsForScreenshots(
Vishnu Nair3af0ec02023-02-10 04:13:48 +00001406 uint32_t rootLayerId, uint32_t uid, std::unordered_set<uint32_t> excludeLayerIds,
Vishnu Nair36d5f8e2023-03-19 13:31:35 -07001407 bool childrenOnly, const std::optional<FloatRect>& optionalParentCrop);
Ady Abraham1b11bc62021-06-03 19:51:19 -07001408
chaviw60c9d3e2021-06-04 12:52:17 -05001409 const sp<WindowInfosListenerInvoker> mWindowInfosListenerInvoker;
rnleea2ecd832021-07-29 13:58:30 -07001410
Nathaniel Nifong1303d912021-10-06 09:41:24 -04001411 // returns the framerate of the layer with the given sequence ID
1412 float getLayerFramerate(nsecs_t now, int32_t id) const {
1413 return mScheduler->getLayerFramerate(now, id);
1414 }
Matt Buckleyef51fba2021-10-12 19:30:12 +00001415
Matt Buckley50c44062022-01-17 20:48:10 +00001416 bool mPowerHintSessionEnabled;
Robert Horvathdce110a2022-09-16 11:08:47 +02001417 // Whether a display should be turned on when initialized
1418 bool mSkipPowerOnForQuiescent;
Lloyd Pique30db6402023-06-26 18:56:51 +00001419
Vishnu Nair7be27602024-03-28 20:27:09 -07001420 frontend::LayerLifecycleManager mLayerLifecycleManager GUARDED_BY(kMainThreadContext);
1421 frontend::LayerHierarchyBuilder mLayerHierarchyBuilder GUARDED_BY(kMainThreadContext);
1422 frontend::LayerSnapshotBuilder mLayerSnapshotBuilder GUARDED_BY(kMainThreadContext);
Vishnu Nair3af0ec02023-02-10 04:13:48 +00001423
Vishnu Naira12c5c72024-08-28 15:42:17 -07001424 mutable std::mutex mCreatedLayersLock;
1425 std::vector<sp<Layer>> mCreatedLayers GUARDED_BY(mCreatedLayersLock);
Vishnu Nair7be27602024-03-28 20:27:09 -07001426 std::vector<std::pair<uint32_t, std::string>> mDestroyedHandles GUARDED_BY(mCreatedLayersLock);
1427 std::vector<std::unique_ptr<frontend::RequestedLayerState>> mNewLayers
1428 GUARDED_BY(mCreatedLayersLock);
1429 std::vector<LayerCreationArgs> mNewLayerArgs GUARDED_BY(mCreatedLayersLock);
Vishnu Nair3af0ec02023-02-10 04:13:48 +00001430 // These classes do not store any client state but help with managing transaction callbacks
1431 // and stats.
Vishnu Nair7be27602024-03-28 20:27:09 -07001432 std::unordered_map<uint32_t, sp<Layer>> mLegacyLayers GUARDED_BY(kMainThreadContext);
Ady Abrahame9ebce02022-02-03 12:05:06 -08001433
Vishnu Nair7be27602024-03-28 20:27:09 -07001434 TransactionHandler mTransactionHandler GUARDED_BY(kMainThreadContext);
1435 ui::DisplayMap<ui::LayerStack, frontend::DisplayInfo> mFrontEndDisplayInfos
1436 GUARDED_BY(kMainThreadContext);
1437 bool mFrontEndDisplayInfosChanged GUARDED_BY(kMainThreadContext) = false;
Patrick Williams1caf3b72023-03-31 10:59:10 -05001438
Patrick Williamsd86bd8c2023-04-21 11:54:11 -05001439 // WindowInfo ids visible during the last commit.
Vishnu Nair7be27602024-03-28 20:27:09 -07001440 std::unordered_set<int32_t> mVisibleWindowIds GUARDED_BY(kMainThreadContext);
Brian Johnson51d8d5d2023-07-28 10:18:47 -07001441
1442 // Mirroring
1443 // Map of displayid to mirrorRoot
1444 ftl::SmallMap<int64_t, sp<SurfaceControl>, 3> mMirrorMapForDebug;
Carlos Martinez Romero5ec086e2023-02-14 00:44:36 +00001445
ramindanic67d22c2023-11-28 14:58:47 -08001446 // NotifyExpectedPresentHint
ramindaniae645822024-01-11 10:57:29 -08001447 enum class NotifyExpectedPresentHintStatus {
1448 // Represents that framework can start sending hint if required.
1449 Start,
1450 // Represents that the hint is already sent.
1451 Sent,
1452 // Represents that the hint will be scheduled with a new frame.
1453 ScheduleOnPresent,
1454 // Represents that a hint will be sent instantly by scheduling on the main thread.
1455 ScheduleOnTx
1456 };
ramindanic67d22c2023-11-28 14:58:47 -08001457 struct NotifyExpectedPresentData {
ramindaniae645822024-01-11 10:57:29 -08001458 TimePoint lastExpectedPresentTimestamp{};
ramindanic67d22c2023-11-28 14:58:47 -08001459 Fps lastFrameInterval{};
ramindaniae645822024-01-11 10:57:29 -08001460 // hintStatus is read and write from multiple threads such as
1461 // main thread, EventThread. And is atomic for that reason.
1462 std::atomic<NotifyExpectedPresentHintStatus> hintStatus =
1463 NotifyExpectedPresentHintStatus::Start;
ramindanic67d22c2023-11-28 14:58:47 -08001464 };
1465 std::unordered_map<PhysicalDisplayId, NotifyExpectedPresentData> mNotifyExpectedPresentMap;
ramindaniae645822024-01-11 10:57:29 -08001466 void sendNotifyExpectedPresentHint(PhysicalDisplayId displayId) override
1467 REQUIRES(kMainThreadContext);
ramindani32a88b12024-01-31 18:45:30 -08001468 void scheduleNotifyExpectedPresentHint(PhysicalDisplayId displayId,
1469 VsyncId vsyncId = VsyncId{
1470 FrameTimelineInfo::INVALID_VSYNC_ID});
ramindanic67d22c2023-11-28 14:58:47 -08001471 void notifyExpectedPresentIfRequired(PhysicalDisplayId, Period vsyncPeriod,
1472 TimePoint expectedPresentTime, Fps frameInterval,
1473 std::optional<Period> timeoutOpt);
1474
Carlos Martinez Romero5ec086e2023-02-14 00:44:36 +00001475 void sfdo_enableRefreshRateOverlay(bool active);
1476 void sfdo_setDebugFlash(int delay);
1477 void sfdo_scheduleComposite();
1478 void sfdo_scheduleCommit();
Carlos Martinez Romerob4ea9e62023-10-25 21:48:56 +00001479 void sfdo_forceClientComposition(bool enabled);
Huihong Luof5029222021-12-16 14:33:46 -08001480};
1481
1482class SurfaceComposerAIDL : public gui::BnSurfaceComposer {
1483public:
Alan Dingfc6eab52024-05-02 18:28:45 -07001484 explicit SurfaceComposerAIDL(sp<SurfaceFlinger> sf) : mFlinger(std::move(sf)) {}
Huihong Luof5029222021-12-16 14:33:46 -08001485
Huihong Luo1b0c49f2022-03-15 19:18:21 -07001486 binder::Status bootFinished() override;
1487 binder::Status createDisplayEventConnection(
1488 VsyncSource vsyncSource, EventRegistration eventRegistration,
Rachel Lee2248f522023-01-27 16:45:23 -08001489 const sp<IBinder>& layerHandle,
Huihong Luo1b0c49f2022-03-15 19:18:21 -07001490 sp<gui::IDisplayEventConnection>* outConnection) override;
Huihong Luod3d8f8e2022-03-08 14:48:46 -08001491 binder::Status createConnection(sp<gui::ISurfaceComposerClient>* outClient) override;
Alan Dingd53801c2024-05-08 16:45:29 -07001492 binder::Status createVirtualDisplay(const std::string& displayName, bool isSecure,
1493 const std::string& uniqueId, float requestedRefreshRate,
1494 sp<IBinder>* outDisplay) override;
1495 binder::Status destroyVirtualDisplay(const sp<IBinder>& displayToken) override;
Huihong Luo07e72362022-02-14 14:26:04 -08001496 binder::Status getPhysicalDisplayIds(std::vector<int64_t>* outDisplayIds) override;
Huihong Luo07e72362022-02-14 14:26:04 -08001497 binder::Status getPhysicalDisplayToken(int64_t displayId, sp<IBinder>* outDisplay) override;
Huihong Luo37396db2022-02-15 10:43:00 -08001498 binder::Status setPowerMode(const sp<IBinder>& display, int mode) override;
Huihong Luo0a81aa32022-02-22 16:02:36 -08001499 binder::Status getSupportedFrameTimestamps(std::vector<FrameEvent>* outSupported) override;
Huihong Luoaa7fc2e2022-02-15 10:43:00 -08001500 binder::Status getDisplayStats(const sp<IBinder>& display,
1501 gui::DisplayStatInfo* outStatInfo) override;
1502 binder::Status getDisplayState(const sp<IBinder>& display,
1503 gui::DisplayState* outState) override;
Sally Qi6bb12822022-10-05 11:42:30 -07001504 binder::Status getStaticDisplayInfo(int64_t displayId,
Huihong Luoa79ddf42022-02-17 00:01:38 -08001505 gui::StaticDisplayInfo* outInfo) override;
Sally Qi6bb12822022-10-05 11:42:30 -07001506 binder::Status getDynamicDisplayInfoFromId(int64_t displayId,
1507 gui::DynamicDisplayInfo* outInfo) override;
1508 binder::Status getDynamicDisplayInfoFromToken(const sp<IBinder>& display,
1509 gui::DynamicDisplayInfo* outInfo) override;
Huihong Luoca3d9a42022-02-22 11:07:34 -08001510 binder::Status getDisplayNativePrimaries(const sp<IBinder>& display,
1511 gui::DisplayPrimaries* outPrimaries) override;
1512 binder::Status setActiveColorMode(const sp<IBinder>& display, int colorMode) override;
1513 binder::Status setBootDisplayMode(const sp<IBinder>& display, int displayModeId) override;
Huihong Luo37396db2022-02-15 10:43:00 -08001514 binder::Status clearBootDisplayMode(const sp<IBinder>& display) override;
1515 binder::Status getBootDisplayModeSupport(bool* outMode) override;
Sally Qi0cbd08b2022-08-17 12:12:28 -07001516 binder::Status getOverlaySupport(gui::OverlayProperties* outProperties) override;
Kriti Dang674b9372022-11-18 10:58:44 +01001517 binder::Status getHdrConversionCapabilities(
1518 std::vector<gui::HdrConversionCapability>*) override;
Kriti Dangd432bb52023-02-09 18:21:04 +01001519 binder::Status setHdrConversionStrategy(const gui::HdrConversionStrategy& hdrConversionStrategy,
1520 int32_t*) override;
Kriti Dang674b9372022-11-18 10:58:44 +01001521 binder::Status getHdrOutputConversionSupport(bool* outSupport) override;
Huihong Luo37396db2022-02-15 10:43:00 -08001522 binder::Status setAutoLowLatencyMode(const sp<IBinder>& display, bool on) override;
1523 binder::Status setGameContentType(const sp<IBinder>& display, bool on) override;
Huihong Luof5029222021-12-16 14:33:46 -08001524 binder::Status captureDisplay(const DisplayCaptureArgs&,
1525 const sp<IScreenCaptureListener>&) override;
John Reck7e4c4872023-11-14 18:31:03 -05001526 binder::Status captureDisplayById(int64_t, const CaptureArgs&,
1527 const sp<IScreenCaptureListener>&) override;
Huihong Luof5029222021-12-16 14:33:46 -08001528 binder::Status captureLayers(const LayerCaptureArgs&,
1529 const sp<IScreenCaptureListener>&) override;
Chavi Weingartenf6fb4452024-01-23 21:10:30 +00001530 binder::Status captureLayersSync(const LayerCaptureArgs&, ScreenCaptureResults* results);
Dominik Laskowski66296b22022-07-12 08:20:36 -07001531
1532 // TODO(b/239076119): Remove deprecated AIDL.
Dominik Laskowskif84183b2022-07-25 14:02:10 -07001533 [[deprecated]] binder::Status clearAnimationFrameStats() override {
1534 return binder::Status::ok();
1535 }
Dominik Laskowski66296b22022-07-12 08:20:36 -07001536 [[deprecated]] binder::Status getAnimationFrameStats(gui::FrameStats*) override {
Dominik Laskowskif84183b2022-07-25 14:02:10 -07001537 return binder::Status::ok();
Dominik Laskowski66296b22022-07-12 08:20:36 -07001538 }
1539
Huihong Luo05539a12022-02-23 10:29:40 -08001540 binder::Status overrideHdrTypes(const sp<IBinder>& display,
1541 const std::vector<int32_t>& hdrTypes) override;
1542 binder::Status onPullAtom(int32_t atomId, gui::PullAtomData* outPullData) override;
Huihong Luo05539a12022-02-23 10:29:40 -08001543 binder::Status getCompositionPreference(gui::CompositionPreference* outPref) override;
1544 binder::Status getDisplayedContentSamplingAttributes(
1545 const sp<IBinder>& display, gui::ContentSamplingAttributes* outAttrs) override;
1546 binder::Status setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
1547 int8_t componentMask,
1548 int64_t maxFrames) override;
Huihong Luo3bdef862022-03-03 11:57:19 -08001549 binder::Status getDisplayedContentSample(const sp<IBinder>& display, int64_t maxFrames,
1550 int64_t timestamp,
1551 gui::DisplayedFrameStats* outStats) override;
Huihong Luo05539a12022-02-23 10:29:40 -08001552 binder::Status getProtectedContentSupport(bool* outSupporte) override;
Huihong Luo37396db2022-02-15 10:43:00 -08001553 binder::Status isWideColorDisplay(const sp<IBinder>& token,
1554 bool* outIsWideColorDisplay) override;
Huihong Luo02186fb2022-02-23 14:21:54 -08001555 binder::Status addRegionSamplingListener(
1556 const gui::ARect& samplingArea, const sp<IBinder>& stopLayerHandle,
1557 const sp<gui::IRegionSamplingListener>& listener) override;
1558 binder::Status removeRegionSamplingListener(
1559 const sp<gui::IRegionSamplingListener>& listener) override;
1560 binder::Status addFpsListener(int32_t taskId, const sp<gui::IFpsListener>& listener) override;
1561 binder::Status removeFpsListener(const sp<gui::IFpsListener>& listener) override;
1562 binder::Status addTunnelModeEnabledListener(
1563 const sp<gui::ITunnelModeEnabledListener>& listener) override;
1564 binder::Status removeTunnelModeEnabledListener(
1565 const sp<gui::ITunnelModeEnabledListener>& listener) override;
Ady Abraham285f8c12022-10-11 17:12:14 -07001566 binder::Status setDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
1567 const gui::DisplayModeSpecs&) override;
Huihong Luo02186fb2022-02-23 14:21:54 -08001568 binder::Status getDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
1569 gui::DisplayModeSpecs* outSpecs) override;
Huihong Luo37396db2022-02-15 10:43:00 -08001570 binder::Status getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
1571 bool* outSupport) override;
1572 binder::Status setDisplayBrightness(const sp<IBinder>& displayToken,
1573 const gui::DisplayBrightness& brightness) override;
1574 binder::Status addHdrLayerInfoListener(const sp<IBinder>& displayToken,
1575 const sp<gui::IHdrLayerInfoListener>& listener) override;
1576 binder::Status removeHdrLayerInfoListener(
1577 const sp<IBinder>& displayToken,
1578 const sp<gui::IHdrLayerInfoListener>& listener) override;
John Reck68796592023-01-25 13:47:12 -05001579
Huihong Luo37396db2022-02-15 10:43:00 -08001580 binder::Status notifyPowerBoost(int boostId) override;
Huihong Luo3bdef862022-03-03 11:57:19 -08001581 binder::Status setGlobalShadowSettings(const gui::Color& ambientColor,
1582 const gui::Color& spotColor, float lightPosY,
1583 float lightPosZ, float lightRadius) override;
1584 binder::Status getDisplayDecorationSupport(
1585 const sp<IBinder>& displayToken,
1586 std::optional<gui::DisplayDecorationSupport>* outSupport) override;
Andy Yu8c2703d2023-11-03 11:22:46 -07001587 binder::Status setGameModeFrameRateOverride(int32_t uid, float frameRate) override;
1588 binder::Status setGameDefaultFrameRateOverride(int32_t uid, float frameRate) override;
Carlos Martinez Romero5ec086e2023-02-14 00:44:36 +00001589 binder::Status enableRefreshRateOverlay(bool active) override;
1590 binder::Status setDebugFlash(int delay) override;
1591 binder::Status scheduleComposite() override;
1592 binder::Status scheduleCommit() override;
Carlos Martinez Romerob4ea9e62023-10-25 21:48:56 +00001593 binder::Status forceClientComposition(bool enabled) override;
Tony Huangf3621102023-09-04 17:14:22 +08001594 binder::Status updateSmallAreaDetection(const std::vector<int32_t>& appIds,
Tony Huang9ac5e6e2023-08-24 09:01:44 +00001595 const std::vector<float>& thresholds) override;
Tony Huangf3621102023-09-04 17:14:22 +08001596 binder::Status setSmallAreaDetectionThreshold(int32_t appId, float threshold) override;
Huihong Luo02186fb2022-02-23 14:21:54 -08001597 binder::Status getGpuContextPriority(int32_t* outPriority) override;
1598 binder::Status getMaxAcquiredBufferCount(int32_t* buffers) override;
Patrick Williamsacd22582023-07-12 13:47:28 -05001599 binder::Status addWindowInfosListener(const sp<gui::IWindowInfosListener>& windowInfosListener,
1600 gui::WindowInfosListenerInfo* outInfo) override;
Huihong Luo02186fb2022-02-23 14:21:54 -08001601 binder::Status removeWindowInfosListener(
1602 const sp<gui::IWindowInfosListener>& windowInfosListener) override;
Ady Abraham07d03c42023-09-27 19:15:08 -07001603 binder::Status getStalledTransactionInfo(
1604 int pid, std::optional<gui::StalledTransactionInfo>* outInfo) override;
1605 binder::Status getSchedulingPolicy(gui::SchedulingPolicy* outPolicy) override;
Wenhui Yangeafc18a2024-05-14 17:15:52 +00001606 binder::Status notifyShutdown() override;
Pascal Mütschardd56514e2024-05-24 17:37:13 +02001607 binder::Status addJankListener(const sp<IBinder>& layer,
1608 const sp<gui::IJankListener>& listener) override;
1609 binder::Status flushJankData(int32_t layerId) override;
1610 binder::Status removeJankListener(int32_t layerId, const sp<gui::IJankListener>& listener,
1611 int64_t afterVsync) override;
Huihong Luof5029222021-12-16 14:33:46 -08001612
1613private:
Huihong Luo07e72362022-02-14 14:26:04 -08001614 static const constexpr bool kUsePermissionCache = true;
1615 status_t checkAccessPermission(bool usePermissionCache = kUsePermissionCache);
Huihong Luo37396db2022-02-15 10:43:00 -08001616 status_t checkControlDisplayBrightnessPermission();
Huihong Luo02186fb2022-02-23 14:21:54 -08001617 status_t checkReadFrameBufferPermission();
Sally Qi6bb12822022-10-05 11:42:30 -07001618 static void getDynamicDisplayInfoInternal(ui::DynamicDisplayInfo& info,
1619 gui::DynamicDisplayInfo*& outInfo);
Huihong Luo07e72362022-02-14 14:26:04 -08001620
1621private:
Alan Dingfc6eab52024-05-02 18:28:45 -07001622 const sp<SurfaceFlinger> mFlinger;
Romain Guy0147a172017-06-01 13:53:56 -07001623};
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001624
Dominik Laskowski9dab3432019-03-27 13:21:10 -07001625} // namespace android