xref: /aosp_15_r20/frameworks/native/services/surfaceflinger/FrontEnd/LayerHierarchy.cpp (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1*38e8c45fSAndroid Build Coastguard Worker /*
2*38e8c45fSAndroid Build Coastguard Worker  * Copyright 2022 The Android Open Source Project
3*38e8c45fSAndroid Build Coastguard Worker  *
4*38e8c45fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*38e8c45fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*38e8c45fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*38e8c45fSAndroid Build Coastguard Worker  *
8*38e8c45fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*38e8c45fSAndroid Build Coastguard Worker  *
10*38e8c45fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*38e8c45fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*38e8c45fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*38e8c45fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*38e8c45fSAndroid Build Coastguard Worker  * limitations under the License.
15*38e8c45fSAndroid Build Coastguard Worker  */
16*38e8c45fSAndroid Build Coastguard Worker 
17*38e8c45fSAndroid Build Coastguard Worker #define ATRACE_TAG ATRACE_TAG_GRAPHICS
18*38e8c45fSAndroid Build Coastguard Worker #undef LOG_TAG
19*38e8c45fSAndroid Build Coastguard Worker #define LOG_TAG "SurfaceFlinger"
20*38e8c45fSAndroid Build Coastguard Worker 
21*38e8c45fSAndroid Build Coastguard Worker #include <android-base/logging.h>
22*38e8c45fSAndroid Build Coastguard Worker 
23*38e8c45fSAndroid Build Coastguard Worker #include "LayerHierarchy.h"
24*38e8c45fSAndroid Build Coastguard Worker #include "LayerLog.h"
25*38e8c45fSAndroid Build Coastguard Worker #include "SwapErase.h"
26*38e8c45fSAndroid Build Coastguard Worker 
27*38e8c45fSAndroid Build Coastguard Worker namespace android::surfaceflinger::frontend {
28*38e8c45fSAndroid Build Coastguard Worker 
29*38e8c45fSAndroid Build Coastguard Worker namespace {
30*38e8c45fSAndroid Build Coastguard Worker auto layerZCompare = [](const std::pair<LayerHierarchy*, LayerHierarchy::Variant>& lhs,
__anon48b1cac90202(const std::pair<LayerHierarchy*, LayerHierarchy::Variant>& lhs, const std::pair<LayerHierarchy*, LayerHierarchy::Variant>& rhs) 31*38e8c45fSAndroid Build Coastguard Worker                         const std::pair<LayerHierarchy*, LayerHierarchy::Variant>& rhs) {
32*38e8c45fSAndroid Build Coastguard Worker     auto lhsLayer = lhs.first->getLayer();
33*38e8c45fSAndroid Build Coastguard Worker     auto rhsLayer = rhs.first->getLayer();
34*38e8c45fSAndroid Build Coastguard Worker     if (lhsLayer->layerStack.id != rhsLayer->layerStack.id) {
35*38e8c45fSAndroid Build Coastguard Worker         return lhsLayer->layerStack.id < rhsLayer->layerStack.id;
36*38e8c45fSAndroid Build Coastguard Worker     }
37*38e8c45fSAndroid Build Coastguard Worker     if (lhsLayer->z != rhsLayer->z) {
38*38e8c45fSAndroid Build Coastguard Worker         return lhsLayer->z < rhsLayer->z;
39*38e8c45fSAndroid Build Coastguard Worker     }
40*38e8c45fSAndroid Build Coastguard Worker     return lhsLayer->id < rhsLayer->id;
41*38e8c45fSAndroid Build Coastguard Worker };
42*38e8c45fSAndroid Build Coastguard Worker 
insertSorted(std::vector<std::pair<LayerHierarchy *,LayerHierarchy::Variant>> & vec,std::pair<LayerHierarchy *,LayerHierarchy::Variant> value)43*38e8c45fSAndroid Build Coastguard Worker void insertSorted(std::vector<std::pair<LayerHierarchy*, LayerHierarchy::Variant>>& vec,
44*38e8c45fSAndroid Build Coastguard Worker                   std::pair<LayerHierarchy*, LayerHierarchy::Variant> value) {
45*38e8c45fSAndroid Build Coastguard Worker     auto it = std::upper_bound(vec.begin(), vec.end(), value, layerZCompare);
46*38e8c45fSAndroid Build Coastguard Worker     vec.insert(it, std::move(value));
47*38e8c45fSAndroid Build Coastguard Worker }
48*38e8c45fSAndroid Build Coastguard Worker } // namespace
49*38e8c45fSAndroid Build Coastguard Worker 
LayerHierarchy(RequestedLayerState * layer)50*38e8c45fSAndroid Build Coastguard Worker LayerHierarchy::LayerHierarchy(RequestedLayerState* layer) : mLayer(layer) {}
51*38e8c45fSAndroid Build Coastguard Worker 
LayerHierarchy(const LayerHierarchy & hierarchy,bool childrenOnly)52*38e8c45fSAndroid Build Coastguard Worker LayerHierarchy::LayerHierarchy(const LayerHierarchy& hierarchy, bool childrenOnly) {
53*38e8c45fSAndroid Build Coastguard Worker     mLayer = (childrenOnly) ? nullptr : hierarchy.mLayer;
54*38e8c45fSAndroid Build Coastguard Worker     mChildren = hierarchy.mChildren;
55*38e8c45fSAndroid Build Coastguard Worker }
56*38e8c45fSAndroid Build Coastguard Worker 
traverse(const Visitor & visitor,LayerHierarchy::TraversalPath & traversalPath,uint32_t depth) const57*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::traverse(const Visitor& visitor, LayerHierarchy::TraversalPath& traversalPath,
58*38e8c45fSAndroid Build Coastguard Worker                               uint32_t depth) const {
59*38e8c45fSAndroid Build Coastguard Worker     LLOG_ALWAYS_FATAL_WITH_TRACE_IF(depth > 50,
60*38e8c45fSAndroid Build Coastguard Worker                                     "Cycle detected in LayerHierarchy::traverse. See "
61*38e8c45fSAndroid Build Coastguard Worker                                     "traverse_stack_overflow_transactions.winscope");
62*38e8c45fSAndroid Build Coastguard Worker 
63*38e8c45fSAndroid Build Coastguard Worker     if (mLayer) {
64*38e8c45fSAndroid Build Coastguard Worker         bool breakTraversal = !visitor(*this, traversalPath);
65*38e8c45fSAndroid Build Coastguard Worker         if (breakTraversal) {
66*38e8c45fSAndroid Build Coastguard Worker             return;
67*38e8c45fSAndroid Build Coastguard Worker         }
68*38e8c45fSAndroid Build Coastguard Worker     }
69*38e8c45fSAndroid Build Coastguard Worker 
70*38e8c45fSAndroid Build Coastguard Worker     LLOG_ALWAYS_FATAL_WITH_TRACE_IF(traversalPath.hasRelZLoop(), "Found relative z loop layerId:%d",
71*38e8c45fSAndroid Build Coastguard Worker                                     traversalPath.invalidRelativeRootId);
72*38e8c45fSAndroid Build Coastguard Worker     for (auto& [child, childVariant] : mChildren) {
73*38e8c45fSAndroid Build Coastguard Worker         ScopedAddToTraversalPath addChildToTraversalPath(traversalPath, child->mLayer->id,
74*38e8c45fSAndroid Build Coastguard Worker                                                          childVariant);
75*38e8c45fSAndroid Build Coastguard Worker         child->traverse(visitor, traversalPath, depth + 1);
76*38e8c45fSAndroid Build Coastguard Worker     }
77*38e8c45fSAndroid Build Coastguard Worker }
78*38e8c45fSAndroid Build Coastguard Worker 
traverseInZOrder(const Visitor & visitor,LayerHierarchy::TraversalPath & traversalPath) const79*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::traverseInZOrder(const Visitor& visitor,
80*38e8c45fSAndroid Build Coastguard Worker                                       LayerHierarchy::TraversalPath& traversalPath) const {
81*38e8c45fSAndroid Build Coastguard Worker     bool traverseThisLayer = (mLayer != nullptr);
82*38e8c45fSAndroid Build Coastguard Worker     for (auto it = mChildren.begin(); it < mChildren.end(); it++) {
83*38e8c45fSAndroid Build Coastguard Worker         auto& [child, childVariant] = *it;
84*38e8c45fSAndroid Build Coastguard Worker         if (traverseThisLayer && child->getLayer()->z >= 0) {
85*38e8c45fSAndroid Build Coastguard Worker             traverseThisLayer = false;
86*38e8c45fSAndroid Build Coastguard Worker             bool breakTraversal = !visitor(*this, traversalPath);
87*38e8c45fSAndroid Build Coastguard Worker             if (breakTraversal) {
88*38e8c45fSAndroid Build Coastguard Worker                 return;
89*38e8c45fSAndroid Build Coastguard Worker             }
90*38e8c45fSAndroid Build Coastguard Worker         }
91*38e8c45fSAndroid Build Coastguard Worker         if (childVariant == LayerHierarchy::Variant::Detached) {
92*38e8c45fSAndroid Build Coastguard Worker             continue;
93*38e8c45fSAndroid Build Coastguard Worker         }
94*38e8c45fSAndroid Build Coastguard Worker         ScopedAddToTraversalPath addChildToTraversalPath(traversalPath, child->mLayer->id,
95*38e8c45fSAndroid Build Coastguard Worker                                                          childVariant);
96*38e8c45fSAndroid Build Coastguard Worker         child->traverseInZOrder(visitor, traversalPath);
97*38e8c45fSAndroid Build Coastguard Worker     }
98*38e8c45fSAndroid Build Coastguard Worker 
99*38e8c45fSAndroid Build Coastguard Worker     if (traverseThisLayer) {
100*38e8c45fSAndroid Build Coastguard Worker         visitor(*this, traversalPath);
101*38e8c45fSAndroid Build Coastguard Worker     }
102*38e8c45fSAndroid Build Coastguard Worker }
103*38e8c45fSAndroid Build Coastguard Worker 
addChild(LayerHierarchy * child,LayerHierarchy::Variant variant)104*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::addChild(LayerHierarchy* child, LayerHierarchy::Variant variant) {
105*38e8c45fSAndroid Build Coastguard Worker     insertSorted(mChildren, {child, variant});
106*38e8c45fSAndroid Build Coastguard Worker }
107*38e8c45fSAndroid Build Coastguard Worker 
removeChild(LayerHierarchy * child)108*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::removeChild(LayerHierarchy* child) {
109*38e8c45fSAndroid Build Coastguard Worker     auto it = std::find_if(mChildren.begin(), mChildren.end(),
110*38e8c45fSAndroid Build Coastguard Worker                            [child](const std::pair<LayerHierarchy*, Variant>& x) {
111*38e8c45fSAndroid Build Coastguard Worker                                return x.first == child;
112*38e8c45fSAndroid Build Coastguard Worker                            });
113*38e8c45fSAndroid Build Coastguard Worker     LLOG_ALWAYS_FATAL_WITH_TRACE_IF(it == mChildren.end(), "Could not find child!");
114*38e8c45fSAndroid Build Coastguard Worker     mChildren.erase(it);
115*38e8c45fSAndroid Build Coastguard Worker }
116*38e8c45fSAndroid Build Coastguard Worker 
sortChildrenByZOrder()117*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::sortChildrenByZOrder() {
118*38e8c45fSAndroid Build Coastguard Worker     std::sort(mChildren.begin(), mChildren.end(), layerZCompare);
119*38e8c45fSAndroid Build Coastguard Worker }
120*38e8c45fSAndroid Build Coastguard Worker 
updateChild(LayerHierarchy * hierarchy,LayerHierarchy::Variant variant)121*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::updateChild(LayerHierarchy* hierarchy, LayerHierarchy::Variant variant) {
122*38e8c45fSAndroid Build Coastguard Worker     auto it = std::find_if(mChildren.begin(), mChildren.end(),
123*38e8c45fSAndroid Build Coastguard Worker                            [hierarchy](std::pair<LayerHierarchy*, Variant>& child) {
124*38e8c45fSAndroid Build Coastguard Worker                                return child.first == hierarchy;
125*38e8c45fSAndroid Build Coastguard Worker                            });
126*38e8c45fSAndroid Build Coastguard Worker     LLOG_ALWAYS_FATAL_WITH_TRACE_IF(it == mChildren.end(), "Could not find child!");
127*38e8c45fSAndroid Build Coastguard Worker     it->second = variant;
128*38e8c45fSAndroid Build Coastguard Worker }
129*38e8c45fSAndroid Build Coastguard Worker 
getLayer() const130*38e8c45fSAndroid Build Coastguard Worker const RequestedLayerState* LayerHierarchy::getLayer() const {
131*38e8c45fSAndroid Build Coastguard Worker     return mLayer;
132*38e8c45fSAndroid Build Coastguard Worker }
133*38e8c45fSAndroid Build Coastguard Worker 
getRelativeParent() const134*38e8c45fSAndroid Build Coastguard Worker const LayerHierarchy* LayerHierarchy::getRelativeParent() const {
135*38e8c45fSAndroid Build Coastguard Worker     return mRelativeParent;
136*38e8c45fSAndroid Build Coastguard Worker }
137*38e8c45fSAndroid Build Coastguard Worker 
getParent() const138*38e8c45fSAndroid Build Coastguard Worker const LayerHierarchy* LayerHierarchy::getParent() const {
139*38e8c45fSAndroid Build Coastguard Worker     return mParent;
140*38e8c45fSAndroid Build Coastguard Worker }
141*38e8c45fSAndroid Build Coastguard Worker 
getDebugStringShort() const142*38e8c45fSAndroid Build Coastguard Worker std::string LayerHierarchy::getDebugStringShort() const {
143*38e8c45fSAndroid Build Coastguard Worker     std::string debug = "LayerHierarchy{";
144*38e8c45fSAndroid Build Coastguard Worker     debug += ((mLayer) ? mLayer->getDebugString() : "root") + " ";
145*38e8c45fSAndroid Build Coastguard Worker     if (mChildren.empty()) {
146*38e8c45fSAndroid Build Coastguard Worker         debug += "no children";
147*38e8c45fSAndroid Build Coastguard Worker     } else {
148*38e8c45fSAndroid Build Coastguard Worker         debug += std::to_string(mChildren.size()) + " children";
149*38e8c45fSAndroid Build Coastguard Worker     }
150*38e8c45fSAndroid Build Coastguard Worker     return debug + "}";
151*38e8c45fSAndroid Build Coastguard Worker }
152*38e8c45fSAndroid Build Coastguard Worker 
dump(std::ostream & out,const std::string & prefix,LayerHierarchy::Variant variant,bool isLastChild,bool includeMirroredHierarchy) const153*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchy::dump(std::ostream& out, const std::string& prefix,
154*38e8c45fSAndroid Build Coastguard Worker                           LayerHierarchy::Variant variant, bool isLastChild,
155*38e8c45fSAndroid Build Coastguard Worker                           bool includeMirroredHierarchy) const {
156*38e8c45fSAndroid Build Coastguard Worker     if (!mLayer) {
157*38e8c45fSAndroid Build Coastguard Worker         out << " ROOT";
158*38e8c45fSAndroid Build Coastguard Worker     } else {
159*38e8c45fSAndroid Build Coastguard Worker         out << prefix + (isLastChild ? "└─ " : "├─ ");
160*38e8c45fSAndroid Build Coastguard Worker         if (variant == LayerHierarchy::Variant::Relative) {
161*38e8c45fSAndroid Build Coastguard Worker             out << "(Relative) ";
162*38e8c45fSAndroid Build Coastguard Worker         } else if (LayerHierarchy::isMirror(variant)) {
163*38e8c45fSAndroid Build Coastguard Worker             if (!includeMirroredHierarchy) {
164*38e8c45fSAndroid Build Coastguard Worker                 out << "(Mirroring) " << *mLayer << "\n" + prefix + "   └─ ...";
165*38e8c45fSAndroid Build Coastguard Worker                 return;
166*38e8c45fSAndroid Build Coastguard Worker             }
167*38e8c45fSAndroid Build Coastguard Worker             out << "(Mirroring) ";
168*38e8c45fSAndroid Build Coastguard Worker         }
169*38e8c45fSAndroid Build Coastguard Worker 
170*38e8c45fSAndroid Build Coastguard Worker         out << *mLayer << " pid=" << mLayer->ownerPid.val() << " uid=" << mLayer->ownerUid.val();
171*38e8c45fSAndroid Build Coastguard Worker     }
172*38e8c45fSAndroid Build Coastguard Worker 
173*38e8c45fSAndroid Build Coastguard Worker     for (size_t i = 0; i < mChildren.size(); i++) {
174*38e8c45fSAndroid Build Coastguard Worker         auto& [child, childVariant] = mChildren[i];
175*38e8c45fSAndroid Build Coastguard Worker         if (childVariant == LayerHierarchy::Variant::Detached) continue;
176*38e8c45fSAndroid Build Coastguard Worker         const bool lastChild = i == (mChildren.size() - 1);
177*38e8c45fSAndroid Build Coastguard Worker         std::string childPrefix = prefix;
178*38e8c45fSAndroid Build Coastguard Worker         if (mLayer) {
179*38e8c45fSAndroid Build Coastguard Worker             childPrefix += (isLastChild ? "   " : "│  ");
180*38e8c45fSAndroid Build Coastguard Worker         }
181*38e8c45fSAndroid Build Coastguard Worker         out << "\n";
182*38e8c45fSAndroid Build Coastguard Worker         child->dump(out, childPrefix, childVariant, lastChild, includeMirroredHierarchy);
183*38e8c45fSAndroid Build Coastguard Worker     }
184*38e8c45fSAndroid Build Coastguard Worker     return;
185*38e8c45fSAndroid Build Coastguard Worker }
186*38e8c45fSAndroid Build Coastguard Worker 
hasRelZLoop(uint32_t & outInvalidRelativeRoot) const187*38e8c45fSAndroid Build Coastguard Worker bool LayerHierarchy::hasRelZLoop(uint32_t& outInvalidRelativeRoot) const {
188*38e8c45fSAndroid Build Coastguard Worker     outInvalidRelativeRoot = UNASSIGNED_LAYER_ID;
189*38e8c45fSAndroid Build Coastguard Worker     traverse([&outInvalidRelativeRoot](const LayerHierarchy&,
190*38e8c45fSAndroid Build Coastguard Worker                                        const LayerHierarchy::TraversalPath& traversalPath) -> bool {
191*38e8c45fSAndroid Build Coastguard Worker         if (traversalPath.hasRelZLoop()) {
192*38e8c45fSAndroid Build Coastguard Worker             outInvalidRelativeRoot = traversalPath.invalidRelativeRootId;
193*38e8c45fSAndroid Build Coastguard Worker             return false;
194*38e8c45fSAndroid Build Coastguard Worker         }
195*38e8c45fSAndroid Build Coastguard Worker         return true;
196*38e8c45fSAndroid Build Coastguard Worker     });
197*38e8c45fSAndroid Build Coastguard Worker     return outInvalidRelativeRoot != UNASSIGNED_LAYER_ID;
198*38e8c45fSAndroid Build Coastguard Worker }
199*38e8c45fSAndroid Build Coastguard Worker 
init(const std::vector<std::unique_ptr<RequestedLayerState>> & layers)200*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::init(const std::vector<std::unique_ptr<RequestedLayerState>>& layers) {
201*38e8c45fSAndroid Build Coastguard Worker     mLayerIdToHierarchy.clear();
202*38e8c45fSAndroid Build Coastguard Worker     mHierarchies.clear();
203*38e8c45fSAndroid Build Coastguard Worker     mRoot = nullptr;
204*38e8c45fSAndroid Build Coastguard Worker     mOffscreenRoot = nullptr;
205*38e8c45fSAndroid Build Coastguard Worker 
206*38e8c45fSAndroid Build Coastguard Worker     mHierarchies.reserve(layers.size());
207*38e8c45fSAndroid Build Coastguard Worker     mLayerIdToHierarchy.reserve(layers.size());
208*38e8c45fSAndroid Build Coastguard Worker     for (auto& layer : layers) {
209*38e8c45fSAndroid Build Coastguard Worker         mHierarchies.emplace_back(std::make_unique<LayerHierarchy>(layer.get()));
210*38e8c45fSAndroid Build Coastguard Worker         mLayerIdToHierarchy[layer->id] = mHierarchies.back().get();
211*38e8c45fSAndroid Build Coastguard Worker     }
212*38e8c45fSAndroid Build Coastguard Worker     for (const auto& layer : layers) {
213*38e8c45fSAndroid Build Coastguard Worker         onLayerAdded(layer.get());
214*38e8c45fSAndroid Build Coastguard Worker     }
215*38e8c45fSAndroid Build Coastguard Worker     detachHierarchyFromRelativeParent(&mOffscreenRoot);
216*38e8c45fSAndroid Build Coastguard Worker     mInitialized = true;
217*38e8c45fSAndroid Build Coastguard Worker }
218*38e8c45fSAndroid Build Coastguard Worker 
attachToParent(LayerHierarchy * hierarchy)219*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::attachToParent(LayerHierarchy* hierarchy) {
220*38e8c45fSAndroid Build Coastguard Worker     auto layer = hierarchy->mLayer;
221*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy::Variant type = layer->hasValidRelativeParent()
222*38e8c45fSAndroid Build Coastguard Worker             ? LayerHierarchy::Variant::Detached
223*38e8c45fSAndroid Build Coastguard Worker             : LayerHierarchy::Variant::Attached;
224*38e8c45fSAndroid Build Coastguard Worker 
225*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy* parent;
226*38e8c45fSAndroid Build Coastguard Worker 
227*38e8c45fSAndroid Build Coastguard Worker     if (layer->parentId != UNASSIGNED_LAYER_ID) {
228*38e8c45fSAndroid Build Coastguard Worker         parent = getHierarchyFromId(layer->parentId);
229*38e8c45fSAndroid Build Coastguard Worker     } else if (layer->canBeRoot) {
230*38e8c45fSAndroid Build Coastguard Worker         parent = &mRoot;
231*38e8c45fSAndroid Build Coastguard Worker     } else {
232*38e8c45fSAndroid Build Coastguard Worker         parent = &mOffscreenRoot;
233*38e8c45fSAndroid Build Coastguard Worker     }
234*38e8c45fSAndroid Build Coastguard Worker     parent->addChild(hierarchy, type);
235*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mParent = parent;
236*38e8c45fSAndroid Build Coastguard Worker }
237*38e8c45fSAndroid Build Coastguard Worker 
detachFromParent(LayerHierarchy * hierarchy)238*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::detachFromParent(LayerHierarchy* hierarchy) {
239*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mParent->removeChild(hierarchy);
240*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mParent = nullptr;
241*38e8c45fSAndroid Build Coastguard Worker }
242*38e8c45fSAndroid Build Coastguard Worker 
attachToRelativeParent(LayerHierarchy * hierarchy)243*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::attachToRelativeParent(LayerHierarchy* hierarchy) {
244*38e8c45fSAndroid Build Coastguard Worker     auto layer = hierarchy->mLayer;
245*38e8c45fSAndroid Build Coastguard Worker     if (!layer->hasValidRelativeParent() || hierarchy->mRelativeParent) {
246*38e8c45fSAndroid Build Coastguard Worker         return;
247*38e8c45fSAndroid Build Coastguard Worker     }
248*38e8c45fSAndroid Build Coastguard Worker 
249*38e8c45fSAndroid Build Coastguard Worker     if (layer->relativeParentId != UNASSIGNED_LAYER_ID) {
250*38e8c45fSAndroid Build Coastguard Worker         hierarchy->mRelativeParent = getHierarchyFromId(layer->relativeParentId);
251*38e8c45fSAndroid Build Coastguard Worker     } else {
252*38e8c45fSAndroid Build Coastguard Worker         hierarchy->mRelativeParent = &mOffscreenRoot;
253*38e8c45fSAndroid Build Coastguard Worker     }
254*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mRelativeParent->addChild(hierarchy, LayerHierarchy::Variant::Relative);
255*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mParent->updateChild(hierarchy, LayerHierarchy::Variant::Detached);
256*38e8c45fSAndroid Build Coastguard Worker }
257*38e8c45fSAndroid Build Coastguard Worker 
detachFromRelativeParent(LayerHierarchy * hierarchy)258*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::detachFromRelativeParent(LayerHierarchy* hierarchy) {
259*38e8c45fSAndroid Build Coastguard Worker     if (hierarchy->mRelativeParent) {
260*38e8c45fSAndroid Build Coastguard Worker         hierarchy->mRelativeParent->removeChild(hierarchy);
261*38e8c45fSAndroid Build Coastguard Worker     }
262*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mRelativeParent = nullptr;
263*38e8c45fSAndroid Build Coastguard Worker     hierarchy->mParent->updateChild(hierarchy, LayerHierarchy::Variant::Attached);
264*38e8c45fSAndroid Build Coastguard Worker }
265*38e8c45fSAndroid Build Coastguard Worker 
getDescendants(LayerHierarchy * root)266*38e8c45fSAndroid Build Coastguard Worker std::vector<LayerHierarchy*> LayerHierarchyBuilder::getDescendants(LayerHierarchy* root) {
267*38e8c45fSAndroid Build Coastguard Worker     std::vector<LayerHierarchy*> hierarchies;
268*38e8c45fSAndroid Build Coastguard Worker     hierarchies.push_back(root);
269*38e8c45fSAndroid Build Coastguard Worker     std::vector<LayerHierarchy*> descendants;
270*38e8c45fSAndroid Build Coastguard Worker     for (size_t i = 0; i < hierarchies.size(); i++) {
271*38e8c45fSAndroid Build Coastguard Worker         LayerHierarchy* hierarchy = hierarchies[i];
272*38e8c45fSAndroid Build Coastguard Worker         if (hierarchy->mLayer) {
273*38e8c45fSAndroid Build Coastguard Worker             descendants.push_back(hierarchy);
274*38e8c45fSAndroid Build Coastguard Worker         }
275*38e8c45fSAndroid Build Coastguard Worker         for (auto& [child, childVariant] : hierarchy->mChildren) {
276*38e8c45fSAndroid Build Coastguard Worker             if (childVariant == LayerHierarchy::Variant::Detached ||
277*38e8c45fSAndroid Build Coastguard Worker                 childVariant == LayerHierarchy::Variant::Attached) {
278*38e8c45fSAndroid Build Coastguard Worker                 hierarchies.push_back(child);
279*38e8c45fSAndroid Build Coastguard Worker             }
280*38e8c45fSAndroid Build Coastguard Worker         }
281*38e8c45fSAndroid Build Coastguard Worker     }
282*38e8c45fSAndroid Build Coastguard Worker     return descendants;
283*38e8c45fSAndroid Build Coastguard Worker }
284*38e8c45fSAndroid Build Coastguard Worker 
attachHierarchyToRelativeParent(LayerHierarchy * root)285*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::attachHierarchyToRelativeParent(LayerHierarchy* root) {
286*38e8c45fSAndroid Build Coastguard Worker     std::vector<LayerHierarchy*> hierarchiesToAttach = getDescendants(root);
287*38e8c45fSAndroid Build Coastguard Worker     for (LayerHierarchy* hierarchy : hierarchiesToAttach) {
288*38e8c45fSAndroid Build Coastguard Worker         attachToRelativeParent(hierarchy);
289*38e8c45fSAndroid Build Coastguard Worker     }
290*38e8c45fSAndroid Build Coastguard Worker }
291*38e8c45fSAndroid Build Coastguard Worker 
detachHierarchyFromRelativeParent(LayerHierarchy * root)292*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::detachHierarchyFromRelativeParent(LayerHierarchy* root) {
293*38e8c45fSAndroid Build Coastguard Worker     std::vector<LayerHierarchy*> hierarchiesToDetach = getDescendants(root);
294*38e8c45fSAndroid Build Coastguard Worker     for (LayerHierarchy* hierarchy : hierarchiesToDetach) {
295*38e8c45fSAndroid Build Coastguard Worker         detachFromRelativeParent(hierarchy);
296*38e8c45fSAndroid Build Coastguard Worker     }
297*38e8c45fSAndroid Build Coastguard Worker }
298*38e8c45fSAndroid Build Coastguard Worker 
onLayerAdded(RequestedLayerState * layer)299*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::onLayerAdded(RequestedLayerState* layer) {
300*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy* hierarchy = getHierarchyFromId(layer->id);
301*38e8c45fSAndroid Build Coastguard Worker     attachToParent(hierarchy);
302*38e8c45fSAndroid Build Coastguard Worker     attachToRelativeParent(hierarchy);
303*38e8c45fSAndroid Build Coastguard Worker 
304*38e8c45fSAndroid Build Coastguard Worker     for (uint32_t mirrorId : layer->mirrorIds) {
305*38e8c45fSAndroid Build Coastguard Worker         LayerHierarchy* mirror = getHierarchyFromId(mirrorId);
306*38e8c45fSAndroid Build Coastguard Worker         hierarchy->addChild(mirror, LayerHierarchy::Variant::Mirror);
307*38e8c45fSAndroid Build Coastguard Worker     }
308*38e8c45fSAndroid Build Coastguard Worker     if (FlagManager::getInstance().detached_mirror()) {
309*38e8c45fSAndroid Build Coastguard Worker         if (layer->layerIdToMirror != UNASSIGNED_LAYER_ID) {
310*38e8c45fSAndroid Build Coastguard Worker             LayerHierarchy* mirror = getHierarchyFromId(layer->layerIdToMirror);
311*38e8c45fSAndroid Build Coastguard Worker             hierarchy->addChild(mirror, LayerHierarchy::Variant::Detached_Mirror);
312*38e8c45fSAndroid Build Coastguard Worker         }
313*38e8c45fSAndroid Build Coastguard Worker     }
314*38e8c45fSAndroid Build Coastguard Worker }
315*38e8c45fSAndroid Build Coastguard Worker 
onLayerDestroyed(RequestedLayerState * layer)316*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::onLayerDestroyed(RequestedLayerState* layer) {
317*38e8c45fSAndroid Build Coastguard Worker     LLOGV(layer->id, "");
318*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy* hierarchy = getHierarchyFromId(layer->id, /*crashOnFailure=*/false);
319*38e8c45fSAndroid Build Coastguard Worker     if (!hierarchy) {
320*38e8c45fSAndroid Build Coastguard Worker         // Layer was never part of the hierarchy if it was created and destroyed in the same
321*38e8c45fSAndroid Build Coastguard Worker         // transaction.
322*38e8c45fSAndroid Build Coastguard Worker         return;
323*38e8c45fSAndroid Build Coastguard Worker     }
324*38e8c45fSAndroid Build Coastguard Worker     // detach from parent
325*38e8c45fSAndroid Build Coastguard Worker     detachFromRelativeParent(hierarchy);
326*38e8c45fSAndroid Build Coastguard Worker     detachFromParent(hierarchy);
327*38e8c45fSAndroid Build Coastguard Worker 
328*38e8c45fSAndroid Build Coastguard Worker     // detach children
329*38e8c45fSAndroid Build Coastguard Worker     for (auto& [child, variant] : hierarchy->mChildren) {
330*38e8c45fSAndroid Build Coastguard Worker         if (variant == LayerHierarchy::Variant::Attached ||
331*38e8c45fSAndroid Build Coastguard Worker             variant == LayerHierarchy::Variant::Detached) {
332*38e8c45fSAndroid Build Coastguard Worker             mOffscreenRoot.addChild(child, LayerHierarchy::Variant::Attached);
333*38e8c45fSAndroid Build Coastguard Worker             child->mParent = &mOffscreenRoot;
334*38e8c45fSAndroid Build Coastguard Worker         } else if (variant == LayerHierarchy::Variant::Relative) {
335*38e8c45fSAndroid Build Coastguard Worker             mOffscreenRoot.addChild(child, LayerHierarchy::Variant::Attached);
336*38e8c45fSAndroid Build Coastguard Worker             child->mRelativeParent = &mOffscreenRoot;
337*38e8c45fSAndroid Build Coastguard Worker         }
338*38e8c45fSAndroid Build Coastguard Worker     }
339*38e8c45fSAndroid Build Coastguard Worker 
340*38e8c45fSAndroid Build Coastguard Worker     swapErase(mHierarchies, [hierarchy](std::unique_ptr<LayerHierarchy>& layerHierarchy) {
341*38e8c45fSAndroid Build Coastguard Worker         return layerHierarchy.get() == hierarchy;
342*38e8c45fSAndroid Build Coastguard Worker     });
343*38e8c45fSAndroid Build Coastguard Worker     mLayerIdToHierarchy.erase(layer->id);
344*38e8c45fSAndroid Build Coastguard Worker }
345*38e8c45fSAndroid Build Coastguard Worker 
updateMirrorLayer(RequestedLayerState * layer)346*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::updateMirrorLayer(RequestedLayerState* layer) {
347*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy* hierarchy = getHierarchyFromId(layer->id);
348*38e8c45fSAndroid Build Coastguard Worker     auto it = hierarchy->mChildren.begin();
349*38e8c45fSAndroid Build Coastguard Worker     while (it != hierarchy->mChildren.end()) {
350*38e8c45fSAndroid Build Coastguard Worker         if (LayerHierarchy::isMirror(it->second)) {
351*38e8c45fSAndroid Build Coastguard Worker             it = hierarchy->mChildren.erase(it);
352*38e8c45fSAndroid Build Coastguard Worker         } else {
353*38e8c45fSAndroid Build Coastguard Worker             it++;
354*38e8c45fSAndroid Build Coastguard Worker         }
355*38e8c45fSAndroid Build Coastguard Worker     }
356*38e8c45fSAndroid Build Coastguard Worker 
357*38e8c45fSAndroid Build Coastguard Worker     for (uint32_t mirrorId : layer->mirrorIds) {
358*38e8c45fSAndroid Build Coastguard Worker         hierarchy->addChild(getHierarchyFromId(mirrorId), LayerHierarchy::Variant::Mirror);
359*38e8c45fSAndroid Build Coastguard Worker     }
360*38e8c45fSAndroid Build Coastguard Worker     if (FlagManager::getInstance().detached_mirror()) {
361*38e8c45fSAndroid Build Coastguard Worker         if (layer->layerIdToMirror != UNASSIGNED_LAYER_ID) {
362*38e8c45fSAndroid Build Coastguard Worker             hierarchy->addChild(getHierarchyFromId(layer->layerIdToMirror),
363*38e8c45fSAndroid Build Coastguard Worker                                 LayerHierarchy::Variant::Detached_Mirror);
364*38e8c45fSAndroid Build Coastguard Worker         }
365*38e8c45fSAndroid Build Coastguard Worker     }
366*38e8c45fSAndroid Build Coastguard Worker }
367*38e8c45fSAndroid Build Coastguard Worker 
doUpdate(const std::vector<std::unique_ptr<RequestedLayerState>> & layers,const std::vector<std::unique_ptr<RequestedLayerState>> & destroyedLayers)368*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::doUpdate(
369*38e8c45fSAndroid Build Coastguard Worker         const std::vector<std::unique_ptr<RequestedLayerState>>& layers,
370*38e8c45fSAndroid Build Coastguard Worker         const std::vector<std::unique_ptr<RequestedLayerState>>& destroyedLayers) {
371*38e8c45fSAndroid Build Coastguard Worker     // rebuild map
372*38e8c45fSAndroid Build Coastguard Worker     for (auto& layer : layers) {
373*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.test(RequestedLayerState::Changes::Created)) {
374*38e8c45fSAndroid Build Coastguard Worker             mHierarchies.emplace_back(std::make_unique<LayerHierarchy>(layer.get()));
375*38e8c45fSAndroid Build Coastguard Worker             mLayerIdToHierarchy[layer->id] = mHierarchies.back().get();
376*38e8c45fSAndroid Build Coastguard Worker         }
377*38e8c45fSAndroid Build Coastguard Worker     }
378*38e8c45fSAndroid Build Coastguard Worker 
379*38e8c45fSAndroid Build Coastguard Worker     for (auto& layer : layers) {
380*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.get() == 0) {
381*38e8c45fSAndroid Build Coastguard Worker             continue;
382*38e8c45fSAndroid Build Coastguard Worker         }
383*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.test(RequestedLayerState::Changes::Created)) {
384*38e8c45fSAndroid Build Coastguard Worker             onLayerAdded(layer.get());
385*38e8c45fSAndroid Build Coastguard Worker             continue;
386*38e8c45fSAndroid Build Coastguard Worker         }
387*38e8c45fSAndroid Build Coastguard Worker         LayerHierarchy* hierarchy = getHierarchyFromId(layer->id);
388*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.test(RequestedLayerState::Changes::Parent)) {
389*38e8c45fSAndroid Build Coastguard Worker             detachFromParent(hierarchy);
390*38e8c45fSAndroid Build Coastguard Worker             attachToParent(hierarchy);
391*38e8c45fSAndroid Build Coastguard Worker         }
392*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.test(RequestedLayerState::Changes::RelativeParent)) {
393*38e8c45fSAndroid Build Coastguard Worker             detachFromRelativeParent(hierarchy);
394*38e8c45fSAndroid Build Coastguard Worker             attachToRelativeParent(hierarchy);
395*38e8c45fSAndroid Build Coastguard Worker         }
396*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.test(RequestedLayerState::Changes::Z)) {
397*38e8c45fSAndroid Build Coastguard Worker             hierarchy->mParent->sortChildrenByZOrder();
398*38e8c45fSAndroid Build Coastguard Worker             if (hierarchy->mRelativeParent) {
399*38e8c45fSAndroid Build Coastguard Worker                 hierarchy->mRelativeParent->sortChildrenByZOrder();
400*38e8c45fSAndroid Build Coastguard Worker             }
401*38e8c45fSAndroid Build Coastguard Worker         }
402*38e8c45fSAndroid Build Coastguard Worker         if (layer->changes.test(RequestedLayerState::Changes::Mirror)) {
403*38e8c45fSAndroid Build Coastguard Worker             updateMirrorLayer(layer.get());
404*38e8c45fSAndroid Build Coastguard Worker         }
405*38e8c45fSAndroid Build Coastguard Worker     }
406*38e8c45fSAndroid Build Coastguard Worker 
407*38e8c45fSAndroid Build Coastguard Worker     for (auto& layer : destroyedLayers) {
408*38e8c45fSAndroid Build Coastguard Worker         onLayerDestroyed(layer.get());
409*38e8c45fSAndroid Build Coastguard Worker     }
410*38e8c45fSAndroid Build Coastguard Worker     // When moving from onscreen to offscreen and vice versa, we need to attach and detach
411*38e8c45fSAndroid Build Coastguard Worker     // from our relative parents. This walks down both trees to do so. We can optimize this
412*38e8c45fSAndroid Build Coastguard Worker     // further by tracking onscreen, offscreen state in LayerHierarchy.
413*38e8c45fSAndroid Build Coastguard Worker     detachHierarchyFromRelativeParent(&mOffscreenRoot);
414*38e8c45fSAndroid Build Coastguard Worker     attachHierarchyToRelativeParent(&mRoot);
415*38e8c45fSAndroid Build Coastguard Worker }
416*38e8c45fSAndroid Build Coastguard Worker 
update(LayerLifecycleManager & layerLifecycleManager)417*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::update(LayerLifecycleManager& layerLifecycleManager) {
418*38e8c45fSAndroid Build Coastguard Worker     if (!mInitialized) {
419*38e8c45fSAndroid Build Coastguard Worker         SFTRACE_NAME("LayerHierarchyBuilder:init");
420*38e8c45fSAndroid Build Coastguard Worker         init(layerLifecycleManager.getLayers());
421*38e8c45fSAndroid Build Coastguard Worker     } else if (layerLifecycleManager.getGlobalChanges().test(
422*38e8c45fSAndroid Build Coastguard Worker                        RequestedLayerState::Changes::Hierarchy)) {
423*38e8c45fSAndroid Build Coastguard Worker         SFTRACE_NAME("LayerHierarchyBuilder:update");
424*38e8c45fSAndroid Build Coastguard Worker         doUpdate(layerLifecycleManager.getLayers(), layerLifecycleManager.getDestroyedLayers());
425*38e8c45fSAndroid Build Coastguard Worker     } else {
426*38e8c45fSAndroid Build Coastguard Worker         return; // nothing to do
427*38e8c45fSAndroid Build Coastguard Worker     }
428*38e8c45fSAndroid Build Coastguard Worker 
429*38e8c45fSAndroid Build Coastguard Worker     uint32_t invalidRelativeRoot;
430*38e8c45fSAndroid Build Coastguard Worker     bool hasRelZLoop = mRoot.hasRelZLoop(invalidRelativeRoot);
431*38e8c45fSAndroid Build Coastguard Worker     while (hasRelZLoop) {
432*38e8c45fSAndroid Build Coastguard Worker         SFTRACE_NAME("FixRelZLoop");
433*38e8c45fSAndroid Build Coastguard Worker         TransactionTraceWriter::getInstance().invoke("relz_loop_detected",
434*38e8c45fSAndroid Build Coastguard Worker                                                      /*overwrite=*/false);
435*38e8c45fSAndroid Build Coastguard Worker         layerLifecycleManager.fixRelativeZLoop(invalidRelativeRoot);
436*38e8c45fSAndroid Build Coastguard Worker         // reinitialize the hierarchy with the updated layer data
437*38e8c45fSAndroid Build Coastguard Worker         init(layerLifecycleManager.getLayers());
438*38e8c45fSAndroid Build Coastguard Worker         // check if we have any remaining loops
439*38e8c45fSAndroid Build Coastguard Worker         hasRelZLoop = mRoot.hasRelZLoop(invalidRelativeRoot);
440*38e8c45fSAndroid Build Coastguard Worker     }
441*38e8c45fSAndroid Build Coastguard Worker }
442*38e8c45fSAndroid Build Coastguard Worker 
getHierarchy() const443*38e8c45fSAndroid Build Coastguard Worker const LayerHierarchy& LayerHierarchyBuilder::getHierarchy() const {
444*38e8c45fSAndroid Build Coastguard Worker     return mRoot;
445*38e8c45fSAndroid Build Coastguard Worker }
446*38e8c45fSAndroid Build Coastguard Worker 
getOffscreenHierarchy() const447*38e8c45fSAndroid Build Coastguard Worker const LayerHierarchy& LayerHierarchyBuilder::getOffscreenHierarchy() const {
448*38e8c45fSAndroid Build Coastguard Worker     return mOffscreenRoot;
449*38e8c45fSAndroid Build Coastguard Worker }
450*38e8c45fSAndroid Build Coastguard Worker 
getDebugString(uint32_t layerId,uint32_t depth) const451*38e8c45fSAndroid Build Coastguard Worker std::string LayerHierarchyBuilder::getDebugString(uint32_t layerId, uint32_t depth) const {
452*38e8c45fSAndroid Build Coastguard Worker     if (depth > 10) return "too deep, loop?";
453*38e8c45fSAndroid Build Coastguard Worker     if (layerId == UNASSIGNED_LAYER_ID) return "";
454*38e8c45fSAndroid Build Coastguard Worker     auto it = mLayerIdToHierarchy.find(layerId);
455*38e8c45fSAndroid Build Coastguard Worker     if (it == mLayerIdToHierarchy.end()) return "not found";
456*38e8c45fSAndroid Build Coastguard Worker 
457*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy* hierarchy = it->second;
458*38e8c45fSAndroid Build Coastguard Worker     if (!hierarchy->mLayer) return "none";
459*38e8c45fSAndroid Build Coastguard Worker 
460*38e8c45fSAndroid Build Coastguard Worker     std::string debug =
461*38e8c45fSAndroid Build Coastguard Worker             "[" + std::to_string(hierarchy->mLayer->id) + "] " + hierarchy->mLayer->name;
462*38e8c45fSAndroid Build Coastguard Worker     if (hierarchy->mRelativeParent) {
463*38e8c45fSAndroid Build Coastguard Worker         debug += " Relative:" + hierarchy->mRelativeParent->getDebugStringShort();
464*38e8c45fSAndroid Build Coastguard Worker     }
465*38e8c45fSAndroid Build Coastguard Worker     if (hierarchy->mParent) {
466*38e8c45fSAndroid Build Coastguard Worker         debug += " Parent:" + hierarchy->mParent->getDebugStringShort();
467*38e8c45fSAndroid Build Coastguard Worker     }
468*38e8c45fSAndroid Build Coastguard Worker     return debug;
469*38e8c45fSAndroid Build Coastguard Worker }
470*38e8c45fSAndroid Build Coastguard Worker 
getPartialHierarchy(uint32_t layerId,bool childrenOnly) const471*38e8c45fSAndroid Build Coastguard Worker LayerHierarchy LayerHierarchyBuilder::getPartialHierarchy(uint32_t layerId,
472*38e8c45fSAndroid Build Coastguard Worker                                                           bool childrenOnly) const {
473*38e8c45fSAndroid Build Coastguard Worker     auto it = mLayerIdToHierarchy.find(layerId);
474*38e8c45fSAndroid Build Coastguard Worker     if (it == mLayerIdToHierarchy.end()) return {nullptr};
475*38e8c45fSAndroid Build Coastguard Worker 
476*38e8c45fSAndroid Build Coastguard Worker     LayerHierarchy hierarchy(*it->second, childrenOnly);
477*38e8c45fSAndroid Build Coastguard Worker     return hierarchy;
478*38e8c45fSAndroid Build Coastguard Worker }
479*38e8c45fSAndroid Build Coastguard Worker 
getHierarchyFromId(uint32_t layerId,bool crashOnFailure)480*38e8c45fSAndroid Build Coastguard Worker LayerHierarchy* LayerHierarchyBuilder::getHierarchyFromId(uint32_t layerId, bool crashOnFailure) {
481*38e8c45fSAndroid Build Coastguard Worker     auto it = mLayerIdToHierarchy.find(layerId);
482*38e8c45fSAndroid Build Coastguard Worker     if (it == mLayerIdToHierarchy.end()) {
483*38e8c45fSAndroid Build Coastguard Worker         LLOG_ALWAYS_FATAL_WITH_TRACE_IF(crashOnFailure, "Could not find hierarchy for layer id %d",
484*38e8c45fSAndroid Build Coastguard Worker                                         layerId);
485*38e8c45fSAndroid Build Coastguard Worker         return nullptr;
486*38e8c45fSAndroid Build Coastguard Worker     };
487*38e8c45fSAndroid Build Coastguard Worker 
488*38e8c45fSAndroid Build Coastguard Worker     return it->second;
489*38e8c45fSAndroid Build Coastguard Worker }
490*38e8c45fSAndroid Build Coastguard Worker 
logSampledChildren(const LayerHierarchy & hierarchy) const491*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::logSampledChildren(const LayerHierarchy& hierarchy) const {
492*38e8c45fSAndroid Build Coastguard Worker     LOG(ERROR) << "Dumping random sampling of child layers.";
493*38e8c45fSAndroid Build Coastguard Worker     int sampleSize = static_cast<int>(hierarchy.mChildren.size() / 100 + 1);
494*38e8c45fSAndroid Build Coastguard Worker     for (const auto& [child, variant] : hierarchy.mChildren) {
495*38e8c45fSAndroid Build Coastguard Worker         if (rand() % sampleSize == 0) {
496*38e8c45fSAndroid Build Coastguard Worker             LOG(ERROR) << "Child Layer: " << *(child->mLayer);
497*38e8c45fSAndroid Build Coastguard Worker         }
498*38e8c45fSAndroid Build Coastguard Worker     }
499*38e8c45fSAndroid Build Coastguard Worker }
500*38e8c45fSAndroid Build Coastguard Worker 
dumpLayerSample(const LayerHierarchy & root) const501*38e8c45fSAndroid Build Coastguard Worker void LayerHierarchyBuilder::dumpLayerSample(const LayerHierarchy& root) const {
502*38e8c45fSAndroid Build Coastguard Worker     LOG(ERROR) << "Dumping layer keeping > 20 children alive:";
503*38e8c45fSAndroid Build Coastguard Worker     // If mLayer is nullptr, it will be skipped while traversing.
504*38e8c45fSAndroid Build Coastguard Worker     if (!root.mLayer && root.mChildren.size() > 20) {
505*38e8c45fSAndroid Build Coastguard Worker         LOG(ERROR) << "ROOT has " << root.mChildren.size() << " children";
506*38e8c45fSAndroid Build Coastguard Worker         logSampledChildren(root);
507*38e8c45fSAndroid Build Coastguard Worker     }
508*38e8c45fSAndroid Build Coastguard Worker     root.traverse([&](const LayerHierarchy& hierarchy, const auto&) -> bool {
509*38e8c45fSAndroid Build Coastguard Worker         if (hierarchy.mChildren.size() <= 20) {
510*38e8c45fSAndroid Build Coastguard Worker             return true;
511*38e8c45fSAndroid Build Coastguard Worker         }
512*38e8c45fSAndroid Build Coastguard Worker         // mLayer is ensured to be non-null. See LayerHierarchy::traverse.
513*38e8c45fSAndroid Build Coastguard Worker         const auto* layer = hierarchy.mLayer;
514*38e8c45fSAndroid Build Coastguard Worker         const auto childrenCount = hierarchy.mChildren.size();
515*38e8c45fSAndroid Build Coastguard Worker         LOG(ERROR) << "Layer " << *layer << " has " << childrenCount << " children";
516*38e8c45fSAndroid Build Coastguard Worker 
517*38e8c45fSAndroid Build Coastguard Worker         const auto* parent = hierarchy.mParent;
518*38e8c45fSAndroid Build Coastguard Worker         while (parent != nullptr) {
519*38e8c45fSAndroid Build Coastguard Worker             if (!parent->mLayer) break;
520*38e8c45fSAndroid Build Coastguard Worker             LOG(ERROR) << "Parent Layer: " << *(parent->mLayer);
521*38e8c45fSAndroid Build Coastguard Worker             parent = parent->mParent;
522*38e8c45fSAndroid Build Coastguard Worker         }
523*38e8c45fSAndroid Build Coastguard Worker 
524*38e8c45fSAndroid Build Coastguard Worker         logSampledChildren(hierarchy);
525*38e8c45fSAndroid Build Coastguard Worker         // Stop traversing.
526*38e8c45fSAndroid Build Coastguard Worker         return false;
527*38e8c45fSAndroid Build Coastguard Worker     });
528*38e8c45fSAndroid Build Coastguard Worker     LOG(ERROR) << "Dumping random sampled layers.";
529*38e8c45fSAndroid Build Coastguard Worker     size_t numLayers = 0;
530*38e8c45fSAndroid Build Coastguard Worker     root.traverse([&](const LayerHierarchy& hierarchy, const auto&) -> bool {
531*38e8c45fSAndroid Build Coastguard Worker         if (hierarchy.mLayer) numLayers++;
532*38e8c45fSAndroid Build Coastguard Worker         if ((rand() % 20 == 13) && hierarchy.mLayer) {
533*38e8c45fSAndroid Build Coastguard Worker             LOG(ERROR) << "Layer: " << *(hierarchy.mLayer);
534*38e8c45fSAndroid Build Coastguard Worker         }
535*38e8c45fSAndroid Build Coastguard Worker         return true;
536*38e8c45fSAndroid Build Coastguard Worker     });
537*38e8c45fSAndroid Build Coastguard Worker     LOG(ERROR) << "Total layer count: " << numLayers;
538*38e8c45fSAndroid Build Coastguard Worker }
539*38e8c45fSAndroid Build Coastguard Worker 
540*38e8c45fSAndroid Build Coastguard Worker const LayerHierarchy::TraversalPath LayerHierarchy::TraversalPath::ROOT =
541*38e8c45fSAndroid Build Coastguard Worker         {.id = UNASSIGNED_LAYER_ID, .variant = LayerHierarchy::Attached};
542*38e8c45fSAndroid Build Coastguard Worker 
toString() const543*38e8c45fSAndroid Build Coastguard Worker std::string LayerHierarchy::TraversalPath::toString() const {
544*38e8c45fSAndroid Build Coastguard Worker     if (id == UNASSIGNED_LAYER_ID) {
545*38e8c45fSAndroid Build Coastguard Worker         return "TraversalPath{ROOT}";
546*38e8c45fSAndroid Build Coastguard Worker     }
547*38e8c45fSAndroid Build Coastguard Worker     std::stringstream ss;
548*38e8c45fSAndroid Build Coastguard Worker     ss << "TraversalPath{.id = " << id;
549*38e8c45fSAndroid Build Coastguard Worker 
550*38e8c45fSAndroid Build Coastguard Worker     if (!mirrorRootIds.empty()) {
551*38e8c45fSAndroid Build Coastguard Worker         ss << ", .mirrorRootIds=";
552*38e8c45fSAndroid Build Coastguard Worker         for (auto rootId : mirrorRootIds) {
553*38e8c45fSAndroid Build Coastguard Worker             ss << rootId << ",";
554*38e8c45fSAndroid Build Coastguard Worker         }
555*38e8c45fSAndroid Build Coastguard Worker     }
556*38e8c45fSAndroid Build Coastguard Worker 
557*38e8c45fSAndroid Build Coastguard Worker     if (!relativeRootIds.empty()) {
558*38e8c45fSAndroid Build Coastguard Worker         ss << ", .relativeRootIds=";
559*38e8c45fSAndroid Build Coastguard Worker         for (auto rootId : relativeRootIds) {
560*38e8c45fSAndroid Build Coastguard Worker             ss << rootId << ",";
561*38e8c45fSAndroid Build Coastguard Worker         }
562*38e8c45fSAndroid Build Coastguard Worker     }
563*38e8c45fSAndroid Build Coastguard Worker 
564*38e8c45fSAndroid Build Coastguard Worker     if (hasRelZLoop()) {
565*38e8c45fSAndroid Build Coastguard Worker         ss << "hasRelZLoop=true invalidRelativeRootId=" << invalidRelativeRootId << ",";
566*38e8c45fSAndroid Build Coastguard Worker     }
567*38e8c45fSAndroid Build Coastguard Worker     ss << "}";
568*38e8c45fSAndroid Build Coastguard Worker     return ss.str();
569*38e8c45fSAndroid Build Coastguard Worker }
570*38e8c45fSAndroid Build Coastguard Worker 
571*38e8c45fSAndroid Build Coastguard Worker // Helper class to update a passed in TraversalPath when visiting a child. When the object goes out
572*38e8c45fSAndroid Build Coastguard Worker // of scope the TraversalPath is reset to its original state.
ScopedAddToTraversalPath(TraversalPath & traversalPath,uint32_t layerId,LayerHierarchy::Variant variant)573*38e8c45fSAndroid Build Coastguard Worker LayerHierarchy::ScopedAddToTraversalPath::ScopedAddToTraversalPath(TraversalPath& traversalPath,
574*38e8c45fSAndroid Build Coastguard Worker                                                                    uint32_t layerId,
575*38e8c45fSAndroid Build Coastguard Worker                                                                    LayerHierarchy::Variant variant)
576*38e8c45fSAndroid Build Coastguard Worker       : mTraversalPath(traversalPath), mParentPath(traversalPath) {
577*38e8c45fSAndroid Build Coastguard Worker     // Update the traversal id with the child layer id and variant. Parent id and variant are
578*38e8c45fSAndroid Build Coastguard Worker     // stored to reset the id upon destruction.
579*38e8c45fSAndroid Build Coastguard Worker     traversalPath.id = layerId;
580*38e8c45fSAndroid Build Coastguard Worker     traversalPath.variant = variant;
581*38e8c45fSAndroid Build Coastguard Worker     if (LayerHierarchy::isMirror(variant)) {
582*38e8c45fSAndroid Build Coastguard Worker         traversalPath.mirrorRootIds.emplace_back(mParentPath.id);
583*38e8c45fSAndroid Build Coastguard Worker     } else if (variant == LayerHierarchy::Variant::Relative) {
584*38e8c45fSAndroid Build Coastguard Worker         if (std::find(traversalPath.relativeRootIds.begin(), traversalPath.relativeRootIds.end(),
585*38e8c45fSAndroid Build Coastguard Worker                       layerId) != traversalPath.relativeRootIds.end()) {
586*38e8c45fSAndroid Build Coastguard Worker             traversalPath.invalidRelativeRootId = layerId;
587*38e8c45fSAndroid Build Coastguard Worker         }
588*38e8c45fSAndroid Build Coastguard Worker         traversalPath.relativeRootIds.emplace_back(layerId);
589*38e8c45fSAndroid Build Coastguard Worker     } else if (variant == LayerHierarchy::Variant::Detached) {
590*38e8c45fSAndroid Build Coastguard Worker         traversalPath.detached = true;
591*38e8c45fSAndroid Build Coastguard Worker     }
592*38e8c45fSAndroid Build Coastguard Worker }
~ScopedAddToTraversalPath()593*38e8c45fSAndroid Build Coastguard Worker LayerHierarchy::ScopedAddToTraversalPath::~ScopedAddToTraversalPath() {
594*38e8c45fSAndroid Build Coastguard Worker     // Reset the traversal id to its original parent state using the state that was saved in
595*38e8c45fSAndroid Build Coastguard Worker     // the constructor.
596*38e8c45fSAndroid Build Coastguard Worker     if (LayerHierarchy::isMirror(mTraversalPath.variant)) {
597*38e8c45fSAndroid Build Coastguard Worker         mTraversalPath.mirrorRootIds.pop_back();
598*38e8c45fSAndroid Build Coastguard Worker     } else if (mTraversalPath.variant == LayerHierarchy::Variant::Relative) {
599*38e8c45fSAndroid Build Coastguard Worker         mTraversalPath.relativeRootIds.pop_back();
600*38e8c45fSAndroid Build Coastguard Worker     }
601*38e8c45fSAndroid Build Coastguard Worker     if (mTraversalPath.invalidRelativeRootId == mTraversalPath.id) {
602*38e8c45fSAndroid Build Coastguard Worker         mTraversalPath.invalidRelativeRootId = UNASSIGNED_LAYER_ID;
603*38e8c45fSAndroid Build Coastguard Worker     }
604*38e8c45fSAndroid Build Coastguard Worker     mTraversalPath.id = mParentPath.id;
605*38e8c45fSAndroid Build Coastguard Worker     mTraversalPath.variant = mParentPath.variant;
606*38e8c45fSAndroid Build Coastguard Worker     mTraversalPath.detached = mParentPath.detached;
607*38e8c45fSAndroid Build Coastguard Worker }
608*38e8c45fSAndroid Build Coastguard Worker 
609*38e8c45fSAndroid Build Coastguard Worker } // namespace android::surfaceflinger::frontend
610