/* * Copyright 2018 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. */ #undef LOG_TAG #define LOG_TAG "TimeStats" #define ATRACE_TAG ATRACE_TAG_GRAPHICS #include "TimeStats.h" #include #include #include #include #include #include #include namespace android { namespace impl { void TimeStats::parseArgs(bool asProto, const Vector& args, std::string& result) { ATRACE_CALL(); std::unordered_map argsMap; for (size_t index = 0; index < args.size(); ++index) { argsMap[std::string(String8(args[index]).c_str())] = index; } if (argsMap.count("-disable")) { disable(); } if (argsMap.count("-dump")) { std::optional maxLayers = std::nullopt; auto iter = argsMap.find("-maxlayers"); if (iter != argsMap.end() && iter->second + 1 < static_cast(args.size())) { int64_t value = strtol(String8(args[iter->second + 1]).c_str(), nullptr, 10); value = std::clamp(value, int64_t(0), int64_t(UINT32_MAX)); maxLayers = static_cast(value); } dump(asProto, maxLayers, result); } if (argsMap.count("-clear")) { clear(); } if (argsMap.count("-enable")) { enable(); } } std::string TimeStats::miniDump() { ATRACE_CALL(); std::string result = "TimeStats miniDump:\n"; std::lock_guard lock(mMutex); android::base::StringAppendF(&result, "Number of tracked layers is %zu\n", mTimeStatsTracker.size()); return result; } void TimeStats::incrementTotalFrames() { if (!mEnabled.load()) return; ATRACE_CALL(); std::lock_guard lock(mMutex); mTimeStats.totalFrames++; } void TimeStats::incrementMissedFrames() { if (!mEnabled.load()) return; ATRACE_CALL(); std::lock_guard lock(mMutex); mTimeStats.missedFrames++; } void TimeStats::incrementClientCompositionFrames() { if (!mEnabled.load()) return; ATRACE_CALL(); std::lock_guard lock(mMutex); mTimeStats.clientCompositionFrames++; } bool TimeStats::recordReadyLocked(int32_t layerID, TimeRecord* timeRecord) { if (!timeRecord->ready) { ALOGV("[%d]-[%" PRIu64 "]-presentFence is still not received", layerID, timeRecord->frameTime.frameNumber); return false; } if (timeRecord->acquireFence != nullptr) { if (timeRecord->acquireFence->getSignalTime() == Fence::SIGNAL_TIME_PENDING) { return false; } if (timeRecord->acquireFence->getSignalTime() != Fence::SIGNAL_TIME_INVALID) { timeRecord->frameTime.acquireTime = timeRecord->acquireFence->getSignalTime(); timeRecord->acquireFence = nullptr; } else { ALOGV("[%d]-[%" PRIu64 "]-acquireFence signal time is invalid", layerID, timeRecord->frameTime.frameNumber); } } if (timeRecord->presentFence != nullptr) { if (timeRecord->presentFence->getSignalTime() == Fence::SIGNAL_TIME_PENDING) { return false; } if (timeRecord->presentFence->getSignalTime() != Fence::SIGNAL_TIME_INVALID) { timeRecord->frameTime.presentTime = timeRecord->presentFence->getSignalTime(); timeRecord->presentFence = nullptr; } else { ALOGV("[%d]-[%" PRIu64 "]-presentFence signal time invalid", layerID, timeRecord->frameTime.frameNumber); } } return true; } static int32_t msBetween(nsecs_t start, nsecs_t end) { int64_t delta = (end - start) / 1000000; delta = std::clamp(delta, int64_t(INT32_MIN), int64_t(INT32_MAX)); return static_cast(delta); } // This regular expression captures the following for instance: // StatusBar in StatusBar#0 // com.appname in com.appname/com.appname.activity#0 // com.appname in SurfaceView - com.appname/com.appname.activity#0 static const std::regex packageNameRegex("(?:SurfaceView[-\\s\\t]+)?([^/]+).*#\\d+"); static std::string getPackageName(const std::string& layerName) { std::smatch match; if (std::regex_match(layerName.begin(), layerName.end(), match, packageNameRegex)) { // There must be a match for group 1 otherwise the whole string is not // matched and the above will return false return match[1]; } return ""; } void TimeStats::flushAvailableRecordsToStatsLocked(int32_t layerID) { ATRACE_CALL(); LayerRecord& layerRecord = mTimeStatsTracker[layerID]; TimeRecord& prevTimeRecord = layerRecord.prevTimeRecord; std::deque& timeRecords = layerRecord.timeRecords; while (!timeRecords.empty()) { if (!recordReadyLocked(layerID, &timeRecords[0])) break; ALOGV("[%d]-[%" PRIu64 "]-presentFenceTime[%" PRId64 "]", layerID, timeRecords[0].frameTime.frameNumber, timeRecords[0].frameTime.presentTime); const std::string& layerName = layerRecord.layerName; if (prevTimeRecord.ready) { if (!mTimeStats.stats.count(layerName)) { mTimeStats.stats[layerName].layerName = layerName; mTimeStats.stats[layerName].packageName = getPackageName(layerName); } TimeStatsHelper::TimeStatsLayer& timeStatsLayer = mTimeStats.stats[layerName]; timeStatsLayer.totalFrames++; timeStatsLayer.droppedFrames += layerRecord.droppedFrames; layerRecord.droppedFrames = 0; const int32_t postToAcquireMs = msBetween(timeRecords[0].frameTime.postTime, timeRecords[0].frameTime.acquireTime); ALOGV("[%d]-[%" PRIu64 "]-post2acquire[%d]", layerID, timeRecords[0].frameTime.frameNumber, postToAcquireMs); timeStatsLayer.deltas["post2acquire"].insert(postToAcquireMs); const int32_t postToPresentMs = msBetween(timeRecords[0].frameTime.postTime, timeRecords[0].frameTime.presentTime); ALOGV("[%d]-[%" PRIu64 "]-post2present[%d]", layerID, timeRecords[0].frameTime.frameNumber, postToPresentMs); timeStatsLayer.deltas["post2present"].insert(postToPresentMs); const int32_t acquireToPresentMs = msBetween(timeRecords[0].frameTime.acquireTime, timeRecords[0].frameTime.presentTime); ALOGV("[%d]-[%" PRIu64 "]-acquire2present[%d]", layerID, timeRecords[0].frameTime.frameNumber, acquireToPresentMs); timeStatsLayer.deltas["acquire2present"].insert(acquireToPresentMs); const int32_t latchToPresentMs = msBetween(timeRecords[0].frameTime.latchTime, timeRecords[0].frameTime.presentTime); ALOGV("[%d]-[%" PRIu64 "]-latch2present[%d]", layerID, timeRecords[0].frameTime.frameNumber, latchToPresentMs); timeStatsLayer.deltas["latch2present"].insert(latchToPresentMs); const int32_t desiredToPresentMs = msBetween(timeRecords[0].frameTime.desiredTime, timeRecords[0].frameTime.presentTime); ALOGV("[%d]-[%" PRIu64 "]-desired2present[%d]", layerID, timeRecords[0].frameTime.frameNumber, desiredToPresentMs); timeStatsLayer.deltas["desired2present"].insert(desiredToPresentMs); const int32_t presentToPresentMs = msBetween(prevTimeRecord.frameTime.presentTime, timeRecords[0].frameTime.presentTime); ALOGV("[%d]-[%" PRIu64 "]-present2present[%d]", layerID, timeRecords[0].frameTime.frameNumber, presentToPresentMs); timeStatsLayer.deltas["present2present"].insert(presentToPresentMs); } // Output additional trace points to track frame time. ATRACE_INT64(("TimeStats-Post - " + layerName).c_str(), timeRecords[0].frameTime.postTime); ATRACE_INT64(("TimeStats-Acquire - " + layerName).c_str(), timeRecords[0].frameTime.acquireTime); ATRACE_INT64(("TimeStats-Latch - " + layerName).c_str(), timeRecords[0].frameTime.latchTime); ATRACE_INT64(("TimeStats-Desired - " + layerName).c_str(), timeRecords[0].frameTime.desiredTime); ATRACE_INT64(("TimeStats-Present - " + layerName).c_str(), timeRecords[0].frameTime.presentTime); prevTimeRecord = timeRecords[0]; timeRecords.pop_front(); layerRecord.waitData--; } } // This regular expression captures the following layer names for instance: // 1) StatusBat#0 // 2) NavigationBar#1 // 3) co(m).*#0 // 4) SurfaceView - co(m).*#0 // Using [-\\s\t]+ for the conjunction part between SurfaceView and co(m).* // is a bit more robust in case there's a slight change. // The layer name would only consist of . / $ _ 0-9 a-z A-Z in most cases. static const std::regex layerNameRegex( "(((SurfaceView[-\\s\\t]+)?com?\\.[./$\\w]+)|((Status|Navigation)Bar))#\\d+"); static bool layerNameIsValid(const std::string& layerName) { return std::regex_match(layerName.begin(), layerName.end(), layerNameRegex); } void TimeStats::setPostTime(int32_t layerID, uint64_t frameNumber, const std::string& layerName, nsecs_t postTime) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-[%s]-PostTime[%" PRId64 "]", layerID, frameNumber, layerName.c_str(), postTime); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID) && mTimeStatsTracker.size() < MAX_NUM_LAYER_RECORDS && layerNameIsValid(layerName)) { mTimeStatsTracker[layerID].layerName = layerName; } if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.timeRecords.size() == MAX_NUM_TIME_RECORDS) { ALOGE("[%d]-[%s]-timeRecords is at its maximum size[%zu]. Ignore this when unittesting.", layerID, layerRecord.layerName.c_str(), MAX_NUM_TIME_RECORDS); mTimeStatsTracker.erase(layerID); return; } // For most media content, the acquireFence is invalid because the buffer is // ready at the queueBuffer stage. In this case, acquireTime should be given // a default value as postTime. TimeRecord timeRecord = { .frameTime = { .frameNumber = frameNumber, .postTime = postTime, .latchTime = postTime, .acquireTime = postTime, .desiredTime = postTime, }, }; layerRecord.timeRecords.push_back(timeRecord); if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) layerRecord.waitData = layerRecord.timeRecords.size() - 1; } void TimeStats::setLatchTime(int32_t layerID, uint64_t frameNumber, nsecs_t latchTime) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-LatchTime[%" PRId64 "]", layerID, frameNumber, latchTime); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) return; TimeRecord& timeRecord = layerRecord.timeRecords[layerRecord.waitData]; if (timeRecord.frameTime.frameNumber == frameNumber) { timeRecord.frameTime.latchTime = latchTime; } } void TimeStats::setDesiredTime(int32_t layerID, uint64_t frameNumber, nsecs_t desiredTime) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-DesiredTime[%" PRId64 "]", layerID, frameNumber, desiredTime); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) return; TimeRecord& timeRecord = layerRecord.timeRecords[layerRecord.waitData]; if (timeRecord.frameTime.frameNumber == frameNumber) { timeRecord.frameTime.desiredTime = desiredTime; } } void TimeStats::setAcquireTime(int32_t layerID, uint64_t frameNumber, nsecs_t acquireTime) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-AcquireTime[%" PRId64 "]", layerID, frameNumber, acquireTime); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) return; TimeRecord& timeRecord = layerRecord.timeRecords[layerRecord.waitData]; if (timeRecord.frameTime.frameNumber == frameNumber) { timeRecord.frameTime.acquireTime = acquireTime; } } void TimeStats::setAcquireFence(int32_t layerID, uint64_t frameNumber, const std::shared_ptr& acquireFence) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-AcquireFenceTime[%" PRId64 "]", layerID, frameNumber, acquireFence->getSignalTime()); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) return; TimeRecord& timeRecord = layerRecord.timeRecords[layerRecord.waitData]; if (timeRecord.frameTime.frameNumber == frameNumber) { timeRecord.acquireFence = acquireFence; } } void TimeStats::setPresentTime(int32_t layerID, uint64_t frameNumber, nsecs_t presentTime) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-PresentTime[%" PRId64 "]", layerID, frameNumber, presentTime); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) return; TimeRecord& timeRecord = layerRecord.timeRecords[layerRecord.waitData]; if (timeRecord.frameTime.frameNumber == frameNumber) { timeRecord.frameTime.presentTime = presentTime; timeRecord.ready = true; layerRecord.waitData++; } flushAvailableRecordsToStatsLocked(layerID); } void TimeStats::setPresentFence(int32_t layerID, uint64_t frameNumber, const std::shared_ptr& presentFence) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-PresentFenceTime[%" PRId64 "]", layerID, frameNumber, presentFence->getSignalTime()); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; if (layerRecord.waitData < 0 || layerRecord.waitData >= static_cast(layerRecord.timeRecords.size())) return; TimeRecord& timeRecord = layerRecord.timeRecords[layerRecord.waitData]; if (timeRecord.frameTime.frameNumber == frameNumber) { timeRecord.presentFence = presentFence; timeRecord.ready = true; layerRecord.waitData++; } flushAvailableRecordsToStatsLocked(layerID); } void TimeStats::onDestroy(int32_t layerID) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-onDestroy", layerID); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; mTimeStatsTracker.erase(layerID); } void TimeStats::removeTimeRecord(int32_t layerID, uint64_t frameNumber) { if (!mEnabled.load()) return; ATRACE_CALL(); ALOGV("[%d]-[%" PRIu64 "]-removeTimeRecord", layerID, frameNumber); std::lock_guard lock(mMutex); if (!mTimeStatsTracker.count(layerID)) return; LayerRecord& layerRecord = mTimeStatsTracker[layerID]; size_t removeAt = 0; for (const TimeRecord& record : layerRecord.timeRecords) { if (record.frameTime.frameNumber == frameNumber) break; removeAt++; } if (removeAt == layerRecord.timeRecords.size()) return; layerRecord.timeRecords.erase(layerRecord.timeRecords.begin() + removeAt); if (layerRecord.waitData > static_cast(removeAt)) { layerRecord.waitData--; } layerRecord.droppedFrames++; } void TimeStats::flushPowerTimeLocked() { if (!mEnabled.load()) return; nsecs_t curTime = systemTime(); // elapsedTime is in milliseconds. int64_t elapsedTime = (curTime - mPowerTime.prevTime) / 1000000; switch (mPowerTime.powerMode) { case HWC_POWER_MODE_NORMAL: mTimeStats.displayOnTime += elapsedTime; break; case HWC_POWER_MODE_OFF: case HWC_POWER_MODE_DOZE: case HWC_POWER_MODE_DOZE_SUSPEND: default: break; } mPowerTime.prevTime = curTime; } void TimeStats::setPowerMode(int32_t powerMode) { if (!mEnabled.load()) { std::lock_guard lock(mMutex); mPowerTime.powerMode = powerMode; return; } std::lock_guard lock(mMutex); if (powerMode == mPowerTime.powerMode) return; flushPowerTimeLocked(); mPowerTime.powerMode = powerMode; } void TimeStats::recordRefreshRate(uint32_t fps, nsecs_t duration) { std::lock_guard lock(mMutex); if (mTimeStats.refreshRateStats.count(fps)) { mTimeStats.refreshRateStats[fps] += duration; } else { mTimeStats.refreshRateStats.insert({fps, duration}); } } void TimeStats::flushAvailableGlobalRecordsToStatsLocked() { ATRACE_CALL(); while (!mGlobalRecord.presentFences.empty()) { const nsecs_t curPresentTime = mGlobalRecord.presentFences.front()->getSignalTime(); if (curPresentTime == Fence::SIGNAL_TIME_PENDING) break; if (curPresentTime == Fence::SIGNAL_TIME_INVALID) { ALOGE("GlobalPresentFence is invalid!"); mGlobalRecord.prevPresentTime = 0; mGlobalRecord.presentFences.pop_front(); continue; } ALOGV("GlobalPresentFenceTime[%" PRId64 "]", mGlobalRecord.presentFences.front()->getSignalTime()); if (mGlobalRecord.prevPresentTime != 0) { const int32_t presentToPresentMs = msBetween(mGlobalRecord.prevPresentTime, curPresentTime); ALOGV("Global present2present[%d] prev[%" PRId64 "] curr[%" PRId64 "]", presentToPresentMs, mGlobalRecord.prevPresentTime, curPresentTime); mTimeStats.presentToPresent.insert(presentToPresentMs); } mGlobalRecord.prevPresentTime = curPresentTime; mGlobalRecord.presentFences.pop_front(); } } void TimeStats::setPresentFenceGlobal(const std::shared_ptr& presentFence) { if (!mEnabled.load()) return; ATRACE_CALL(); std::lock_guard lock(mMutex); if (presentFence == nullptr || !presentFence->isValid()) { mGlobalRecord.prevPresentTime = 0; return; } if (mPowerTime.powerMode != HWC_POWER_MODE_NORMAL) { // Try flushing the last present fence on HWC_POWER_MODE_NORMAL. flushAvailableGlobalRecordsToStatsLocked(); mGlobalRecord.presentFences.clear(); mGlobalRecord.prevPresentTime = 0; return; } if (mGlobalRecord.presentFences.size() == MAX_NUM_TIME_RECORDS) { // The front presentFence must be trapped in pending status in this // case. Try dequeuing the front one to recover. ALOGE("GlobalPresentFences is already at its maximum size[%zu]", MAX_NUM_TIME_RECORDS); mGlobalRecord.prevPresentTime = 0; mGlobalRecord.presentFences.pop_front(); } mGlobalRecord.presentFences.emplace_back(presentFence); flushAvailableGlobalRecordsToStatsLocked(); } void TimeStats::enable() { if (mEnabled.load()) return; ATRACE_CALL(); std::lock_guard lock(mMutex); mEnabled.store(true); mTimeStats.statsStart = static_cast(std::time(0)); mPowerTime.prevTime = systemTime(); ALOGD("Enabled"); } void TimeStats::disable() { if (!mEnabled.load()) return; ATRACE_CALL(); std::lock_guard lock(mMutex); flushPowerTimeLocked(); mEnabled.store(false); mTimeStats.statsEnd = static_cast(std::time(0)); ALOGD("Disabled"); } void TimeStats::clear() { ATRACE_CALL(); std::lock_guard lock(mMutex); mTimeStatsTracker.clear(); mTimeStats.stats.clear(); mTimeStats.statsStart = (mEnabled.load() ? static_cast(std::time(0)) : 0); mTimeStats.statsEnd = 0; mTimeStats.totalFrames = 0; mTimeStats.missedFrames = 0; mTimeStats.clientCompositionFrames = 0; mTimeStats.displayOnTime = 0; mTimeStats.presentToPresent.hist.clear(); mTimeStats.refreshRateStats.clear(); mPowerTime.prevTime = systemTime(); mGlobalRecord.prevPresentTime = 0; mGlobalRecord.presentFences.clear(); ALOGD("Cleared"); } bool TimeStats::isEnabled() { return mEnabled.load(); } void TimeStats::dump(bool asProto, std::optional maxLayers, std::string& result) { ATRACE_CALL(); std::lock_guard lock(mMutex); if (mTimeStats.statsStart == 0) { return; } mTimeStats.statsEnd = static_cast(std::time(0)); flushPowerTimeLocked(); if (asProto) { ALOGD("Dumping TimeStats as proto"); SFTimeStatsGlobalProto timeStatsProto = mTimeStats.toProto(maxLayers); result.append(timeStatsProto.SerializeAsString().c_str(), timeStatsProto.ByteSize()); } else { ALOGD("Dumping TimeStats as text"); result.append(mTimeStats.toString(maxLayers)); result.append("\n"); } } } // namespace impl } // namespace android