/* * Copyright 2022 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 #include #include #include #include #include #include #include #include #include #include using namespace android::surfaceflinger; namespace android { class TransactionTraceTestSuite : public testing::Test, public testing::WithParamInterface { public: static std::vector sTransactionTraces; static constexpr std::string_view sTransactionTracePrefix = "transactions_trace_"; static constexpr std::string_view sLayersTracePrefix = "layers_trace_"; static constexpr std::string_view sTracePostfix = ".winscope"; perfetto::protos::TransactionTraceFile mTransactionTrace; perfetto::protos::LayersTraceFileProto mExpectedLayersTraceProto; perfetto::protos::LayersTraceFileProto mActualLayersTraceProto; protected: void SetUp() override { std::filesystem::path transactionTracePath = GetParam(); parseTransactionTraceFromFile(transactionTracePath.c_str(), mTransactionTrace); std::string expectedLayersFilename = std::string(sLayersTracePrefix) + transactionTracePath.filename().string().substr(sTransactionTracePrefix.length()); std::string expectedLayersTracePath = transactionTracePath.parent_path().string() + "/" + expectedLayersFilename; EXPECT_TRUE(std::filesystem::exists(std::filesystem::path(expectedLayersTracePath))); parseLayersTraceFromFile(expectedLayersTracePath.c_str(), mExpectedLayersTraceProto); TemporaryDir temp_dir; std::string actualLayersTracePath = std::string(temp_dir.path) + "/" + expectedLayersFilename + "_actual"; { auto traceFlags = LayerTracing::TRACE_INPUT | LayerTracing::TRACE_BUFFERS; std::ofstream outStream{actualLayersTracePath, std::ios::binary | std::ios::app}; auto layerTracing = LayerTracing{outStream}; EXPECT_TRUE(LayerTraceGenerator().generate(mTransactionTrace, traceFlags, layerTracing, /*onlyLastEntry=*/true)) << "Failed to generate layers trace from " << transactionTracePath; } EXPECT_TRUE(std::filesystem::exists(std::filesystem::path(actualLayersTracePath))); parseLayersTraceFromFile(actualLayersTracePath.c_str(), mActualLayersTraceProto); } void parseTransactionTraceFromFile(const char* transactionTracePath, perfetto::protos::TransactionTraceFile& outProto) { ALOGD("Parsing file %s...", transactionTracePath); std::fstream input(transactionTracePath, std::ios::in | std::ios::binary); EXPECT_TRUE(input) << "Error could not open " << transactionTracePath; EXPECT_TRUE(outProto.ParseFromIstream(&input)) << "Failed to parse " << transactionTracePath; } void parseLayersTraceFromFile(const char* layersTracePath, perfetto::protos::LayersTraceFileProto& outProto) { ALOGD("Parsing file %s...", layersTracePath); std::fstream input(layersTracePath, std::ios::in | std::ios::binary); EXPECT_TRUE(input) << "Error could not open " << layersTracePath; EXPECT_TRUE(outProto.ParseFromIstream(&input)) << "Failed to parse " << layersTracePath; } }; std::vector TransactionTraceTestSuite::sTransactionTraces{}; struct LayerInfo { uint64_t id; std::string name; uint64_t parent; int z; uint64_t curr_frame; float x; float y; uint32_t bufferWidth; uint32_t bufferHeight; Rect touchableRegionBounds; }; bool operator==(const LayerInfo& lh, const LayerInfo& rh) { return std::make_tuple(lh.id, lh.name, lh.parent, lh.z, lh.curr_frame, lh.bufferWidth, lh.bufferHeight, lh.touchableRegionBounds) == std::make_tuple(rh.id, rh.name, rh.parent, rh.z, rh.curr_frame, rh.bufferWidth, rh.bufferHeight, rh.touchableRegionBounds); } bool compareById(const LayerInfo& a, const LayerInfo& b) { return a.id < b.id; } inline void PrintTo(const LayerInfo& info, ::std::ostream* os) { *os << "Layer [" << info.id << "] name=" << info.name << " parent=" << info.parent << " z=" << info.z << " curr_frame=" << info.curr_frame << " x=" << info.x << " y=" << info.y << " bufferWidth=" << info.bufferWidth << " bufferHeight=" << info.bufferHeight << "touchableRegionBounds={" << info.touchableRegionBounds.left << "," << info.touchableRegionBounds.top << "," << info.touchableRegionBounds.right << "," << info.touchableRegionBounds.bottom << "}"; } struct find_id { uint64_t id; find_id(uint64_t id) : id(id) {} bool operator()(LayerInfo const& m) const { return m.id == id; } }; static LayerInfo getLayerInfoFromProto(perfetto::protos::LayerProto& proto) { Rect touchableRegionBounds = Rect::INVALID_RECT; // ignore touchable region for layers without buffers, the new fe aggressively avoids // calculating state for layers that are not visible which could lead to mismatches if (proto.has_input_window_info() && proto.input_window_info().has_touchable_region() && proto.has_active_buffer()) { Region touchableRegion; LayerProtoHelper::readFromProto(proto.input_window_info().touchable_region(), touchableRegion); touchableRegionBounds = touchableRegion.bounds(); } return {static_cast(proto.id()), proto.name(), static_cast(proto.parent()), proto.z(), proto.curr_frame(), proto.has_position() ? proto.position().x() : -1, proto.has_position() ? proto.position().y() : -1, proto.has_active_buffer() ? proto.active_buffer().width() : 0, proto.has_active_buffer() ? proto.active_buffer().height() : 0, touchableRegionBounds}; } static std::vector getLayerInfosFromProto(perfetto::protos::LayersSnapshotProto& entry) { std::unordered_map snapshotIdToLayerId; std::vector layers; layers.reserve(static_cast(entry.layers().layers_size())); bool mapSnapshotIdToLayerId = false; for (int i = 0; i < entry.layers().layers_size(); i++) { auto layer = entry.layers().layers(i); LayerInfo layerInfo = getLayerInfoFromProto(layer); uint64_t layerId = layerInfo.name.find("(Mirror)") == std::string::npos ? static_cast(layer.original_id()) : static_cast(layer.original_id()) | 1ull << 63; snapshotIdToLayerId[layerInfo.id] = layerId; if (layer.original_id() != 0) { mapSnapshotIdToLayerId = true; } layers.push_back(layerInfo); } std::sort(layers.begin(), layers.end(), compareById); if (!mapSnapshotIdToLayerId) { return layers; } for (auto& layer : layers) { layer.id = snapshotIdToLayerId[layer.id]; auto it = snapshotIdToLayerId.find(layer.parent); layer.parent = it == snapshotIdToLayerId.end() ? static_cast(-1) : it->second; } return layers; } TEST_P(TransactionTraceTestSuite, validateEndState) { ASSERT_GT(mActualLayersTraceProto.entry_size(), 0); ASSERT_GT(mExpectedLayersTraceProto.entry_size(), 0); auto expectedLastEntry = mExpectedLayersTraceProto.entry(mExpectedLayersTraceProto.entry_size() - 1); auto actualLastEntry = mActualLayersTraceProto.entry(mActualLayersTraceProto.entry_size() - 1); EXPECT_EQ(expectedLastEntry.layers().layers_size(), actualLastEntry.layers().layers_size()); std::vector expectedLayers = getLayerInfosFromProto(expectedLastEntry); std::vector actualLayers = getLayerInfosFromProto(actualLastEntry); size_t i = 0; for (; i < actualLayers.size() && i < expectedLayers.size(); i++) { auto it = std::find_if(actualLayers.begin(), actualLayers.end(), find_id(expectedLayers[i].id)); EXPECT_NE(it, actualLayers.end()); EXPECT_EQ(expectedLayers[i], *it); ALOGV("Validating %s[%" PRIu64 "] parent=%" PRIu64 " z=%d frame=%" PRIu64, expectedLayers[i].name.c_str(), expectedLayers[i].id, expectedLayers[i].parent, expectedLayers[i].z, expectedLayers[i].curr_frame); } EXPECT_EQ(expectedLayers.size(), actualLayers.size()); if (i < actualLayers.size()) { for (size_t j = 0; j < actualLayers.size(); j++) { if (std::find_if(expectedLayers.begin(), expectedLayers.end(), find_id(actualLayers[j].id)) == expectedLayers.end()) { ALOGD("actualLayers [%" PRIu64 "]:%s parent=%" PRIu64 " z=%d frame=%" PRIu64, actualLayers[j].id, actualLayers[j].name.c_str(), actualLayers[j].parent, actualLayers[j].z, actualLayers[j].curr_frame); } } FAIL(); } if (i < expectedLayers.size()) { for (size_t j = 0; j < expectedLayers.size(); j++) { if (std::find_if(actualLayers.begin(), actualLayers.end(), find_id(expectedLayers[j].id)) == actualLayers.end()) { ALOGD("expectedLayers [%" PRIu64 "]:%s parent=%" PRIu64 " z=%d frame=%" PRIu64, expectedLayers[j].id, expectedLayers[j].name.c_str(), expectedLayers[j].parent, expectedLayers[j].z, expectedLayers[j].curr_frame); } } FAIL(); } } std::string PrintToStringParamName(const ::testing::TestParamInfo& info) { const auto& prefix = android::TransactionTraceTestSuite::sTransactionTracePrefix; const auto& postfix = android::TransactionTraceTestSuite::sTracePostfix; const auto& filename = info.param.filename().string(); return filename.substr(prefix.length(), filename.length() - prefix.length() - postfix.length()); } INSTANTIATE_TEST_CASE_P(TransactionTraceTestSuites, TransactionTraceTestSuite, testing::ValuesIn(TransactionTraceTestSuite::sTransactionTraces), PrintToStringParamName); } // namespace android int main(int argc, char** argv) { for (const auto& entry : std::filesystem::directory_iterator( android::base::GetExecutableDirectory() + "/testdata/")) { if (!entry.is_regular_file()) { continue; } const auto& filename = entry.path().filename().string(); const auto& prefix = android::TransactionTraceTestSuite::sTransactionTracePrefix; if (filename.compare(0, prefix.length(), prefix)) { continue; } const std::string& path = entry.path().string(); const auto& postfix = android::TransactionTraceTestSuite::sTracePostfix; if (path.compare(path.length() - postfix.length(), postfix.length(), postfix)) { continue; } android::TransactionTraceTestSuite::sTransactionTraces.push_back(path); } ::testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS(); }