From 1f6d6d5db93ef4c3bbaeb5241eede30635fa5ff1 Mon Sep 17 00:00:00 2001 From: Evan Rosky Date: Thu, 6 Dec 2018 10:47:26 -0800 Subject: Add metadata store to surfaces This adds a key/value metadata storage mechanism to surfaces that allows the windowmanager to pass information to the surfaceflinger frontend. This then moves the existing metadata (window type and ownerUID) into this metadata structure. Bug: 122925737 Test: Phone boots and surfaces fling. Some unittests Change-Id: I72c574737b7f75be2311a341812b15d385f507ed --- libs/gui/LayerMetadata.cpp | 114 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 libs/gui/LayerMetadata.cpp (limited to 'libs/gui/LayerMetadata.cpp') diff --git a/libs/gui/LayerMetadata.cpp b/libs/gui/LayerMetadata.cpp new file mode 100644 index 0000000000..c8a2b0754b --- /dev/null +++ b/libs/gui/LayerMetadata.cpp @@ -0,0 +1,114 @@ +/* + * Copyright (C) 2019 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include +#include +#include + +using android::base::StringPrintf; + +namespace android { + +LayerMetadata::LayerMetadata() = default; + +LayerMetadata::LayerMetadata(std::unordered_map> map) + : mMap(std::move(map)) {} + +LayerMetadata::LayerMetadata(const LayerMetadata& other) = default; + +LayerMetadata::LayerMetadata(LayerMetadata&& other) = default; + +void LayerMetadata::merge(const LayerMetadata& other) { + for (const auto& entry : other.mMap) { + mMap[entry.first] = entry.second; + } +} + +status_t LayerMetadata::writeToParcel(Parcel* parcel) const { + parcel->writeInt32(static_cast(mMap.size())); + status_t status = OK; + for (const auto& entry : mMap) { + status = parcel->writeUint32(entry.first); + if (status != OK) { + break; + } + status = parcel->writeByteVector(entry.second); + if (status != OK) { + break; + } + } + return status; +} + +status_t LayerMetadata::readFromParcel(const Parcel* parcel) { + int size = parcel->readInt32(); + status_t status = OK; + mMap.clear(); + for (int i = 0; i < size; ++i) { + uint32_t key = parcel->readUint32(); + status = parcel->readByteVector(&mMap[key]); + if (status != OK) { + break; + } + } + return status; +} + +LayerMetadata& LayerMetadata::operator=(const LayerMetadata& other) { + mMap = other.mMap; + return *this; +} + +LayerMetadata& LayerMetadata::operator=(LayerMetadata&& other) { + mMap = std::move(other.mMap); + return *this; +} + +bool LayerMetadata::has(uint32_t key) const { + return mMap.count(key); +} + +int32_t LayerMetadata::getInt32(uint32_t key, int32_t fallback) const { + if (!has(key)) return fallback; + const std::vector& data = mMap.at(key); + if (data.size() < sizeof(uint32_t)) return fallback; + Parcel p; + p.setData(data.data(), data.size()); + return p.readInt32(); +} + +void LayerMetadata::setInt32(uint32_t key, int32_t value) { + std::vector& data = mMap[key]; + Parcel p; + p.writeInt32(value); + data.resize(p.dataSize()); + memcpy(data.data(), p.data(), p.dataSize()); +} + +std::string LayerMetadata::itemToString(uint32_t key, const char* separator) const { + if (!has(key)) return std::string(); + switch (key) { + case METADATA_OWNER_UID: + return StringPrintf("ownerUID%s%d", separator, getInt32(key, 0)); + case METADATA_WINDOW_TYPE: + return StringPrintf("windowType%s%d", separator, getInt32(key, 0)); + default: + return StringPrintf("%d%s%dbytes", key, separator, + static_cast(mMap.at(key).size())); + } +} + +} // namespace android -- cgit v1.2.3-59-g8ed1b From 15a5d93a759ded0d880a24537961cb062a9c0dda Mon Sep 17 00:00:00 2001 From: Evan Rosky Date: Thu, 6 Dec 2018 10:47:26 -0800 Subject: Add task-id metadata constant This can be used by alternate front-ends to associate surfaces with tasks. Bug: 122925737 Test: phone boots and surfaces still fling Change-Id: If8e42908e61c4a99d1e53a006c04fe7c036c437d --- libs/gui/LayerMetadata.cpp | 2 ++ libs/gui/include/gui/LayerMetadata.h | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) (limited to 'libs/gui/LayerMetadata.cpp') diff --git a/libs/gui/LayerMetadata.cpp b/libs/gui/LayerMetadata.cpp index c8a2b0754b..745433a605 100644 --- a/libs/gui/LayerMetadata.cpp +++ b/libs/gui/LayerMetadata.cpp @@ -105,6 +105,8 @@ std::string LayerMetadata::itemToString(uint32_t key, const char* separator) con return StringPrintf("ownerUID%s%d", separator, getInt32(key, 0)); case METADATA_WINDOW_TYPE: return StringPrintf("windowType%s%d", separator, getInt32(key, 0)); + case METADATA_TASK_ID: + return StringPrintf("taskId%s%d", separator, getInt32(key, 0)); default: return StringPrintf("%d%s%dbytes", key, separator, static_cast(mMap.at(key).size())); diff --git a/libs/gui/include/gui/LayerMetadata.h b/libs/gui/include/gui/LayerMetadata.h index 50121817d5..3ae10e461d 100644 --- a/libs/gui/include/gui/LayerMetadata.h +++ b/libs/gui/include/gui/LayerMetadata.h @@ -22,7 +22,7 @@ namespace android { -enum { METADATA_OWNER_UID = 1, METADATA_WINDOW_TYPE = 2 }; +enum { METADATA_OWNER_UID = 1, METADATA_WINDOW_TYPE = 2, METADATA_TASK_ID = 3 }; struct LayerMetadata : public Parcelable { std::unordered_map> mMap; -- cgit v1.2.3-59-g8ed1b From ef876c9c6bb5118c457c9146964d76de854c11fc Mon Sep 17 00:00:00 2001 From: Evan Rosky Date: Fri, 25 Jan 2019 17:46:06 -0800 Subject: Merge metadata from transaction instead of replace This was replacing metadata when set in transactions rather than merging. To fix this, merge has been augmented to also report if a change occurred and to erase empty entries (as a mechanism to "unset" metadata) Bug: 122925737 Test: Added more unittests Change-Id: Ia854cbcc1ddd334f18ffacea667cbb98778ec210 --- libs/gui/LayerMetadata.cpp | 17 +++++++-- libs/gui/include/gui/LayerMetadata.h | 4 ++- services/surfaceflinger/Layer.cpp | 6 ++-- services/surfaceflinger/Layer.h | 2 +- services/surfaceflinger/SurfaceFlinger.cpp | 2 +- .../tests/unittests/LayerMetadataTest.cpp | 41 +++++++++++++++++----- 6 files changed, 54 insertions(+), 18 deletions(-) (limited to 'libs/gui/LayerMetadata.cpp') diff --git a/libs/gui/LayerMetadata.cpp b/libs/gui/LayerMetadata.cpp index 745433a605..04d2871c77 100644 --- a/libs/gui/LayerMetadata.cpp +++ b/libs/gui/LayerMetadata.cpp @@ -31,10 +31,23 @@ LayerMetadata::LayerMetadata(const LayerMetadata& other) = default; LayerMetadata::LayerMetadata(LayerMetadata&& other) = default; -void LayerMetadata::merge(const LayerMetadata& other) { +bool LayerMetadata::merge(const LayerMetadata& other, bool eraseEmpty) { + bool changed = false; for (const auto& entry : other.mMap) { - mMap[entry.first] = entry.second; + auto it = mMap.find(entry.first); + if (it != mMap.cend() && it->second != entry.second) { + if (eraseEmpty && entry.second.empty()) { + mMap.erase(it); + } else { + it->second = entry.second; + } + changed = true; + } else if (it == mMap.cend() && !entry.second.empty()) { + mMap[entry.first] = entry.second; + changed = true; + } } + return changed; } status_t LayerMetadata::writeToParcel(Parcel* parcel) const { diff --git a/libs/gui/include/gui/LayerMetadata.h b/libs/gui/include/gui/LayerMetadata.h index 3ae10e461d..47f0cede3a 100644 --- a/libs/gui/include/gui/LayerMetadata.h +++ b/libs/gui/include/gui/LayerMetadata.h @@ -34,7 +34,9 @@ struct LayerMetadata : public Parcelable { LayerMetadata& operator=(const LayerMetadata& other); LayerMetadata& operator=(LayerMetadata&& other); - void merge(const LayerMetadata& other); + // Merges other into this LayerMetadata. If eraseEmpty is true, any entries in + // in this whose keys are paired with empty values in other will be erased. + bool merge(const LayerMetadata& other, bool eraseEmpty = false); status_t writeToParcel(Parcel* parcel) const override; status_t readFromParcel(const Parcel* parcel) override; diff --git a/services/surfaceflinger/Layer.cpp b/services/surfaceflinger/Layer.cpp index 2de169dcb1..646402ccad 100644 --- a/services/surfaceflinger/Layer.cpp +++ b/services/surfaceflinger/Layer.cpp @@ -1334,10 +1334,8 @@ bool Layer::setOverrideScalingMode(int32_t scalingMode) { return true; } -bool Layer::setMetadata(LayerMetadata data) { - bool changed = data.mMap != mCurrentState.metadata.mMap; - if (!changed) return false; - mCurrentState.metadata = std::move(data); +bool Layer::setMetadata(const LayerMetadata& data) { + if (!mCurrentState.metadata.merge(data, true /* eraseEmpty */)) return false; mCurrentState.sequence++; mCurrentState.modified = true; setTransactionFlags(eTransactionNeeded); diff --git a/services/surfaceflinger/Layer.h b/services/surfaceflinger/Layer.h index f099df613b..367129aa70 100644 --- a/services/surfaceflinger/Layer.h +++ b/services/surfaceflinger/Layer.h @@ -290,7 +290,7 @@ public: uint64_t frameNumber); virtual void deferTransactionUntil_legacy(const sp& barrierLayer, uint64_t frameNumber); virtual bool setOverrideScalingMode(int32_t overrideScalingMode); - virtual bool setMetadata(LayerMetadata data); + virtual bool setMetadata(const LayerMetadata& data); virtual bool reparentChildren(const sp& layer); virtual void setChildrenDrawingParent(const sp& layer); virtual bool reparent(const sp& newParentHandle); diff --git a/services/surfaceflinger/SurfaceFlinger.cpp b/services/surfaceflinger/SurfaceFlinger.cpp index 9d03ae7f5f..b5b0108b2d 100644 --- a/services/surfaceflinger/SurfaceFlinger.cpp +++ b/services/surfaceflinger/SurfaceFlinger.cpp @@ -4116,7 +4116,7 @@ status_t SurfaceFlinger::createLayer(const String8& name, const sp& clie } } - layer->setMetadata(std::move(metadata)); + layer->setMetadata(metadata); bool addToCurrentState = callingThreadHasUnscopedSurfaceFlingerAccess(); result = addClientLayer(client, *handle, *gbp, layer, *parent, diff --git a/services/surfaceflinger/tests/unittests/LayerMetadataTest.cpp b/services/surfaceflinger/tests/unittests/LayerMetadataTest.cpp index 92c9f92bf1..75a061bf77 100644 --- a/services/surfaceflinger/tests/unittests/LayerMetadataTest.cpp +++ b/services/surfaceflinger/tests/unittests/LayerMetadataTest.cpp @@ -62,24 +62,47 @@ TEST_F(LayerMetadataTest, testLayerMetadata) { metadata.mMap[2] = std::vector{'a', 'b'}; ASSERT_EQ(0, metadata.getInt32(2, 0)); + Parcel p; + metadata.writeToParcel(&p); + LayerMetadata reconstructed; + reconstructed.setInt32(3, 1); // to make sure it gets replaced + p.setDataPosition(0); + reconstructed.readFromParcel(&p); + ASSERT_EQ(metadata.mMap, reconstructed.mMap); +} + +TEST_F(LayerMetadataTest, merge) { + LayerMetadata metadata; + metadata.setInt32(4, 2); + metadata.mMap[2] = std::vector{'a', 'b'}; + LayerMetadata second; std::vector someData{'c', 'd', '\0'}; second.mMap[2] = someData; second.setInt32(6, 5); - metadata.merge(second); + second.mMap[4].clear(); // will not delete if eraseEmpty is false + bool changed = metadata.merge(second); + ASSERT_TRUE(changed); ASSERT_EQ(3, metadata.mMap.size()); ASSERT_EQ(someData, second.mMap[2]); ASSERT_EQ(5, metadata.getInt32(6, 0)); - ASSERT_EQ(2, metadata.getInt32(4, 0)); + ASSERT_TRUE(metadata.mMap.at(4).empty()); - Parcel p; - metadata.writeToParcel(&p); - LayerMetadata reconstructed; - reconstructed.setInt32(3, 1); // to make sure it gets replaced - p.setDataPosition(0); - reconstructed.readFromParcel(&p); - ASSERT_EQ(metadata.mMap, reconstructed.mMap); + LayerMetadata withErase; + withErase.mMap[6].clear(); + changed = metadata.merge(withErase, true /* eraseEmpty */); + ASSERT_TRUE(changed); + ASSERT_EQ(2, metadata.mMap.size()); + ASSERT_EQ(someData, second.mMap[2]); + ASSERT_EQ(true, metadata.has(4)); + + // test for change detection + LayerMetadata third; + third.mMap[2] = someData; + third.mMap[5].clear(); + changed = metadata.merge(third); + ASSERT_FALSE(changed); } } // namespace -- cgit v1.2.3-59-g8ed1b