xref: /aosp_15_r20/frameworks/native/libs/gui/SurfaceComposerClient.cpp (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1 /*
2  * Copyright (C) 2007 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #define LOG_TAG "SurfaceComposerClient"
18 
19 #include <semaphore.h>
20 #include <stdint.h>
21 #include <sys/types.h>
22 
23 #include <android/gui/BnWindowInfosReportedListener.h>
24 #include <android/gui/DisplayState.h>
25 #include <android/gui/EdgeExtensionParameters.h>
26 #include <android/gui/ISurfaceComposerClient.h>
27 #include <android/gui/IWindowInfosListener.h>
28 #include <android/gui/TrustedPresentationThresholds.h>
29 #include <android/os/IInputConstants.h>
30 #include <com_android_graphics_libgui_flags.h>
31 #include <gui/DisplayLuts.h>
32 #include <gui/FrameRateUtils.h>
33 #include <gui/TraceUtils.h>
34 #include <utils/Errors.h>
35 #include <utils/Log.h>
36 #include <utils/SortedVector.h>
37 #include <utils/String8.h>
38 #include <utils/threads.h>
39 
40 #include <binder/IPCThreadState.h>
41 #include <binder/IServiceManager.h>
42 #include <binder/ProcessState.h>
43 
44 #include <system/graphics.h>
45 
46 #include <gui/AidlUtil.h>
47 #include <gui/BufferItemConsumer.h>
48 #include <gui/CpuConsumer.h>
49 #include <gui/IGraphicBufferProducer.h>
50 #include <gui/ISurfaceComposer.h>
51 #include <gui/LayerState.h>
52 #include <gui/Surface.h>
53 #include <gui/SurfaceComposerClient.h>
54 #include <gui/WindowInfo.h>
55 #include <private/gui/ParcelUtils.h>
56 #include <ui/DisplayMode.h>
57 #include <ui/DisplayState.h>
58 #include <ui/DynamicDisplayInfo.h>
59 #include <ui/FrameRateCategoryRate.h>
60 
61 #include <android-base/thread_annotations.h>
62 #include <gui/LayerStatePermissions.h>
63 #include <gui/ScreenCaptureResults.h>
64 #include <private/gui/ComposerService.h>
65 #include <private/gui/ComposerServiceAIDL.h>
66 
67 // This server size should always be smaller than the server cache size
68 #define BUFFER_CACHE_MAX_SIZE 4096
69 
70 namespace android {
71 
72 using aidl::android::hardware::graphics::common::DisplayDecorationSupport;
73 using gui::FocusRequest;
74 using gui::IRegionSamplingListener;
75 using gui::TrustedPresentationThresholds;
76 using gui::WindowInfo;
77 using gui::WindowInfoHandle;
78 using gui::WindowInfosListener;
79 using gui::aidl_utils::statusTFromBinderStatus;
80 using ui::ColorMode;
81 // ---------------------------------------------------------------------------
82 
83 ANDROID_SINGLETON_STATIC_INSTANCE(ComposerService);
84 ANDROID_SINGLETON_STATIC_INSTANCE(ComposerServiceAIDL);
85 
86 namespace {
87 // Initialize transaction id counter used to generate transaction ids
88 std::atomic<uint32_t> idCounter = 0;
generateId()89 int64_t generateId() {
90     return (((int64_t)getpid()) << 32) | ++idCounter;
91 }
92 
93 constexpr int64_t INVALID_VSYNC = -1;
94 const constexpr char* LOG_SURFACE_CONTROL_REGISTRY = "SurfaceControlRegistry";
95 
96 } // namespace
97 
98 const std::string SurfaceComposerClient::kEmpty{};
99 
ComposerService()100 ComposerService::ComposerService()
101 : Singleton<ComposerService>() {
102     Mutex::Autolock _l(mLock);
103     connectLocked();
104 }
105 
connectLocked()106 bool ComposerService::connectLocked() {
107     const String16 name("SurfaceFlinger");
108     mComposerService = waitForService<ISurfaceComposer>(name);
109     if (mComposerService == nullptr) {
110         return false; // fatal error or permission problem
111     }
112 
113     // Create the death listener.
114     class DeathObserver : public IBinder::DeathRecipient {
115         ComposerService& mComposerService;
116         virtual void binderDied(const wp<IBinder>& who) {
117             ALOGW("ComposerService remote (surfaceflinger) died [%p]",
118                   who.unsafe_get());
119             mComposerService.composerServiceDied();
120         }
121      public:
122         explicit DeathObserver(ComposerService& mgr) : mComposerService(mgr) { }
123     };
124 
125     mDeathObserver = new DeathObserver(*const_cast<ComposerService*>(this));
126     IInterface::asBinder(mComposerService)->linkToDeath(mDeathObserver);
127     return true;
128 }
129 
getComposerService()130 /*static*/ sp<ISurfaceComposer> ComposerService::getComposerService() {
131     ComposerService& instance = ComposerService::getInstance();
132     Mutex::Autolock _l(instance.mLock);
133     if (instance.mComposerService == nullptr) {
134         if (ComposerService::getInstance().connectLocked()) {
135             ALOGD("ComposerService reconnected");
136         }
137     }
138     return instance.mComposerService;
139 }
140 
composerServiceDied()141 void ComposerService::composerServiceDied()
142 {
143     Mutex::Autolock _l(mLock);
144     mComposerService = nullptr;
145     mDeathObserver = nullptr;
146 }
147 
ComposerServiceAIDL()148 ComposerServiceAIDL::ComposerServiceAIDL() : Singleton<ComposerServiceAIDL>() {
149     std::scoped_lock lock(mMutex);
150     connectLocked();
151 }
152 
connectLocked()153 bool ComposerServiceAIDL::connectLocked() {
154     const String16 name("SurfaceFlingerAIDL");
155     mComposerService = waitForService<gui::ISurfaceComposer>(name);
156     if (mComposerService == nullptr) {
157         return false; // fatal error or permission problem
158     }
159 
160     // Create the death listener.
161     class DeathObserver : public IBinder::DeathRecipient {
162         ComposerServiceAIDL& mComposerService;
163         virtual void binderDied(const wp<IBinder>& who) {
164             ALOGW("ComposerService aidl remote (surfaceflinger) died [%p]", who.unsafe_get());
165             mComposerService.composerServiceDied();
166         }
167 
168     public:
169         explicit DeathObserver(ComposerServiceAIDL& mgr) : mComposerService(mgr) {}
170     };
171 
172     mDeathObserver = new DeathObserver(*const_cast<ComposerServiceAIDL*>(this));
173     IInterface::asBinder(mComposerService)->linkToDeath(mDeathObserver);
174     return true;
175 }
176 
getComposerService()177 /*static*/ sp<gui::ISurfaceComposer> ComposerServiceAIDL::getComposerService() {
178     ComposerServiceAIDL& instance = ComposerServiceAIDL::getInstance();
179     std::scoped_lock lock(instance.mMutex);
180     if (instance.mComposerService == nullptr) {
181         if (ComposerServiceAIDL::getInstance().connectLocked()) {
182             ALOGD("ComposerServiceAIDL reconnected");
183             WindowInfosListenerReporter::getInstance()->reconnect(instance.mComposerService);
184         }
185     }
186     return instance.mComposerService;
187 }
188 
composerServiceDied()189 void ComposerServiceAIDL::composerServiceDied() {
190     std::scoped_lock lock(mMutex);
191     mComposerService = nullptr;
192     mDeathObserver = nullptr;
193 }
194 
195 class DefaultComposerClient: public Singleton<DefaultComposerClient> {
196     Mutex mLock;
197     sp<SurfaceComposerClient> mClient;
198     friend class Singleton<ComposerService>;
199 public:
getComposerClient()200     static sp<SurfaceComposerClient> getComposerClient() {
201         DefaultComposerClient& dc = DefaultComposerClient::getInstance();
202         Mutex::Autolock _l(dc.mLock);
203         if (dc.mClient == nullptr) {
204             dc.mClient = new SurfaceComposerClient;
205         }
206         return dc.mClient;
207     }
208 };
209 ANDROID_SINGLETON_STATIC_INSTANCE(DefaultComposerClient);
210 
211 
getDefault()212 sp<SurfaceComposerClient> SurfaceComposerClient::getDefault() {
213     return DefaultComposerClient::getComposerClient();
214 }
215 
216 // ---------------------------------------------------------------------------
217 
~JankDataListener()218 JankDataListener::~JankDataListener() {
219 }
220 
flushJankData()221 status_t JankDataListener::flushJankData() {
222     if (mLayerId == -1) {
223         return INVALID_OPERATION;
224     }
225 
226     binder::Status status = ComposerServiceAIDL::getComposerService()->flushJankData(mLayerId);
227     return statusTFromBinderStatus(status);
228 }
229 
230 std::mutex JankDataListenerFanOut::sFanoutInstanceMutex;
231 std::unordered_map<int32_t, sp<JankDataListenerFanOut>> JankDataListenerFanOut::sFanoutInstances;
232 
onJankData(const std::vector<gui::JankData> & jankData)233 binder::Status JankDataListenerFanOut::onJankData(const std::vector<gui::JankData>& jankData) {
234     // Find the highest VSync ID.
235     int64_t lastVsync = jankData.empty()
236             ? 0
237             : std::max_element(jankData.begin(), jankData.end(),
238                                [](const gui::JankData& jd1, const gui::JankData& jd2) {
239                                    return jd1.frameVsyncId < jd2.frameVsyncId;
240                                })
241                       ->frameVsyncId;
242 
243     // Fan out the jank data callback.
244     std::vector<wp<JankDataListener>> listenersToRemove;
245     for (auto listener : getActiveListeners()) {
246         if (!listener->onJankDataAvailable(jankData) ||
247             (listener->mRemoveAfter >= 0 && listener->mRemoveAfter <= lastVsync)) {
248             listenersToRemove.push_back(listener);
249         }
250     }
251 
252     return removeListeners(listenersToRemove)
253             ? binder::Status::ok()
254             : binder::Status::fromExceptionCode(binder::Status::EX_NULL_POINTER);
255 }
256 
addListener(sp<SurfaceControl> sc,sp<JankDataListener> listener)257 status_t JankDataListenerFanOut::addListener(sp<SurfaceControl> sc, sp<JankDataListener> listener) {
258     sp<IBinder> layer = sc->getHandle();
259     if (layer == nullptr) {
260         return UNEXPECTED_NULL;
261     }
262     int32_t layerId = sc->getLayerId();
263 
264     sFanoutInstanceMutex.lock();
265     auto it = sFanoutInstances.find(layerId);
266     bool registerNeeded = it == sFanoutInstances.end();
267     sp<JankDataListenerFanOut> fanout;
268     if (registerNeeded) {
269         fanout = sp<JankDataListenerFanOut>::make(layerId);
270         sFanoutInstances.insert({layerId, fanout});
271     } else {
272         fanout = it->second;
273     }
274 
275     fanout->mMutex.lock();
276     fanout->mListeners.insert(listener);
277     fanout->mMutex.unlock();
278 
279     sFanoutInstanceMutex.unlock();
280 
281     if (registerNeeded) {
282         binder::Status status =
283                 ComposerServiceAIDL::getComposerService()->addJankListener(layer, fanout);
284         return statusTFromBinderStatus(status);
285     }
286     return OK;
287 }
288 
removeListener(sp<JankDataListener> listener)289 status_t JankDataListenerFanOut::removeListener(sp<JankDataListener> listener) {
290     int32_t layerId = listener->mLayerId;
291     if (layerId == -1) {
292         return INVALID_OPERATION;
293     }
294 
295     int64_t removeAfter = INVALID_VSYNC;
296     sp<JankDataListenerFanOut> fanout;
297 
298     sFanoutInstanceMutex.lock();
299     auto it = sFanoutInstances.find(layerId);
300     if (it != sFanoutInstances.end()) {
301         fanout = it->second;
302         removeAfter = fanout->updateAndGetRemovalVSync();
303     }
304 
305     if (removeAfter != INVALID_VSYNC) {
306         // Remove this instance from the map, so that no new listeners are added
307         // while we're scheduled to be removed.
308         sFanoutInstances.erase(layerId);
309     }
310     sFanoutInstanceMutex.unlock();
311 
312     if (removeAfter < 0) {
313         return OK;
314     }
315 
316     binder::Status status =
317             ComposerServiceAIDL::getComposerService()->removeJankListener(layerId, fanout,
318                                                                           removeAfter);
319     return statusTFromBinderStatus(status);
320 }
321 
getActiveListeners()322 std::vector<sp<JankDataListener>> JankDataListenerFanOut::getActiveListeners() {
323     std::scoped_lock<std::mutex> lock(mMutex);
324 
325     std::vector<sp<JankDataListener>> listeners;
326     for (auto it = mListeners.begin(); it != mListeners.end();) {
327         auto listener = it->promote();
328         if (!listener) {
329             it = mListeners.erase(it);
330         } else {
331             listeners.push_back(std::move(listener));
332             it++;
333         }
334     }
335     return listeners;
336 }
337 
removeListeners(const std::vector<wp<JankDataListener>> & listeners)338 bool JankDataListenerFanOut::removeListeners(const std::vector<wp<JankDataListener>>& listeners) {
339     std::scoped_lock<std::mutex> fanoutLock(sFanoutInstanceMutex);
340     std::scoped_lock<std::mutex> listenersLock(mMutex);
341 
342     for (auto listener : listeners) {
343         mListeners.erase(listener);
344     }
345 
346     if (mListeners.empty()) {
347         sFanoutInstances.erase(mLayerId);
348         return false;
349     }
350     return true;
351 }
352 
updateAndGetRemovalVSync()353 int64_t JankDataListenerFanOut::updateAndGetRemovalVSync() {
354     std::scoped_lock<std::mutex> lock(mMutex);
355     if (mRemoveAfter >= 0) {
356         // We've already been scheduled to be removed. Don't schedule again.
357         return INVALID_VSYNC;
358     }
359 
360     int64_t removeAfter = 0;
361     for (auto it = mListeners.begin(); it != mListeners.end();) {
362         auto listener = it->promote();
363         if (!listener) {
364             it = mListeners.erase(it);
365         } else if (listener->mRemoveAfter < 0) {
366             // We have at least one listener that's still interested. Don't remove.
367             return INVALID_VSYNC;
368         } else {
369             removeAfter = std::max(removeAfter, listener->mRemoveAfter);
370             it++;
371         }
372     }
373 
374     mRemoveAfter = removeAfter;
375     return removeAfter;
376 }
377 
378 // ---------------------------------------------------------------------------
379 
380 // TransactionCompletedListener does not use ANDROID_SINGLETON_STATIC_INSTANCE because it needs
381 // to be able to return a sp<> to its instance to pass to SurfaceFlinger.
382 // ANDROID_SINGLETON_STATIC_INSTANCE only allows a reference to an instance.
383 
384 // 0 is an invalid callback id
TransactionCompletedListener()385 TransactionCompletedListener::TransactionCompletedListener() : mCallbackIdCounter(1) {}
386 
getNextIdLocked()387 int64_t TransactionCompletedListener::getNextIdLocked() {
388     return mCallbackIdCounter++;
389 }
390 
391 sp<TransactionCompletedListener> TransactionCompletedListener::sInstance = nullptr;
392 static std::mutex sListenerInstanceMutex;
393 
setInstance(const sp<TransactionCompletedListener> & listener)394 void TransactionCompletedListener::setInstance(const sp<TransactionCompletedListener>& listener) {
395     sInstance = listener;
396 }
397 
getInstance()398 sp<TransactionCompletedListener> TransactionCompletedListener::getInstance() {
399     std::lock_guard<std::mutex> lock(sListenerInstanceMutex);
400     if (sInstance == nullptr) {
401         sInstance = new TransactionCompletedListener;
402     }
403     return sInstance;
404 }
405 
getIInstance()406 sp<ITransactionCompletedListener> TransactionCompletedListener::getIInstance() {
407     return static_cast<sp<ITransactionCompletedListener>>(getInstance());
408 }
409 
startListeningLocked()410 void TransactionCompletedListener::startListeningLocked() {
411     if (mListening) {
412         return;
413     }
414     ProcessState::self()->startThreadPool();
415     mListening = true;
416 }
417 
addCallbackFunction(const TransactionCompletedCallback & callbackFunction,const std::unordered_set<sp<SurfaceControl>,SurfaceComposerClient::SCHash> & surfaceControls,CallbackId::Type callbackType)418 CallbackId TransactionCompletedListener::addCallbackFunction(
419         const TransactionCompletedCallback& callbackFunction,
420         const std::unordered_set<sp<SurfaceControl>, SurfaceComposerClient::SCHash>&
421                 surfaceControls,
422         CallbackId::Type callbackType) {
423     std::lock_guard<std::mutex> lock(mMutex);
424     startListeningLocked();
425 
426     CallbackId callbackId(getNextIdLocked(), callbackType);
427     mCallbacks[callbackId].callbackFunction = callbackFunction;
428     auto& callbackSurfaceControls = mCallbacks[callbackId].surfaceControls;
429 
430     for (const auto& surfaceControl : surfaceControls) {
431         callbackSurfaceControls[surfaceControl->getHandle()] = surfaceControl;
432     }
433 
434     return callbackId;
435 }
436 
setReleaseBufferCallback(const ReleaseCallbackId & callbackId,ReleaseBufferCallback listener)437 void TransactionCompletedListener::setReleaseBufferCallback(const ReleaseCallbackId& callbackId,
438                                                             ReleaseBufferCallback listener) {
439     std::scoped_lock<std::mutex> lock(mMutex);
440     mReleaseBufferCallbacks[callbackId] = listener;
441 }
442 
addSurfaceStatsListener(void * context,void * cookie,sp<SurfaceControl> surfaceControl,SurfaceStatsCallback listener)443 void TransactionCompletedListener::addSurfaceStatsListener(void* context, void* cookie,
444         sp<SurfaceControl> surfaceControl, SurfaceStatsCallback listener) {
445     std::scoped_lock<std::recursive_mutex> lock(mSurfaceStatsListenerMutex);
446     mSurfaceStatsListeners.insert(
447             {surfaceControl->getLayerId(), SurfaceStatsCallbackEntry(context, cookie, listener)});
448 }
449 
removeSurfaceStatsListener(void * context,void * cookie)450 void TransactionCompletedListener::removeSurfaceStatsListener(void* context, void* cookie) {
451     std::scoped_lock<std::recursive_mutex> lock(mSurfaceStatsListenerMutex);
452     for (auto it = mSurfaceStatsListeners.begin(); it != mSurfaceStatsListeners.end();) {
453         auto [itContext, itCookie, itListener] = it->second;
454         if (itContext == context && itCookie == cookie) {
455             it = mSurfaceStatsListeners.erase(it);
456         } else {
457             it++;
458         }
459     }
460 }
461 
addSurfaceControlToCallbacks(const sp<SurfaceControl> & surfaceControl,const std::unordered_set<CallbackId,CallbackIdHash> & callbackIds)462 void TransactionCompletedListener::addSurfaceControlToCallbacks(
463         const sp<SurfaceControl>& surfaceControl,
464         const std::unordered_set<CallbackId, CallbackIdHash>& callbackIds) {
465     std::lock_guard<std::mutex> lock(mMutex);
466 
467     for (auto callbackId : callbackIds) {
468         mCallbacks[callbackId].surfaceControls.emplace(std::piecewise_construct,
469                                                        std::forward_as_tuple(
470                                                                surfaceControl->getHandle()),
471                                                        std::forward_as_tuple(surfaceControl));
472     }
473 }
474 
onTransactionCompleted(ListenerStats listenerStats)475 void TransactionCompletedListener::onTransactionCompleted(ListenerStats listenerStats) {
476     std::unordered_map<CallbackId, CallbackTranslation, CallbackIdHash> callbacksMap;
477     {
478         std::lock_guard<std::mutex> lock(mMutex);
479 
480         /* This listener knows all the sp<IBinder> to sp<SurfaceControl> for all its registered
481          * callbackIds, except for when Transactions are merged together. This probably cannot be
482          * solved before this point because the Transactions could be merged together and applied in
483          * a different process.
484          *
485          * Fortunately, we get all the callbacks for this listener for the same frame together at
486          * the same time. This means if any Transactions were merged together, we will get their
487          * callbacks at the same time. We can combine all the sp<IBinder> to sp<SurfaceControl> maps
488          * for all the callbackIds to generate one super map that contains all the sp<IBinder> to
489          * sp<SurfaceControl> that could possibly exist for the callbacks.
490          */
491         callbacksMap = mCallbacks;
492         for (const auto& transactionStats : listenerStats.transactionStats) {
493             for (auto& callbackId : transactionStats.callbackIds) {
494                 mCallbacks.erase(callbackId);
495             }
496         }
497     }
498     for (const auto& transactionStats : listenerStats.transactionStats) {
499         // handle on commit callbacks
500         for (auto callbackId : transactionStats.callbackIds) {
501             if (callbackId.type != CallbackId::Type::ON_COMMIT) {
502                 continue;
503             }
504             auto& [callbackFunction, callbackSurfaceControls] = callbacksMap[callbackId];
505             if (!callbackFunction) {
506                 continue;
507             }
508             std::vector<SurfaceControlStats> surfaceControlStats;
509             for (const auto& surfaceStats : transactionStats.surfaceStats) {
510                 surfaceControlStats
511                         .emplace_back(callbacksMap[callbackId]
512                                               .surfaceControls[surfaceStats.surfaceControl],
513                                       transactionStats.latchTime, surfaceStats.acquireTimeOrFence,
514                                       transactionStats.presentFence,
515                                       surfaceStats.previousReleaseFence, surfaceStats.transformHint,
516                                       surfaceStats.eventStats,
517                                       surfaceStats.currentMaxAcquiredBufferCount);
518             }
519 
520             callbackFunction(transactionStats.latchTime, transactionStats.presentFence,
521                              surfaceControlStats);
522 
523             // More than one transaction may contain the same callback id. Erase the callback from
524             // the map to ensure that it is only called once. This can happen if transactions are
525             // parcelled out of process and applied in both processes.
526             callbacksMap.erase(callbackId);
527         }
528 
529         // handle on complete callbacks
530         for (auto callbackId : transactionStats.callbackIds) {
531             if (callbackId.type != CallbackId::Type::ON_COMPLETE) {
532                 continue;
533             }
534             auto& [callbackFunction, callbackSurfaceControls] = callbacksMap[callbackId];
535             if (!callbackFunction) {
536                 ALOGE("cannot call null callback function, skipping");
537                 continue;
538             }
539             std::vector<SurfaceControlStats> surfaceControlStats;
540             for (const auto& surfaceStats : transactionStats.surfaceStats) {
541                 surfaceControlStats
542                         .emplace_back(callbacksMap[callbackId]
543                                               .surfaceControls[surfaceStats.surfaceControl],
544                                       transactionStats.latchTime, surfaceStats.acquireTimeOrFence,
545                                       transactionStats.presentFence,
546                                       surfaceStats.previousReleaseFence, surfaceStats.transformHint,
547                                       surfaceStats.eventStats,
548                                       surfaceStats.currentMaxAcquiredBufferCount);
549                 if (callbacksMap[callbackId].surfaceControls[surfaceStats.surfaceControl] &&
550                     surfaceStats.transformHint.has_value()) {
551                     callbacksMap[callbackId]
552                             .surfaceControls[surfaceStats.surfaceControl]
553                             ->setTransformHint(*surfaceStats.transformHint);
554                 }
555                 // If there is buffer id set, we look up any pending client release buffer callbacks
556                 // and call them. This is a performance optimization when we have a transaction
557                 // callback and a release buffer callback happening at the same time to avoid an
558                 // additional ipc call from the server.
559                 if (surfaceStats.previousReleaseCallbackId != ReleaseCallbackId::INVALID_ID) {
560                     ReleaseBufferCallback callback;
561                     {
562                         std::scoped_lock<std::mutex> lock(mMutex);
563                         callback = popReleaseBufferCallbackLocked(
564                                 surfaceStats.previousReleaseCallbackId);
565                     }
566                     if (callback) {
567                         callback(surfaceStats.previousReleaseCallbackId,
568                                  surfaceStats.previousReleaseFence
569                                          ? surfaceStats.previousReleaseFence
570                                          : Fence::NO_FENCE,
571                                  surfaceStats.currentMaxAcquiredBufferCount);
572                     }
573                 }
574             }
575 
576             callbackFunction(transactionStats.latchTime, transactionStats.presentFence,
577                              surfaceControlStats);
578         }
579     }
580 
581     for (const auto& transactionStats : listenerStats.transactionStats) {
582         for (const auto& surfaceStats : transactionStats.surfaceStats) {
583             // The callbackMap contains the SurfaceControl object, which we need to look up the
584             // layerId. Since we don't know which callback contains the SurfaceControl, iterate
585             // through all until the SC is found.
586             int32_t layerId = -1;
587             for (auto callbackId : transactionStats.callbackIds) {
588                 if (callbackId.type != CallbackId::Type::ON_COMPLETE) {
589                     // We only want to run the stats callback for ON_COMPLETE
590                     continue;
591                 }
592                 sp<SurfaceControl> sc =
593                         callbacksMap[callbackId].surfaceControls[surfaceStats.surfaceControl];
594                 if (sc != nullptr) {
595                     layerId = sc->getLayerId();
596                     break;
597                 }
598             }
599 
600             if (layerId != -1) {
601                 // Acquire surface stats listener lock such that we guarantee that after calling
602                 // unregister, there won't be any further callback.
603                 std::scoped_lock<std::recursive_mutex> lock(mSurfaceStatsListenerMutex);
604                 auto listenerRange = mSurfaceStatsListeners.equal_range(layerId);
605                 for (auto it = listenerRange.first; it != listenerRange.second; it++) {
606                     auto entry = it->second;
607                     entry.callback(entry.context, transactionStats.latchTime,
608                         transactionStats.presentFence, surfaceStats);
609                 }
610             }
611         }
612     }
613 }
614 
onTransactionQueueStalled(const String8 & reason)615 void TransactionCompletedListener::onTransactionQueueStalled(const String8& reason) {
616     std::unordered_map<void*, std::function<void(const std::string&)>> callbackCopy;
617     {
618         std::scoped_lock<std::mutex> lock(mMutex);
619         callbackCopy = mQueueStallListeners;
620     }
621     for (auto const& it : callbackCopy) {
622         it.second(reason.c_str());
623     }
624 }
625 
addQueueStallListener(std::function<void (const std::string &)> stallListener,void * id)626 void TransactionCompletedListener::addQueueStallListener(
627         std::function<void(const std::string&)> stallListener, void* id) {
628     std::scoped_lock<std::mutex> lock(mMutex);
629     mQueueStallListeners[id] = stallListener;
630 }
631 
removeQueueStallListener(void * id)632 void TransactionCompletedListener::removeQueueStallListener(void* id) {
633     std::scoped_lock<std::mutex> lock(mMutex);
634     mQueueStallListeners.erase(id);
635 }
636 
onReleaseBuffer(ReleaseCallbackId callbackId,sp<Fence> releaseFence,uint32_t currentMaxAcquiredBufferCount)637 void TransactionCompletedListener::onReleaseBuffer(ReleaseCallbackId callbackId,
638                                                    sp<Fence> releaseFence,
639                                                    uint32_t currentMaxAcquiredBufferCount) {
640     ReleaseBufferCallback callback;
641     {
642         std::scoped_lock<std::mutex> lock(mMutex);
643         callback = popReleaseBufferCallbackLocked(callbackId);
644     }
645     if (!callback) {
646         ALOGE("Could not call release buffer callback, buffer not found %s",
647               callbackId.to_string().c_str());
648         return;
649     }
650     std::optional<uint32_t> optionalMaxAcquiredBufferCount =
651             currentMaxAcquiredBufferCount == UINT_MAX
652             ? std::nullopt
653             : std::make_optional<uint32_t>(currentMaxAcquiredBufferCount);
654     callback(callbackId, releaseFence, optionalMaxAcquiredBufferCount);
655 }
656 
popReleaseBufferCallbackLocked(const ReleaseCallbackId & callbackId)657 ReleaseBufferCallback TransactionCompletedListener::popReleaseBufferCallbackLocked(
658         const ReleaseCallbackId& callbackId) {
659     ReleaseBufferCallback callback;
660     auto itr = mReleaseBufferCallbacks.find(callbackId);
661     if (itr == mReleaseBufferCallbacks.end()) {
662         return nullptr;
663     }
664     callback = itr->second;
665     mReleaseBufferCallbacks.erase(itr);
666     return callback;
667 }
668 
removeReleaseBufferCallback(const ReleaseCallbackId & callbackId)669 void TransactionCompletedListener::removeReleaseBufferCallback(
670         const ReleaseCallbackId& callbackId) {
671     {
672         std::scoped_lock<std::mutex> lock(mMutex);
673         popReleaseBufferCallbackLocked(callbackId);
674     }
675 }
676 
PresentationCallbackRAII(TransactionCompletedListener * tcl,int id)677 SurfaceComposerClient::PresentationCallbackRAII::PresentationCallbackRAII(
678         TransactionCompletedListener* tcl, int id) {
679     mTcl = tcl;
680     mId = id;
681 }
682 
~PresentationCallbackRAII()683 SurfaceComposerClient::PresentationCallbackRAII::~PresentationCallbackRAII() {
684     mTcl->clearTrustedPresentationCallback(mId);
685 }
686 
687 sp<SurfaceComposerClient::PresentationCallbackRAII>
addTrustedPresentationCallback(TrustedPresentationCallback tpc,int id,void * context)688 TransactionCompletedListener::addTrustedPresentationCallback(TrustedPresentationCallback tpc,
689                                                              int id, void* context) {
690     std::scoped_lock<std::mutex> lock(mMutex);
691     mTrustedPresentationCallbacks[id] =
692             std::tuple<TrustedPresentationCallback, void*>(tpc, context);
693     return new SurfaceComposerClient::PresentationCallbackRAII(this, id);
694 }
695 
clearTrustedPresentationCallback(int id)696 void TransactionCompletedListener::clearTrustedPresentationCallback(int id) {
697     std::scoped_lock<std::mutex> lock(mMutex);
698     mTrustedPresentationCallbacks.erase(id);
699 }
700 
onTrustedPresentationChanged(int id,bool presentedWithinThresholds)701 void TransactionCompletedListener::onTrustedPresentationChanged(int id,
702                                                                 bool presentedWithinThresholds) {
703     TrustedPresentationCallback tpc;
704     void* context;
705     {
706         std::scoped_lock<std::mutex> lock(mMutex);
707         auto it = mTrustedPresentationCallbacks.find(id);
708         if (it == mTrustedPresentationCallbacks.end()) {
709             return;
710         }
711         std::tie(tpc, context) = it->second;
712     }
713     tpc(context, presentedWithinThresholds);
714 }
715 
716 // ---------------------------------------------------------------------------
717 
718 void removeDeadBufferCallback(void* /*context*/, uint64_t graphicBufferId);
719 
720 /**
721  * We use the BufferCache to reduce the overhead of exchanging GraphicBuffers with
722  * the server. If we were to simply parcel the GraphicBuffer we would pay two overheads
723  *     1. Cost of sending the FD
724  *     2. Cost of importing the GraphicBuffer with the mapper in the receiving process.
725  * To ease this cost we implement the following scheme of caching buffers to integers,
726  * or said-otherwise, naming them with integers. This is the scheme known as slots in
727  * the legacy BufferQueue system.
728  *     1. When sending Buffers to SurfaceFlinger we look up the Buffer in the cache.
729  *     2. If there is a cache-hit we remove the Buffer from the Transaction and instead
730  *        send the cached integer.
731  *     3. If there is a cache miss, we cache the new buffer and send the integer
732  *        along with the Buffer, SurfaceFlinger on it's side creates a new cache
733  *        entry, and we use the integer for further communication.
734  * A few details about lifetime:
735  *     1. The cache evicts by LRU. The server side cache is keyed by BufferCache::getToken
736  *        which is per process Unique. The server side cache is larger than the client side
737  *        cache so that the server will never evict entries before the client.
738  *     2. When the client evicts an entry it notifies the server via an uncacheBuffer
739  *        transaction.
740  *     3. The client only references the Buffers by ID, and uses buffer->addDeathCallback
741  *        to auto-evict destroyed buffers.
742  */
743 class BufferCache : public Singleton<BufferCache> {
744 public:
BufferCache()745     BufferCache() : token(new BBinder()) {}
746 
getToken()747     sp<IBinder> getToken() {
748         return IInterface::asBinder(TransactionCompletedListener::getIInstance());
749     }
750 
getCacheId(const sp<GraphicBuffer> & buffer,uint64_t * cacheId)751     status_t getCacheId(const sp<GraphicBuffer>& buffer, uint64_t* cacheId) {
752         std::lock_guard<std::mutex> lock(mMutex);
753 
754         auto itr = mBuffers.find(buffer->getId());
755         if (itr == mBuffers.end()) {
756             return BAD_VALUE;
757         }
758         itr->second = getCounter();
759         *cacheId = buffer->getId();
760         return NO_ERROR;
761     }
762 
cache(const sp<GraphicBuffer> & buffer,std::optional<client_cache_t> & outUncacheBuffer)763     uint64_t cache(const sp<GraphicBuffer>& buffer,
764                    std::optional<client_cache_t>& outUncacheBuffer) {
765         std::lock_guard<std::mutex> lock(mMutex);
766 
767         if (mBuffers.size() >= BUFFER_CACHE_MAX_SIZE) {
768             outUncacheBuffer = findLeastRecentlyUsedBuffer();
769             mBuffers.erase(outUncacheBuffer->id);
770         }
771 
772         buffer->addDeathCallback(removeDeadBufferCallback, nullptr);
773 
774         mBuffers[buffer->getId()] = getCounter();
775         return buffer->getId();
776     }
777 
uncache(uint64_t cacheId)778     void uncache(uint64_t cacheId) {
779         std::lock_guard<std::mutex> lock(mMutex);
780         if (mBuffers.erase(cacheId)) {
781             SurfaceComposerClient::doUncacheBufferTransaction(cacheId);
782         }
783     }
784 
785 private:
findLeastRecentlyUsedBuffer()786     client_cache_t findLeastRecentlyUsedBuffer() REQUIRES(mMutex) {
787         auto itr = mBuffers.begin();
788         uint64_t minCounter = itr->second;
789         auto minBuffer = itr;
790         itr++;
791 
792         while (itr != mBuffers.end()) {
793             uint64_t counter = itr->second;
794             if (counter < minCounter) {
795                 minCounter = counter;
796                 minBuffer = itr;
797             }
798             itr++;
799         }
800 
801         return {.token = getToken(), .id = minBuffer->first};
802     }
803 
getCounter()804     uint64_t getCounter() REQUIRES(mMutex) {
805         static uint64_t counter = 0;
806         return counter++;
807     }
808 
809     std::mutex mMutex;
810     std::map<uint64_t /*Cache id*/, uint64_t /*counter*/> mBuffers GUARDED_BY(mMutex);
811 
812     // Used by ISurfaceComposer to identify which process is sending the cached buffer.
813     sp<IBinder> token;
814 };
815 
816 ANDROID_SINGLETON_STATIC_INSTANCE(BufferCache);
817 
removeDeadBufferCallback(void *,uint64_t graphicBufferId)818 void removeDeadBufferCallback(void* /*context*/, uint64_t graphicBufferId) {
819     // GraphicBuffer id's are used as the cache ids.
820     BufferCache::getInstance().uncache(graphicBufferId);
821 }
822 
823 // ---------------------------------------------------------------------------
824 
Transaction()825 SurfaceComposerClient::Transaction::Transaction() {
826     mId = generateId();
827     mTransactionCompletedListener = TransactionCompletedListener::getInstance();
828 }
829 
Transaction(const Transaction & other)830 SurfaceComposerClient::Transaction::Transaction(const Transaction& other)
831       : mId(other.mId),
832         mAnimation(other.mAnimation),
833         mEarlyWakeupStart(other.mEarlyWakeupStart),
834         mEarlyWakeupEnd(other.mEarlyWakeupEnd),
835         mMayContainBuffer(other.mMayContainBuffer),
836         mDesiredPresentTime(other.mDesiredPresentTime),
837         mIsAutoTimestamp(other.mIsAutoTimestamp),
838         mFrameTimelineInfo(other.mFrameTimelineInfo),
839         mApplyToken(other.mApplyToken) {
840     mDisplayStates = other.mDisplayStates;
841     mComposerStates = other.mComposerStates;
842     mInputWindowCommands = other.mInputWindowCommands;
843     mListenerCallbacks = other.mListenerCallbacks;
844     mTransactionCompletedListener = TransactionCompletedListener::getInstance();
845 }
846 
sanitize(int pid,int uid)847 void SurfaceComposerClient::Transaction::sanitize(int pid, int uid) {
848     uint32_t permissions = LayerStatePermissions::getTransactionPermissions(pid, uid);
849     for (auto & [handle, composerState] : mComposerStates) {
850         composerState.state.sanitize(permissions);
851     }
852     if (!mInputWindowCommands.empty() &&
853         (permissions & layer_state_t::Permission::ACCESS_SURFACE_FLINGER) == 0) {
854         ALOGE("Only privileged callers are allowed to send input commands.");
855         mInputWindowCommands.clear();
856     }
857 }
858 
859 std::unique_ptr<SurfaceComposerClient::Transaction>
createFromParcel(const Parcel * parcel)860 SurfaceComposerClient::Transaction::createFromParcel(const Parcel* parcel) {
861     auto transaction = std::make_unique<Transaction>();
862     if (transaction->readFromParcel(parcel) == NO_ERROR) {
863         return transaction;
864     }
865     return nullptr;
866 }
867 
868 
readFromParcel(const Parcel * parcel)869 status_t SurfaceComposerClient::Transaction::readFromParcel(const Parcel* parcel) {
870     const uint64_t transactionId = parcel->readUint64();
871     const bool animation = parcel->readBool();
872     const bool earlyWakeupStart = parcel->readBool();
873     const bool earlyWakeupEnd = parcel->readBool();
874     const int64_t desiredPresentTime = parcel->readInt64();
875     const bool isAutoTimestamp = parcel->readBool();
876     const bool logCallPoints = parcel->readBool();
877     FrameTimelineInfo frameTimelineInfo;
878     frameTimelineInfo.readFromParcel(parcel);
879 
880     sp<IBinder> applyToken;
881     parcel->readNullableStrongBinder(&applyToken);
882     size_t count = static_cast<size_t>(parcel->readUint32());
883     if (count > parcel->dataSize()) {
884         return BAD_VALUE;
885     }
886     SortedVector<DisplayState> displayStates;
887     displayStates.setCapacity(count);
888     for (size_t i = 0; i < count; i++) {
889         DisplayState displayState;
890         if (displayState.read(*parcel) == BAD_VALUE) {
891             return BAD_VALUE;
892         }
893         displayStates.add(displayState);
894     }
895 
896     count = static_cast<size_t>(parcel->readUint32());
897     if (count > parcel->dataSize()) {
898         return BAD_VALUE;
899     }
900     std::unordered_map<sp<ITransactionCompletedListener>, CallbackInfo, TCLHash> listenerCallbacks;
901     listenerCallbacks.reserve(count);
902     for (size_t i = 0; i < count; i++) {
903         sp<ITransactionCompletedListener> listener =
904                 interface_cast<ITransactionCompletedListener>(parcel->readStrongBinder());
905         size_t numCallbackIds = parcel->readUint32();
906         if (numCallbackIds > parcel->dataSize()) {
907             return BAD_VALUE;
908         }
909         for (size_t j = 0; j < numCallbackIds; j++) {
910             CallbackId id;
911             parcel->readParcelable(&id);
912             listenerCallbacks[listener].callbackIds.insert(id);
913         }
914         size_t numSurfaces = parcel->readUint32();
915         if (numSurfaces > parcel->dataSize()) {
916             return BAD_VALUE;
917         }
918         for (size_t j = 0; j < numSurfaces; j++) {
919             sp<SurfaceControl> surface;
920             SAFE_PARCEL(SurfaceControl::readFromParcel, *parcel, &surface);
921             listenerCallbacks[listener].surfaceControls.insert(surface);
922         }
923     }
924 
925     count = static_cast<size_t>(parcel->readUint32());
926     if (count > parcel->dataSize()) {
927         return BAD_VALUE;
928     }
929     std::unordered_map<sp<IBinder>, ComposerState, IBinderHash> composerStates;
930     composerStates.reserve(count);
931     for (size_t i = 0; i < count; i++) {
932         sp<IBinder> surfaceControlHandle;
933         SAFE_PARCEL(parcel->readStrongBinder, &surfaceControlHandle);
934 
935         ComposerState composerState;
936         if (composerState.read(*parcel) == BAD_VALUE) {
937             return BAD_VALUE;
938         }
939         composerStates[surfaceControlHandle] = composerState;
940     }
941 
942     InputWindowCommands inputWindowCommands;
943     inputWindowCommands.read(*parcel);
944 
945     count = static_cast<size_t>(parcel->readUint32());
946     if (count > parcel->dataSize()) {
947         return BAD_VALUE;
948     }
949     std::vector<client_cache_t> uncacheBuffers(count);
950     for (size_t i = 0; i < count; i++) {
951         sp<IBinder> tmpBinder;
952         SAFE_PARCEL(parcel->readStrongBinder, &tmpBinder);
953         uncacheBuffers[i].token = tmpBinder;
954         SAFE_PARCEL(parcel->readUint64, &uncacheBuffers[i].id);
955     }
956 
957     count = static_cast<size_t>(parcel->readUint32());
958     if (count > parcel->dataSize()) {
959         return BAD_VALUE;
960     }
961     std::vector<uint64_t> mergedTransactionIds(count);
962     for (size_t i = 0; i < count; i++) {
963         SAFE_PARCEL(parcel->readUint64, &mergedTransactionIds[i]);
964     }
965 
966     // Parsing was successful. Update the object.
967     mId = transactionId;
968     mAnimation = animation;
969     mEarlyWakeupStart = earlyWakeupStart;
970     mEarlyWakeupEnd = earlyWakeupEnd;
971     mDesiredPresentTime = desiredPresentTime;
972     mIsAutoTimestamp = isAutoTimestamp;
973     mFrameTimelineInfo = frameTimelineInfo;
974     mDisplayStates = displayStates;
975     mListenerCallbacks = listenerCallbacks;
976     mComposerStates = composerStates;
977     mInputWindowCommands = inputWindowCommands;
978     mApplyToken = applyToken;
979     mUncacheBuffers = std::move(uncacheBuffers);
980     mMergedTransactionIds = std::move(mergedTransactionIds);
981     return NO_ERROR;
982 }
983 
writeToParcel(Parcel * parcel) const984 status_t SurfaceComposerClient::Transaction::writeToParcel(Parcel* parcel) const {
985     // If we write the Transaction to a parcel, we want to ensure the Buffers are cached
986     // before crossing the IPC boundary. Otherwise the receiving party will cache the buffers
987     // but is unlikely to use them again as they are owned by the other process.
988     // You may be asking yourself, is this const cast safe? Const cast is safe up
989     // until the point where you try and write to an object that was originally const at which
990     // point we enter undefined behavior. In this case we are safe though, because there are
991     // two possibilities:
992     //    1. The SurfaceComposerClient::Transaction was originally non-const. Safe.
993     //    2. It was originall const! In this case not only was it useless, but it by definition
994     //       contains no composer states and so cacheBuffers will not perform any writes.
995 
996     const_cast<SurfaceComposerClient::Transaction*>(this)->cacheBuffers();
997 
998     parcel->writeUint64(mId);
999     parcel->writeBool(mAnimation);
1000     parcel->writeBool(mEarlyWakeupStart);
1001     parcel->writeBool(mEarlyWakeupEnd);
1002     parcel->writeInt64(mDesiredPresentTime);
1003     parcel->writeBool(mIsAutoTimestamp);
1004     parcel->writeBool(mLogCallPoints);
1005     mFrameTimelineInfo.writeToParcel(parcel);
1006     parcel->writeStrongBinder(mApplyToken);
1007     parcel->writeUint32(static_cast<uint32_t>(mDisplayStates.size()));
1008     for (auto const& displayState : mDisplayStates) {
1009         displayState.write(*parcel);
1010     }
1011 
1012     parcel->writeUint32(static_cast<uint32_t>(mListenerCallbacks.size()));
1013     for (auto const& [listener, callbackInfo] : mListenerCallbacks) {
1014         parcel->writeStrongBinder(ITransactionCompletedListener::asBinder(listener));
1015         parcel->writeUint32(static_cast<uint32_t>(callbackInfo.callbackIds.size()));
1016         for (auto callbackId : callbackInfo.callbackIds) {
1017             parcel->writeParcelable(callbackId);
1018         }
1019         parcel->writeUint32(static_cast<uint32_t>(callbackInfo.surfaceControls.size()));
1020         for (auto surfaceControl : callbackInfo.surfaceControls) {
1021             SAFE_PARCEL(surfaceControl->writeToParcel, *parcel);
1022         }
1023     }
1024 
1025     parcel->writeUint32(static_cast<uint32_t>(mComposerStates.size()));
1026     for (auto const& [handle, composerState] : mComposerStates) {
1027         SAFE_PARCEL(parcel->writeStrongBinder, handle);
1028         composerState.write(*parcel);
1029     }
1030 
1031     mInputWindowCommands.write(*parcel);
1032 
1033     SAFE_PARCEL(parcel->writeUint32, static_cast<uint32_t>(mUncacheBuffers.size()));
1034     for (const client_cache_t& uncacheBuffer : mUncacheBuffers) {
1035         SAFE_PARCEL(parcel->writeStrongBinder, uncacheBuffer.token.promote());
1036         SAFE_PARCEL(parcel->writeUint64, uncacheBuffer.id);
1037     }
1038 
1039     SAFE_PARCEL(parcel->writeUint32, static_cast<uint32_t>(mMergedTransactionIds.size()));
1040     for (auto mergedTransactionId : mMergedTransactionIds) {
1041         SAFE_PARCEL(parcel->writeUint64, mergedTransactionId);
1042     }
1043 
1044     return NO_ERROR;
1045 }
1046 
releaseBufferIfOverwriting(const layer_state_t & state)1047 void SurfaceComposerClient::Transaction::releaseBufferIfOverwriting(const layer_state_t& state) {
1048     if (!(state.what & layer_state_t::eBufferChanged) || !state.bufferData->hasBuffer()) {
1049         return;
1050     }
1051 
1052     auto listener = state.bufferData->releaseBufferListener;
1053     sp<Fence> fence =
1054             state.bufferData->acquireFence ? state.bufferData->acquireFence : Fence::NO_FENCE;
1055     if (state.bufferData->releaseBufferEndpoint ==
1056         IInterface::asBinder(TransactionCompletedListener::getIInstance())) {
1057         // if the callback is in process, run on a different thread to avoid any lock contigency
1058         // issues in the client.
1059         SurfaceComposerClient::getDefault()
1060                 ->mReleaseCallbackThread
1061                 .addReleaseCallback(state.bufferData->generateReleaseCallbackId(), fence);
1062     } else {
1063         listener->onReleaseBuffer(state.bufferData->generateReleaseCallbackId(), fence, UINT_MAX);
1064     }
1065 }
1066 
merge(Transaction && other)1067 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::merge(Transaction&& other) {
1068     while (mMergedTransactionIds.size() + other.mMergedTransactionIds.size() >
1069                    MAX_MERGE_HISTORY_LENGTH - 1 &&
1070            mMergedTransactionIds.size() > 0) {
1071         mMergedTransactionIds.pop_back();
1072     }
1073     if (other.mMergedTransactionIds.size() == MAX_MERGE_HISTORY_LENGTH) {
1074         mMergedTransactionIds.insert(mMergedTransactionIds.begin(),
1075                                      other.mMergedTransactionIds.begin(),
1076                                      other.mMergedTransactionIds.end() - 1);
1077     } else if (other.mMergedTransactionIds.size() > 0u) {
1078         mMergedTransactionIds.insert(mMergedTransactionIds.begin(),
1079                                      other.mMergedTransactionIds.begin(),
1080                                      other.mMergedTransactionIds.end());
1081     }
1082     mMergedTransactionIds.insert(mMergedTransactionIds.begin(), other.mId);
1083 
1084     for (auto const& [handle, composerState] : other.mComposerStates) {
1085         if (mComposerStates.count(handle) == 0) {
1086             mComposerStates[handle] = composerState;
1087         } else {
1088             if (composerState.state.what & layer_state_t::eBufferChanged) {
1089                 releaseBufferIfOverwriting(mComposerStates[handle].state);
1090             }
1091             mComposerStates[handle].state.merge(composerState.state);
1092         }
1093     }
1094 
1095     for (auto const& state : other.mDisplayStates) {
1096         ssize_t index = mDisplayStates.indexOf(state);
1097         if (index < 0) {
1098             mDisplayStates.add(state);
1099         } else {
1100             mDisplayStates.editItemAt(static_cast<size_t>(index)).merge(state);
1101         }
1102     }
1103 
1104     for (const auto& [listener, callbackInfo] : other.mListenerCallbacks) {
1105         auto& [callbackIds, surfaceControls] = callbackInfo;
1106         mListenerCallbacks[listener].callbackIds.insert(std::make_move_iterator(
1107                                                                 callbackIds.begin()),
1108                                                         std::make_move_iterator(callbackIds.end()));
1109 
1110         mListenerCallbacks[listener].surfaceControls.insert(surfaceControls.begin(),
1111                                                             surfaceControls.end());
1112 
1113         auto& currentProcessCallbackInfo =
1114                 mListenerCallbacks[TransactionCompletedListener::getIInstance()];
1115         currentProcessCallbackInfo.surfaceControls
1116                 .insert(std::make_move_iterator(surfaceControls.begin()),
1117                         std::make_move_iterator(surfaceControls.end()));
1118 
1119         // register all surface controls for all callbackIds for this listener that is merging
1120         for (const auto& surfaceControl : currentProcessCallbackInfo.surfaceControls) {
1121             mTransactionCompletedListener
1122                     ->addSurfaceControlToCallbacks(surfaceControl,
1123                                                    currentProcessCallbackInfo.callbackIds);
1124         }
1125     }
1126 
1127     for (const auto& cacheId : other.mUncacheBuffers) {
1128         mUncacheBuffers.push_back(cacheId);
1129     }
1130 
1131     mInputWindowCommands.merge(other.mInputWindowCommands);
1132 
1133     mMayContainBuffer |= other.mMayContainBuffer;
1134     mEarlyWakeupStart = mEarlyWakeupStart || other.mEarlyWakeupStart;
1135     mEarlyWakeupEnd = mEarlyWakeupEnd || other.mEarlyWakeupEnd;
1136     mApplyToken = other.mApplyToken;
1137 
1138     mergeFrameTimelineInfo(mFrameTimelineInfo, other.mFrameTimelineInfo);
1139 
1140     mLogCallPoints |= other.mLogCallPoints;
1141     if (mLogCallPoints) {
1142         ALOG(LOG_DEBUG, LOG_SURFACE_CONTROL_REGISTRY,
1143              "Transaction %" PRIu64 " merged with transaction %" PRIu64, other.getId(), mId);
1144     }
1145 
1146     other.clear();
1147     return *this;
1148 }
1149 
clear()1150 void SurfaceComposerClient::Transaction::clear() {
1151     mComposerStates.clear();
1152     mDisplayStates.clear();
1153     mListenerCallbacks.clear();
1154     mInputWindowCommands.clear();
1155     mUncacheBuffers.clear();
1156     mMayContainBuffer = false;
1157     mAnimation = false;
1158     mEarlyWakeupStart = false;
1159     mEarlyWakeupEnd = false;
1160     mDesiredPresentTime = 0;
1161     mIsAutoTimestamp = true;
1162     mFrameTimelineInfo = {};
1163     mApplyToken = nullptr;
1164     mMergedTransactionIds.clear();
1165     mLogCallPoints = false;
1166 }
1167 
getId()1168 uint64_t SurfaceComposerClient::Transaction::getId() {
1169     return mId;
1170 }
1171 
getMergedTransactionIds()1172 std::vector<uint64_t> SurfaceComposerClient::Transaction::getMergedTransactionIds() {
1173     return mMergedTransactionIds;
1174 }
1175 
doUncacheBufferTransaction(uint64_t cacheId)1176 void SurfaceComposerClient::doUncacheBufferTransaction(uint64_t cacheId) {
1177     sp<ISurfaceComposer> sf(ComposerService::getComposerService());
1178 
1179     client_cache_t uncacheBuffer;
1180     uncacheBuffer.token = BufferCache::getInstance().getToken();
1181     uncacheBuffer.id = cacheId;
1182     Vector<ComposerState> composerStates;
1183     Vector<DisplayState> displayStates;
1184     status_t status = sf->setTransactionState(FrameTimelineInfo{}, composerStates, displayStates,
1185                                               ISurfaceComposer::eOneWay,
1186                                               Transaction::getDefaultApplyToken(), {}, systemTime(),
1187                                               true, {uncacheBuffer}, false, {}, generateId(), {});
1188     if (status != NO_ERROR) {
1189         ALOGE_AND_TRACE("SurfaceComposerClient::doUncacheBufferTransaction - %s",
1190                         strerror(-status));
1191     }
1192 }
1193 
cacheBuffers()1194 void SurfaceComposerClient::Transaction::cacheBuffers() {
1195     if (!mMayContainBuffer) {
1196         return;
1197     }
1198 
1199     size_t count = 0;
1200     for (auto& [handle, cs] : mComposerStates) {
1201         layer_state_t* s = &(mComposerStates[handle].state);
1202         if (!(s->what & layer_state_t::eBufferChanged)) {
1203             continue;
1204         } else if (s->bufferData &&
1205                    s->bufferData->flags.test(BufferData::BufferDataChange::cachedBufferChanged)) {
1206             // If eBufferChanged and eCachedBufferChanged are both trued then that means
1207             // we already cached the buffer in a previous call to cacheBuffers, perhaps
1208             // from writeToParcel on a Transaction that was merged in to this one.
1209             continue;
1210         }
1211 
1212         // Don't try to cache a null buffer. Sending null buffers is cheap so we shouldn't waste
1213         // time trying to cache them.
1214         if (!s->bufferData || !s->bufferData->buffer) {
1215             continue;
1216         }
1217 
1218         uint64_t cacheId = 0;
1219         status_t ret = BufferCache::getInstance().getCacheId(s->bufferData->buffer, &cacheId);
1220         if (ret == NO_ERROR) {
1221             // Cache-hit. Strip the buffer and send only the id.
1222             s->bufferData->buffer = nullptr;
1223         } else {
1224             // Cache-miss. Include the buffer and send the new cacheId.
1225             std::optional<client_cache_t> uncacheBuffer;
1226             cacheId = BufferCache::getInstance().cache(s->bufferData->buffer, uncacheBuffer);
1227             if (uncacheBuffer) {
1228                 mUncacheBuffers.push_back(*uncacheBuffer);
1229             }
1230         }
1231         s->bufferData->flags |= BufferData::BufferDataChange::cachedBufferChanged;
1232         s->bufferData->cachedBuffer.token = BufferCache::getInstance().getToken();
1233         s->bufferData->cachedBuffer.id = cacheId;
1234 
1235         // If we have more buffers than the size of the cache, we should stop caching so we don't
1236         // evict other buffers in this transaction
1237         count++;
1238         if (count >= BUFFER_CACHE_MAX_SIZE) {
1239             break;
1240         }
1241     }
1242 }
1243 
1244 class SyncCallback {
1245 public:
getCallback(std::shared_ptr<SyncCallback> & callbackContext)1246     static auto getCallback(std::shared_ptr<SyncCallback>& callbackContext) {
1247         return [callbackContext](void* /* unused context */, nsecs_t /* latchTime */,
1248                                  const sp<Fence>& /* presentFence */,
1249                                  const std::vector<SurfaceControlStats>& /* stats */) {
1250             if (!callbackContext) {
1251                 ALOGE("failed to get callback context for SyncCallback");
1252                 return;
1253             }
1254             LOG_ALWAYS_FATAL_IF(sem_post(&callbackContext->mSemaphore), "sem_post failed");
1255         };
1256     }
~SyncCallback()1257     ~SyncCallback() {
1258         if (mInitialized) {
1259             LOG_ALWAYS_FATAL_IF(sem_destroy(&mSemaphore), "sem_destroy failed");
1260         }
1261     }
init()1262     void init() {
1263         LOG_ALWAYS_FATAL_IF(clock_gettime(CLOCK_MONOTONIC, &mTimeoutTimespec) == -1,
1264                             "clock_gettime() fail! in SyncCallback::init");
1265         mTimeoutTimespec.tv_sec += 4;
1266         LOG_ALWAYS_FATAL_IF(sem_init(&mSemaphore, 0, 0), "sem_init failed");
1267         mInitialized = true;
1268     }
wait()1269     void wait() {
1270         int result = sem_clockwait(&mSemaphore, CLOCK_MONOTONIC, &mTimeoutTimespec);
1271         if (result && errno != ETIMEDOUT && errno != EINTR) {
1272             LOG_ALWAYS_FATAL("sem_clockwait failed(%d)", errno);
1273         } else if (errno == ETIMEDOUT) {
1274             ALOGW("Sync transaction timed out waiting for commit callback.");
1275         }
1276     }
getContext()1277     void* getContext() { return static_cast<void*>(this); }
1278 
1279 private:
1280     sem_t mSemaphore;
1281     bool mInitialized = false;
1282     timespec mTimeoutTimespec;
1283 };
1284 
apply(bool synchronous,bool oneWay)1285 status_t SurfaceComposerClient::Transaction::apply(bool synchronous, bool oneWay) {
1286     if (mStatus != NO_ERROR) {
1287         return mStatus;
1288     }
1289 
1290     std::shared_ptr<SyncCallback> syncCallback = std::make_shared<SyncCallback>();
1291     if (synchronous) {
1292         syncCallback->init();
1293         addTransactionCommittedCallback(SyncCallback::getCallback(syncCallback),
1294                                         /*callbackContext=*/nullptr);
1295     }
1296 
1297     bool hasListenerCallbacks = !mListenerCallbacks.empty();
1298     std::vector<ListenerCallbacks> listenerCallbacks;
1299     // For every listener with registered callbacks
1300     for (const auto& [listener, callbackInfo] : mListenerCallbacks) {
1301         auto& [callbackIds, surfaceControls] = callbackInfo;
1302         if (callbackIds.empty()) {
1303             continue;
1304         }
1305 
1306         if (surfaceControls.empty()) {
1307             listenerCallbacks.emplace_back(IInterface::asBinder(listener), std::move(callbackIds));
1308         } else {
1309             // If the listener has any SurfaceControls set on this Transaction update the surface
1310             // state
1311             for (const auto& surfaceControl : surfaceControls) {
1312                 layer_state_t* s = getLayerState(surfaceControl);
1313                 if (!s) {
1314                     ALOGE("failed to get layer state");
1315                     continue;
1316                 }
1317                 std::vector<CallbackId> callbacks(callbackIds.begin(), callbackIds.end());
1318                 s->what |= layer_state_t::eHasListenerCallbacksChanged;
1319                 s->listeners.emplace_back(IInterface::asBinder(listener), callbacks);
1320             }
1321         }
1322     }
1323 
1324     cacheBuffers();
1325 
1326     Vector<ComposerState> composerStates;
1327     Vector<DisplayState> displayStates;
1328     uint32_t flags = 0;
1329 
1330     for (auto const& kv : mComposerStates) {
1331         composerStates.add(kv.second);
1332     }
1333 
1334     displayStates = std::move(mDisplayStates);
1335 
1336     if (mAnimation) {
1337         flags |= ISurfaceComposer::eAnimation;
1338     }
1339     if (oneWay) {
1340         if (synchronous) {
1341             ALOGE("Transaction attempted to set synchronous and one way at the same time"
1342                   " this is an invalid request. Synchronous will win for safety");
1343         } else {
1344             flags |= ISurfaceComposer::eOneWay;
1345         }
1346     }
1347 
1348     // If both mEarlyWakeupStart and mEarlyWakeupEnd are set
1349     // it is equivalent for none
1350     if (mEarlyWakeupStart && !mEarlyWakeupEnd) {
1351         flags |= ISurfaceComposer::eEarlyWakeupStart;
1352     }
1353     if (mEarlyWakeupEnd && !mEarlyWakeupStart) {
1354         flags |= ISurfaceComposer::eEarlyWakeupEnd;
1355     }
1356 
1357     sp<IBinder> applyToken = mApplyToken ? mApplyToken : getDefaultApplyToken();
1358 
1359     sp<ISurfaceComposer> sf(ComposerService::getComposerService());
1360     status_t binderStatus =
1361             sf->setTransactionState(mFrameTimelineInfo, composerStates, displayStates, flags,
1362                                     applyToken, mInputWindowCommands, mDesiredPresentTime,
1363                                     mIsAutoTimestamp, mUncacheBuffers, hasListenerCallbacks,
1364                                     listenerCallbacks, mId, mMergedTransactionIds);
1365     mId = generateId();
1366 
1367     // Clear the current states and flags
1368     clear();
1369 
1370     if (synchronous && binderStatus == OK) {
1371         syncCallback->wait();
1372     }
1373 
1374     if (mLogCallPoints) {
1375         ALOG(LOG_DEBUG, LOG_SURFACE_CONTROL_REGISTRY, "Transaction %" PRIu64 " applied", mId);
1376     }
1377 
1378     mStatus = NO_ERROR;
1379     return binderStatus;
1380 }
1381 
1382 sp<IBinder> SurfaceComposerClient::Transaction::sApplyToken = new BBinder();
1383 
1384 std::mutex SurfaceComposerClient::Transaction::sApplyTokenMutex;
1385 
getDefaultApplyToken()1386 sp<IBinder> SurfaceComposerClient::Transaction::getDefaultApplyToken() {
1387     std::scoped_lock lock{sApplyTokenMutex};
1388     return sApplyToken;
1389 }
1390 
setDefaultApplyToken(sp<IBinder> applyToken)1391 void SurfaceComposerClient::Transaction::setDefaultApplyToken(sp<IBinder> applyToken) {
1392     std::scoped_lock lock{sApplyTokenMutex};
1393     sApplyToken = std::move(applyToken);
1394 }
1395 
sendSurfaceFlushJankDataTransaction(const sp<SurfaceControl> & sc)1396 status_t SurfaceComposerClient::Transaction::sendSurfaceFlushJankDataTransaction(
1397         const sp<SurfaceControl>& sc) {
1398     Transaction t;
1399     layer_state_t* s = t.getLayerState(sc);
1400     if (!s) {
1401         return BAD_INDEX;
1402     }
1403 
1404     s->what |= layer_state_t::eFlushJankData;
1405     t.registerSurfaceControlForCallback(sc);
1406     return t.apply(/*sync=*/false, /* oneWay=*/true);
1407 }
1408 
enableDebugLogCallPoints()1409 void SurfaceComposerClient::Transaction::enableDebugLogCallPoints() {
1410     mLogCallPoints = true;
1411 }
1412 
1413 // ---------------------------------------------------------------------------
1414 
createVirtualDisplay(const std::string & displayName,bool isSecure,const std::string & uniqueId,float requestedRefreshRate)1415 sp<IBinder> SurfaceComposerClient::createVirtualDisplay(const std::string& displayName,
1416                                                         bool isSecure, const std::string& uniqueId,
1417                                                         float requestedRefreshRate) {
1418     sp<IBinder> display = nullptr;
1419     binder::Status status =
1420             ComposerServiceAIDL::getComposerService()->createVirtualDisplay(displayName, isSecure,
1421                                                                             uniqueId,
1422                                                                             requestedRefreshRate,
1423                                                                             &display);
1424     return status.isOk() ? display : nullptr;
1425 }
1426 
destroyVirtualDisplay(const sp<IBinder> & displayToken)1427 status_t SurfaceComposerClient::destroyVirtualDisplay(const sp<IBinder>& displayToken) {
1428     return ComposerServiceAIDL::getComposerService()
1429             ->destroyVirtualDisplay(displayToken)
1430             .transactionError();
1431 }
1432 
getPhysicalDisplayIds()1433 std::vector<PhysicalDisplayId> SurfaceComposerClient::getPhysicalDisplayIds() {
1434     std::vector<int64_t> displayIds;
1435     std::vector<PhysicalDisplayId> physicalDisplayIds;
1436     binder::Status status =
1437             ComposerServiceAIDL::getComposerService()->getPhysicalDisplayIds(&displayIds);
1438     if (status.isOk()) {
1439         physicalDisplayIds.reserve(displayIds.size());
1440         for (auto item : displayIds) {
1441             auto id = DisplayId::fromValue<PhysicalDisplayId>(static_cast<uint64_t>(item));
1442             physicalDisplayIds.push_back(*id);
1443         }
1444     }
1445     return physicalDisplayIds;
1446 }
1447 
getPhysicalDisplayToken(PhysicalDisplayId displayId)1448 sp<IBinder> SurfaceComposerClient::getPhysicalDisplayToken(PhysicalDisplayId displayId) {
1449     sp<IBinder> display = nullptr;
1450     binder::Status status =
1451             ComposerServiceAIDL::getComposerService()->getPhysicalDisplayToken(displayId.value,
1452                                                                                &display);
1453     return status.isOk() ? display : nullptr;
1454 }
1455 
getStalledTransactionInfo(pid_t pid)1456 std::optional<gui::StalledTransactionInfo> SurfaceComposerClient::getStalledTransactionInfo(
1457         pid_t pid) {
1458     std::optional<gui::StalledTransactionInfo> result;
1459     ComposerServiceAIDL::getComposerService()->getStalledTransactionInfo(pid, &result);
1460     return result;
1461 }
1462 
setAnimationTransaction()1463 void SurfaceComposerClient::Transaction::setAnimationTransaction() {
1464     mAnimation = true;
1465 }
1466 
setEarlyWakeupStart()1467 void SurfaceComposerClient::Transaction::setEarlyWakeupStart() {
1468     mEarlyWakeupStart = true;
1469 }
1470 
setEarlyWakeupEnd()1471 void SurfaceComposerClient::Transaction::setEarlyWakeupEnd() {
1472     mEarlyWakeupEnd = true;
1473 }
1474 
getLayerState(const sp<SurfaceControl> & sc)1475 layer_state_t* SurfaceComposerClient::Transaction::getLayerState(const sp<SurfaceControl>& sc) {
1476     auto handle = sc->getLayerStateHandle();
1477 
1478     if (mComposerStates.count(handle) == 0) {
1479         // we don't have it, add an initialized layer_state to our list
1480         ComposerState s;
1481 
1482         s.state.surface = handle;
1483         s.state.layerId = sc->getLayerId();
1484 
1485         mComposerStates[handle] = s;
1486     }
1487 
1488     return &(mComposerStates[handle].state);
1489 }
1490 
registerSurfaceControlForCallback(const sp<SurfaceControl> & sc)1491 void SurfaceComposerClient::Transaction::registerSurfaceControlForCallback(
1492         const sp<SurfaceControl>& sc) {
1493     auto& callbackInfo = mListenerCallbacks[TransactionCompletedListener::getIInstance()];
1494     callbackInfo.surfaceControls.insert(sc);
1495 
1496     mTransactionCompletedListener->addSurfaceControlToCallbacks(sc, callbackInfo.callbackIds);
1497 }
1498 
setPosition(const sp<SurfaceControl> & sc,float x,float y)1499 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setPosition(
1500         const sp<SurfaceControl>& sc, float x, float y) {
1501     layer_state_t* s = getLayerState(sc);
1502     if (!s) {
1503         mStatus = BAD_INDEX;
1504         return *this;
1505     }
1506     s->what |= layer_state_t::ePositionChanged;
1507     s->x = x;
1508     s->y = y;
1509 
1510     registerSurfaceControlForCallback(sc);
1511     return *this;
1512 }
1513 
show(const sp<SurfaceControl> & sc)1514 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::show(
1515         const sp<SurfaceControl>& sc) {
1516     return setFlags(sc, 0, layer_state_t::eLayerHidden);
1517 }
1518 
hide(const sp<SurfaceControl> & sc)1519 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::hide(
1520         const sp<SurfaceControl>& sc) {
1521     return setFlags(sc, layer_state_t::eLayerHidden, layer_state_t::eLayerHidden);
1522 }
1523 
setLayer(const sp<SurfaceControl> & sc,int32_t z)1524 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setLayer(
1525         const sp<SurfaceControl>& sc, int32_t z) {
1526     layer_state_t* s = getLayerState(sc);
1527     if (!s) {
1528         mStatus = BAD_INDEX;
1529         return *this;
1530     }
1531     s->what |= layer_state_t::eLayerChanged;
1532     s->what &= ~layer_state_t::eRelativeLayerChanged;
1533     s->z = z;
1534 
1535     registerSurfaceControlForCallback(sc);
1536     return *this;
1537 }
1538 
setRelativeLayer(const sp<SurfaceControl> & sc,const sp<SurfaceControl> & relativeTo,int32_t z)1539 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setRelativeLayer(
1540         const sp<SurfaceControl>& sc, const sp<SurfaceControl>& relativeTo, int32_t z) {
1541     layer_state_t* s = getLayerState(sc);
1542     if (!s) {
1543         mStatus = BAD_INDEX;
1544         return *this;
1545     }
1546     s->what |= layer_state_t::eRelativeLayerChanged;
1547     s->what &= ~layer_state_t::eLayerChanged;
1548     s->relativeLayerSurfaceControl = relativeTo;
1549     s->z = z;
1550 
1551     registerSurfaceControlForCallback(sc);
1552     return *this;
1553 }
1554 
setFlags(const sp<SurfaceControl> & sc,uint32_t flags,uint32_t mask)1555 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setFlags(
1556         const sp<SurfaceControl>& sc, uint32_t flags,
1557         uint32_t mask) {
1558     layer_state_t* s = getLayerState(sc);
1559     if (!s) {
1560         mStatus = BAD_INDEX;
1561         return *this;
1562     }
1563     s->what |= layer_state_t::eFlagsChanged;
1564     s->flags &= ~mask;
1565     s->flags |= (flags & mask);
1566     s->mask |= mask;
1567 
1568     registerSurfaceControlForCallback(sc);
1569     return *this;
1570 }
1571 
setTransparentRegionHint(const sp<SurfaceControl> & sc,const Region & transparentRegion)1572 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setTransparentRegionHint(
1573         const sp<SurfaceControl>& sc,
1574         const Region& transparentRegion) {
1575     layer_state_t* s = getLayerState(sc);
1576     if (!s) {
1577         mStatus = BAD_INDEX;
1578         return *this;
1579     }
1580     s->what |= layer_state_t::eTransparentRegionChanged;
1581     s->transparentRegion = transparentRegion;
1582 
1583     registerSurfaceControlForCallback(sc);
1584     return *this;
1585 }
1586 
setDimmingEnabled(const sp<SurfaceControl> & sc,bool dimmingEnabled)1587 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setDimmingEnabled(
1588         const sp<SurfaceControl>& sc, bool dimmingEnabled) {
1589     layer_state_t* s = getLayerState(sc);
1590     if (!s) {
1591         mStatus = BAD_INDEX;
1592         return *this;
1593     }
1594     s->what |= layer_state_t::eDimmingEnabledChanged;
1595     s->dimmingEnabled = dimmingEnabled;
1596 
1597     registerSurfaceControlForCallback(sc);
1598     return *this;
1599 }
1600 
setAlpha(const sp<SurfaceControl> & sc,float alpha)1601 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setAlpha(
1602         const sp<SurfaceControl>& sc, float alpha) {
1603     layer_state_t* s = getLayerState(sc);
1604     if (!s) {
1605         mStatus = BAD_INDEX;
1606         return *this;
1607     }
1608     if (alpha < 0.0f || alpha > 1.0f) {
1609         ALOGE("SurfaceComposerClient::Transaction::setAlpha: invalid alpha %f, clamping", alpha);
1610     }
1611     s->what |= layer_state_t::eAlphaChanged;
1612     s->color.a = std::clamp(alpha, 0.f, 1.f);
1613 
1614     registerSurfaceControlForCallback(sc);
1615     return *this;
1616 }
1617 
setLayerStack(const sp<SurfaceControl> & sc,ui::LayerStack layerStack)1618 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setLayerStack(
1619         const sp<SurfaceControl>& sc, ui::LayerStack layerStack) {
1620     layer_state_t* s = getLayerState(sc);
1621     if (!s) {
1622         mStatus = BAD_INDEX;
1623         return *this;
1624     }
1625     s->what |= layer_state_t::eLayerStackChanged;
1626     s->layerStack = layerStack;
1627 
1628     registerSurfaceControlForCallback(sc);
1629     return *this;
1630 }
1631 
setMetadata(const sp<SurfaceControl> & sc,uint32_t key,const Parcel & p)1632 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setMetadata(
1633         const sp<SurfaceControl>& sc, uint32_t key, const Parcel& p) {
1634     layer_state_t* s = getLayerState(sc);
1635     if (!s) {
1636         mStatus = BAD_INDEX;
1637         return *this;
1638     }
1639     s->what |= layer_state_t::eMetadataChanged;
1640 
1641     s->metadata.mMap[key] = {p.data(), p.data() + p.dataSize()};
1642 
1643     registerSurfaceControlForCallback(sc);
1644     return *this;
1645 }
1646 
setMatrix(const sp<SurfaceControl> & sc,float dsdx,float dtdx,float dtdy,float dsdy)1647 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setMatrix(
1648         const sp<SurfaceControl>& sc, float dsdx, float dtdx,
1649         float dtdy, float dsdy) {
1650     layer_state_t* s = getLayerState(sc);
1651     if (!s) {
1652         mStatus = BAD_INDEX;
1653         return *this;
1654     }
1655     s->what |= layer_state_t::eMatrixChanged;
1656     layer_state_t::matrix22_t matrix;
1657     matrix.dsdx = dsdx;
1658     matrix.dtdx = dtdx;
1659     matrix.dsdy = dsdy;
1660     matrix.dtdy = dtdy;
1661     s->matrix = matrix;
1662 
1663     registerSurfaceControlForCallback(sc);
1664     return *this;
1665 }
1666 
setCrop(const sp<SurfaceControl> & sc,const Rect & crop)1667 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setCrop(
1668         const sp<SurfaceControl>& sc, const Rect& crop) {
1669     return setCrop(sc, crop.toFloatRect());
1670 }
1671 
setCrop(const sp<SurfaceControl> & sc,const FloatRect & crop)1672 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setCrop(
1673         const sp<SurfaceControl>& sc, const FloatRect& crop) {
1674     layer_state_t* s = getLayerState(sc);
1675     if (!s) {
1676         mStatus = BAD_INDEX;
1677         return *this;
1678     }
1679     s->what |= layer_state_t::eCropChanged;
1680     s->crop = crop;
1681 
1682     registerSurfaceControlForCallback(sc);
1683     return *this;
1684 }
1685 
setCornerRadius(const sp<SurfaceControl> & sc,float cornerRadius)1686 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setCornerRadius(
1687         const sp<SurfaceControl>& sc, float cornerRadius) {
1688     layer_state_t* s = getLayerState(sc);
1689     if (!s) {
1690         mStatus = BAD_INDEX;
1691         return *this;
1692     }
1693     s->what |= layer_state_t::eCornerRadiusChanged;
1694     s->cornerRadius = cornerRadius;
1695     return *this;
1696 }
1697 
setBackgroundBlurRadius(const sp<SurfaceControl> & sc,int backgroundBlurRadius)1698 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBackgroundBlurRadius(
1699         const sp<SurfaceControl>& sc, int backgroundBlurRadius) {
1700     layer_state_t* s = getLayerState(sc);
1701     if (!s) {
1702         mStatus = BAD_INDEX;
1703         return *this;
1704     }
1705     s->what |= layer_state_t::eBackgroundBlurRadiusChanged;
1706     s->backgroundBlurRadius = backgroundBlurRadius;
1707     return *this;
1708 }
1709 
setBlurRegions(const sp<SurfaceControl> & sc,const std::vector<BlurRegion> & blurRegions)1710 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBlurRegions(
1711         const sp<SurfaceControl>& sc, const std::vector<BlurRegion>& blurRegions) {
1712     layer_state_t* s = getLayerState(sc);
1713     if (!s) {
1714         mStatus = BAD_INDEX;
1715         return *this;
1716     }
1717     s->what |= layer_state_t::eBlurRegionsChanged;
1718     s->blurRegions = blurRegions;
1719     return *this;
1720 }
1721 
reparent(const sp<SurfaceControl> & sc,const sp<SurfaceControl> & newParent)1722 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::reparent(
1723         const sp<SurfaceControl>& sc, const sp<SurfaceControl>& newParent) {
1724     layer_state_t* s = getLayerState(sc);
1725     if (!s) {
1726         mStatus = BAD_INDEX;
1727         return *this;
1728     }
1729     if (SurfaceControl::isSameSurface(sc, newParent)) {
1730         return *this;
1731     }
1732     s->what |= layer_state_t::eReparent;
1733     s->parentSurfaceControlForChild = newParent ? newParent->getParentingLayer() : nullptr;
1734 
1735     registerSurfaceControlForCallback(sc);
1736     return *this;
1737 }
1738 
setColor(const sp<SurfaceControl> & sc,const half3 & color)1739 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setColor(
1740         const sp<SurfaceControl>& sc,
1741         const half3& color) {
1742     layer_state_t* s = getLayerState(sc);
1743     if (!s) {
1744         mStatus = BAD_INDEX;
1745         return *this;
1746     }
1747     s->what |= layer_state_t::eColorChanged;
1748     s->color.rgb = color;
1749 
1750     registerSurfaceControlForCallback(sc);
1751     return *this;
1752 }
1753 
setBackgroundColor(const sp<SurfaceControl> & sc,const half3 & color,float alpha,ui::Dataspace dataspace)1754 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBackgroundColor(
1755         const sp<SurfaceControl>& sc, const half3& color, float alpha, ui::Dataspace dataspace) {
1756     layer_state_t* s = getLayerState(sc);
1757     if (!s) {
1758         mStatus = BAD_INDEX;
1759         return *this;
1760     }
1761 
1762     s->what |= layer_state_t::eBackgroundColorChanged;
1763     s->bgColor.rgb = color;
1764     s->bgColor.a = alpha;
1765     s->bgColorDataspace = dataspace;
1766 
1767     registerSurfaceControlForCallback(sc);
1768     return *this;
1769 }
1770 
setTransform(const sp<SurfaceControl> & sc,uint32_t transform)1771 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setTransform(
1772         const sp<SurfaceControl>& sc, uint32_t transform) {
1773     layer_state_t* s = getLayerState(sc);
1774     if (!s) {
1775         mStatus = BAD_INDEX;
1776         return *this;
1777     }
1778     s->what |= layer_state_t::eBufferTransformChanged;
1779     s->bufferTransform = transform;
1780 
1781     registerSurfaceControlForCallback(sc);
1782     return *this;
1783 }
1784 
1785 SurfaceComposerClient::Transaction&
setTransformToDisplayInverse(const sp<SurfaceControl> & sc,bool transformToDisplayInverse)1786 SurfaceComposerClient::Transaction::setTransformToDisplayInverse(const sp<SurfaceControl>& sc,
1787                                                                  bool transformToDisplayInverse) {
1788     layer_state_t* s = getLayerState(sc);
1789     if (!s) {
1790         mStatus = BAD_INDEX;
1791         return *this;
1792     }
1793     s->what |= layer_state_t::eTransformToDisplayInverseChanged;
1794     s->transformToDisplayInverse = transformToDisplayInverse;
1795 
1796     registerSurfaceControlForCallback(sc);
1797     return *this;
1798 }
1799 
getAndClearBuffer(const sp<SurfaceControl> & sc)1800 std::shared_ptr<BufferData> SurfaceComposerClient::Transaction::getAndClearBuffer(
1801         const sp<SurfaceControl>& sc) {
1802     layer_state_t* s = getLayerState(sc);
1803     if (!s) {
1804         return nullptr;
1805     }
1806     if (!(s->what & layer_state_t::eBufferChanged)) {
1807         return nullptr;
1808     }
1809 
1810     std::shared_ptr<BufferData> bufferData = std::move(s->bufferData);
1811 
1812     mTransactionCompletedListener->removeReleaseBufferCallback(
1813             bufferData->generateReleaseCallbackId());
1814     s->what &= ~layer_state_t::eBufferChanged;
1815     s->bufferData = nullptr;
1816 
1817     return bufferData;
1818 }
1819 
setBufferHasBarrier(const sp<SurfaceControl> & sc,uint64_t barrierFrameNumber)1820 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBufferHasBarrier(
1821         const sp<SurfaceControl>& sc, uint64_t barrierFrameNumber) {
1822     layer_state_t* s = getLayerState(sc);
1823     if (!s) {
1824         mStatus = BAD_INDEX;
1825         return *this;
1826     }
1827     s->bufferData->hasBarrier = true;
1828     s->bufferData->barrierFrameNumber = barrierFrameNumber;
1829     return *this;
1830 }
1831 
setBuffer(const sp<SurfaceControl> & sc,const sp<GraphicBuffer> & buffer,const std::optional<sp<Fence>> & fence,const std::optional<uint64_t> & optFrameNumber,uint32_t producerId,ReleaseBufferCallback callback,nsecs_t dequeueTime)1832 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBuffer(
1833         const sp<SurfaceControl>& sc, const sp<GraphicBuffer>& buffer,
1834         const std::optional<sp<Fence>>& fence, const std::optional<uint64_t>& optFrameNumber,
1835         uint32_t producerId, ReleaseBufferCallback callback, nsecs_t dequeueTime) {
1836     layer_state_t* s = getLayerState(sc);
1837     if (!s) {
1838         mStatus = BAD_INDEX;
1839         return *this;
1840     }
1841 
1842     releaseBufferIfOverwriting(*s);
1843 
1844     std::shared_ptr<BufferData> bufferData = std::make_shared<BufferData>();
1845     bufferData->buffer = buffer;
1846     if (buffer) {
1847         uint64_t frameNumber = sc->resolveFrameNumber(optFrameNumber);
1848         bufferData->frameNumber = frameNumber;
1849         bufferData->producerId = producerId;
1850         bufferData->flags |= BufferData::BufferDataChange::frameNumberChanged;
1851         bufferData->dequeueTime = dequeueTime;
1852         if (fence) {
1853             bufferData->acquireFence = *fence;
1854             bufferData->flags |= BufferData::BufferDataChange::fenceChanged;
1855         }
1856         bufferData->releaseBufferEndpoint = IInterface::asBinder(mTransactionCompletedListener);
1857         setReleaseBufferCallback(bufferData.get(), callback);
1858     }
1859 
1860     if (mIsAutoTimestamp) {
1861         mDesiredPresentTime = systemTime();
1862     }
1863     s->what |= layer_state_t::eBufferChanged;
1864     s->bufferData = std::move(bufferData);
1865     registerSurfaceControlForCallback(sc);
1866 
1867     // With the current infrastructure, a release callback will not be invoked if there's no
1868     // transaction callback in the case when a buffer is latched and not released early. This is
1869     // because the legacy implementation didn't have a release callback and sent releases in the
1870     // transaction callback. Because of this, we need to make sure to have a transaction callback
1871     // set up when a buffer is sent in a transaction to ensure the caller gets the release
1872     // callback, regardless if they set up a transaction callback.
1873     //
1874     // TODO (b/230380821): Remove when release callbacks are separated from transaction callbacks
1875     addTransactionCompletedCallback([](void*, nsecs_t, const sp<Fence>&,
1876                                        const std::vector<SurfaceControlStats>&) {},
1877                                     nullptr);
1878 
1879     mMayContainBuffer = true;
1880     return *this;
1881 }
1882 
unsetBuffer(const sp<SurfaceControl> & sc)1883 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::unsetBuffer(
1884         const sp<SurfaceControl>& sc) {
1885     layer_state_t* s = getLayerState(sc);
1886     if (!s) {
1887         mStatus = BAD_INDEX;
1888         return *this;
1889     }
1890 
1891     if (!(s->what & layer_state_t::eBufferChanged)) {
1892         return *this;
1893     }
1894 
1895     releaseBufferIfOverwriting(*s);
1896 
1897     s->what &= ~layer_state_t::eBufferChanged;
1898     s->bufferData = nullptr;
1899     return *this;
1900 }
1901 
setReleaseBufferCallback(BufferData * bufferData,ReleaseBufferCallback callback)1902 void SurfaceComposerClient::Transaction::setReleaseBufferCallback(BufferData* bufferData,
1903                                                                   ReleaseBufferCallback callback) {
1904     if (!callback) {
1905         return;
1906     }
1907 
1908     if (!bufferData->buffer) {
1909         ALOGW("Transaction::setReleaseBufferCallback"
1910               "ignored trying to set a callback on a null buffer.");
1911         return;
1912     }
1913 
1914     bufferData->releaseBufferListener =
1915             static_cast<sp<ITransactionCompletedListener>>(mTransactionCompletedListener);
1916     mTransactionCompletedListener->setReleaseBufferCallback(bufferData->generateReleaseCallbackId(),
1917                                                             callback);
1918 }
1919 
setDataspace(const sp<SurfaceControl> & sc,ui::Dataspace dataspace)1920 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setDataspace(
1921         const sp<SurfaceControl>& sc, ui::Dataspace dataspace) {
1922     layer_state_t* s = getLayerState(sc);
1923     if (!s) {
1924         mStatus = BAD_INDEX;
1925         return *this;
1926     }
1927     s->what |= layer_state_t::eDataspaceChanged;
1928     s->dataspace = dataspace;
1929 
1930     registerSurfaceControlForCallback(sc);
1931     return *this;
1932 }
1933 
setExtendedRangeBrightness(const sp<SurfaceControl> & sc,float currentBufferRatio,float desiredRatio)1934 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setExtendedRangeBrightness(
1935         const sp<SurfaceControl>& sc, float currentBufferRatio, float desiredRatio) {
1936     layer_state_t* s = getLayerState(sc);
1937     if (!s) {
1938         mStatus = BAD_INDEX;
1939         return *this;
1940     }
1941     s->what |= layer_state_t::eExtendedRangeBrightnessChanged;
1942     s->currentHdrSdrRatio = currentBufferRatio;
1943     s->desiredHdrSdrRatio = desiredRatio;
1944 
1945     registerSurfaceControlForCallback(sc);
1946     return *this;
1947 }
1948 
setDesiredHdrHeadroom(const sp<SurfaceControl> & sc,float desiredRatio)1949 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setDesiredHdrHeadroom(
1950         const sp<SurfaceControl>& sc, float desiredRatio) {
1951     layer_state_t* s = getLayerState(sc);
1952     if (!s) {
1953         mStatus = BAD_INDEX;
1954         return *this;
1955     }
1956     s->what |= layer_state_t::eDesiredHdrHeadroomChanged;
1957     s->desiredHdrSdrRatio = desiredRatio;
1958 
1959     registerSurfaceControlForCallback(sc);
1960     return *this;
1961 }
1962 
setLuts(const sp<SurfaceControl> & sc,const base::unique_fd & lutFd,const std::vector<int32_t> & offsets,const std::vector<int32_t> & dimensions,const std::vector<int32_t> & sizes,const std::vector<int32_t> & samplingKeys)1963 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setLuts(
1964         const sp<SurfaceControl>& sc, const base::unique_fd& lutFd,
1965         const std::vector<int32_t>& offsets, const std::vector<int32_t>& dimensions,
1966         const std::vector<int32_t>& sizes, const std::vector<int32_t>& samplingKeys) {
1967     layer_state_t* s = getLayerState(sc);
1968     if (!s) {
1969         mStatus = BAD_INDEX;
1970         return *this;
1971     }
1972 
1973     s->what |= layer_state_t::eLutsChanged;
1974     if (lutFd.ok()) {
1975         s->luts = std::make_shared<gui::DisplayLuts>(base::unique_fd(dup(lutFd.get())), offsets,
1976                                                      dimensions, sizes, samplingKeys);
1977     } else {
1978         s->luts = nullptr;
1979     }
1980 
1981     registerSurfaceControlForCallback(sc);
1982     return *this;
1983 }
1984 
setCachingHint(const sp<SurfaceControl> & sc,gui::CachingHint cachingHint)1985 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setCachingHint(
1986         const sp<SurfaceControl>& sc, gui::CachingHint cachingHint) {
1987     layer_state_t* s = getLayerState(sc);
1988     if (!s) {
1989         mStatus = BAD_INDEX;
1990         return *this;
1991     }
1992     s->what |= layer_state_t::eCachingHintChanged;
1993     s->cachingHint = cachingHint;
1994 
1995     registerSurfaceControlForCallback(sc);
1996     return *this;
1997 }
1998 
setHdrMetadata(const sp<SurfaceControl> & sc,const HdrMetadata & hdrMetadata)1999 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setHdrMetadata(
2000         const sp<SurfaceControl>& sc, const HdrMetadata& hdrMetadata) {
2001     layer_state_t* s = getLayerState(sc);
2002     if (!s) {
2003         mStatus = BAD_INDEX;
2004         return *this;
2005     }
2006     s->what |= layer_state_t::eHdrMetadataChanged;
2007     s->hdrMetadata = hdrMetadata;
2008 
2009     registerSurfaceControlForCallback(sc);
2010     return *this;
2011 }
2012 
setSurfaceDamageRegion(const sp<SurfaceControl> & sc,const Region & surfaceDamageRegion)2013 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setSurfaceDamageRegion(
2014         const sp<SurfaceControl>& sc, const Region& surfaceDamageRegion) {
2015     layer_state_t* s = getLayerState(sc);
2016     if (!s) {
2017         mStatus = BAD_INDEX;
2018         return *this;
2019     }
2020     s->what |= layer_state_t::eSurfaceDamageRegionChanged;
2021     s->surfaceDamageRegion = surfaceDamageRegion;
2022 
2023     registerSurfaceControlForCallback(sc);
2024     return *this;
2025 }
2026 
setApi(const sp<SurfaceControl> & sc,int32_t api)2027 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setApi(
2028         const sp<SurfaceControl>& sc, int32_t api) {
2029     layer_state_t* s = getLayerState(sc);
2030     if (!s) {
2031         mStatus = BAD_INDEX;
2032         return *this;
2033     }
2034     s->what |= layer_state_t::eApiChanged;
2035     s->api = api;
2036 
2037     registerSurfaceControlForCallback(sc);
2038     return *this;
2039 }
2040 
setSidebandStream(const sp<SurfaceControl> & sc,const sp<NativeHandle> & sidebandStream)2041 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setSidebandStream(
2042         const sp<SurfaceControl>& sc, const sp<NativeHandle>& sidebandStream) {
2043     layer_state_t* s = getLayerState(sc);
2044     if (!s) {
2045         mStatus = BAD_INDEX;
2046         return *this;
2047     }
2048     s->what |= layer_state_t::eSidebandStreamChanged;
2049     s->sidebandStream = sidebandStream;
2050 
2051     registerSurfaceControlForCallback(sc);
2052     return *this;
2053 }
2054 
setDesiredPresentTime(nsecs_t desiredPresentTime)2055 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setDesiredPresentTime(
2056         nsecs_t desiredPresentTime) {
2057     mDesiredPresentTime = desiredPresentTime;
2058     mIsAutoTimestamp = false;
2059     return *this;
2060 }
2061 
setColorSpaceAgnostic(const sp<SurfaceControl> & sc,const bool agnostic)2062 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setColorSpaceAgnostic(
2063         const sp<SurfaceControl>& sc, const bool agnostic) {
2064     layer_state_t* s = getLayerState(sc);
2065     if (!s) {
2066         mStatus = BAD_INDEX;
2067         return *this;
2068     }
2069     s->what |= layer_state_t::eColorSpaceAgnosticChanged;
2070     s->colorSpaceAgnostic = agnostic;
2071 
2072     registerSurfaceControlForCallback(sc);
2073     return *this;
2074 }
2075 
2076 SurfaceComposerClient::Transaction&
setFrameRateSelectionPriority(const sp<SurfaceControl> & sc,int32_t priority)2077 SurfaceComposerClient::Transaction::setFrameRateSelectionPriority(const sp<SurfaceControl>& sc,
2078                                                                   int32_t priority) {
2079     layer_state_t* s = getLayerState(sc);
2080     if (!s) {
2081         mStatus = BAD_INDEX;
2082         return *this;
2083     }
2084 
2085     s->what |= layer_state_t::eFrameRateSelectionPriority;
2086     s->frameRateSelectionPriority = priority;
2087 
2088     registerSurfaceControlForCallback(sc);
2089     return *this;
2090 }
2091 
addTransactionCallback(TransactionCompletedCallbackTakesContext callback,void * callbackContext,CallbackId::Type callbackType)2092 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::addTransactionCallback(
2093         TransactionCompletedCallbackTakesContext callback, void* callbackContext,
2094         CallbackId::Type callbackType) {
2095     auto callbackWithContext =
2096             std::bind(std::move(callback), callbackContext, std::placeholders::_1,
2097                       std::placeholders::_2, std::placeholders::_3);
2098     const auto& surfaceControls = mListenerCallbacks[mTransactionCompletedListener].surfaceControls;
2099 
2100     CallbackId callbackId =
2101             mTransactionCompletedListener->addCallbackFunction(callbackWithContext, surfaceControls,
2102                                                                callbackType);
2103 
2104     mListenerCallbacks[mTransactionCompletedListener].callbackIds.emplace(callbackId);
2105     return *this;
2106 }
2107 
2108 SurfaceComposerClient::Transaction&
addTransactionCompletedCallback(TransactionCompletedCallbackTakesContext callback,void * callbackContext)2109 SurfaceComposerClient::Transaction::addTransactionCompletedCallback(
2110         TransactionCompletedCallbackTakesContext callback, void* callbackContext) {
2111     return addTransactionCallback(std::move(callback), callbackContext,
2112                                   CallbackId::Type::ON_COMPLETE);
2113 }
2114 
2115 SurfaceComposerClient::Transaction&
addTransactionCommittedCallback(TransactionCompletedCallbackTakesContext callback,void * callbackContext)2116 SurfaceComposerClient::Transaction::addTransactionCommittedCallback(
2117         TransactionCompletedCallbackTakesContext callback, void* callbackContext) {
2118     return addTransactionCallback(std::move(callback), callbackContext,
2119                                   CallbackId::Type::ON_COMMIT);
2120 }
2121 
notifyProducerDisconnect(const sp<SurfaceControl> & sc)2122 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::notifyProducerDisconnect(
2123         const sp<SurfaceControl>& sc) {
2124     layer_state_t* s = getLayerState(sc);
2125     if (!s) {
2126         mStatus = BAD_INDEX;
2127         return *this;
2128     }
2129 
2130     s->what |= layer_state_t::eProducerDisconnect;
2131     return *this;
2132 }
2133 
setInputWindowInfo(const sp<SurfaceControl> & sc,sp<WindowInfoHandle> info)2134 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setInputWindowInfo(
2135         const sp<SurfaceControl>& sc, sp<WindowInfoHandle> info) {
2136     layer_state_t* s = getLayerState(sc);
2137     if (!s) {
2138         mStatus = BAD_INDEX;
2139         return *this;
2140     }
2141     s->windowInfoHandle = std::move(info);
2142     s->what |= layer_state_t::eInputInfoChanged;
2143     return *this;
2144 }
2145 
setFocusedWindow(const FocusRequest & request)2146 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setFocusedWindow(
2147         const FocusRequest& request) {
2148     mInputWindowCommands.focusRequests.push_back(request);
2149     return *this;
2150 }
2151 
2152 SurfaceComposerClient::Transaction&
addWindowInfosReportedListener(sp<gui::IWindowInfosReportedListener> windowInfosReportedListener)2153 SurfaceComposerClient::Transaction::addWindowInfosReportedListener(
2154         sp<gui::IWindowInfosReportedListener> windowInfosReportedListener) {
2155     mInputWindowCommands.windowInfosReportedListeners.insert(windowInfosReportedListener);
2156     return *this;
2157 }
2158 
setColorTransform(const sp<SurfaceControl> & sc,const mat3 & matrix,const vec3 & translation)2159 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setColorTransform(
2160     const sp<SurfaceControl>& sc, const mat3& matrix, const vec3& translation) {
2161     layer_state_t* s = getLayerState(sc);
2162     if (!s) {
2163         mStatus = BAD_INDEX;
2164         return *this;
2165     }
2166     s->what |= layer_state_t::eColorTransformChanged;
2167     s->colorTransform = mat4(matrix, translation);
2168 
2169     registerSurfaceControlForCallback(sc);
2170     return *this;
2171 }
2172 
setGeometry(const sp<SurfaceControl> & sc,const Rect & source,const Rect & dst,int transform)2173 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setGeometry(
2174         const sp<SurfaceControl>& sc, const Rect& source, const Rect& dst, int transform) {
2175     setCrop(sc, source);
2176 
2177     int x = dst.left;
2178     int y = dst.top;
2179 
2180     float sourceWidth = source.getWidth();
2181     float sourceHeight = source.getHeight();
2182 
2183     float xScale = sourceWidth < 0 ? 1.0f : dst.getWidth() / sourceWidth;
2184     float yScale = sourceHeight < 0 ? 1.0f : dst.getHeight() / sourceHeight;
2185     float matrix[4] = {1, 0, 0, 1};
2186 
2187     switch (transform) {
2188         case NATIVE_WINDOW_TRANSFORM_FLIP_H:
2189             matrix[0] = -xScale; matrix[1] = 0;
2190             matrix[2] = 0; matrix[3] = yScale;
2191             x += source.getWidth();
2192             break;
2193         case NATIVE_WINDOW_TRANSFORM_FLIP_V:
2194             matrix[0] = xScale; matrix[1] = 0;
2195             matrix[2] = 0; matrix[3] = -yScale;
2196             y += source.getHeight();
2197             break;
2198         case NATIVE_WINDOW_TRANSFORM_ROT_90:
2199             matrix[0] = 0; matrix[1] = -yScale;
2200             matrix[2] = xScale; matrix[3] = 0;
2201             x += source.getHeight();
2202             break;
2203         case NATIVE_WINDOW_TRANSFORM_ROT_180:
2204             matrix[0] = -xScale; matrix[1] = 0;
2205             matrix[2] = 0; matrix[3] = -yScale;
2206             x += source.getWidth();
2207             y += source.getHeight();
2208             break;
2209         case NATIVE_WINDOW_TRANSFORM_ROT_270:
2210             matrix[0] = 0; matrix[1] = yScale;
2211             matrix[2] = -xScale; matrix[3] = 0;
2212             y += source.getWidth();
2213             break;
2214         default:
2215             matrix[0] = xScale; matrix[1] = 0;
2216             matrix[2] = 0; matrix[3] = yScale;
2217             break;
2218     }
2219     setMatrix(sc, matrix[0], matrix[1], matrix[2], matrix[3]);
2220     float offsetX = xScale * source.left;
2221     float offsetY = yScale * source.top;
2222     setPosition(sc, x - offsetX, y - offsetY);
2223 
2224     return *this;
2225 }
2226 
setShadowRadius(const sp<SurfaceControl> & sc,float shadowRadius)2227 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setShadowRadius(
2228         const sp<SurfaceControl>& sc, float shadowRadius) {
2229     layer_state_t* s = getLayerState(sc);
2230     if (!s) {
2231         mStatus = BAD_INDEX;
2232         return *this;
2233     }
2234     s->what |= layer_state_t::eShadowRadiusChanged;
2235     s->shadowRadius = shadowRadius;
2236     return *this;
2237 }
2238 
setFrameRate(const sp<SurfaceControl> & sc,float frameRate,int8_t compatibility,int8_t changeFrameRateStrategy)2239 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setFrameRate(
2240         const sp<SurfaceControl>& sc, float frameRate, int8_t compatibility,
2241         int8_t changeFrameRateStrategy) {
2242     layer_state_t* s = getLayerState(sc);
2243     if (!s) {
2244         mStatus = BAD_INDEX;
2245         return *this;
2246     }
2247     // Allow privileged values as well here, those will be ignored by SF if
2248     // the caller is not privileged
2249     if (!ValidateFrameRate(frameRate, compatibility, changeFrameRateStrategy,
2250                            "Transaction::setFrameRate",
2251                            /*privileged=*/true)) {
2252         mStatus = BAD_VALUE;
2253         return *this;
2254     }
2255     s->what |= layer_state_t::eFrameRateChanged;
2256     s->frameRate = frameRate;
2257     s->frameRateCompatibility = compatibility;
2258     s->changeFrameRateStrategy = changeFrameRateStrategy;
2259     return *this;
2260 }
2261 
2262 SurfaceComposerClient::Transaction&
setDefaultFrameRateCompatibility(const sp<SurfaceControl> & sc,int8_t compatibility)2263 SurfaceComposerClient::Transaction::setDefaultFrameRateCompatibility(const sp<SurfaceControl>& sc,
2264                                                                      int8_t compatibility) {
2265     layer_state_t* s = getLayerState(sc);
2266     if (!s) {
2267         mStatus = BAD_INDEX;
2268         return *this;
2269     }
2270     s->what |= layer_state_t::eDefaultFrameRateCompatibilityChanged;
2271     s->defaultFrameRateCompatibility = compatibility;
2272     return *this;
2273 }
2274 
setFrameRateCategory(const sp<SurfaceControl> & sc,int8_t category,bool smoothSwitchOnly)2275 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setFrameRateCategory(
2276         const sp<SurfaceControl>& sc, int8_t category, bool smoothSwitchOnly) {
2277     layer_state_t* s = getLayerState(sc);
2278     if (!s) {
2279         mStatus = BAD_INDEX;
2280         return *this;
2281     }
2282     s->what |= layer_state_t::eFrameRateCategoryChanged;
2283     s->frameRateCategory = category;
2284     s->frameRateCategorySmoothSwitchOnly = smoothSwitchOnly;
2285     return *this;
2286 }
2287 
2288 SurfaceComposerClient::Transaction&
setFrameRateSelectionStrategy(const sp<SurfaceControl> & sc,int8_t strategy)2289 SurfaceComposerClient::Transaction::setFrameRateSelectionStrategy(const sp<SurfaceControl>& sc,
2290                                                                   int8_t strategy) {
2291     layer_state_t* s = getLayerState(sc);
2292     if (!s) {
2293         mStatus = BAD_INDEX;
2294         return *this;
2295     }
2296     s->what |= layer_state_t::eFrameRateSelectionStrategyChanged;
2297     s->frameRateSelectionStrategy = strategy;
2298     return *this;
2299 }
2300 
setFixedTransformHint(const sp<SurfaceControl> & sc,int32_t fixedTransformHint)2301 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setFixedTransformHint(
2302         const sp<SurfaceControl>& sc, int32_t fixedTransformHint) {
2303     layer_state_t* s = getLayerState(sc);
2304     if (!s) {
2305         mStatus = BAD_INDEX;
2306         return *this;
2307     }
2308 
2309     const ui::Transform::RotationFlags transform = fixedTransformHint == -1
2310             ? ui::Transform::ROT_INVALID
2311             : ui::Transform::toRotationFlags(static_cast<ui::Rotation>(fixedTransformHint));
2312     s->what |= layer_state_t::eFixedTransformHintChanged;
2313     s->fixedTransformHint = transform;
2314     return *this;
2315 }
2316 
setFrameTimelineInfo(const FrameTimelineInfo & frameTimelineInfo)2317 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setFrameTimelineInfo(
2318         const FrameTimelineInfo& frameTimelineInfo) {
2319     mergeFrameTimelineInfo(mFrameTimelineInfo, frameTimelineInfo);
2320     return *this;
2321 }
2322 
setAutoRefresh(const sp<SurfaceControl> & sc,bool autoRefresh)2323 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setAutoRefresh(
2324         const sp<SurfaceControl>& sc, bool autoRefresh) {
2325     layer_state_t* s = getLayerState(sc);
2326     if (!s) {
2327         mStatus = BAD_INDEX;
2328         return *this;
2329     }
2330 
2331     s->what |= layer_state_t::eAutoRefreshChanged;
2332     s->autoRefresh = autoRefresh;
2333     return *this;
2334 }
2335 
setTrustedOverlay(const sp<SurfaceControl> & sc,bool isTrustedOverlay)2336 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setTrustedOverlay(
2337         const sp<SurfaceControl>& sc, bool isTrustedOverlay) {
2338     return setTrustedOverlay(sc,
2339                              isTrustedOverlay ? gui::TrustedOverlay::ENABLED
2340                                               : gui::TrustedOverlay::UNSET);
2341 }
2342 
setTrustedOverlay(const sp<SurfaceControl> & sc,gui::TrustedOverlay trustedOverlay)2343 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setTrustedOverlay(
2344         const sp<SurfaceControl>& sc, gui::TrustedOverlay trustedOverlay) {
2345     layer_state_t* s = getLayerState(sc);
2346     if (!s) {
2347         mStatus = BAD_INDEX;
2348         return *this;
2349     }
2350 
2351     s->what |= layer_state_t::eTrustedOverlayChanged;
2352     s->trustedOverlay = trustedOverlay;
2353     return *this;
2354 }
2355 
setApplyToken(const sp<IBinder> & applyToken)2356 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setApplyToken(
2357         const sp<IBinder>& applyToken) {
2358     mApplyToken = applyToken;
2359     return *this;
2360 }
2361 
setStretchEffect(const sp<SurfaceControl> & sc,const StretchEffect & stretchEffect)2362 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setStretchEffect(
2363     const sp<SurfaceControl>& sc, const StretchEffect& stretchEffect) {
2364     layer_state_t* s = getLayerState(sc);
2365     if (!s) {
2366         mStatus = BAD_INDEX;
2367         return *this;
2368     }
2369 
2370     s->what |= layer_state_t::eStretchChanged;
2371     s->stretchEffect = stretchEffect;
2372     return *this;
2373 }
2374 
flagEdgeExtensionEffectUseShader()2375 bool SurfaceComposerClient::flagEdgeExtensionEffectUseShader() {
2376     return com::android::graphics::libgui::flags::edge_extension_shader();
2377 }
2378 
setEdgeExtensionEffect(const sp<SurfaceControl> & sc,const gui::EdgeExtensionParameters & effect)2379 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setEdgeExtensionEffect(
2380         const sp<SurfaceControl>& sc, const gui::EdgeExtensionParameters& effect) {
2381     layer_state_t* s = getLayerState(sc);
2382     if (!s) {
2383         mStatus = BAD_INDEX;
2384         return *this;
2385     }
2386 
2387     s->what |= layer_state_t::eEdgeExtensionChanged;
2388     s->edgeExtensionParameters = effect;
2389     return *this;
2390 }
2391 
setBufferCrop(const sp<SurfaceControl> & sc,const Rect & bufferCrop)2392 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBufferCrop(
2393         const sp<SurfaceControl>& sc, const Rect& bufferCrop) {
2394     layer_state_t* s = getLayerState(sc);
2395     if (!s) {
2396         mStatus = BAD_INDEX;
2397         return *this;
2398     }
2399 
2400     s->what |= layer_state_t::eBufferCropChanged;
2401     s->bufferCrop = bufferCrop;
2402 
2403     registerSurfaceControlForCallback(sc);
2404     return *this;
2405 }
2406 
setDestinationFrame(const sp<SurfaceControl> & sc,const Rect & destinationFrame)2407 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setDestinationFrame(
2408         const sp<SurfaceControl>& sc, const Rect& destinationFrame) {
2409     layer_state_t* s = getLayerState(sc);
2410     if (!s) {
2411         mStatus = BAD_INDEX;
2412         return *this;
2413     }
2414 
2415     s->what |= layer_state_t::eDestinationFrameChanged;
2416     s->destinationFrame = destinationFrame;
2417 
2418     registerSurfaceControlForCallback(sc);
2419     return *this;
2420 }
2421 
setDropInputMode(const sp<SurfaceControl> & sc,gui::DropInputMode mode)2422 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setDropInputMode(
2423         const sp<SurfaceControl>& sc, gui::DropInputMode mode) {
2424     layer_state_t* s = getLayerState(sc);
2425     if (!s) {
2426         mStatus = BAD_INDEX;
2427         return *this;
2428     }
2429 
2430     s->what |= layer_state_t::eDropInputModeChanged;
2431     s->dropInputMode = mode;
2432 
2433     registerSurfaceControlForCallback(sc);
2434     return *this;
2435 }
2436 
setBufferReleaseChannel(const sp<SurfaceControl> & sc,const std::shared_ptr<gui::BufferReleaseChannel::ProducerEndpoint> & channel)2437 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setBufferReleaseChannel(
2438         const sp<SurfaceControl>& sc,
2439         const std::shared_ptr<gui::BufferReleaseChannel::ProducerEndpoint>& channel) {
2440     layer_state_t* s = getLayerState(sc);
2441     if (!s) {
2442         mStatus = BAD_INDEX;
2443         return *this;
2444     }
2445 
2446     s->what |= layer_state_t::eBufferReleaseChannelChanged;
2447     s->bufferReleaseChannel = channel;
2448 
2449     registerSurfaceControlForCallback(sc);
2450     return *this;
2451 }
2452 
setPictureProfileHandle(const sp<SurfaceControl> & sc,const PictureProfileHandle & pictureProfileHandle)2453 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setPictureProfileHandle(
2454         const sp<SurfaceControl>& sc, const PictureProfileHandle& pictureProfileHandle) {
2455     if (com_android_graphics_libgui_flags_apply_picture_profiles()) {
2456         layer_state_t* s = getLayerState(sc);
2457         if (!s) {
2458             mStatus = BAD_INDEX;
2459             return *this;
2460         }
2461 
2462         s->what |= layer_state_t::ePictureProfileHandleChanged;
2463         s->pictureProfileHandle = pictureProfileHandle;
2464 
2465         registerSurfaceControlForCallback(sc);
2466     }
2467     return *this;
2468 }
2469 
setContentPriority(const sp<SurfaceControl> & sc,int32_t priority)2470 SurfaceComposerClient::Transaction& SurfaceComposerClient::Transaction::setContentPriority(
2471         const sp<SurfaceControl>& sc, int32_t priority) {
2472     if (com_android_graphics_libgui_flags_apply_picture_profiles()) {
2473         layer_state_t* s = getLayerState(sc);
2474         if (!s) {
2475             mStatus = BAD_INDEX;
2476             return *this;
2477         }
2478 
2479         s->what |= layer_state_t::eAppContentPriorityChanged;
2480         s->appContentPriority = priority;
2481 
2482         registerSurfaceControlForCallback(sc);
2483     }
2484     return *this;
2485 }
2486 
2487 // ---------------------------------------------------------------------------
2488 
getDisplayState(const sp<IBinder> & token)2489 DisplayState& SurfaceComposerClient::Transaction::getDisplayState(const sp<IBinder>& token) {
2490     DisplayState s;
2491     s.token = token;
2492     ssize_t index = mDisplayStates.indexOf(s);
2493     if (index < 0) {
2494         // we don't have it, add an initialized layer_state to our list
2495         s.what = 0;
2496         index = mDisplayStates.add(s);
2497     }
2498     return mDisplayStates.editItemAt(static_cast<size_t>(index));
2499 }
2500 
setDisplaySurface(const sp<IBinder> & token,const sp<IGraphicBufferProducer> & bufferProducer)2501 status_t SurfaceComposerClient::Transaction::setDisplaySurface(const sp<IBinder>& token,
2502         const sp<IGraphicBufferProducer>& bufferProducer) {
2503     if (bufferProducer.get() != nullptr) {
2504         // Make sure that composition can never be stalled by a virtual display
2505         // consumer that isn't processing buffers fast enough.
2506         status_t err = bufferProducer->setAsyncMode(true);
2507         if (err != NO_ERROR) {
2508             ALOGE("Composer::setDisplaySurface Failed to enable async mode on the "
2509                     "BufferQueue. This BufferQueue cannot be used for virtual "
2510                     "display. (%d)", err);
2511             return err;
2512         }
2513     }
2514     DisplayState& s(getDisplayState(token));
2515     s.surface = bufferProducer;
2516     s.what |= DisplayState::eSurfaceChanged;
2517     return NO_ERROR;
2518 }
2519 
setDisplayLayerStack(const sp<IBinder> & token,ui::LayerStack layerStack)2520 void SurfaceComposerClient::Transaction::setDisplayLayerStack(const sp<IBinder>& token,
2521                                                               ui::LayerStack layerStack) {
2522     DisplayState& s(getDisplayState(token));
2523     s.layerStack = layerStack;
2524     s.what |= DisplayState::eLayerStackChanged;
2525 }
2526 
setDisplayFlags(const sp<IBinder> & token,uint32_t flags)2527 void SurfaceComposerClient::Transaction::setDisplayFlags(const sp<IBinder>& token, uint32_t flags) {
2528     DisplayState& s(getDisplayState(token));
2529     s.flags = flags;
2530     s.what |= DisplayState::eFlagsChanged;
2531 }
2532 
setDisplayProjection(const sp<IBinder> & token,ui::Rotation orientation,const Rect & layerStackRect,const Rect & displayRect)2533 void SurfaceComposerClient::Transaction::setDisplayProjection(const sp<IBinder>& token,
2534                                                               ui::Rotation orientation,
2535                                                               const Rect& layerStackRect,
2536                                                               const Rect& displayRect) {
2537     DisplayState& s(getDisplayState(token));
2538     s.orientation = orientation;
2539     s.layerStackSpaceRect = layerStackRect;
2540     s.orientedDisplaySpaceRect = displayRect;
2541     s.what |= DisplayState::eDisplayProjectionChanged;
2542 }
2543 
setDisplaySize(const sp<IBinder> & token,uint32_t width,uint32_t height)2544 void SurfaceComposerClient::Transaction::setDisplaySize(const sp<IBinder>& token, uint32_t width, uint32_t height) {
2545     DisplayState& s(getDisplayState(token));
2546     s.width = width;
2547     s.height = height;
2548     s.what |= DisplayState::eDisplaySizeChanged;
2549 }
2550 
2551 // copied from FrameTimelineInfo::merge()
mergeFrameTimelineInfo(FrameTimelineInfo & t,const FrameTimelineInfo & other)2552 void SurfaceComposerClient::Transaction::mergeFrameTimelineInfo(FrameTimelineInfo& t,
2553                                                                 const FrameTimelineInfo& other) {
2554     // When merging vsync Ids we take the oldest valid one
2555     if (t.vsyncId != FrameTimelineInfo::INVALID_VSYNC_ID &&
2556         other.vsyncId != FrameTimelineInfo::INVALID_VSYNC_ID) {
2557         if (other.vsyncId > t.vsyncId) {
2558             t = other;
2559         }
2560     } else if (t.vsyncId == FrameTimelineInfo::INVALID_VSYNC_ID) {
2561         t = other;
2562     }
2563 }
2564 
2565 SurfaceComposerClient::Transaction&
setTrustedPresentationCallback(const sp<SurfaceControl> & sc,TrustedPresentationCallback cb,const TrustedPresentationThresholds & thresholds,void * context,sp<SurfaceComposerClient::PresentationCallbackRAII> & outCallbackRef)2566 SurfaceComposerClient::Transaction::setTrustedPresentationCallback(
2567         const sp<SurfaceControl>& sc, TrustedPresentationCallback cb,
2568         const TrustedPresentationThresholds& thresholds, void* context,
2569         sp<SurfaceComposerClient::PresentationCallbackRAII>& outCallbackRef) {
2570     outCallbackRef =
2571             mTransactionCompletedListener->addTrustedPresentationCallback(cb, sc->getLayerId(),
2572                                                                           context);
2573 
2574     layer_state_t* s = getLayerState(sc);
2575     if (!s) {
2576         mStatus = BAD_INDEX;
2577         return *this;
2578     }
2579     s->what |= layer_state_t::eTrustedPresentationInfoChanged;
2580     s->trustedPresentationThresholds = thresholds;
2581     s->trustedPresentationListener.callbackInterface = TransactionCompletedListener::getIInstance();
2582     s->trustedPresentationListener.callbackId = sc->getLayerId();
2583 
2584     return *this;
2585 }
2586 
2587 SurfaceComposerClient::Transaction&
clearTrustedPresentationCallback(const sp<SurfaceControl> & sc)2588 SurfaceComposerClient::Transaction::clearTrustedPresentationCallback(const sp<SurfaceControl>& sc) {
2589     mTransactionCompletedListener->clearTrustedPresentationCallback(sc->getLayerId());
2590 
2591     layer_state_t* s = getLayerState(sc);
2592     if (!s) {
2593         mStatus = BAD_INDEX;
2594         return *this;
2595     }
2596     s->what |= layer_state_t::eTrustedPresentationInfoChanged;
2597     s->trustedPresentationThresholds = TrustedPresentationThresholds();
2598     s->trustedPresentationListener.callbackInterface = nullptr;
2599     s->trustedPresentationListener.callbackId = -1;
2600 
2601     return *this;
2602 }
2603 
2604 // ---------------------------------------------------------------------------
2605 
SurfaceComposerClient()2606 SurfaceComposerClient::SurfaceComposerClient() : mStatus(NO_INIT) {}
2607 
SurfaceComposerClient(const sp<ISurfaceComposerClient> & client)2608 SurfaceComposerClient::SurfaceComposerClient(const sp<ISurfaceComposerClient>& client)
2609       : mStatus(NO_ERROR), mClient(client) {}
2610 
onFirstRef()2611 void SurfaceComposerClient::onFirstRef() {
2612     sp<gui::ISurfaceComposer> sf(ComposerServiceAIDL::getComposerService());
2613     if (sf != nullptr && mStatus == NO_INIT) {
2614         sp<ISurfaceComposerClient> conn;
2615         binder::Status status = sf->createConnection(&conn);
2616         if (status.isOk() && conn != nullptr) {
2617             mClient = conn;
2618             mStatus = NO_ERROR;
2619         }
2620     }
2621 }
2622 
~SurfaceComposerClient()2623 SurfaceComposerClient::~SurfaceComposerClient() {
2624     dispose();
2625 }
2626 
initCheck() const2627 status_t SurfaceComposerClient::initCheck() const {
2628     return mStatus;
2629 }
2630 
connection() const2631 sp<IBinder> SurfaceComposerClient::connection() const {
2632     return IInterface::asBinder(mClient);
2633 }
2634 
linkToComposerDeath(const sp<IBinder::DeathRecipient> & recipient,void * cookie,uint32_t flags)2635 status_t SurfaceComposerClient::linkToComposerDeath(
2636         const sp<IBinder::DeathRecipient>& recipient,
2637         void* cookie, uint32_t flags) {
2638     sp<ISurfaceComposer> sf(ComposerService::getComposerService());
2639     return IInterface::asBinder(sf)->linkToDeath(recipient, cookie, flags);
2640 }
2641 
dispose()2642 void SurfaceComposerClient::dispose() {
2643     // this can be called more than once.
2644     sp<ISurfaceComposerClient> client;
2645     Mutex::Autolock _lm(mLock);
2646     if (mClient != nullptr) {
2647         client = mClient; // hold ref while lock is held
2648         mClient.clear();
2649     }
2650     mStatus = NO_INIT;
2651 }
2652 
bootFinished()2653 status_t SurfaceComposerClient::bootFinished() {
2654     sp<gui::ISurfaceComposer> sf(ComposerServiceAIDL::getComposerService());
2655     binder::Status status = sf->bootFinished();
2656     return statusTFromBinderStatus(status);
2657 }
2658 
createSurface(const String8 & name,uint32_t w,uint32_t h,PixelFormat format,int32_t flags,const sp<IBinder> & parentHandle,LayerMetadata metadata,uint32_t * outTransformHint)2659 sp<SurfaceControl> SurfaceComposerClient::createSurface(const String8& name, uint32_t w, uint32_t h,
2660                                                         PixelFormat format, int32_t flags,
2661                                                         const sp<IBinder>& parentHandle,
2662                                                         LayerMetadata metadata,
2663                                                         uint32_t* outTransformHint) {
2664     sp<SurfaceControl> s;
2665     createSurfaceChecked(name, w, h, format, &s, flags, parentHandle, std::move(metadata),
2666                          outTransformHint);
2667     return s;
2668 }
2669 
toString(const String16 & string)2670 static std::string toString(const String16& string) {
2671     return std::string(String8(string).c_str());
2672 }
2673 
createSurfaceChecked(const String8 & name,uint32_t w,uint32_t h,PixelFormat format,sp<SurfaceControl> * outSurface,int32_t flags,const sp<IBinder> & parentHandle,LayerMetadata metadata,uint32_t * outTransformHint)2674 status_t SurfaceComposerClient::createSurfaceChecked(const String8& name, uint32_t w, uint32_t h,
2675                                                      PixelFormat format,
2676                                                      sp<SurfaceControl>* outSurface, int32_t flags,
2677                                                      const sp<IBinder>& parentHandle,
2678                                                      LayerMetadata metadata,
2679                                                      uint32_t* outTransformHint) {
2680     status_t err = mStatus;
2681 
2682     if (mStatus == NO_ERROR) {
2683         gui::CreateSurfaceResult result;
2684         binder::Status status = mClient->createSurface(std::string(name.c_str()), flags,
2685                                                        parentHandle, std::move(metadata), &result);
2686         err = statusTFromBinderStatus(status);
2687         if (outTransformHint) {
2688             *outTransformHint = result.transformHint;
2689         }
2690         ALOGE_IF(err, "SurfaceComposerClient::createSurface error %s", strerror(-err));
2691         if (err == NO_ERROR) {
2692             *outSurface = new SurfaceControl(this, result.handle, result.layerId,
2693                                              toString(result.layerName), w, h, format,
2694                                              result.transformHint, flags);
2695         }
2696     }
2697     return err;
2698 }
2699 
mirrorSurface(SurfaceControl * mirrorFromSurface)2700 sp<SurfaceControl> SurfaceComposerClient::mirrorSurface(SurfaceControl* mirrorFromSurface) {
2701     if (mirrorFromSurface == nullptr) {
2702         return nullptr;
2703     }
2704 
2705     sp<IBinder> mirrorFromHandle = mirrorFromSurface->getHandle();
2706     gui::CreateSurfaceResult result;
2707     const binder::Status status = mClient->mirrorSurface(mirrorFromHandle, &result);
2708     const status_t err = statusTFromBinderStatus(status);
2709     if (err == NO_ERROR) {
2710         return new SurfaceControl(this, result.handle, result.layerId, toString(result.layerName));
2711     }
2712     return nullptr;
2713 }
2714 
mirrorDisplay(DisplayId displayId)2715 sp<SurfaceControl> SurfaceComposerClient::mirrorDisplay(DisplayId displayId) {
2716     gui::CreateSurfaceResult result;
2717     const binder::Status status = mClient->mirrorDisplay(displayId.value, &result);
2718     const status_t err = statusTFromBinderStatus(status);
2719     if (err == NO_ERROR) {
2720         return new SurfaceControl(this, result.handle, result.layerId, toString(result.layerName));
2721     }
2722     return nullptr;
2723 }
2724 
clearLayerFrameStats(const sp<IBinder> & token) const2725 status_t SurfaceComposerClient::clearLayerFrameStats(const sp<IBinder>& token) const {
2726     if (mStatus != NO_ERROR) {
2727         return mStatus;
2728     }
2729     const binder::Status status = mClient->clearLayerFrameStats(token);
2730     return statusTFromBinderStatus(status);
2731 }
2732 
getLayerFrameStats(const sp<IBinder> & token,FrameStats * outStats) const2733 status_t SurfaceComposerClient::getLayerFrameStats(const sp<IBinder>& token,
2734         FrameStats* outStats) const {
2735     if (mStatus != NO_ERROR) {
2736         return mStatus;
2737     }
2738     gui::FrameStats stats;
2739     const binder::Status status = mClient->getLayerFrameStats(token, &stats);
2740     if (status.isOk()) {
2741         outStats->refreshPeriodNano = stats.refreshPeriodNano;
2742         outStats->desiredPresentTimesNano.setCapacity(stats.desiredPresentTimesNano.size());
2743         for (const auto& t : stats.desiredPresentTimesNano) {
2744             outStats->desiredPresentTimesNano.add(t);
2745         }
2746         outStats->actualPresentTimesNano.setCapacity(stats.actualPresentTimesNano.size());
2747         for (const auto& t : stats.actualPresentTimesNano) {
2748             outStats->actualPresentTimesNano.add(t);
2749         }
2750         outStats->frameReadyTimesNano.setCapacity(stats.frameReadyTimesNano.size());
2751         for (const auto& t : stats.frameReadyTimesNano) {
2752             outStats->frameReadyTimesNano.add(t);
2753         }
2754     }
2755     return statusTFromBinderStatus(status);
2756 }
2757 
2758 // ----------------------------------------------------------------------------
2759 
getDisplayState(const sp<IBinder> & display,ui::DisplayState * state)2760 status_t SurfaceComposerClient::getDisplayState(const sp<IBinder>& display,
2761                                                 ui::DisplayState* state) {
2762     gui::DisplayState ds;
2763     binder::Status status =
2764             ComposerServiceAIDL::getComposerService()->getDisplayState(display, &ds);
2765     if (status.isOk()) {
2766         state->layerStack = ui::LayerStack::fromValue(ds.layerStack);
2767         state->orientation = static_cast<ui::Rotation>(ds.orientation);
2768         state->layerStackSpaceRect =
2769                 ui::Size(ds.layerStackSpaceRect.width, ds.layerStackSpaceRect.height);
2770     }
2771     return statusTFromBinderStatus(status);
2772 }
2773 
getStaticDisplayInfo(int64_t displayId,ui::StaticDisplayInfo * outInfo)2774 status_t SurfaceComposerClient::getStaticDisplayInfo(int64_t displayId,
2775                                                      ui::StaticDisplayInfo* outInfo) {
2776     using Tag = android::gui::DeviceProductInfo::ManufactureOrModelDate::Tag;
2777     gui::StaticDisplayInfo ginfo;
2778     binder::Status status =
2779             ComposerServiceAIDL::getComposerService()->getStaticDisplayInfo(displayId, &ginfo);
2780     if (status.isOk()) {
2781         // convert gui::StaticDisplayInfo to ui::StaticDisplayInfo
2782         outInfo->connectionType = static_cast<ui::DisplayConnectionType>(ginfo.connectionType);
2783         outInfo->density = ginfo.density;
2784         outInfo->secure = ginfo.secure;
2785         outInfo->installOrientation = static_cast<ui::Rotation>(ginfo.installOrientation);
2786 
2787         if (const std::optional<gui::DeviceProductInfo> dpi = ginfo.deviceProductInfo) {
2788             DeviceProductInfo info;
2789             info.name = dpi->name;
2790             if (dpi->manufacturerPnpId.size() > 0) {
2791                 // copid from PnpId = std::array<char, 4> in ui/DeviceProductInfo.h
2792                 constexpr int kMaxPnpIdSize = 4;
2793                 size_t count = std::max<size_t>(kMaxPnpIdSize, dpi->manufacturerPnpId.size());
2794                 std::copy_n(dpi->manufacturerPnpId.begin(), count, info.manufacturerPnpId.begin());
2795             }
2796             if (dpi->relativeAddress.size() > 0) {
2797                 std::copy(dpi->relativeAddress.begin(), dpi->relativeAddress.end(),
2798                           std::back_inserter(info.relativeAddress));
2799             }
2800             info.productId = dpi->productId;
2801 
2802             const gui::DeviceProductInfo::ManufactureOrModelDate& date =
2803                     dpi->manufactureOrModelDate;
2804             if (date.getTag() == Tag::modelYear) {
2805                 DeviceProductInfo::ModelYear modelYear;
2806                 modelYear.year = static_cast<uint32_t>(date.get<Tag::modelYear>().year);
2807                 info.manufactureOrModelDate = modelYear;
2808             } else if (date.getTag() == Tag::manufactureYear) {
2809                 DeviceProductInfo::ManufactureYear manufactureYear;
2810                 manufactureYear.year = date.get<Tag::manufactureYear>().modelYear.year;
2811                 info.manufactureOrModelDate = manufactureYear;
2812             } else if (date.getTag() == Tag::manufactureWeekAndYear) {
2813                 DeviceProductInfo::ManufactureWeekAndYear weekAndYear;
2814                 weekAndYear.year =
2815                         date.get<Tag::manufactureWeekAndYear>().manufactureYear.modelYear.year;
2816                 weekAndYear.week = date.get<Tag::manufactureWeekAndYear>().week;
2817                 info.manufactureOrModelDate = weekAndYear;
2818             }
2819 
2820             outInfo->deviceProductInfo = info;
2821         }
2822     }
2823     return statusTFromBinderStatus(status);
2824 }
2825 
getDynamicDisplayInfoInternal(gui::DynamicDisplayInfo & ginfo,ui::DynamicDisplayInfo * & outInfo)2826 void SurfaceComposerClient::getDynamicDisplayInfoInternal(gui::DynamicDisplayInfo& ginfo,
2827                                                           ui::DynamicDisplayInfo*& outInfo) {
2828     // convert gui::DynamicDisplayInfo to ui::DynamicDisplayInfo
2829     outInfo->supportedDisplayModes.clear();
2830     outInfo->supportedDisplayModes.reserve(ginfo.supportedDisplayModes.size());
2831     for (const auto& mode : ginfo.supportedDisplayModes) {
2832         ui::DisplayMode outMode;
2833         outMode.id = mode.id;
2834         outMode.resolution.width = mode.resolution.width;
2835         outMode.resolution.height = mode.resolution.height;
2836         outMode.xDpi = mode.xDpi;
2837         outMode.yDpi = mode.yDpi;
2838         outMode.peakRefreshRate = mode.peakRefreshRate;
2839         outMode.vsyncRate = mode.vsyncRate;
2840         outMode.appVsyncOffset = mode.appVsyncOffset;
2841         outMode.sfVsyncOffset = mode.sfVsyncOffset;
2842         outMode.presentationDeadline = mode.presentationDeadline;
2843         outMode.group = mode.group;
2844         std::transform(mode.supportedHdrTypes.begin(), mode.supportedHdrTypes.end(),
2845                        std::back_inserter(outMode.supportedHdrTypes),
2846                        [](const int32_t& value) { return static_cast<ui::Hdr>(value); });
2847         outInfo->supportedDisplayModes.push_back(outMode);
2848     }
2849 
2850     outInfo->activeDisplayModeId = ginfo.activeDisplayModeId;
2851     outInfo->renderFrameRate = ginfo.renderFrameRate;
2852 
2853     outInfo->supportedColorModes.clear();
2854     outInfo->supportedColorModes.reserve(ginfo.supportedColorModes.size());
2855     for (const auto& cmode : ginfo.supportedColorModes) {
2856         outInfo->supportedColorModes.push_back(static_cast<ui::ColorMode>(cmode));
2857     }
2858 
2859     outInfo->activeColorMode = static_cast<ui::ColorMode>(ginfo.activeColorMode);
2860 
2861     std::vector<ui::Hdr> types;
2862     types.reserve(ginfo.hdrCapabilities.supportedHdrTypes.size());
2863     for (const auto& hdr : ginfo.hdrCapabilities.supportedHdrTypes) {
2864         types.push_back(static_cast<ui::Hdr>(hdr));
2865     }
2866     outInfo->hdrCapabilities = HdrCapabilities(types, ginfo.hdrCapabilities.maxLuminance,
2867                                                ginfo.hdrCapabilities.maxAverageLuminance,
2868                                                ginfo.hdrCapabilities.minLuminance);
2869 
2870     outInfo->autoLowLatencyModeSupported = ginfo.autoLowLatencyModeSupported;
2871     outInfo->gameContentTypeSupported = ginfo.gameContentTypeSupported;
2872     outInfo->preferredBootDisplayMode = ginfo.preferredBootDisplayMode;
2873     outInfo->hasArrSupport = ginfo.hasArrSupport;
2874     outInfo->frameRateCategoryRate = ui::FrameRateCategoryRate(ginfo.frameRateCategoryRate.normal,
2875                                                                ginfo.frameRateCategoryRate.high);
2876     outInfo->supportedRefreshRates.clear();
2877     outInfo->supportedRefreshRates.reserve(ginfo.supportedRefreshRates.size());
2878     for (const auto rate : ginfo.supportedRefreshRates) {
2879         outInfo->supportedRefreshRates.push_back(static_cast<float>(rate));
2880     }
2881 }
2882 
getDynamicDisplayInfoFromId(int64_t displayId,ui::DynamicDisplayInfo * outInfo)2883 status_t SurfaceComposerClient::getDynamicDisplayInfoFromId(int64_t displayId,
2884                                                             ui::DynamicDisplayInfo* outInfo) {
2885     gui::DynamicDisplayInfo ginfo;
2886     binder::Status status =
2887             ComposerServiceAIDL::getComposerService()->getDynamicDisplayInfoFromId(displayId,
2888                                                                                    &ginfo);
2889     if (status.isOk()) {
2890         getDynamicDisplayInfoInternal(ginfo, outInfo);
2891     }
2892     return statusTFromBinderStatus(status);
2893 }
2894 
getDynamicDisplayInfoFromToken(const sp<IBinder> & display,ui::DynamicDisplayInfo * outInfo)2895 status_t SurfaceComposerClient::getDynamicDisplayInfoFromToken(const sp<IBinder>& display,
2896                                                                ui::DynamicDisplayInfo* outInfo) {
2897     gui::DynamicDisplayInfo ginfo;
2898     binder::Status status =
2899             ComposerServiceAIDL::getComposerService()->getDynamicDisplayInfoFromToken(display,
2900                                                                                       &ginfo);
2901     if (status.isOk()) {
2902         getDynamicDisplayInfoInternal(ginfo, outInfo);
2903     }
2904     return statusTFromBinderStatus(status);
2905 }
2906 
getActiveDisplayMode(const sp<IBinder> & display,ui::DisplayMode * mode)2907 status_t SurfaceComposerClient::getActiveDisplayMode(const sp<IBinder>& display,
2908                                                      ui::DisplayMode* mode) {
2909     ui::DynamicDisplayInfo info;
2910 
2911     status_t result = getDynamicDisplayInfoFromToken(display, &info);
2912     if (result != NO_ERROR) {
2913         return result;
2914     }
2915 
2916     if (const auto activeMode = info.getActiveDisplayMode()) {
2917         *mode = *activeMode;
2918         return NO_ERROR;
2919     }
2920 
2921     ALOGE("Active display mode not found.");
2922     return NAME_NOT_FOUND;
2923 }
2924 
setDesiredDisplayModeSpecs(const sp<IBinder> & displayToken,const gui::DisplayModeSpecs & specs)2925 status_t SurfaceComposerClient::setDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
2926                                                            const gui::DisplayModeSpecs& specs) {
2927     binder::Status status =
2928             ComposerServiceAIDL::getComposerService()->setDesiredDisplayModeSpecs(displayToken,
2929                                                                                   specs);
2930     return statusTFromBinderStatus(status);
2931 }
2932 
getDesiredDisplayModeSpecs(const sp<IBinder> & displayToken,gui::DisplayModeSpecs * outSpecs)2933 status_t SurfaceComposerClient::getDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
2934                                                            gui::DisplayModeSpecs* outSpecs) {
2935     if (!outSpecs) {
2936         return BAD_VALUE;
2937     }
2938     binder::Status status =
2939             ComposerServiceAIDL::getComposerService()->getDesiredDisplayModeSpecs(displayToken,
2940                                                                                   outSpecs);
2941     return statusTFromBinderStatus(status);
2942 }
2943 
getDisplayNativePrimaries(const sp<IBinder> & display,ui::DisplayPrimaries & outPrimaries)2944 status_t SurfaceComposerClient::getDisplayNativePrimaries(const sp<IBinder>& display,
2945         ui::DisplayPrimaries& outPrimaries) {
2946     gui::DisplayPrimaries primaries;
2947     binder::Status status =
2948             ComposerServiceAIDL::getComposerService()->getDisplayNativePrimaries(display,
2949                                                                                  &primaries);
2950     if (status.isOk()) {
2951         outPrimaries.red.X = primaries.red.X;
2952         outPrimaries.red.Y = primaries.red.Y;
2953         outPrimaries.red.Z = primaries.red.Z;
2954 
2955         outPrimaries.green.X = primaries.green.X;
2956         outPrimaries.green.Y = primaries.green.Y;
2957         outPrimaries.green.Z = primaries.green.Z;
2958 
2959         outPrimaries.blue.X = primaries.blue.X;
2960         outPrimaries.blue.Y = primaries.blue.Y;
2961         outPrimaries.blue.Z = primaries.blue.Z;
2962 
2963         outPrimaries.white.X = primaries.white.X;
2964         outPrimaries.white.Y = primaries.white.Y;
2965         outPrimaries.white.Z = primaries.white.Z;
2966     }
2967     return statusTFromBinderStatus(status);
2968 }
2969 
setActiveColorMode(const sp<IBinder> & display,ColorMode colorMode)2970 status_t SurfaceComposerClient::setActiveColorMode(const sp<IBinder>& display,
2971         ColorMode colorMode) {
2972     binder::Status status = ComposerServiceAIDL::getComposerService()
2973                                     ->setActiveColorMode(display, static_cast<int>(colorMode));
2974     return statusTFromBinderStatus(status);
2975 }
2976 
getBootDisplayModeSupport(bool * support)2977 status_t SurfaceComposerClient::getBootDisplayModeSupport(bool* support) {
2978     binder::Status status =
2979             ComposerServiceAIDL::getComposerService()->getBootDisplayModeSupport(support);
2980     return statusTFromBinderStatus(status);
2981 }
2982 
getOverlaySupport(gui::OverlayProperties * outProperties)2983 status_t SurfaceComposerClient::getOverlaySupport(gui::OverlayProperties* outProperties) {
2984     binder::Status status =
2985             ComposerServiceAIDL::getComposerService()->getOverlaySupport(outProperties);
2986     return statusTFromBinderStatus(status);
2987 }
2988 
setBootDisplayMode(const sp<IBinder> & display,ui::DisplayModeId displayModeId)2989 status_t SurfaceComposerClient::setBootDisplayMode(const sp<IBinder>& display,
2990                                                    ui::DisplayModeId displayModeId) {
2991     binder::Status status = ComposerServiceAIDL::getComposerService()
2992                                     ->setBootDisplayMode(display, static_cast<int>(displayModeId));
2993     return statusTFromBinderStatus(status);
2994 }
2995 
clearBootDisplayMode(const sp<IBinder> & display)2996 status_t SurfaceComposerClient::clearBootDisplayMode(const sp<IBinder>& display) {
2997     binder::Status status =
2998             ComposerServiceAIDL::getComposerService()->clearBootDisplayMode(display);
2999     return statusTFromBinderStatus(status);
3000 }
3001 
getHdrConversionCapabilities(std::vector<gui::HdrConversionCapability> * hdrConversionCapabilities)3002 status_t SurfaceComposerClient::getHdrConversionCapabilities(
3003         std::vector<gui::HdrConversionCapability>* hdrConversionCapabilities) {
3004     binder::Status status = ComposerServiceAIDL::getComposerService()->getHdrConversionCapabilities(
3005             hdrConversionCapabilities);
3006     return statusTFromBinderStatus(status);
3007 }
3008 
setHdrConversionStrategy(gui::HdrConversionStrategy hdrConversionStrategy,ui::Hdr * outPreferredHdrOutputType)3009 status_t SurfaceComposerClient::setHdrConversionStrategy(
3010         gui::HdrConversionStrategy hdrConversionStrategy, ui::Hdr* outPreferredHdrOutputType) {
3011     int hdrType;
3012     binder::Status status = ComposerServiceAIDL::getComposerService()
3013                                     ->setHdrConversionStrategy(hdrConversionStrategy, &hdrType);
3014     *outPreferredHdrOutputType = static_cast<ui::Hdr>(hdrType);
3015     return statusTFromBinderStatus(status);
3016 }
3017 
getHdrOutputConversionSupport(bool * isSupported)3018 status_t SurfaceComposerClient::getHdrOutputConversionSupport(bool* isSupported) {
3019     binder::Status status =
3020             ComposerServiceAIDL::getComposerService()->getHdrOutputConversionSupport(isSupported);
3021     return statusTFromBinderStatus(status);
3022 }
3023 
setGameModeFrameRateOverride(uid_t uid,float frameRate)3024 status_t SurfaceComposerClient::setGameModeFrameRateOverride(uid_t uid, float frameRate) {
3025     binder::Status status =
3026             ComposerServiceAIDL::getComposerService()->setGameModeFrameRateOverride(uid, frameRate);
3027     return statusTFromBinderStatus(status);
3028 }
3029 
setGameDefaultFrameRateOverride(uid_t uid,float frameRate)3030 status_t SurfaceComposerClient::setGameDefaultFrameRateOverride(uid_t uid, float frameRate) {
3031     binder::Status status =
3032             ComposerServiceAIDL::getComposerService()->setGameDefaultFrameRateOverride(uid,
3033                                                                                        frameRate);
3034     return statusTFromBinderStatus(status);
3035 }
3036 
updateSmallAreaDetection(std::vector<int32_t> & appIds,std::vector<float> & thresholds)3037 status_t SurfaceComposerClient::updateSmallAreaDetection(std::vector<int32_t>& appIds,
3038                                                          std::vector<float>& thresholds) {
3039     binder::Status status =
3040             ComposerServiceAIDL::getComposerService()->updateSmallAreaDetection(appIds, thresholds);
3041     return statusTFromBinderStatus(status);
3042 }
3043 
setSmallAreaDetectionThreshold(int32_t appId,float threshold)3044 status_t SurfaceComposerClient::setSmallAreaDetectionThreshold(int32_t appId, float threshold) {
3045     binder::Status status =
3046             ComposerServiceAIDL::getComposerService()->setSmallAreaDetectionThreshold(appId,
3047                                                                                       threshold);
3048     return statusTFromBinderStatus(status);
3049 }
3050 
setAutoLowLatencyMode(const sp<IBinder> & display,bool on)3051 void SurfaceComposerClient::setAutoLowLatencyMode(const sp<IBinder>& display, bool on) {
3052     ComposerServiceAIDL::getComposerService()->setAutoLowLatencyMode(display, on);
3053 }
3054 
setGameContentType(const sp<IBinder> & display,bool on)3055 void SurfaceComposerClient::setGameContentType(const sp<IBinder>& display, bool on) {
3056     ComposerServiceAIDL::getComposerService()->setGameContentType(display, on);
3057 }
3058 
setDisplayPowerMode(const sp<IBinder> & token,int mode)3059 void SurfaceComposerClient::setDisplayPowerMode(const sp<IBinder>& token,
3060         int mode) {
3061     ComposerServiceAIDL::getComposerService()->setPowerMode(token, mode);
3062 }
3063 
getMaxLayerPictureProfiles(const sp<IBinder> & token,int32_t * outMaxProfiles)3064 status_t SurfaceComposerClient::getMaxLayerPictureProfiles(const sp<IBinder>& token,
3065                                                            int32_t* outMaxProfiles) {
3066     binder::Status status =
3067             ComposerServiceAIDL::getComposerService()->getMaxLayerPictureProfiles(token,
3068                                                                                   outMaxProfiles);
3069     return statusTFromBinderStatus(status);
3070 }
3071 
getCompositionPreference(ui::Dataspace * defaultDataspace,ui::PixelFormat * defaultPixelFormat,ui::Dataspace * wideColorGamutDataspace,ui::PixelFormat * wideColorGamutPixelFormat)3072 status_t SurfaceComposerClient::getCompositionPreference(
3073         ui::Dataspace* defaultDataspace, ui::PixelFormat* defaultPixelFormat,
3074         ui::Dataspace* wideColorGamutDataspace, ui::PixelFormat* wideColorGamutPixelFormat) {
3075     gui::CompositionPreference pref;
3076     binder::Status status =
3077             ComposerServiceAIDL::getComposerService()->getCompositionPreference(&pref);
3078     if (status.isOk()) {
3079         *defaultDataspace = static_cast<ui::Dataspace>(pref.defaultDataspace);
3080         *defaultPixelFormat = static_cast<ui::PixelFormat>(pref.defaultPixelFormat);
3081         *wideColorGamutDataspace = static_cast<ui::Dataspace>(pref.wideColorGamutDataspace);
3082         *wideColorGamutPixelFormat = static_cast<ui::PixelFormat>(pref.wideColorGamutPixelFormat);
3083     }
3084     return statusTFromBinderStatus(status);
3085 }
3086 
getProtectedContentSupport()3087 bool SurfaceComposerClient::getProtectedContentSupport() {
3088     bool supported = false;
3089     ComposerServiceAIDL::getComposerService()->getProtectedContentSupport(&supported);
3090     return supported;
3091 }
3092 
clearAnimationFrameStats()3093 status_t SurfaceComposerClient::clearAnimationFrameStats() {
3094     binder::Status status = ComposerServiceAIDL::getComposerService()->clearAnimationFrameStats();
3095     return statusTFromBinderStatus(status);
3096 }
3097 
getAnimationFrameStats(FrameStats * outStats)3098 status_t SurfaceComposerClient::getAnimationFrameStats(FrameStats* outStats) {
3099     gui::FrameStats stats;
3100     binder::Status status =
3101             ComposerServiceAIDL::getComposerService()->getAnimationFrameStats(&stats);
3102     if (status.isOk()) {
3103         outStats->refreshPeriodNano = stats.refreshPeriodNano;
3104         outStats->desiredPresentTimesNano.setCapacity(stats.desiredPresentTimesNano.size());
3105         for (const auto& t : stats.desiredPresentTimesNano) {
3106             outStats->desiredPresentTimesNano.add(t);
3107         }
3108         outStats->actualPresentTimesNano.setCapacity(stats.actualPresentTimesNano.size());
3109         for (const auto& t : stats.actualPresentTimesNano) {
3110             outStats->actualPresentTimesNano.add(t);
3111         }
3112         outStats->frameReadyTimesNano.setCapacity(stats.frameReadyTimesNano.size());
3113         for (const auto& t : stats.frameReadyTimesNano) {
3114             outStats->frameReadyTimesNano.add(t);
3115         }
3116     }
3117     return statusTFromBinderStatus(status);
3118 }
3119 
overrideHdrTypes(const sp<IBinder> & display,const std::vector<ui::Hdr> & hdrTypes)3120 status_t SurfaceComposerClient::overrideHdrTypes(const sp<IBinder>& display,
3121                                                  const std::vector<ui::Hdr>& hdrTypes) {
3122     std::vector<int32_t> hdrTypesVector;
3123     hdrTypesVector.reserve(hdrTypes.size());
3124     for (auto t : hdrTypes) {
3125         hdrTypesVector.push_back(static_cast<int32_t>(t));
3126     }
3127 
3128     binder::Status status =
3129             ComposerServiceAIDL::getComposerService()->overrideHdrTypes(display, hdrTypesVector);
3130     return statusTFromBinderStatus(status);
3131 }
3132 
onPullAtom(const int32_t atomId,std::string * outData,bool * success)3133 status_t SurfaceComposerClient::onPullAtom(const int32_t atomId, std::string* outData,
3134                                            bool* success) {
3135     gui::PullAtomData pad;
3136     binder::Status status = ComposerServiceAIDL::getComposerService()->onPullAtom(atomId, &pad);
3137     if (status.isOk()) {
3138         outData->assign(pad.data.begin(), pad.data.end());
3139         *success = pad.success;
3140     }
3141     return statusTFromBinderStatus(status);
3142 }
3143 
getDisplayedContentSamplingAttributes(const sp<IBinder> & display,ui::PixelFormat * outFormat,ui::Dataspace * outDataspace,uint8_t * outComponentMask)3144 status_t SurfaceComposerClient::getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
3145                                                                       ui::PixelFormat* outFormat,
3146                                                                       ui::Dataspace* outDataspace,
3147                                                                       uint8_t* outComponentMask) {
3148     if (!outFormat || !outDataspace || !outComponentMask) {
3149         return BAD_VALUE;
3150     }
3151 
3152     gui::ContentSamplingAttributes attrs;
3153     binder::Status status = ComposerServiceAIDL::getComposerService()
3154                                     ->getDisplayedContentSamplingAttributes(display, &attrs);
3155     if (status.isOk()) {
3156         *outFormat = static_cast<ui::PixelFormat>(attrs.format);
3157         *outDataspace = static_cast<ui::Dataspace>(attrs.dataspace);
3158         *outComponentMask = static_cast<uint8_t>(attrs.componentMask);
3159     }
3160     return statusTFromBinderStatus(status);
3161 }
3162 
setDisplayContentSamplingEnabled(const sp<IBinder> & display,bool enable,uint8_t componentMask,uint64_t maxFrames)3163 status_t SurfaceComposerClient::setDisplayContentSamplingEnabled(const sp<IBinder>& display,
3164                                                                  bool enable, uint8_t componentMask,
3165                                                                  uint64_t maxFrames) {
3166     binder::Status status =
3167             ComposerServiceAIDL::getComposerService()
3168                     ->setDisplayContentSamplingEnabled(display, enable,
3169                                                        static_cast<int8_t>(componentMask),
3170                                                        static_cast<int64_t>(maxFrames));
3171     return statusTFromBinderStatus(status);
3172 }
3173 
getDisplayedContentSample(const sp<IBinder> & display,uint64_t maxFrames,uint64_t timestamp,DisplayedFrameStats * outStats)3174 status_t SurfaceComposerClient::getDisplayedContentSample(const sp<IBinder>& display,
3175                                                           uint64_t maxFrames, uint64_t timestamp,
3176                                                           DisplayedFrameStats* outStats) {
3177     if (!outStats) {
3178         return BAD_VALUE;
3179     }
3180 
3181     gui::DisplayedFrameStats stats;
3182     binder::Status status =
3183             ComposerServiceAIDL::getComposerService()->getDisplayedContentSample(display, maxFrames,
3184                                                                                  timestamp, &stats);
3185     if (status.isOk()) {
3186         // convert gui::DisplayedFrameStats to ui::DisplayedFrameStats
3187         outStats->numFrames = static_cast<uint64_t>(stats.numFrames);
3188         outStats->component_0_sample.reserve(stats.component_0_sample.size());
3189         for (const auto& s : stats.component_0_sample) {
3190             outStats->component_0_sample.push_back(static_cast<uint64_t>(s));
3191         }
3192         outStats->component_1_sample.reserve(stats.component_1_sample.size());
3193         for (const auto& s : stats.component_1_sample) {
3194             outStats->component_1_sample.push_back(static_cast<uint64_t>(s));
3195         }
3196         outStats->component_2_sample.reserve(stats.component_2_sample.size());
3197         for (const auto& s : stats.component_2_sample) {
3198             outStats->component_2_sample.push_back(static_cast<uint64_t>(s));
3199         }
3200         outStats->component_3_sample.reserve(stats.component_3_sample.size());
3201         for (const auto& s : stats.component_3_sample) {
3202             outStats->component_3_sample.push_back(static_cast<uint64_t>(s));
3203         }
3204     }
3205     return statusTFromBinderStatus(status);
3206 }
3207 
isWideColorDisplay(const sp<IBinder> & display,bool * outIsWideColorDisplay)3208 status_t SurfaceComposerClient::isWideColorDisplay(const sp<IBinder>& display,
3209                                                    bool* outIsWideColorDisplay) {
3210     binder::Status status =
3211             ComposerServiceAIDL::getComposerService()->isWideColorDisplay(display,
3212                                                                           outIsWideColorDisplay);
3213     return statusTFromBinderStatus(status);
3214 }
3215 
addRegionSamplingListener(const Rect & samplingArea,const sp<IBinder> & stopLayerHandle,const sp<IRegionSamplingListener> & listener)3216 status_t SurfaceComposerClient::addRegionSamplingListener(
3217         const Rect& samplingArea, const sp<IBinder>& stopLayerHandle,
3218         const sp<IRegionSamplingListener>& listener) {
3219     gui::ARect rect;
3220     rect.left = samplingArea.left;
3221     rect.top = samplingArea.top;
3222     rect.right = samplingArea.right;
3223     rect.bottom = samplingArea.bottom;
3224     binder::Status status =
3225             ComposerServiceAIDL::getComposerService()->addRegionSamplingListener(rect,
3226                                                                                  stopLayerHandle,
3227                                                                                  listener);
3228     return statusTFromBinderStatus(status);
3229 }
3230 
removeRegionSamplingListener(const sp<IRegionSamplingListener> & listener)3231 status_t SurfaceComposerClient::removeRegionSamplingListener(
3232         const sp<IRegionSamplingListener>& listener) {
3233     binder::Status status =
3234             ComposerServiceAIDL::getComposerService()->removeRegionSamplingListener(listener);
3235     return statusTFromBinderStatus(status);
3236 }
3237 
addFpsListener(int32_t taskId,const sp<gui::IFpsListener> & listener)3238 status_t SurfaceComposerClient::addFpsListener(int32_t taskId,
3239                                                const sp<gui::IFpsListener>& listener) {
3240     binder::Status status =
3241             ComposerServiceAIDL::getComposerService()->addFpsListener(taskId, listener);
3242     return statusTFromBinderStatus(status);
3243 }
3244 
removeFpsListener(const sp<gui::IFpsListener> & listener)3245 status_t SurfaceComposerClient::removeFpsListener(const sp<gui::IFpsListener>& listener) {
3246     binder::Status status = ComposerServiceAIDL::getComposerService()->removeFpsListener(listener);
3247     return statusTFromBinderStatus(status);
3248 }
3249 
addTunnelModeEnabledListener(const sp<gui::ITunnelModeEnabledListener> & listener)3250 status_t SurfaceComposerClient::addTunnelModeEnabledListener(
3251         const sp<gui::ITunnelModeEnabledListener>& listener) {
3252     binder::Status status =
3253             ComposerServiceAIDL::getComposerService()->addTunnelModeEnabledListener(listener);
3254     return statusTFromBinderStatus(status);
3255 }
3256 
removeTunnelModeEnabledListener(const sp<gui::ITunnelModeEnabledListener> & listener)3257 status_t SurfaceComposerClient::removeTunnelModeEnabledListener(
3258         const sp<gui::ITunnelModeEnabledListener>& listener) {
3259     binder::Status status =
3260             ComposerServiceAIDL::getComposerService()->removeTunnelModeEnabledListener(listener);
3261     return statusTFromBinderStatus(status);
3262 }
3263 
getDisplayBrightnessSupport(const sp<IBinder> & displayToken)3264 bool SurfaceComposerClient::getDisplayBrightnessSupport(const sp<IBinder>& displayToken) {
3265     bool support = false;
3266     binder::Status status =
3267             ComposerServiceAIDL::getComposerService()->getDisplayBrightnessSupport(displayToken,
3268                                                                                    &support);
3269     return status.isOk() ? support : false;
3270 }
3271 
setDisplayBrightness(const sp<IBinder> & displayToken,const gui::DisplayBrightness & brightness)3272 status_t SurfaceComposerClient::setDisplayBrightness(const sp<IBinder>& displayToken,
3273                                                      const gui::DisplayBrightness& brightness) {
3274     binder::Status status =
3275             ComposerServiceAIDL::getComposerService()->setDisplayBrightness(displayToken,
3276                                                                             brightness);
3277     return statusTFromBinderStatus(status);
3278 }
3279 
addHdrLayerInfoListener(const sp<IBinder> & displayToken,const sp<gui::IHdrLayerInfoListener> & listener)3280 status_t SurfaceComposerClient::addHdrLayerInfoListener(
3281         const sp<IBinder>& displayToken, const sp<gui::IHdrLayerInfoListener>& listener) {
3282     binder::Status status =
3283             ComposerServiceAIDL::getComposerService()->addHdrLayerInfoListener(displayToken,
3284                                                                                listener);
3285     return statusTFromBinderStatus(status);
3286 }
3287 
removeHdrLayerInfoListener(const sp<IBinder> & displayToken,const sp<gui::IHdrLayerInfoListener> & listener)3288 status_t SurfaceComposerClient::removeHdrLayerInfoListener(
3289         const sp<IBinder>& displayToken, const sp<gui::IHdrLayerInfoListener>& listener) {
3290     binder::Status status =
3291             ComposerServiceAIDL::getComposerService()->removeHdrLayerInfoListener(displayToken,
3292                                                                                   listener);
3293     return statusTFromBinderStatus(status);
3294 }
3295 
setActivePictureListener(const sp<gui::IActivePictureListener> & listener)3296 status_t SurfaceComposerClient::setActivePictureListener(
3297         const sp<gui::IActivePictureListener>& listener) {
3298     binder::Status status =
3299             ComposerServiceAIDL::getComposerService()->setActivePictureListener(listener);
3300     return statusTFromBinderStatus(status);
3301 }
3302 
notifyPowerBoost(int32_t boostId)3303 status_t SurfaceComposerClient::notifyPowerBoost(int32_t boostId) {
3304     binder::Status status = ComposerServiceAIDL::getComposerService()->notifyPowerBoost(boostId);
3305     return statusTFromBinderStatus(status);
3306 }
3307 
setGlobalShadowSettings(const half4 & ambientColor,const half4 & spotColor,float lightPosY,float lightPosZ,float lightRadius)3308 status_t SurfaceComposerClient::setGlobalShadowSettings(const half4& ambientColor,
3309                                                         const half4& spotColor, float lightPosY,
3310                                                         float lightPosZ, float lightRadius) {
3311     gui::Color ambientColorG, spotColorG;
3312     ambientColorG.r = ambientColor.r;
3313     ambientColorG.g = ambientColor.g;
3314     ambientColorG.b = ambientColor.b;
3315     ambientColorG.a = ambientColor.a;
3316     spotColorG.r = spotColor.r;
3317     spotColorG.g = spotColor.g;
3318     spotColorG.b = spotColor.b;
3319     spotColorG.a = spotColor.a;
3320     binder::Status status =
3321             ComposerServiceAIDL::getComposerService()->setGlobalShadowSettings(ambientColorG,
3322                                                                                spotColorG,
3323                                                                                lightPosY, lightPosZ,
3324                                                                                lightRadius);
3325     return statusTFromBinderStatus(status);
3326 }
3327 
getDisplayDecorationSupport(const sp<IBinder> & displayToken)3328 std::optional<DisplayDecorationSupport> SurfaceComposerClient::getDisplayDecorationSupport(
3329         const sp<IBinder>& displayToken) {
3330     std::optional<gui::DisplayDecorationSupport> gsupport;
3331     binder::Status status =
3332             ComposerServiceAIDL::getComposerService()->getDisplayDecorationSupport(displayToken,
3333                                                                                    &gsupport);
3334     std::optional<DisplayDecorationSupport> support;
3335     if (status.isOk() && gsupport.has_value()) {
3336         support.emplace(DisplayDecorationSupport{
3337           .format =
3338                 static_cast<aidl::android::hardware::graphics::common::PixelFormat>(
3339                 gsupport->format),
3340           .alphaInterpretation =
3341                 static_cast<aidl::android::hardware::graphics::common::AlphaInterpretation>(
3342                         gsupport->alphaInterpretation)
3343         });
3344     }
3345     return support;
3346 }
3347 
getGpuContextPriority()3348 int SurfaceComposerClient::getGpuContextPriority() {
3349     int priority;
3350     binder::Status status =
3351             ComposerServiceAIDL::getComposerService()->getGpuContextPriority(&priority);
3352     if (!status.isOk()) {
3353         status_t err = statusTFromBinderStatus(status);
3354         ALOGE("getGpuContextPriority failed to read data:  %s (%d)", strerror(-err), err);
3355         return 0;
3356     }
3357     return priority;
3358 }
3359 
addWindowInfosListener(const sp<WindowInfosListener> & windowInfosListener,std::pair<std::vector<gui::WindowInfo>,std::vector<gui::DisplayInfo>> * outInitialInfo)3360 status_t SurfaceComposerClient::addWindowInfosListener(
3361         const sp<WindowInfosListener>& windowInfosListener,
3362         std::pair<std::vector<gui::WindowInfo>, std::vector<gui::DisplayInfo>>* outInitialInfo) {
3363     return WindowInfosListenerReporter::getInstance()
3364             ->addWindowInfosListener(windowInfosListener, ComposerServiceAIDL::getComposerService(),
3365                                      outInitialInfo);
3366 }
3367 
removeWindowInfosListener(const sp<WindowInfosListener> & windowInfosListener)3368 status_t SurfaceComposerClient::removeWindowInfosListener(
3369         const sp<WindowInfosListener>& windowInfosListener) {
3370     return WindowInfosListenerReporter::getInstance()
3371             ->removeWindowInfosListener(windowInfosListener,
3372                                         ComposerServiceAIDL::getComposerService());
3373 }
3374 
notifyShutdown()3375 void SurfaceComposerClient::notifyShutdown() {
3376     ComposerServiceAIDL::getComposerService()->notifyShutdown();
3377 }
3378 // ----------------------------------------------------------------------------
3379 
captureDisplay(const DisplayCaptureArgs & captureArgs,const sp<IScreenCaptureListener> & captureListener)3380 status_t ScreenshotClient::captureDisplay(const DisplayCaptureArgs& captureArgs,
3381                                           const sp<IScreenCaptureListener>& captureListener) {
3382     sp<gui::ISurfaceComposer> s(ComposerServiceAIDL::getComposerService());
3383     if (s == nullptr) return NO_INIT;
3384 
3385     binder::Status status = s->captureDisplay(captureArgs, captureListener);
3386     return statusTFromBinderStatus(status);
3387 }
3388 
captureDisplay(DisplayId displayId,const gui::CaptureArgs & captureArgs,const sp<IScreenCaptureListener> & captureListener)3389 status_t ScreenshotClient::captureDisplay(DisplayId displayId, const gui::CaptureArgs& captureArgs,
3390                                           const sp<IScreenCaptureListener>& captureListener) {
3391     sp<gui::ISurfaceComposer> s(ComposerServiceAIDL::getComposerService());
3392     if (s == nullptr) return NO_INIT;
3393 
3394     binder::Status status = s->captureDisplayById(displayId.value, captureArgs, captureListener);
3395     return statusTFromBinderStatus(status);
3396 }
3397 
captureLayers(const LayerCaptureArgs & captureArgs,const sp<IScreenCaptureListener> & captureListener,bool sync)3398 status_t ScreenshotClient::captureLayers(const LayerCaptureArgs& captureArgs,
3399                                          const sp<IScreenCaptureListener>& captureListener,
3400                                          bool sync) {
3401     sp<gui::ISurfaceComposer> s(ComposerServiceAIDL::getComposerService());
3402     if (s == nullptr) return NO_INIT;
3403 
3404     binder::Status status;
3405     if (sync) {
3406         gui::ScreenCaptureResults captureResults;
3407         status = s->captureLayersSync(captureArgs, &captureResults);
3408         captureListener->onScreenCaptureCompleted(captureResults);
3409     } else {
3410         status = s->captureLayers(captureArgs, captureListener);
3411     }
3412     return statusTFromBinderStatus(status);
3413 }
3414 
3415 // ---------------------------------------------------------------------------------
3416 
addReleaseCallback(const ReleaseCallbackId callbackId,sp<Fence> releaseFence)3417 void ReleaseCallbackThread::addReleaseCallback(const ReleaseCallbackId callbackId,
3418                                                sp<Fence> releaseFence) {
3419     std::scoped_lock<std::mutex> lock(mMutex);
3420     if (!mStarted) {
3421         mThread = std::thread(&ReleaseCallbackThread::threadMain, this);
3422         mStarted = true;
3423     }
3424 
3425     mCallbackInfos.emplace(callbackId, std::move(releaseFence));
3426     mReleaseCallbackPending.notify_one();
3427 }
3428 
threadMain()3429 void ReleaseCallbackThread::threadMain() {
3430     const auto listener = TransactionCompletedListener::getInstance();
3431     std::queue<std::tuple<const ReleaseCallbackId, const sp<Fence>>> callbackInfos;
3432     while (true) {
3433         {
3434             std::unique_lock<std::mutex> lock(mMutex);
3435             base::ScopedLockAssertion assumeLocked(mMutex);
3436             callbackInfos = std::move(mCallbackInfos);
3437             mCallbackInfos = {};
3438         }
3439 
3440         while (!callbackInfos.empty()) {
3441             auto [callbackId, releaseFence] = callbackInfos.front();
3442             listener->onReleaseBuffer(callbackId, std::move(releaseFence), UINT_MAX);
3443             callbackInfos.pop();
3444         }
3445 
3446         {
3447             std::unique_lock<std::mutex> lock(mMutex);
3448             base::ScopedLockAssertion assumeLocked(mMutex);
3449             if (mCallbackInfos.size() == 0) {
3450                 mReleaseCallbackPending.wait(lock);
3451             }
3452         }
3453     }
3454 }
3455 
3456 } // namespace android
3457