blob: d1385c0409fb483bec3477c60856c77b23ed7a2b [file] [log] [blame]
Adithya Srinivasanf279e042020-08-17 14:56:27 -07001/*
2 * Copyright 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Marin Shalamanovbed7fd32020-12-21 20:02:20 +010017
Alec Mouri9a29e672020-09-14 12:39:14 -070018#include "gmock/gmock-spec-builders.h"
19#include "mock/MockTimeStats.h"
Adithya Srinivasanf279e042020-08-17 14:56:27 -070020#undef LOG_TAG
21#define LOG_TAG "LibSurfaceFlingerUnittests"
22
23#include <FrameTimeline/FrameTimeline.h>
24#include <gtest/gtest.h>
25#include <log/log.h>
Adithya Srinivasan01189672020-10-20 14:23:05 -070026#include <perfetto/trace/trace.pb.h>
Adithya Srinivasanf279e042020-08-17 14:56:27 -070027#include <cinttypes>
28
29using namespace std::chrono_literals;
Alec Mouri363faf02021-01-29 16:34:55 -080030using testing::_;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -080031using testing::AtLeast;
Alec Mouri9a29e672020-09-14 12:39:14 -070032using testing::Contains;
Adithya Srinivasan01189672020-10-20 14:23:05 -070033using FrameTimelineEvent = perfetto::protos::FrameTimelineEvent;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +000034using ProtoExpectedDisplayFrameStart =
35 perfetto::protos::FrameTimelineEvent_ExpectedDisplayFrameStart;
36using ProtoExpectedSurfaceFrameStart =
37 perfetto::protos::FrameTimelineEvent_ExpectedSurfaceFrameStart;
38using ProtoActualDisplayFrameStart = perfetto::protos::FrameTimelineEvent_ActualDisplayFrameStart;
39using ProtoActualSurfaceFrameStart = perfetto::protos::FrameTimelineEvent_ActualSurfaceFrameStart;
40using ProtoFrameEnd = perfetto::protos::FrameTimelineEvent_FrameEnd;
Adithya Srinivasan01189672020-10-20 14:23:05 -070041using ProtoPresentType = perfetto::protos::FrameTimelineEvent_PresentType;
42using ProtoJankType = perfetto::protos::FrameTimelineEvent_JankType;
Adithya Srinivasan78e58af2021-02-25 00:08:08 +000043using ProtoPredictionType = perfetto::protos::FrameTimelineEvent_PredictionType;
Alec Mouri9a29e672020-09-14 12:39:14 -070044
Adithya Srinivasanf279e042020-08-17 14:56:27 -070045namespace android::frametimeline {
46
47class FrameTimelineTest : public testing::Test {
48public:
49 FrameTimelineTest() {
50 const ::testing::TestInfo* const test_info =
51 ::testing::UnitTest::GetInstance()->current_test_info();
52 ALOGD("**** Setting up for %s.%s\n", test_info->test_case_name(), test_info->name());
53 }
54
55 ~FrameTimelineTest() {
56 const ::testing::TestInfo* const test_info =
57 ::testing::UnitTest::GetInstance()->current_test_info();
58 ALOGD("**** Tearing down after %s.%s\n", test_info->test_case_name(), test_info->name());
59 }
60
Adithya Srinivasan01189672020-10-20 14:23:05 -070061 static void SetUpTestSuite() {
62 // Need to initialize tracing in process for testing, and only once per test suite.
63 perfetto::TracingInitArgs args;
64 args.backends = perfetto::kInProcessBackend;
65 perfetto::Tracing::Initialize(args);
66 }
67
Adithya Srinivasanf279e042020-08-17 14:56:27 -070068 void SetUp() override {
Alec Mouri9a29e672020-09-14 12:39:14 -070069 mTimeStats = std::make_shared<mock::TimeStats>();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +000070 mFrameTimeline = std::make_unique<impl::FrameTimeline>(mTimeStats, kSurfaceFlingerPid,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +000071 kTestThresholds, kHwcDuration);
Adithya Srinivasan01189672020-10-20 14:23:05 -070072 mFrameTimeline->registerDataSource();
Adithya Srinivasanf279e042020-08-17 14:56:27 -070073 mTokenManager = &mFrameTimeline->mTokenManager;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +000074 mTraceCookieCounter = &mFrameTimeline->mTraceCookieCounter;
Adithya Srinivasan2d736322020-10-01 16:53:48 -070075 maxDisplayFrames = &mFrameTimeline->mMaxDisplayFrames;
Adithya Srinivasanf279e042020-08-17 14:56:27 -070076 maxTokenRetentionTime = mTokenManager->kMaxRetentionTime;
77 }
78
Adithya Srinivasan01189672020-10-20 14:23:05 -070079 // Each tracing session can be used for a single block of Start -> Stop.
80 static std::unique_ptr<perfetto::TracingSession> getTracingSessionForTest() {
81 perfetto::TraceConfig cfg;
82 cfg.set_duration_ms(500);
83 cfg.add_buffers()->set_size_kb(1024);
84 auto* ds_cfg = cfg.add_data_sources()->mutable_config();
85 ds_cfg->set_name(impl::FrameTimeline::kFrameTimelineDataSource);
86
87 auto tracingSession = perfetto::Tracing::NewTrace(perfetto::kInProcessBackend);
88 tracingSession->Setup(cfg);
89 return tracingSession;
90 }
91
92 std::vector<perfetto::protos::TracePacket> readFrameTimelinePacketsBlocking(
93 perfetto::TracingSession* tracingSession) {
94 std::vector<char> raw_trace = tracingSession->ReadTraceBlocking();
95 perfetto::protos::Trace trace;
96 EXPECT_TRUE(trace.ParseFromArray(raw_trace.data(), int(raw_trace.size())));
97
98 std::vector<perfetto::protos::TracePacket> packets;
99 for (const auto& packet : trace.packet()) {
100 if (!packet.has_frame_timeline_event()) {
101 continue;
102 }
103 packets.emplace_back(packet);
104 }
105 return packets;
106 }
107
108 void addEmptyDisplayFrame() {
109 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000110 // Trigger a flushPresentFence by calling setSfPresent for the next frame
Adithya Srinivasan01189672020-10-20 14:23:05 -0700111 mFrameTimeline->setSfPresent(2500, presentFence1);
112 }
113
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700114 void flushTokens(nsecs_t flushTime) {
115 std::lock_guard<std::mutex> lock(mTokenManager->mMutex);
116 mTokenManager->flushTokens(flushTime);
117 }
118
119 SurfaceFrame& getSurfaceFrame(size_t displayFrameIdx, size_t surfaceFrameIdx) {
120 std::lock_guard<std::mutex> lock(mFrameTimeline->mMutex);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800121 return *(mFrameTimeline->mDisplayFrames[displayFrameIdx]
122 ->getSurfaceFrames()[surfaceFrameIdx]);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700123 }
124
125 std::shared_ptr<impl::FrameTimeline::DisplayFrame> getDisplayFrame(size_t idx) {
126 std::lock_guard<std::mutex> lock(mFrameTimeline->mMutex);
127 return mFrameTimeline->mDisplayFrames[idx];
128 }
129
130 static bool compareTimelineItems(const TimelineItem& a, const TimelineItem& b) {
131 return a.startTime == b.startTime && a.endTime == b.endTime &&
132 a.presentTime == b.presentTime;
133 }
134
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000135 const std::map<int64_t, TokenManagerPrediction>& getPredictions() const {
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700136 return mTokenManager->mPredictions;
137 }
138
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000139 uint32_t getNumberOfDisplayFrames() const {
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700140 std::lock_guard<std::mutex> lock(mFrameTimeline->mMutex);
141 return static_cast<uint32_t>(mFrameTimeline->mDisplayFrames.size());
142 }
143
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000144 int64_t snoopCurrentTraceCookie() const { return mTraceCookieCounter->mTraceCookie; }
145
146 void flushTrace() {
147 using FrameTimelineDataSource = impl::FrameTimeline::FrameTimelineDataSource;
148 FrameTimelineDataSource::Trace(
149 [&](FrameTimelineDataSource::TraceContext ctx) { ctx.Flush(); });
150 }
151
Alec Mouri9a29e672020-09-14 12:39:14 -0700152 std::shared_ptr<mock::TimeStats> mTimeStats;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700153 std::unique_ptr<impl::FrameTimeline> mFrameTimeline;
154 impl::TokenManager* mTokenManager;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000155 TraceCookieCounter* mTraceCookieCounter;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700156 FenceToFenceTimeMap fenceFactory;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700157 uint32_t* maxDisplayFrames;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700158 nsecs_t maxTokenRetentionTime;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000159 static constexpr pid_t kSurfaceFlingerPid = 666;
Adithya Srinivasanead17162021-02-18 02:17:37 +0000160 static constexpr nsecs_t kPresentThreshold = std::chrono::nanoseconds(2ns).count();
161 static constexpr nsecs_t kDeadlineThreshold = std::chrono::nanoseconds(2ns).count();
162 static constexpr nsecs_t kStartThreshold = std::chrono::nanoseconds(2ns).count();
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800163 static constexpr JankClassificationThresholds kTestThresholds{kPresentThreshold,
164 kDeadlineThreshold,
165 kStartThreshold};
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000166 static constexpr nsecs_t kHwcDuration = std::chrono::nanoseconds(3ns).count();
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700167};
168
Alec Mouri9a29e672020-09-14 12:39:14 -0700169static const std::string sLayerNameOne = "layer1";
170static const std::string sLayerNameTwo = "layer2";
171static constexpr const uid_t sUidOne = 0;
Adithya Srinivasan9febda82020-10-19 10:49:41 -0700172static constexpr pid_t sPidOne = 10;
173static constexpr pid_t sPidTwo = 20;
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000174static constexpr int32_t sInputEventId = 5;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800175static constexpr int32_t sLayerIdOne = 1;
176static constexpr int32_t sLayerIdTwo = 2;
Alec Mouri9a29e672020-09-14 12:39:14 -0700177
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700178TEST_F(FrameTimelineTest, tokenManagerRemovesStalePredictions) {
179 int64_t token1 = mTokenManager->generateTokenForPredictions({0, 0, 0});
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000180 EXPECT_EQ(getPredictions().size(), 1u);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700181 flushTokens(systemTime() + maxTokenRetentionTime);
182 int64_t token2 = mTokenManager->generateTokenForPredictions({10, 20, 30});
183 std::optional<TimelineItem> predictions = mTokenManager->getPredictionsForToken(token1);
184
185 // token1 should have expired
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000186 EXPECT_EQ(getPredictions().size(), 1u);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700187 EXPECT_EQ(predictions.has_value(), false);
188
189 predictions = mTokenManager->getPredictionsForToken(token2);
190 EXPECT_EQ(compareTimelineItems(*predictions, TimelineItem(10, 20, 30)), true);
191}
192
Adithya Srinivasan9febda82020-10-19 10:49:41 -0700193TEST_F(FrameTimelineTest, createSurfaceFrameForToken_getOwnerPidReturnsCorrectPid) {
Alec Mouriadebf5c2021-01-05 12:57:36 -0800194 auto surfaceFrame1 =
195 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000196 sLayerNameOne, sLayerNameOne,
197 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -0800198 auto surfaceFrame2 =
199 mFrameTimeline->createSurfaceFrameForToken({}, sPidTwo, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000200 sLayerNameOne, sLayerNameOne,
201 /*isBuffer*/ true);
Adithya Srinivasan9febda82020-10-19 10:49:41 -0700202 EXPECT_EQ(surfaceFrame1->getOwnerPid(), sPidOne);
203 EXPECT_EQ(surfaceFrame2->getOwnerPid(), sPidTwo);
204}
205
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700206TEST_F(FrameTimelineTest, createSurfaceFrameForToken_noToken) {
Alec Mouriadebf5c2021-01-05 12:57:36 -0800207 auto surfaceFrame =
208 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000209 sLayerNameOne, sLayerNameOne,
210 /*isBuffer*/ true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700211 EXPECT_EQ(surfaceFrame->getPredictionState(), PredictionState::None);
212}
213
214TEST_F(FrameTimelineTest, createSurfaceFrameForToken_expiredToken) {
215 int64_t token1 = mTokenManager->generateTokenForPredictions({0, 0, 0});
216 flushTokens(systemTime() + maxTokenRetentionTime);
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000217 auto surfaceFrame =
218 mFrameTimeline->createSurfaceFrameForToken({token1, sInputEventId}, sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000219 sLayerIdOne, sLayerNameOne, sLayerNameOne,
220 /*isBuffer*/ true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700221
222 EXPECT_EQ(surfaceFrame->getPredictionState(), PredictionState::Expired);
223}
224
225TEST_F(FrameTimelineTest, createSurfaceFrameForToken_validToken) {
226 int64_t token1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000227 auto surfaceFrame =
228 mFrameTimeline->createSurfaceFrameForToken({token1, sInputEventId}, sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000229 sLayerIdOne, sLayerNameOne, sLayerNameOne,
230 /*isBuffer*/ true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700231
232 EXPECT_EQ(surfaceFrame->getPredictionState(), PredictionState::Valid);
233 EXPECT_EQ(compareTimelineItems(surfaceFrame->getPredictions(), TimelineItem(10, 20, 30)), true);
234}
235
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000236TEST_F(FrameTimelineTest, createSurfaceFrameForToken_validInputEventId) {
237 int64_t token1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
238 constexpr int32_t inputEventId = 1;
239 auto surfaceFrame =
240 mFrameTimeline->createSurfaceFrameForToken({token1, inputEventId}, sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000241 sLayerIdOne, sLayerNameOne, sLayerNameOne,
242 /*isBuffer*/ true);
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000243
244 EXPECT_EQ(inputEventId, surfaceFrame->getInputEventId());
245}
246
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700247TEST_F(FrameTimelineTest, presentFenceSignaled_droppedFramesNotUpdated) {
248 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700249 int64_t token1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000250 auto surfaceFrame1 =
251 mFrameTimeline->createSurfaceFrameForToken({token1, sInputEventId}, sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000252 sLayerIdOne, sLayerNameOne, sLayerNameOne,
253 /*isBuffer*/ true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700254
255 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -0800256 mFrameTimeline->setSfWakeUp(token1, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000257 surfaceFrame1->setDropTime(12);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800258 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Dropped);
259 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700260 mFrameTimeline->setSfPresent(25, presentFence1);
261 presentFence1->signalForTest(30);
262
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000263 addEmptyDisplayFrame();
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700264
265 auto& droppedSurfaceFrame = getSurfaceFrame(0, 0);
266 EXPECT_EQ(droppedSurfaceFrame.getPresentState(), SurfaceFrame::PresentState::Dropped);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000267 EXPECT_EQ(0u, droppedSurfaceFrame.getActuals().endTime);
268 EXPECT_EQ(12u, droppedSurfaceFrame.getDropTime());
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700269 EXPECT_EQ(droppedSurfaceFrame.getActuals().presentTime, 0);
270}
271
272TEST_F(FrameTimelineTest, presentFenceSignaled_presentedFramesUpdated) {
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800273 // Layer specific increment
Alec Mouri363faf02021-01-29 16:34:55 -0800274 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_)).Times(2);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700275 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
276 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700277 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 26, 30});
Alec Mouri9a29e672020-09-14 12:39:14 -0700278 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000279 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800280 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000281 sLayerNameOne, /*isBuffer*/ true);
Alec Mouri9a29e672020-09-14 12:39:14 -0700282 auto surfaceFrame2 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000283 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800284 sUidOne, sLayerIdTwo, sLayerNameTwo,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000285 sLayerNameTwo, /*isBuffer*/ true);
Alec Mouri7d436ec2021-01-27 20:40:50 -0800286 mFrameTimeline->setSfWakeUp(sfToken1, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800287 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
288 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
289 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
290 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700291 mFrameTimeline->setSfPresent(26, presentFence1);
292 auto displayFrame = getDisplayFrame(0);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800293 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
294 auto& presentedSurfaceFrame2 = getSurfaceFrame(0, 1);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700295 presentFence1->signalForTest(42);
296
297 // Fences haven't been flushed yet, so it should be 0
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800298 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700299 EXPECT_EQ(presentedSurfaceFrame1.getActuals().presentTime, 0);
300 EXPECT_EQ(presentedSurfaceFrame2.getActuals().presentTime, 0);
301
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000302 addEmptyDisplayFrame();
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700303
304 // Fences have flushed, so the present timestamps should be updated
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800305 EXPECT_EQ(displayFrame->getActuals().presentTime, 42);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700306 EXPECT_EQ(presentedSurfaceFrame1.getActuals().presentTime, 42);
307 EXPECT_EQ(presentedSurfaceFrame2.getActuals().presentTime, 42);
Jorim Jaggi9c03b502020-11-24 23:51:31 +0100308 EXPECT_NE(surfaceFrame1->getJankType(), std::nullopt);
309 EXPECT_NE(surfaceFrame2->getJankType(), std::nullopt);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700310}
311
312TEST_F(FrameTimelineTest, displayFramesSlidingWindowMovesAfterLimit) {
313 // Insert kMaxDisplayFrames' count of DisplayFrames to fill the deque
314 int frameTimeFactor = 0;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800315 // Layer specific increment
Alec Mouri363faf02021-01-29 16:34:55 -0800316 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_))
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800317 .Times(static_cast<int32_t>(*maxDisplayFrames));
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700318 for (size_t i = 0; i < *maxDisplayFrames; i++) {
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700319 auto presentFence = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
320 int64_t surfaceFrameToken = mTokenManager->generateTokenForPredictions(
321 {10 + frameTimeFactor, 20 + frameTimeFactor, 30 + frameTimeFactor});
322 int64_t sfToken = mTokenManager->generateTokenForPredictions(
323 {22 + frameTimeFactor, 26 + frameTimeFactor, 30 + frameTimeFactor});
Alec Mouri9a29e672020-09-14 12:39:14 -0700324 auto surfaceFrame =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000325 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken, sInputEventId},
Alec Mouriadebf5c2021-01-05 12:57:36 -0800326 sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000327 sLayerNameOne, sLayerNameOne,
328 /*isBuffer*/ true);
Alec Mouri7d436ec2021-01-27 20:40:50 -0800329 mFrameTimeline->setSfWakeUp(sfToken, 22 + frameTimeFactor, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800330 surfaceFrame->setPresentState(SurfaceFrame::PresentState::Presented);
331 mFrameTimeline->addSurfaceFrame(surfaceFrame);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700332 mFrameTimeline->setSfPresent(27 + frameTimeFactor, presentFence);
333 presentFence->signalForTest(32 + frameTimeFactor);
334 frameTimeFactor += 30;
335 }
336 auto displayFrame0 = getDisplayFrame(0);
337
338 // The 0th Display Frame should have actuals 22, 27, 32
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800339 EXPECT_EQ(compareTimelineItems(displayFrame0->getActuals(), TimelineItem(22, 27, 32)), true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700340
341 // Add one more display frame
342 auto presentFence = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
343 int64_t surfaceFrameToken = mTokenManager->generateTokenForPredictions(
344 {10 + frameTimeFactor, 20 + frameTimeFactor, 30 + frameTimeFactor});
345 int64_t sfToken = mTokenManager->generateTokenForPredictions(
346 {22 + frameTimeFactor, 26 + frameTimeFactor, 30 + frameTimeFactor});
Alec Mouri9a29e672020-09-14 12:39:14 -0700347 auto surfaceFrame =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000348 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800349 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000350 sLayerNameOne, /*isBuffer*/ true);
Alec Mouri7d436ec2021-01-27 20:40:50 -0800351 mFrameTimeline->setSfWakeUp(sfToken, 22 + frameTimeFactor, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800352 surfaceFrame->setPresentState(SurfaceFrame::PresentState::Presented);
353 mFrameTimeline->addSurfaceFrame(surfaceFrame);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700354 mFrameTimeline->setSfPresent(27 + frameTimeFactor, presentFence);
355 presentFence->signalForTest(32 + frameTimeFactor);
356 displayFrame0 = getDisplayFrame(0);
357
358 // The window should have slided by 1 now and the previous 0th display frame
359 // should have been removed from the deque
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800360 EXPECT_EQ(compareTimelineItems(displayFrame0->getActuals(), TimelineItem(52, 57, 62)), true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700361}
362
Ady Abraham7f8a1e62020-09-28 16:09:35 -0700363TEST_F(FrameTimelineTest, surfaceFrameEndTimeAcquireFenceAfterQueue) {
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000364 auto surfaceFrame =
365 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, 0, sLayerIdOne,
366 "acquireFenceAfterQueue",
367 "acquireFenceAfterQueue", /*isBuffer*/ true);
Ady Abraham7f8a1e62020-09-28 16:09:35 -0700368 surfaceFrame->setActualQueueTime(123);
369 surfaceFrame->setAcquireFenceTime(456);
370 EXPECT_EQ(surfaceFrame->getActuals().endTime, 456);
371}
372
373TEST_F(FrameTimelineTest, surfaceFrameEndTimeAcquireFenceBeforeQueue) {
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000374 auto surfaceFrame =
375 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, 0, sLayerIdOne,
376 "acquireFenceAfterQueue",
377 "acquireFenceAfterQueue", /*isBuffer*/ true);
Ady Abraham7f8a1e62020-09-28 16:09:35 -0700378 surfaceFrame->setActualQueueTime(456);
379 surfaceFrame->setAcquireFenceTime(123);
380 EXPECT_EQ(surfaceFrame->getActuals().endTime, 456);
381}
382
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700383TEST_F(FrameTimelineTest, setMaxDisplayFramesSetsSizeProperly) {
384 auto presentFence = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
385 presentFence->signalForTest(2);
386
387 // Size shouldn't exceed maxDisplayFrames - 64
388 for (size_t i = 0; i < *maxDisplayFrames + 10; i++) {
Adithya Srinivasan9febda82020-10-19 10:49:41 -0700389 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -0800390 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000391 sLayerNameOne, sLayerNameOne,
392 /*isBuffer*/ true);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700393 int64_t sfToken = mTokenManager->generateTokenForPredictions({22, 26, 30});
Alec Mouri7d436ec2021-01-27 20:40:50 -0800394 mFrameTimeline->setSfWakeUp(sfToken, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800395 surfaceFrame->setPresentState(SurfaceFrame::PresentState::Presented);
396 mFrameTimeline->addSurfaceFrame(surfaceFrame);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700397 mFrameTimeline->setSfPresent(27, presentFence);
398 }
399 EXPECT_EQ(getNumberOfDisplayFrames(), *maxDisplayFrames);
400
401 // Increase the size to 256
402 mFrameTimeline->setMaxDisplayFrames(256);
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000403 EXPECT_EQ(*maxDisplayFrames, 256u);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700404
405 for (size_t i = 0; i < *maxDisplayFrames + 10; i++) {
Adithya Srinivasan9febda82020-10-19 10:49:41 -0700406 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -0800407 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000408 sLayerNameOne, sLayerNameOne,
409 /*isBuffer*/ true);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700410 int64_t sfToken = mTokenManager->generateTokenForPredictions({22, 26, 30});
Alec Mouri7d436ec2021-01-27 20:40:50 -0800411 mFrameTimeline->setSfWakeUp(sfToken, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800412 surfaceFrame->setPresentState(SurfaceFrame::PresentState::Presented);
413 mFrameTimeline->addSurfaceFrame(surfaceFrame);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700414 mFrameTimeline->setSfPresent(27, presentFence);
415 }
416 EXPECT_EQ(getNumberOfDisplayFrames(), *maxDisplayFrames);
417
418 // Shrink the size to 128
419 mFrameTimeline->setMaxDisplayFrames(128);
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000420 EXPECT_EQ(*maxDisplayFrames, 128u);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700421
422 for (size_t i = 0; i < *maxDisplayFrames + 10; i++) {
Adithya Srinivasan9febda82020-10-19 10:49:41 -0700423 auto surfaceFrame =
Alec Mouriadebf5c2021-01-05 12:57:36 -0800424 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000425 sLayerNameOne, sLayerNameOne,
426 /*isBuffer*/ true);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700427 int64_t sfToken = mTokenManager->generateTokenForPredictions({22, 26, 30});
Alec Mouri7d436ec2021-01-27 20:40:50 -0800428 mFrameTimeline->setSfWakeUp(sfToken, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800429 surfaceFrame->setPresentState(SurfaceFrame::PresentState::Presented);
430 mFrameTimeline->addSurfaceFrame(surfaceFrame);
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700431 mFrameTimeline->setSfPresent(27, presentFence);
432 }
433 EXPECT_EQ(getNumberOfDisplayFrames(), *maxDisplayFrames);
434}
Alec Mouri9a29e672020-09-14 12:39:14 -0700435
Adithya Srinivasan7c4ac7a2021-03-08 23:48:03 +0000436TEST_F(FrameTimelineTest, presentFenceSignaled_invalidSignalTime) {
437 Fps refreshRate = Fps::fromPeriodNsecs(11);
438
439 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
440 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 60});
441 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
442
443 auto surfaceFrame1 =
444 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
445 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000446 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan7c4ac7a2021-03-08 23:48:03 +0000447 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
448 surfaceFrame1->setAcquireFenceTime(20);
449 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
450 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
451
452 mFrameTimeline->setSfPresent(59, presentFence1);
453 presentFence1->signalForTest(-1);
454 addEmptyDisplayFrame();
455
456 auto displayFrame0 = getDisplayFrame(0);
457 EXPECT_EQ(displayFrame0->getActuals().presentTime, -1);
458 EXPECT_EQ(displayFrame0->getJankType(), JankType::Unknown);
459 EXPECT_EQ(surfaceFrame1->getActuals().presentTime, -1);
460 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::Unknown);
461}
462
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800463// Tests related to TimeStats
Adithya Srinivasan7c4ac7a2021-03-08 23:48:03 +0000464TEST_F(FrameTimelineTest, presentFenceSignaled_doesNotReportForInvalidTokens) {
465 Fps refreshRate = Fps::fromPeriodNsecs(11);
466 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_)).Times(0);
467 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
468 int64_t surfaceFrameToken1 = -1;
469 int64_t sfToken1 = -1;
470
471 auto surfaceFrame1 =
472 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
473 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000474 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan7c4ac7a2021-03-08 23:48:03 +0000475 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
476 surfaceFrame1->setAcquireFenceTime(20);
477 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
478 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
479 presentFence1->signalForTest(70);
480
481 mFrameTimeline->setSfPresent(59, presentFence1);
482}
483
Alec Mouri9a29e672020-09-14 12:39:14 -0700484TEST_F(FrameTimelineTest, presentFenceSignaled_reportsLongSfCpu) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000485 Fps refreshRate = Fps::fromPeriodNsecs(11);
486 // Deadline delta is 2ms because, sf's adjusted deadline is 60 - composerTime(3) = 57ms.
Alec Mouri9a29e672020-09-14 12:39:14 -0700487 EXPECT_CALL(*mTimeStats,
Alec Mouri363faf02021-01-29 16:34:55 -0800488 incrementJankyFrames(
489 TimeStats::JankyFramesInfo{refreshRate, std::nullopt, sUidOne,
490 sLayerNameOne,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000491 JankType::SurfaceFlingerCpuDeadlineMissed, 2, 10,
Alec Mouri363faf02021-01-29 16:34:55 -0800492 0}));
Alec Mouri9a29e672020-09-14 12:39:14 -0700493 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000494 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 60});
495 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
496
Alec Mouri9a29e672020-09-14 12:39:14 -0700497 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000498 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800499 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000500 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000501 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
502 surfaceFrame1->setAcquireFenceTime(20);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800503 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
504 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000505 presentFence1->signalForTest(70);
Alec Mouri9a29e672020-09-14 12:39:14 -0700506
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000507 mFrameTimeline->setSfPresent(59, presentFence1);
Alec Mouri9a29e672020-09-14 12:39:14 -0700508}
509
510TEST_F(FrameTimelineTest, presentFenceSignaled_reportsDisplayMiss) {
Alec Mouri363faf02021-01-29 16:34:55 -0800511 Fps refreshRate = Fps::fromPeriodNsecs(30);
Alec Mouri9a29e672020-09-14 12:39:14 -0700512 EXPECT_CALL(*mTimeStats,
Alec Mouri363faf02021-01-29 16:34:55 -0800513 incrementJankyFrames(TimeStats::JankyFramesInfo{refreshRate, std::nullopt, sUidOne,
514 sLayerNameOne, JankType::DisplayHAL,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000515 -1, 0, 0}));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800516
Alec Mouri9a29e672020-09-14 12:39:14 -0700517 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000518 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 60});
519 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
520
Alec Mouri9a29e672020-09-14 12:39:14 -0700521 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000522 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800523 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000524 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000525 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800526 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000527 surfaceFrame1->setAcquireFenceTime(20);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800528 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000529 presentFence1->signalForTest(90);
530 mFrameTimeline->setSfPresent(56, presentFence1);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800531 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::DisplayHAL);
Alec Mouri9a29e672020-09-14 12:39:14 -0700532}
533
534TEST_F(FrameTimelineTest, presentFenceSignaled_reportsAppMiss) {
Alec Mouri363faf02021-01-29 16:34:55 -0800535 Fps refreshRate = Fps(11.0);
Alec Mouri9a29e672020-09-14 12:39:14 -0700536 EXPECT_CALL(*mTimeStats,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000537 incrementJankyFrames(TimeStats::JankyFramesInfo{refreshRate, std::nullopt, sUidOne,
538 sLayerNameOne,
539 JankType::AppDeadlineMissed, -1, 0,
540 25}));
Alec Mouri9a29e672020-09-14 12:39:14 -0700541 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000542 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 60});
543 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({82, 90, 90});
544
Alec Mouri9a29e672020-09-14 12:39:14 -0700545 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000546 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800547 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000548 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000549 surfaceFrame1->setAcquireFenceTime(45);
550 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
Alec Mouri9a29e672020-09-14 12:39:14 -0700551
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800552 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
553 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000554 presentFence1->signalForTest(90);
555 mFrameTimeline->setSfPresent(86, presentFence1);
Jorim Jaggi9c03b502020-11-24 23:51:31 +0100556
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800557 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::AppDeadlineMissed);
Alec Mouri9a29e672020-09-14 12:39:14 -0700558}
559
Adithya Srinivasanead17162021-02-18 02:17:37 +0000560TEST_F(FrameTimelineTest, presentFenceSignaled_reportsSfScheduling) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000561 Fps refreshRate = Fps::fromPeriodNsecs(32);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000562 EXPECT_CALL(*mTimeStats,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000563 incrementJankyFrames(TimeStats::JankyFramesInfo{refreshRate, std::nullopt, sUidOne,
564 sLayerNameOne,
565 JankType::SurfaceFlingerScheduling,
566 -1, 0, -10}));
Adithya Srinivasanead17162021-02-18 02:17:37 +0000567 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000568 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({40, 60, 92});
569 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
570
Adithya Srinivasanead17162021-02-18 02:17:37 +0000571 auto surfaceFrame1 =
572 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800573 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000574 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000575 surfaceFrame1->setAcquireFenceTime(50);
576 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000577
578 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
579 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000580 presentFence1->signalForTest(60);
581 mFrameTimeline->setSfPresent(56, presentFence1);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000582
583 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::SurfaceFlingerScheduling);
584}
585
586TEST_F(FrameTimelineTest, presentFenceSignaled_reportsSfPredictionError) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000587 Fps refreshRate = Fps::fromPeriodNsecs(16);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000588 EXPECT_CALL(*mTimeStats,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000589 incrementJankyFrames(TimeStats::JankyFramesInfo{refreshRate, std::nullopt, sUidOne,
590 sLayerNameOne,
591 JankType::PredictionError, -1, 5,
592 0}));
Adithya Srinivasanead17162021-02-18 02:17:37 +0000593 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000594 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({30, 40, 60});
595 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
596
Adithya Srinivasanead17162021-02-18 02:17:37 +0000597 auto surfaceFrame1 =
598 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800599 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000600 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000601 surfaceFrame1->setAcquireFenceTime(40);
602 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000603
604 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
605 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000606 presentFence1->signalForTest(65);
607 mFrameTimeline->setSfPresent(56, presentFence1);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000608
609 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::PredictionError);
610}
611
612TEST_F(FrameTimelineTest, presentFenceSignaled_reportsAppBufferStuffing) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000613 Fps refreshRate = Fps::fromPeriodNsecs(32);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000614 EXPECT_CALL(*mTimeStats,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000615 incrementJankyFrames(TimeStats::JankyFramesInfo{refreshRate, std::nullopt, sUidOne,
616 sLayerNameOne,
617 JankType::BufferStuffing, -1, 0,
618 0}));
Adithya Srinivasanead17162021-02-18 02:17:37 +0000619 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000620 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({30, 40, 58});
621 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({82, 90, 90});
622
Adithya Srinivasanead17162021-02-18 02:17:37 +0000623 auto surfaceFrame1 =
624 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800625 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000626 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000627 surfaceFrame1->setAcquireFenceTime(40);
628 mFrameTimeline->setSfWakeUp(sfToken1, 82, refreshRate);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000629
630 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000631 /*previousLatchTime*/ 56);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000632 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000633 presentFence1->signalForTest(90);
634 mFrameTimeline->setSfPresent(86, presentFence1);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000635
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000636 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::BufferStuffing);
Adithya Srinivasanead17162021-02-18 02:17:37 +0000637}
638
Alec Mouri363faf02021-01-29 16:34:55 -0800639TEST_F(FrameTimelineTest, presentFenceSignaled_reportsAppMissWithRenderRate) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000640 Fps refreshRate = Fps::fromPeriodNsecs(11);
641 Fps renderRate = Fps::fromPeriodNsecs(30);
Alec Mouri363faf02021-01-29 16:34:55 -0800642 EXPECT_CALL(*mTimeStats,
643 incrementJankyFrames(
644 TimeStats::JankyFramesInfo{refreshRate, renderRate, sUidOne, sLayerNameOne,
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000645 JankType::AppDeadlineMissed, -1, 0, 25}));
Alec Mouri363faf02021-01-29 16:34:55 -0800646 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000647 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 60});
648 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({82, 90, 90});
649
Alec Mouri363faf02021-01-29 16:34:55 -0800650 auto surfaceFrame1 =
651 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800652 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000653 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000654 surfaceFrame1->setAcquireFenceTime(45);
655 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
Alec Mouri363faf02021-01-29 16:34:55 -0800656
657 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
658 surfaceFrame1->setRenderRate(renderRate);
659 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000660 presentFence1->signalForTest(90);
661 mFrameTimeline->setSfPresent(86, presentFence1);
Alec Mouri363faf02021-01-29 16:34:55 -0800662
663 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::AppDeadlineMissed);
664}
665
Adithya Srinivasan115ac692021-03-06 01:21:30 +0000666TEST_F(FrameTimelineTest, presentFenceSignaled_displayFramePredictionExpiredPresentsSurfaceFrame) {
667 Fps refreshRate = Fps::fromPeriodNsecs(11);
668 Fps renderRate = Fps::fromPeriodNsecs(30);
669
670 EXPECT_CALL(*mTimeStats,
671 incrementJankyFrames(TimeStats::JankyFramesInfo{refreshRate, renderRate, sUidOne,
672 sLayerNameOne, JankType::Unknown,
673 -1, -1, 25}));
674 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
675 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 60});
676 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({82, 90, 90});
677
678 auto surfaceFrame1 =
679 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
680 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000681 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan115ac692021-03-06 01:21:30 +0000682 surfaceFrame1->setAcquireFenceTime(45);
683 // Trigger a prediction expiry
684 flushTokens(systemTime() + maxTokenRetentionTime);
685 mFrameTimeline->setSfWakeUp(sfToken1, 52, refreshRate);
686
687 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
688 surfaceFrame1->setRenderRate(renderRate);
689 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
690 presentFence1->signalForTest(90);
691 mFrameTimeline->setSfPresent(86, presentFence1);
692
693 auto displayFrame = getDisplayFrame(0);
694 EXPECT_EQ(displayFrame->getJankType(), JankType::Unknown);
695 EXPECT_EQ(displayFrame->getFrameStartMetadata(), FrameStartMetadata::UnknownStart);
696 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::UnknownFinish);
697 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::UnknownPresent);
698
699 EXPECT_EQ(surfaceFrame1->getActuals().presentTime, 90);
700 EXPECT_EQ(surfaceFrame1->getJankType(), JankType::Unknown);
701}
702
Adithya Srinivasan01189672020-10-20 14:23:05 -0700703/*
704 * Tracing Tests
705 *
706 * Trace packets are flushed all the way only when the next packet is traced.
707 * For example: trace<Display/Surface>Frame() will create a TracePacket but not flush it. Only when
708 * another TracePacket is created, the previous one is guaranteed to be flushed. The following tests
709 * will have additional empty frames created for this reason.
710 */
711TEST_F(FrameTimelineTest, tracing_noPacketsSentWithoutTraceStart) {
712 auto tracingSession = getTracingSessionForTest();
713 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700714 int64_t token1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000715 auto surfaceFrame1 =
716 mFrameTimeline->createSurfaceFrameForToken({token1, sInputEventId}, sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000717 sLayerIdOne, sLayerNameOne, sLayerNameOne,
718 /*isBuffer*/ true);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700719
720 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -0800721 mFrameTimeline->setSfWakeUp(token1, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800722 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Dropped);
723 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700724 mFrameTimeline->setSfPresent(25, presentFence1);
725 presentFence1->signalForTest(30);
726
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000727 addEmptyDisplayFrame();
Adithya Srinivasan01189672020-10-20 14:23:05 -0700728
729 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000730 EXPECT_EQ(packets.size(), 0u);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700731}
732
733TEST_F(FrameTimelineTest, tracing_sanityTest) {
734 auto tracingSession = getTracingSessionForTest();
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800735 // Layer specific increment
Alec Mouri363faf02021-01-29 16:34:55 -0800736 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_));
Adithya Srinivasan01189672020-10-20 14:23:05 -0700737 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700738
739 tracingSession->StartBlocking();
740 int64_t token1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
741 int64_t token2 = mTokenManager->generateTokenForPredictions({40, 50, 60});
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000742 auto surfaceFrame1 =
743 mFrameTimeline->createSurfaceFrameForToken({token1, sInputEventId}, sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000744 sLayerIdOne, sLayerNameOne, sLayerNameOne,
745 /*isBuffer*/ true);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700746
747 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -0800748 mFrameTimeline->setSfWakeUp(token2, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800749 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
750 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700751 mFrameTimeline->setSfPresent(25, presentFence1);
752 presentFence1->signalForTest(30);
753
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000754 addEmptyDisplayFrame();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000755 flushTrace();
Adithya Srinivasan01189672020-10-20 14:23:05 -0700756 tracingSession->StopBlocking();
757
758 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000759 // Display Frame 1 has 8 packets - 4 from DisplayFrame and 4 from SurfaceFrame.
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000760 EXPECT_EQ(packets.size(), 8u);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700761}
762
763TEST_F(FrameTimelineTest, traceDisplayFrame_invalidTokenDoesNotEmitTracePacket) {
764 auto tracingSession = getTracingSessionForTest();
765 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700766
767 tracingSession->StartBlocking();
Adithya Srinivasan01189672020-10-20 14:23:05 -0700768
769 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -0800770 mFrameTimeline->setSfWakeUp(-1, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan01189672020-10-20 14:23:05 -0700771 mFrameTimeline->setSfPresent(25, presentFence1);
772 presentFence1->signalForTest(30);
773
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000774 addEmptyDisplayFrame();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000775 flushTrace();
Adithya Srinivasan01189672020-10-20 14:23:05 -0700776 tracingSession->StopBlocking();
777
778 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000779 EXPECT_EQ(packets.size(), 0u);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700780}
781
782TEST_F(FrameTimelineTest, traceSurfaceFrame_invalidTokenDoesNotEmitTracePacket) {
783 auto tracingSession = getTracingSessionForTest();
784 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700785
786 tracingSession->StartBlocking();
787 int64_t token1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
Alec Mouriadebf5c2021-01-05 12:57:36 -0800788 auto surfaceFrame1 =
789 mFrameTimeline->createSurfaceFrameForToken({}, sPidOne, sUidOne, sLayerIdOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000790 sLayerNameOne, sLayerNameOne,
791 /*isBuffer*/ true);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700792
793 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -0800794 mFrameTimeline->setSfWakeUp(token1, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800795 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Dropped);
796 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700797 mFrameTimeline->setSfPresent(25, presentFence1);
798 presentFence1->signalForTest(30);
799
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000800 addEmptyDisplayFrame();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000801 flushTrace();
Adithya Srinivasan01189672020-10-20 14:23:05 -0700802 tracingSession->StopBlocking();
803
804 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000805 // Display Frame 1 has 4 packets (SurfaceFrame shouldn't be traced since it has an invalid
806 // token).
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000807 EXPECT_EQ(packets.size(), 4u);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700808}
809
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000810ProtoExpectedDisplayFrameStart createProtoExpectedDisplayFrameStart(int64_t cookie, int64_t token,
811 pid_t pid) {
812 ProtoExpectedDisplayFrameStart proto;
813 proto.set_cookie(cookie);
814 proto.set_token(token);
815 proto.set_pid(pid);
816 return proto;
817}
818
819ProtoActualDisplayFrameStart createProtoActualDisplayFrameStart(
820 int64_t cookie, int64_t token, pid_t pid, ProtoPresentType presentType, bool onTimeFinish,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000821 bool gpuComposition, ProtoJankType jankType, ProtoPredictionType predictionType) {
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000822 ProtoActualDisplayFrameStart proto;
823 proto.set_cookie(cookie);
824 proto.set_token(token);
825 proto.set_pid(pid);
826 proto.set_present_type(presentType);
827 proto.set_on_time_finish(onTimeFinish);
828 proto.set_gpu_composition(gpuComposition);
829 proto.set_jank_type(jankType);
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000830 proto.set_prediction_type(predictionType);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000831 return proto;
832}
833
834ProtoExpectedSurfaceFrameStart createProtoExpectedSurfaceFrameStart(int64_t cookie, int64_t token,
835 int64_t displayFrameToken,
836 pid_t pid,
837 std::string layerName) {
838 ProtoExpectedSurfaceFrameStart proto;
839 proto.set_cookie(cookie);
840 proto.set_token(token);
841 proto.set_display_frame_token(displayFrameToken);
842 proto.set_pid(pid);
843 proto.set_layer_name(layerName);
844 return proto;
845}
846
847ProtoActualSurfaceFrameStart createProtoActualSurfaceFrameStart(
848 int64_t cookie, int64_t token, int64_t displayFrameToken, pid_t pid, std::string layerName,
849 ProtoPresentType presentType, bool onTimeFinish, bool gpuComposition,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000850 ProtoJankType jankType, ProtoPredictionType predictionType) {
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000851 ProtoActualSurfaceFrameStart proto;
852 proto.set_cookie(cookie);
853 proto.set_token(token);
854 proto.set_display_frame_token(displayFrameToken);
855 proto.set_pid(pid);
856 proto.set_layer_name(layerName);
857 proto.set_present_type(presentType);
858 proto.set_on_time_finish(onTimeFinish);
859 proto.set_gpu_composition(gpuComposition);
860 proto.set_jank_type(jankType);
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000861 proto.set_prediction_type(predictionType);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000862 return proto;
863}
864
865ProtoFrameEnd createProtoFrameEnd(int64_t cookie) {
866 ProtoFrameEnd proto;
867 proto.set_cookie(cookie);
868 return proto;
869}
870
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000871void validateTraceEvent(const ProtoExpectedDisplayFrameStart& received,
872 const ProtoExpectedDisplayFrameStart& source) {
873 ASSERT_TRUE(received.has_cookie());
874 EXPECT_EQ(received.cookie(), source.cookie());
875
Adithya Srinivasan01189672020-10-20 14:23:05 -0700876 ASSERT_TRUE(received.has_token());
877 EXPECT_EQ(received.token(), source.token());
878
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000879 ASSERT_TRUE(received.has_pid());
880 EXPECT_EQ(received.pid(), source.pid());
881}
882
883void validateTraceEvent(const ProtoActualDisplayFrameStart& received,
884 const ProtoActualDisplayFrameStart& source) {
885 ASSERT_TRUE(received.has_cookie());
886 EXPECT_EQ(received.cookie(), source.cookie());
887
888 ASSERT_TRUE(received.has_token());
889 EXPECT_EQ(received.token(), source.token());
890
891 ASSERT_TRUE(received.has_pid());
892 EXPECT_EQ(received.pid(), source.pid());
893
Adithya Srinivasan01189672020-10-20 14:23:05 -0700894 ASSERT_TRUE(received.has_present_type());
895 EXPECT_EQ(received.present_type(), source.present_type());
896 ASSERT_TRUE(received.has_on_time_finish());
897 EXPECT_EQ(received.on_time_finish(), source.on_time_finish());
898 ASSERT_TRUE(received.has_gpu_composition());
899 EXPECT_EQ(received.gpu_composition(), source.gpu_composition());
900 ASSERT_TRUE(received.has_jank_type());
901 EXPECT_EQ(received.jank_type(), source.jank_type());
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000902 ASSERT_TRUE(received.has_prediction_type());
903 EXPECT_EQ(received.prediction_type(), source.prediction_type());
Adithya Srinivasan01189672020-10-20 14:23:05 -0700904}
905
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000906void validateTraceEvent(const ProtoExpectedSurfaceFrameStart& received,
907 const ProtoExpectedSurfaceFrameStart& source) {
908 ASSERT_TRUE(received.has_cookie());
909 EXPECT_EQ(received.cookie(), source.cookie());
910
Adithya Srinivasan01189672020-10-20 14:23:05 -0700911 ASSERT_TRUE(received.has_token());
912 EXPECT_EQ(received.token(), source.token());
913
914 ASSERT_TRUE(received.has_display_frame_token());
915 EXPECT_EQ(received.display_frame_token(), source.display_frame_token());
916
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000917 ASSERT_TRUE(received.has_pid());
918 EXPECT_EQ(received.pid(), source.pid());
919
920 ASSERT_TRUE(received.has_layer_name());
921 EXPECT_EQ(received.layer_name(), source.layer_name());
922}
923
924void validateTraceEvent(const ProtoActualSurfaceFrameStart& received,
925 const ProtoActualSurfaceFrameStart& source) {
926 ASSERT_TRUE(received.has_cookie());
927 EXPECT_EQ(received.cookie(), source.cookie());
928
929 ASSERT_TRUE(received.has_token());
930 EXPECT_EQ(received.token(), source.token());
931
932 ASSERT_TRUE(received.has_display_frame_token());
933 EXPECT_EQ(received.display_frame_token(), source.display_frame_token());
934
935 ASSERT_TRUE(received.has_pid());
936 EXPECT_EQ(received.pid(), source.pid());
937
938 ASSERT_TRUE(received.has_layer_name());
939 EXPECT_EQ(received.layer_name(), source.layer_name());
940
Adithya Srinivasan01189672020-10-20 14:23:05 -0700941 ASSERT_TRUE(received.has_present_type());
942 EXPECT_EQ(received.present_type(), source.present_type());
943 ASSERT_TRUE(received.has_on_time_finish());
944 EXPECT_EQ(received.on_time_finish(), source.on_time_finish());
945 ASSERT_TRUE(received.has_gpu_composition());
946 EXPECT_EQ(received.gpu_composition(), source.gpu_composition());
947 ASSERT_TRUE(received.has_jank_type());
948 EXPECT_EQ(received.jank_type(), source.jank_type());
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000949 ASSERT_TRUE(received.has_prediction_type());
950 EXPECT_EQ(received.prediction_type(), source.prediction_type());
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000951}
Adithya Srinivasan01189672020-10-20 14:23:05 -0700952
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000953void validateTraceEvent(const ProtoFrameEnd& received, const ProtoFrameEnd& source) {
954 ASSERT_TRUE(received.has_cookie());
955 EXPECT_EQ(received.cookie(), source.cookie());
Adithya Srinivasan01189672020-10-20 14:23:05 -0700956}
957
958TEST_F(FrameTimelineTest, traceDisplayFrame_emitsValidTracePacket) {
959 auto tracingSession = getTracingSessionForTest();
960 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700961
962 tracingSession->StartBlocking();
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000963 int64_t displayFrameToken1 = mTokenManager->generateTokenForPredictions({10, 30, 30});
Adithya Srinivasan01189672020-10-20 14:23:05 -0700964
965 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -0800966 mFrameTimeline->setSfWakeUp(displayFrameToken1, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan01189672020-10-20 14:23:05 -0700967 mFrameTimeline->setSfPresent(26, presentFence1);
968 presentFence1->signalForTest(31);
969
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000970 int64_t traceCookie = snoopCurrentTraceCookie();
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000971 auto protoExpectedDisplayFrameStart =
972 createProtoExpectedDisplayFrameStart(traceCookie + 1, displayFrameToken1,
973 kSurfaceFlingerPid);
974 auto protoExpectedDisplayFrameEnd = createProtoFrameEnd(traceCookie + 1);
975 auto protoActualDisplayFrameStart =
976 createProtoActualDisplayFrameStart(traceCookie + 2, displayFrameToken1,
977 kSurfaceFlingerPid,
978 FrameTimelineEvent::PRESENT_ON_TIME, true, false,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +0000979 FrameTimelineEvent::JANK_NONE,
980 FrameTimelineEvent::PREDICTION_VALID);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000981 auto protoActualDisplayFrameEnd = createProtoFrameEnd(traceCookie + 2);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000982
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000983 addEmptyDisplayFrame();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000984 flushTrace();
Adithya Srinivasan01189672020-10-20 14:23:05 -0700985 tracingSession->StopBlocking();
986
987 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000988 EXPECT_EQ(packets.size(), 4u);
Adithya Srinivasan01189672020-10-20 14:23:05 -0700989
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000990 // Packet - 0 : ExpectedDisplayFrameStart
991 const auto& packet0 = packets[0];
992 ASSERT_TRUE(packet0.has_timestamp());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000993 EXPECT_EQ(packet0.timestamp(), 10u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000994 ASSERT_TRUE(packet0.has_frame_timeline_event());
Adithya Srinivasan01189672020-10-20 14:23:05 -0700995
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000996 const auto& event0 = packet0.frame_timeline_event();
997 ASSERT_TRUE(event0.has_expected_display_frame_start());
998 const auto& expectedDisplayFrameStart = event0.expected_display_frame_start();
999 validateTraceEvent(expectedDisplayFrameStart, protoExpectedDisplayFrameStart);
1000
1001 // Packet - 1 : FrameEnd (ExpectedDisplayFrame)
1002 const auto& packet1 = packets[1];
1003 ASSERT_TRUE(packet1.has_timestamp());
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001004 EXPECT_EQ(packet1.timestamp(), 30u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001005 ASSERT_TRUE(packet1.has_frame_timeline_event());
1006
1007 const auto& event1 = packet1.frame_timeline_event();
1008 ASSERT_TRUE(event1.has_frame_end());
1009 const auto& expectedDisplayFrameEnd = event1.frame_end();
1010 validateTraceEvent(expectedDisplayFrameEnd, protoExpectedDisplayFrameEnd);
1011
1012 // Packet - 2 : ActualDisplayFrameStart
1013 const auto& packet2 = packets[2];
1014 ASSERT_TRUE(packet2.has_timestamp());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001015 EXPECT_EQ(packet2.timestamp(), 20u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001016 ASSERT_TRUE(packet2.has_frame_timeline_event());
1017
1018 const auto& event2 = packet2.frame_timeline_event();
1019 ASSERT_TRUE(event2.has_actual_display_frame_start());
1020 const auto& actualDisplayFrameStart = event2.actual_display_frame_start();
1021 validateTraceEvent(actualDisplayFrameStart, protoActualDisplayFrameStart);
1022
1023 // Packet - 3 : FrameEnd (ActualDisplayFrame)
1024 const auto& packet3 = packets[3];
1025 ASSERT_TRUE(packet3.has_timestamp());
Adithya Srinivasan1a971632021-02-26 23:10:29 +00001026 EXPECT_EQ(packet3.timestamp(), 31u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001027 ASSERT_TRUE(packet3.has_frame_timeline_event());
1028
1029 const auto& event3 = packet3.frame_timeline_event();
1030 ASSERT_TRUE(event3.has_frame_end());
1031 const auto& actualDisplayFrameEnd = event3.frame_end();
1032 validateTraceEvent(actualDisplayFrameEnd, protoActualDisplayFrameEnd);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001033}
1034
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001035TEST_F(FrameTimelineTest, traceDisplayFrame_predictionExpiredDoesNotTraceExpectedTimeline) {
1036 auto tracingSession = getTracingSessionForTest();
1037 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1038
1039 tracingSession->StartBlocking();
1040 int64_t displayFrameToken1 = mTokenManager->generateTokenForPredictions({10, 25, 30});
1041 // Flush the token so that it would expire
1042 flushTokens(systemTime() + maxTokenRetentionTime);
1043
1044 // Set up the display frame
1045 mFrameTimeline->setSfWakeUp(displayFrameToken1, 20, Fps::fromPeriodNsecs(11));
1046 mFrameTimeline->setSfPresent(26, presentFence1);
1047 presentFence1->signalForTest(31);
1048
1049 int64_t traceCookie = snoopCurrentTraceCookie();
1050
1051 auto protoActualDisplayFrameStart =
1052 createProtoActualDisplayFrameStart(traceCookie + 1, displayFrameToken1,
1053 kSurfaceFlingerPid,
1054 FrameTimelineEvent::PRESENT_UNSPECIFIED, false,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +00001055 false, FrameTimelineEvent::JANK_UNKNOWN,
1056 FrameTimelineEvent::PREDICTION_EXPIRED);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001057 auto protoActualDisplayFrameEnd = createProtoFrameEnd(traceCookie + 1);
1058
1059 addEmptyDisplayFrame();
1060 flushTrace();
1061 tracingSession->StopBlocking();
1062
1063 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
1064 // Only actual timeline packets should be in the trace
1065 EXPECT_EQ(packets.size(), 2u);
1066
1067 // Packet - 0 : ActualDisplayFrameStart
1068 const auto& packet0 = packets[0];
1069 ASSERT_TRUE(packet0.has_timestamp());
1070 EXPECT_EQ(packet0.timestamp(), 20u);
1071 ASSERT_TRUE(packet0.has_frame_timeline_event());
1072
1073 const auto& event0 = packet0.frame_timeline_event();
1074 ASSERT_TRUE(event0.has_actual_display_frame_start());
1075 const auto& actualDisplayFrameStart = event0.actual_display_frame_start();
1076 validateTraceEvent(actualDisplayFrameStart, protoActualDisplayFrameStart);
1077
1078 // Packet - 1 : FrameEnd (ActualDisplayFrame)
1079 const auto& packet1 = packets[1];
1080 ASSERT_TRUE(packet1.has_timestamp());
Adithya Srinivasan1a971632021-02-26 23:10:29 +00001081 EXPECT_EQ(packet1.timestamp(), 31u);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001082 ASSERT_TRUE(packet1.has_frame_timeline_event());
1083
1084 const auto& event1 = packet1.frame_timeline_event();
1085 ASSERT_TRUE(event1.has_frame_end());
1086 const auto& actualDisplayFrameEnd = event1.frame_end();
1087 validateTraceEvent(actualDisplayFrameEnd, protoActualDisplayFrameEnd);
1088}
1089
Adithya Srinivasan01189672020-10-20 14:23:05 -07001090TEST_F(FrameTimelineTest, traceSurfaceFrame_emitsValidTracePacket) {
1091 auto tracingSession = getTracingSessionForTest();
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001092 // Layer specific increment
Alec Mouri363faf02021-01-29 16:34:55 -08001093 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_));
Adithya Srinivasan01189672020-10-20 14:23:05 -07001094 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1095 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1096
1097 tracingSession->StartBlocking();
1098 int64_t surfaceFrameToken = mTokenManager->generateTokenForPredictions({10, 25, 40});
1099 int64_t displayFrameToken1 = mTokenManager->generateTokenForPredictions({30, 35, 40});
Adithya Srinivasan01189672020-10-20 14:23:05 -07001100
1101 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001102 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001103 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001104 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001105 auto surfaceFrame2 =
1106 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001107 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001108 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001109 surfaceFrame1->setActualQueueTime(10);
1110 surfaceFrame1->setDropTime(15);
1111
1112 surfaceFrame2->setActualQueueTime(15);
1113 surfaceFrame2->setAcquireFenceTime(20);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001114
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001115 // First 2 cookies will be used by the DisplayFrame
1116 int64_t traceCookie = snoopCurrentTraceCookie() + 2;
1117
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001118 auto protoDroppedSurfaceFrameExpectedStart =
1119 createProtoExpectedSurfaceFrameStart(traceCookie + 1, surfaceFrameToken,
1120 displayFrameToken1, sPidOne, sLayerNameOne);
1121 auto protoDroppedSurfaceFrameExpectedEnd = createProtoFrameEnd(traceCookie + 1);
1122 auto protoDroppedSurfaceFrameActualStart =
1123 createProtoActualSurfaceFrameStart(traceCookie + 2, surfaceFrameToken,
1124 displayFrameToken1, sPidOne, sLayerNameOne,
1125 FrameTimelineEvent::PRESENT_DROPPED, false, false,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +00001126 FrameTimelineEvent::JANK_NONE,
1127 FrameTimelineEvent::PREDICTION_VALID);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001128 auto protoDroppedSurfaceFrameActualEnd = createProtoFrameEnd(traceCookie + 2);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001129
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001130 auto protoPresentedSurfaceFrameExpectedStart =
1131 createProtoExpectedSurfaceFrameStart(traceCookie + 3, surfaceFrameToken,
1132 displayFrameToken1, sPidOne, sLayerNameOne);
1133 auto protoPresentedSurfaceFrameExpectedEnd = createProtoFrameEnd(traceCookie + 3);
1134 auto protoPresentedSurfaceFrameActualStart =
1135 createProtoActualSurfaceFrameStart(traceCookie + 4, surfaceFrameToken,
1136 displayFrameToken1, sPidOne, sLayerNameOne,
1137 FrameTimelineEvent::PRESENT_ON_TIME, true, false,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +00001138 FrameTimelineEvent::JANK_NONE,
1139 FrameTimelineEvent::PREDICTION_VALID);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001140 auto protoPresentedSurfaceFrameActualEnd = createProtoFrameEnd(traceCookie + 4);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001141
1142 // Set up the display frame
Alec Mouri7d436ec2021-01-27 20:40:50 -08001143 mFrameTimeline->setSfWakeUp(displayFrameToken1, 20, Fps::fromPeriodNsecs(11));
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001144 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Dropped);
1145 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001146 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001147 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001148 mFrameTimeline->setSfPresent(26, presentFence1);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001149 presentFence1->signalForTest(40);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001150
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001151 addEmptyDisplayFrame();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001152 flushTrace();
Adithya Srinivasan01189672020-10-20 14:23:05 -07001153 tracingSession->StopBlocking();
1154
1155 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001156 // 4 DisplayFrame + 4 DroppedSurfaceFrame + 4 PresentedSurfaceFrame
1157 EXPECT_EQ(packets.size(), 12u);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001158
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001159 // Packet - 4 : ExpectedSurfaceFrameStart1
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001160 const auto& packet4 = packets[4];
1161 ASSERT_TRUE(packet4.has_timestamp());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001162 EXPECT_EQ(packet4.timestamp(), 10u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001163 ASSERT_TRUE(packet4.has_frame_timeline_event());
Adithya Srinivasan01189672020-10-20 14:23:05 -07001164
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001165 const auto& event4 = packet4.frame_timeline_event();
1166 ASSERT_TRUE(event4.has_expected_surface_frame_start());
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001167 const auto& expectedSurfaceFrameStart1 = event4.expected_surface_frame_start();
1168 validateTraceEvent(expectedSurfaceFrameStart1, protoDroppedSurfaceFrameExpectedStart);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001169
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001170 // Packet - 5 : FrameEnd (ExpectedSurfaceFrame1)
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001171 const auto& packet5 = packets[5];
1172 ASSERT_TRUE(packet5.has_timestamp());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001173 EXPECT_EQ(packet5.timestamp(), 25u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001174 ASSERT_TRUE(packet5.has_frame_timeline_event());
1175
1176 const auto& event5 = packet5.frame_timeline_event();
1177 ASSERT_TRUE(event5.has_frame_end());
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001178 const auto& expectedSurfaceFrameEnd1 = event5.frame_end();
1179 validateTraceEvent(expectedSurfaceFrameEnd1, protoDroppedSurfaceFrameExpectedEnd);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001180
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001181 // Packet - 6 : ActualSurfaceFrameStart1
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001182 const auto& packet6 = packets[6];
1183 ASSERT_TRUE(packet6.has_timestamp());
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001184 EXPECT_EQ(packet6.timestamp(), 10u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001185 ASSERT_TRUE(packet6.has_frame_timeline_event());
1186
1187 const auto& event6 = packet6.frame_timeline_event();
1188 ASSERT_TRUE(event6.has_actual_surface_frame_start());
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001189 const auto& actualSurfaceFrameStart1 = event6.actual_surface_frame_start();
1190 validateTraceEvent(actualSurfaceFrameStart1, protoDroppedSurfaceFrameActualStart);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001191
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001192 // Packet - 7 : FrameEnd (ActualSurfaceFrame1)
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001193 const auto& packet7 = packets[7];
1194 ASSERT_TRUE(packet7.has_timestamp());
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001195 EXPECT_EQ(packet7.timestamp(), 15u);
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001196 ASSERT_TRUE(packet7.has_frame_timeline_event());
1197
1198 const auto& event7 = packet7.frame_timeline_event();
1199 ASSERT_TRUE(event7.has_frame_end());
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001200 const auto& actualSurfaceFrameEnd1 = event7.frame_end();
1201 validateTraceEvent(actualSurfaceFrameEnd1, protoDroppedSurfaceFrameActualEnd);
1202
1203 // Packet - 8 : ExpectedSurfaceFrameStart2
1204 const auto& packet8 = packets[8];
1205 ASSERT_TRUE(packet8.has_timestamp());
1206 EXPECT_EQ(packet8.timestamp(), 10u);
1207 ASSERT_TRUE(packet8.has_frame_timeline_event());
1208
1209 const auto& event8 = packet8.frame_timeline_event();
1210 ASSERT_TRUE(event8.has_expected_surface_frame_start());
1211 const auto& expectedSurfaceFrameStart2 = event8.expected_surface_frame_start();
1212 validateTraceEvent(expectedSurfaceFrameStart2, protoPresentedSurfaceFrameExpectedStart);
1213
1214 // Packet - 9 : FrameEnd (ExpectedSurfaceFrame2)
1215 const auto& packet9 = packets[9];
1216 ASSERT_TRUE(packet9.has_timestamp());
1217 EXPECT_EQ(packet9.timestamp(), 25u);
1218 ASSERT_TRUE(packet9.has_frame_timeline_event());
1219
1220 const auto& event9 = packet9.frame_timeline_event();
1221 ASSERT_TRUE(event9.has_frame_end());
1222 const auto& expectedSurfaceFrameEnd2 = event9.frame_end();
1223 validateTraceEvent(expectedSurfaceFrameEnd2, protoPresentedSurfaceFrameExpectedEnd);
1224
1225 // Packet - 10 : ActualSurfaceFrameStart2
1226 const auto& packet10 = packets[10];
1227 ASSERT_TRUE(packet10.has_timestamp());
1228 EXPECT_EQ(packet10.timestamp(), 10u);
1229 ASSERT_TRUE(packet10.has_frame_timeline_event());
1230
1231 const auto& event10 = packet10.frame_timeline_event();
1232 ASSERT_TRUE(event10.has_actual_surface_frame_start());
1233 const auto& actualSurfaceFrameStart2 = event10.actual_surface_frame_start();
1234 validateTraceEvent(actualSurfaceFrameStart2, protoPresentedSurfaceFrameActualStart);
1235
1236 // Packet - 11 : FrameEnd (ActualSurfaceFrame2)
1237 const auto& packet11 = packets[11];
1238 ASSERT_TRUE(packet11.has_timestamp());
1239 EXPECT_EQ(packet11.timestamp(), 20u);
1240 ASSERT_TRUE(packet11.has_frame_timeline_event());
1241
1242 const auto& event11 = packet11.frame_timeline_event();
1243 ASSERT_TRUE(event11.has_frame_end());
1244 const auto& actualSurfaceFrameEnd2 = event11.frame_end();
1245 validateTraceEvent(actualSurfaceFrameEnd2, protoPresentedSurfaceFrameActualEnd);
1246}
1247
1248TEST_F(FrameTimelineTest, traceSurfaceFrame_predictionExpiredDoesNotTraceExpectedTimeline) {
1249 auto tracingSession = getTracingSessionForTest();
1250 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1251
1252 tracingSession->StartBlocking();
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001253 constexpr nsecs_t appStartTime = std::chrono::nanoseconds(10ms).count();
1254 constexpr nsecs_t appEndTime = std::chrono::nanoseconds(20ms).count();
1255 constexpr nsecs_t appPresentTime = std::chrono::nanoseconds(30ms).count();
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001256 int64_t surfaceFrameToken =
1257 mTokenManager->generateTokenForPredictions({appStartTime, appEndTime, appPresentTime});
1258
1259 // Flush the token so that it would expire
1260 flushTokens(systemTime() + maxTokenRetentionTime);
1261 auto surfaceFrame1 =
1262 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken, /*inputEventId*/ 0},
Alec Mouriadebf5c2021-01-05 12:57:36 -08001263 sPidOne, sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001264 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001265 surfaceFrame1->setActualQueueTime(appEndTime);
1266 surfaceFrame1->setAcquireFenceTime(appEndTime);
1267
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001268 constexpr nsecs_t sfStartTime = std::chrono::nanoseconds(20ms).count();
1269 constexpr nsecs_t sfEndTime = std::chrono::nanoseconds(30ms).count();
1270 constexpr nsecs_t sfPresentTime = std::chrono::nanoseconds(30ms).count();
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001271 int64_t displayFrameToken =
1272 mTokenManager->generateTokenForPredictions({sfStartTime, sfEndTime, sfPresentTime});
1273
1274 // First 2 cookies will be used by the DisplayFrame
1275 int64_t traceCookie = snoopCurrentTraceCookie() + 2;
1276
1277 auto protoActualSurfaceFrameStart =
1278 createProtoActualSurfaceFrameStart(traceCookie + 1, surfaceFrameToken,
1279 displayFrameToken, sPidOne, sLayerNameOne,
1280 FrameTimelineEvent::PRESENT_UNSPECIFIED, false,
Adithya Srinivasan78e58af2021-02-25 00:08:08 +00001281 false, FrameTimelineEvent::JANK_UNKNOWN,
1282 FrameTimelineEvent::PREDICTION_EXPIRED);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +00001283 auto protoActualSurfaceFrameEnd = createProtoFrameEnd(traceCookie + 1);
1284
1285 // Set up the display frame
1286 mFrameTimeline->setSfWakeUp(displayFrameToken, sfStartTime, Fps::fromPeriodNsecs(11));
1287 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1288 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1289 mFrameTimeline->setSfPresent(sfEndTime, presentFence1);
1290 presentFence1->signalForTest(sfPresentTime);
1291
1292 addEmptyDisplayFrame();
1293 flushTrace();
1294 tracingSession->StopBlocking();
1295
1296 auto packets = readFrameTimelinePacketsBlocking(tracingSession.get());
1297 // Display Frame 4 packets + SurfaceFrame 2 packets
1298 ASSERT_EQ(packets.size(), 6u);
1299
1300 // Packet - 4 : ActualSurfaceFrameStart
1301 const auto& packet4 = packets[4];
1302 ASSERT_TRUE(packet4.has_timestamp());
1303 EXPECT_EQ(packet4.timestamp(),
1304 static_cast<uint64_t>(appEndTime - SurfaceFrame::kPredictionExpiredStartTimeDelta));
1305 ASSERT_TRUE(packet4.has_frame_timeline_event());
1306
1307 const auto& event4 = packet4.frame_timeline_event();
1308 ASSERT_TRUE(event4.has_actual_surface_frame_start());
1309 const auto& actualSurfaceFrameStart = event4.actual_surface_frame_start();
1310 validateTraceEvent(actualSurfaceFrameStart, protoActualSurfaceFrameStart);
1311
1312 // Packet - 5 : FrameEnd (ActualSurfaceFrame)
1313 const auto& packet5 = packets[5];
1314 ASSERT_TRUE(packet5.has_timestamp());
1315 EXPECT_EQ(packet5.timestamp(), static_cast<uint64_t>(appEndTime));
1316 ASSERT_TRUE(packet5.has_frame_timeline_event());
1317
1318 const auto& event5 = packet5.frame_timeline_event();
1319 ASSERT_TRUE(event5.has_frame_end());
1320 const auto& actualSurfaceFrameEnd = event5.frame_end();
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +00001321 validateTraceEvent(actualSurfaceFrameEnd, protoActualSurfaceFrameEnd);
Adithya Srinivasan01189672020-10-20 14:23:05 -07001322}
1323
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001324// Tests for Jank classification
1325TEST_F(FrameTimelineTest, jankClassification_presentOnTimeDoesNotClassify) {
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001326 // Layer specific increment
Alec Mouri363faf02021-01-29 16:34:55 -08001327 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001328 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1329 int64_t surfaceFrameToken = mTokenManager->generateTokenForPredictions({10, 20, 30});
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001330 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 30, 30});
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001331 auto surfaceFrame =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001332 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001333 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001334 sLayerNameOne, /*isBuffer*/ true);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001335 mFrameTimeline->setSfWakeUp(sfToken1, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001336 surfaceFrame->setPresentState(SurfaceFrame::PresentState::Presented);
1337 mFrameTimeline->addSurfaceFrame(surfaceFrame);
1338 mFrameTimeline->setSfPresent(26, presentFence1);
1339 auto displayFrame = getDisplayFrame(0);
1340 auto& presentedSurfaceFrame = getSurfaceFrame(0, 0);
1341 presentFence1->signalForTest(29);
1342
1343 // Fences haven't been flushed yet, so it should be 0
1344 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
1345 EXPECT_EQ(presentedSurfaceFrame.getActuals().presentTime, 0);
1346
1347 addEmptyDisplayFrame();
1348 displayFrame = getDisplayFrame(0);
1349
1350 // Fences have flushed, so the present timestamps should be updated
1351 EXPECT_EQ(displayFrame->getActuals().presentTime, 29);
1352 EXPECT_EQ(presentedSurfaceFrame.getActuals().presentTime, 29);
1353 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1354 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1355 EXPECT_EQ(displayFrame->getJankType(), JankType::None);
1356}
1357
1358TEST_F(FrameTimelineTest, jankClassification_displayFrameOnTimeFinishEarlyPresent) {
Alec Mouri363faf02021-01-29 16:34:55 -08001359 Fps vsyncRate = Fps::fromPeriodNsecs(11);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001360 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001361 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 30, 40});
1362 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({52, 60, 70});
Alec Mouri363faf02021-01-29 16:34:55 -08001363 mFrameTimeline->setSfWakeUp(sfToken1, 22, vsyncRate);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001364 mFrameTimeline->setSfPresent(26, presentFence1);
1365 auto displayFrame = getDisplayFrame(0);
1366 presentFence1->signalForTest(30);
1367
1368 // Fences for the first frame haven't been flushed yet, so it should be 0
1369 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
1370
1371 // Trigger a flush by finalizing the next DisplayFrame
1372 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Alec Mouri363faf02021-01-29 16:34:55 -08001373 mFrameTimeline->setSfWakeUp(sfToken2, 52, vsyncRate);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001374 mFrameTimeline->setSfPresent(56, presentFence2);
1375 displayFrame = getDisplayFrame(0);
1376
1377 // Fences for the first frame have flushed, so the present timestamps should be updated
1378 EXPECT_EQ(displayFrame->getActuals().presentTime, 30);
1379 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1380 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1381 EXPECT_EQ(displayFrame->getJankType(), JankType::SurfaceFlingerScheduling);
1382
1383 // Fences for the second frame haven't been flushed yet, so it should be 0
1384 auto displayFrame2 = getDisplayFrame(1);
1385 presentFence2->signalForTest(65);
1386 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001387 addEmptyDisplayFrame();
1388 displayFrame2 = getDisplayFrame(1);
1389
1390 // Fences for the second frame have flushed, so the present timestamps should be updated
1391 EXPECT_EQ(displayFrame2->getActuals().presentTime, 65);
1392 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1393 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1394 EXPECT_EQ(displayFrame2->getJankType(), JankType::PredictionError);
1395}
1396
1397TEST_F(FrameTimelineTest, jankClassification_displayFrameOnTimeFinishLatePresent) {
Alec Mouri363faf02021-01-29 16:34:55 -08001398 Fps vsyncRate = Fps::fromPeriodNsecs(11);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001399 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001400 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 30, 40});
1401 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({52, 60, 70});
Alec Mouri363faf02021-01-29 16:34:55 -08001402 mFrameTimeline->setSfWakeUp(sfToken1, 22, vsyncRate);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001403 mFrameTimeline->setSfPresent(26, presentFence1);
1404 auto displayFrame = getDisplayFrame(0);
1405 presentFence1->signalForTest(50);
1406
1407 // Fences for the first frame haven't been flushed yet, so it should be 0
1408 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
1409
1410 // Trigger a flush by finalizing the next DisplayFrame
1411 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Alec Mouri363faf02021-01-29 16:34:55 -08001412 mFrameTimeline->setSfWakeUp(sfToken2, 52, vsyncRate);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001413 mFrameTimeline->setSfPresent(56, presentFence2);
1414 displayFrame = getDisplayFrame(0);
1415
1416 // Fences for the first frame have flushed, so the present timestamps should be updated
1417 EXPECT_EQ(displayFrame->getActuals().presentTime, 50);
1418 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1419 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1420 EXPECT_EQ(displayFrame->getJankType(), JankType::DisplayHAL);
1421
1422 // Fences for the second frame haven't been flushed yet, so it should be 0
1423 auto displayFrame2 = getDisplayFrame(1);
1424 presentFence2->signalForTest(75);
1425 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
1426
1427 addEmptyDisplayFrame();
1428 displayFrame2 = getDisplayFrame(1);
1429
1430 // Fences for the second frame have flushed, so the present timestamps should be updated
1431 EXPECT_EQ(displayFrame2->getActuals().presentTime, 75);
1432 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1433 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1434 EXPECT_EQ(displayFrame2->getJankType(), JankType::PredictionError);
1435}
1436
1437TEST_F(FrameTimelineTest, jankClassification_displayFrameLateFinishEarlyPresent) {
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001438 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1439 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({12, 18, 40});
Alec Mouri7d436ec2021-01-27 20:40:50 -08001440 mFrameTimeline->setSfWakeUp(sfToken1, 12, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001441
1442 mFrameTimeline->setSfPresent(22, presentFence1);
1443 auto displayFrame = getDisplayFrame(0);
1444 presentFence1->signalForTest(28);
1445
1446 // Fences haven't been flushed yet, so it should be 0
1447 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
1448
1449 addEmptyDisplayFrame();
1450 displayFrame = getDisplayFrame(0);
1451
1452 // Fences have flushed, so the present timestamps should be updated
1453 EXPECT_EQ(displayFrame->getActuals().presentTime, 28);
1454 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1455 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1456 EXPECT_EQ(displayFrame->getJankType(), JankType::SurfaceFlingerScheduling);
1457}
1458
1459TEST_F(FrameTimelineTest, jankClassification_displayFrameLateFinishLatePresent) {
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001460 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1461 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 26, 40});
Alec Mouri7d436ec2021-01-27 20:40:50 -08001462 mFrameTimeline->setSfWakeUp(sfToken1, 12, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001463 mFrameTimeline->setSfPresent(36, presentFence1);
1464 auto displayFrame = getDisplayFrame(0);
1465 presentFence1->signalForTest(52);
1466
1467 // Fences haven't been flushed yet, so it should be 0
1468 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
1469
1470 addEmptyDisplayFrame();
1471 displayFrame = getDisplayFrame(0);
1472
1473 // Fences have flushed, so the present timestamps should be updated
1474 EXPECT_EQ(displayFrame->getActuals().presentTime, 52);
1475 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1476 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1477 EXPECT_EQ(displayFrame->getJankType(), JankType::SurfaceFlingerCpuDeadlineMissed);
1478}
1479
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001480TEST_F(FrameTimelineTest, jankClassification_displayFrameLateStartLateFinishLatePresent) {
1481 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1482 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 26, 40});
1483 mFrameTimeline->setSfWakeUp(sfToken1, 26, Fps::fromPeriodNsecs(11));
1484 mFrameTimeline->setSfPresent(36, presentFence1);
1485 auto displayFrame = getDisplayFrame(0);
1486 presentFence1->signalForTest(52);
1487
1488 // Fences haven't been flushed yet, so it should be 0
1489 EXPECT_EQ(displayFrame->getActuals().presentTime, 0);
1490
1491 addEmptyDisplayFrame();
1492 displayFrame = getDisplayFrame(0);
1493
1494 // Fences have flushed, so the present timestamps should be updated
1495 EXPECT_EQ(displayFrame->getActuals().presentTime, 52);
1496 EXPECT_EQ(displayFrame->getFrameStartMetadata(), FrameStartMetadata::LateStart);
1497 EXPECT_EQ(displayFrame->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1498 EXPECT_EQ(displayFrame->getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1499 EXPECT_EQ(displayFrame->getJankType(), JankType::SurfaceFlingerScheduling);
1500}
1501
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001502TEST_F(FrameTimelineTest, jankClassification_surfaceFrameOnTimeFinishEarlyPresent) {
Alec Mouri363faf02021-01-29 16:34:55 -08001503 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001504 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001505 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 30, 40});
1506 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({52, 60, 70});
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001507 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({5, 16, 40});
1508 int64_t surfaceFrameToken2 = mTokenManager->generateTokenForPredictions({25, 36, 70});
1509 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001510 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001511 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001512 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001513 surfaceFrame1->setAcquireFenceTime(16);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001514 mFrameTimeline->setSfWakeUp(sfToken1, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001515 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1516 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001517 mFrameTimeline->setSfPresent(27, presentFence1);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001518 auto displayFrame1 = getDisplayFrame(0);
1519 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
1520 presentFence1->signalForTest(30);
1521
1522 // Fences for the first frame haven't been flushed yet, so it should be 0
1523 EXPECT_EQ(displayFrame1->getActuals().presentTime, 0);
1524 auto actuals1 = presentedSurfaceFrame1.getActuals();
1525 EXPECT_EQ(actuals1.presentTime, 0);
1526
1527 // Trigger a flush by finalizing the next DisplayFrame
1528 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1529 auto surfaceFrame2 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001530 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken2, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001531 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001532 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001533 surfaceFrame2->setAcquireFenceTime(36);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001534 mFrameTimeline->setSfWakeUp(sfToken2, 52, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001535 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
1536 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001537 mFrameTimeline->setSfPresent(57, presentFence2);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001538 auto displayFrame2 = getDisplayFrame(1);
1539 auto& presentedSurfaceFrame2 = getSurfaceFrame(1, 0);
1540
1541 // Fences for the first frame have flushed, so the present timestamps should be updated
1542 EXPECT_EQ(displayFrame1->getActuals().presentTime, 30);
1543 EXPECT_EQ(displayFrame1->getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1544 EXPECT_EQ(displayFrame1->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1545 EXPECT_EQ(displayFrame1->getJankType(), JankType::SurfaceFlingerScheduling);
1546
1547 actuals1 = presentedSurfaceFrame1.getActuals();
1548 EXPECT_EQ(actuals1.presentTime, 30);
1549 EXPECT_EQ(presentedSurfaceFrame1.getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1550 EXPECT_EQ(presentedSurfaceFrame1.getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1551 EXPECT_EQ(presentedSurfaceFrame1.getJankType(), JankType::SurfaceFlingerScheduling);
1552
1553 // Fences for the second frame haven't been flushed yet, so it should be 0
1554 presentFence2->signalForTest(65);
1555 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
1556 auto actuals2 = presentedSurfaceFrame2.getActuals();
1557 EXPECT_EQ(actuals2.presentTime, 0);
1558
Alec Mouri363faf02021-01-29 16:34:55 -08001559 ::testing::Mock::VerifyAndClearExpectations(mTimeStats.get());
1560
1561 EXPECT_CALL(*mTimeStats,
1562 incrementJankyFrames(
1563 TimeStats::JankyFramesInfo{Fps::fromPeriodNsecs(11), std::nullopt, sUidOne,
1564 sLayerNameOne, JankType::PredictionError, 0, 5,
1565 0}));
1566
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001567 addEmptyDisplayFrame();
1568
1569 // Fences for the second frame have flushed, so the present timestamps should be updated
1570 EXPECT_EQ(displayFrame2->getActuals().presentTime, 65);
1571 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1572 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1573 EXPECT_EQ(displayFrame2->getJankType(), JankType::PredictionError);
1574
1575 actuals2 = presentedSurfaceFrame2.getActuals();
1576 EXPECT_EQ(actuals2.presentTime, 65);
1577 EXPECT_EQ(presentedSurfaceFrame2.getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1578 EXPECT_EQ(presentedSurfaceFrame2.getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1579 EXPECT_EQ(presentedSurfaceFrame2.getJankType(), JankType::PredictionError);
1580}
1581
1582TEST_F(FrameTimelineTest, jankClassification_surfaceFrameOnTimeFinishLatePresent) {
Alec Mouri363faf02021-01-29 16:34:55 -08001583 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001584 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001585 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({22, 30, 40});
1586 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({52, 60, 70});
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001587 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({5, 16, 40});
1588 int64_t surfaceFrameToken2 = mTokenManager->generateTokenForPredictions({25, 36, 70});
1589 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001590 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001591 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001592 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001593 surfaceFrame1->setAcquireFenceTime(16);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001594 mFrameTimeline->setSfWakeUp(sfToken1, 22, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001595 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1596 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1597 mFrameTimeline->setSfPresent(26, presentFence1);
1598 auto displayFrame1 = getDisplayFrame(0);
1599 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
1600 presentFence1->signalForTest(50);
1601
1602 // Fences for the first frame haven't been flushed yet, so it should be 0
1603 EXPECT_EQ(displayFrame1->getActuals().presentTime, 0);
1604 auto actuals1 = presentedSurfaceFrame1.getActuals();
1605 EXPECT_EQ(actuals1.presentTime, 0);
1606
1607 // Trigger a flush by finalizing the next DisplayFrame
1608 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1609 auto surfaceFrame2 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001610 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken2, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001611 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001612 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001613 surfaceFrame2->setAcquireFenceTime(36);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001614 mFrameTimeline->setSfWakeUp(sfToken2, 52, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001615 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
1616 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001617 mFrameTimeline->setSfPresent(57, presentFence2);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001618 auto displayFrame2 = getDisplayFrame(1);
1619 auto& presentedSurfaceFrame2 = getSurfaceFrame(1, 0);
1620
1621 // Fences for the first frame have flushed, so the present timestamps should be updated
1622 EXPECT_EQ(displayFrame1->getActuals().presentTime, 50);
1623 EXPECT_EQ(displayFrame1->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1624 EXPECT_EQ(displayFrame1->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1625 EXPECT_EQ(displayFrame1->getJankType(), JankType::DisplayHAL);
1626
1627 actuals1 = presentedSurfaceFrame1.getActuals();
1628 EXPECT_EQ(actuals1.presentTime, 50);
1629 EXPECT_EQ(presentedSurfaceFrame1.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1630 EXPECT_EQ(presentedSurfaceFrame1.getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1631 EXPECT_EQ(presentedSurfaceFrame1.getJankType(), JankType::DisplayHAL);
1632
1633 // Fences for the second frame haven't been flushed yet, so it should be 0
1634 presentFence2->signalForTest(86);
1635 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
1636 auto actuals2 = presentedSurfaceFrame2.getActuals();
1637 EXPECT_EQ(actuals2.presentTime, 0);
1638
Alec Mouri363faf02021-01-29 16:34:55 -08001639 ::testing::Mock::VerifyAndClearExpectations(mTimeStats.get());
1640
1641 EXPECT_CALL(*mTimeStats,
1642 incrementJankyFrames(
1643 TimeStats::JankyFramesInfo{Fps::fromPeriodNsecs(11), std::nullopt, sUidOne,
1644 sLayerNameOne, JankType::PredictionError, 0, 5,
1645 0}));
1646
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001647 addEmptyDisplayFrame();
1648
1649 // Fences for the second frame have flushed, so the present timestamps should be updated
1650 EXPECT_EQ(displayFrame2->getActuals().presentTime, 86);
1651 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1652 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1653 EXPECT_EQ(displayFrame2->getJankType(), JankType::PredictionError);
1654
1655 actuals2 = presentedSurfaceFrame2.getActuals();
1656 EXPECT_EQ(actuals2.presentTime, 86);
1657 EXPECT_EQ(presentedSurfaceFrame2.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1658 EXPECT_EQ(presentedSurfaceFrame2.getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1659 EXPECT_EQ(presentedSurfaceFrame2.getJankType(), JankType::PredictionError);
1660}
1661
1662TEST_F(FrameTimelineTest, jankClassification_surfaceFrameLateFinishEarlyPresent) {
Alec Mouri363faf02021-01-29 16:34:55 -08001663 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_));
Alec Mouri7d436ec2021-01-27 20:40:50 -08001664
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001665 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001666 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({42, 50, 50});
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001667 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({5, 26, 60});
1668 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001669 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001670 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001671 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001672 surfaceFrame1->setAcquireFenceTime(40);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001673 mFrameTimeline->setSfWakeUp(sfToken1, 42, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001674 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1675 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1676 mFrameTimeline->setSfPresent(46, presentFence1);
1677 auto displayFrame1 = getDisplayFrame(0);
1678 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
1679 presentFence1->signalForTest(50);
1680
1681 // Fences for the first frame haven't been flushed yet, so it should be 0
1682 EXPECT_EQ(displayFrame1->getActuals().presentTime, 0);
1683 auto actuals1 = presentedSurfaceFrame1.getActuals();
1684 EXPECT_EQ(actuals1.presentTime, 0);
1685
1686 addEmptyDisplayFrame();
1687
1688 // Fences for the first frame have flushed, so the present timestamps should be updated
1689 EXPECT_EQ(displayFrame1->getActuals().presentTime, 50);
1690 EXPECT_EQ(displayFrame1->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1691 EXPECT_EQ(displayFrame1->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1692 EXPECT_EQ(displayFrame1->getJankType(), JankType::None);
1693
1694 actuals1 = presentedSurfaceFrame1.getActuals();
1695 EXPECT_EQ(actuals1.presentTime, 50);
1696 EXPECT_EQ(presentedSurfaceFrame1.getFramePresentMetadata(), FramePresentMetadata::EarlyPresent);
1697 EXPECT_EQ(presentedSurfaceFrame1.getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1698 EXPECT_EQ(presentedSurfaceFrame1.getJankType(), JankType::Unknown);
1699}
1700
1701TEST_F(FrameTimelineTest, jankClassification_surfaceFrameLateFinishLatePresent) {
1702 // First frame - DisplayFrame is not janky. This should classify the SurfaceFrame as
1703 // AppDeadlineMissed. Second frame - DisplayFrame is janky. This should propagate DisplayFrame's
1704 // jank to the SurfaceFrame.
1705
Alec Mouri363faf02021-01-29 16:34:55 -08001706 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_)).Times(2);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001707 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001708 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({32, 40, 40});
1709 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({42, 50, 50});
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001710 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({5, 16, 30});
1711 int64_t surfaceFrameToken2 = mTokenManager->generateTokenForPredictions({25, 36, 50});
1712 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001713 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001714 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001715 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001716 surfaceFrame1->setAcquireFenceTime(26);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001717 mFrameTimeline->setSfWakeUp(sfToken1, 32, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001718 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1719 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1720 mFrameTimeline->setSfPresent(36, presentFence1);
1721 auto displayFrame1 = getDisplayFrame(0);
1722 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
1723 presentFence1->signalForTest(40);
1724
1725 // Fences for the first frame haven't been flushed yet, so it should be 0
1726 EXPECT_EQ(displayFrame1->getActuals().presentTime, 0);
1727 auto actuals1 = presentedSurfaceFrame1.getActuals();
1728 EXPECT_EQ(actuals1.presentTime, 0);
1729
1730 // Trigger a flush by finalizing the next DisplayFrame
1731 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1732 auto surfaceFrame2 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001733 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken2, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001734 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001735 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001736 surfaceFrame2->setAcquireFenceTime(40);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001737 mFrameTimeline->setSfWakeUp(sfToken2, 43, Fps::fromPeriodNsecs(11));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001738 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
1739 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
1740 mFrameTimeline->setSfPresent(56, presentFence2);
1741 auto displayFrame2 = getDisplayFrame(1);
1742 auto& presentedSurfaceFrame2 = getSurfaceFrame(1, 0);
1743
1744 // Fences for the first frame have flushed, so the present timestamps should be updated
1745 EXPECT_EQ(displayFrame1->getActuals().presentTime, 40);
1746 EXPECT_EQ(displayFrame1->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1747 EXPECT_EQ(displayFrame1->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1748 EXPECT_EQ(displayFrame1->getJankType(), JankType::None);
1749
1750 actuals1 = presentedSurfaceFrame1.getActuals();
1751 EXPECT_EQ(actuals1.presentTime, 40);
1752 EXPECT_EQ(presentedSurfaceFrame1.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1753 EXPECT_EQ(presentedSurfaceFrame1.getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1754 EXPECT_EQ(presentedSurfaceFrame1.getJankType(), JankType::AppDeadlineMissed);
1755
1756 // Fences for the second frame haven't been flushed yet, so it should be 0
1757 presentFence2->signalForTest(60);
1758 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
1759 auto actuals2 = presentedSurfaceFrame2.getActuals();
1760 EXPECT_EQ(actuals2.presentTime, 0);
1761
1762 addEmptyDisplayFrame();
1763
1764 // Fences for the second frame have flushed, so the present timestamps should be updated
1765 EXPECT_EQ(displayFrame2->getActuals().presentTime, 60);
1766 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1767 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1768 EXPECT_EQ(displayFrame2->getJankType(), JankType::SurfaceFlingerCpuDeadlineMissed);
1769
1770 actuals2 = presentedSurfaceFrame2.getActuals();
1771 EXPECT_EQ(actuals2.presentTime, 60);
1772 EXPECT_EQ(presentedSurfaceFrame2.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1773 EXPECT_EQ(presentedSurfaceFrame2.getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1774 EXPECT_EQ(presentedSurfaceFrame2.getJankType(), JankType::SurfaceFlingerCpuDeadlineMissed);
1775}
1776
1777TEST_F(FrameTimelineTest, jankClassification_multiJankBufferStuffingAndAppDeadlineMissed) {
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001778 // Layer specific increment
Alec Mouri363faf02021-01-29 16:34:55 -08001779 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_)).Times(2);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001780 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1781 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
1782 int64_t surfaceFrameToken2 = mTokenManager->generateTokenForPredictions({40, 50, 60});
1783
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001784 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
1785 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({112, 120, 120});
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001786 auto surfaceFrame1 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001787 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001788 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001789 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001790 surfaceFrame1->setAcquireFenceTime(50);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001791 mFrameTimeline->setSfWakeUp(sfToken1, 52, Fps::fromPeriodNsecs(30));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001792 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1793 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1794 mFrameTimeline->setSfPresent(56, presentFence1);
1795 auto displayFrame1 = getDisplayFrame(0);
1796 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
1797 presentFence1->signalForTest(60);
1798
1799 // Fences for the first frame haven't been flushed yet, so it should be 0
1800 EXPECT_EQ(displayFrame1->getActuals().presentTime, 0);
1801 auto actuals1 = presentedSurfaceFrame1.getActuals();
1802 EXPECT_EQ(actuals1.presentTime, 0);
1803
1804 // Trigger a flush by finalizing the next DisplayFrame
1805 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1806 auto surfaceFrame2 =
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -10001807 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken2, sInputEventId}, sPidOne,
Alec Mouriadebf5c2021-01-05 12:57:36 -08001808 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001809 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001810 surfaceFrame2->setAcquireFenceTime(84);
Alec Mouri7d436ec2021-01-27 20:40:50 -08001811 mFrameTimeline->setSfWakeUp(sfToken2, 112, Fps::fromPeriodNsecs(30));
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -08001812 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented, 54);
1813 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
1814 mFrameTimeline->setSfPresent(116, presentFence2);
1815 auto displayFrame2 = getDisplayFrame(1);
1816 auto& presentedSurfaceFrame2 = getSurfaceFrame(1, 0);
1817 presentFence2->signalForTest(120);
1818
1819 // Fences for the first frame have flushed, so the present timestamps should be updated
1820 EXPECT_EQ(displayFrame1->getActuals().presentTime, 60);
1821 actuals1 = presentedSurfaceFrame1.getActuals();
1822 EXPECT_EQ(actuals1.endTime, 50);
1823 EXPECT_EQ(actuals1.presentTime, 60);
1824
1825 EXPECT_EQ(displayFrame1->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1826 EXPECT_EQ(displayFrame1->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1827 EXPECT_EQ(displayFrame1->getJankType(), JankType::None);
1828
1829 EXPECT_EQ(presentedSurfaceFrame1.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1830 EXPECT_EQ(presentedSurfaceFrame1.getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1831 EXPECT_EQ(presentedSurfaceFrame1.getJankType(), JankType::AppDeadlineMissed);
1832
1833 // Fences for the second frame haven't been flushed yet, so it should be 0
1834 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
1835 auto actuals2 = presentedSurfaceFrame2.getActuals();
1836 EXPECT_EQ(actuals2.presentTime, 0);
1837
1838 addEmptyDisplayFrame();
1839
1840 // Fences for the second frame have flushed, so the present timestamps should be updated
1841 EXPECT_EQ(displayFrame2->getActuals().presentTime, 120);
1842 actuals2 = presentedSurfaceFrame2.getActuals();
1843 EXPECT_EQ(actuals2.presentTime, 120);
1844
1845 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1846 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1847 EXPECT_EQ(displayFrame2->getJankType(), JankType::None);
1848
1849 EXPECT_EQ(presentedSurfaceFrame2.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1850 EXPECT_EQ(presentedSurfaceFrame2.getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1851 EXPECT_EQ(presentedSurfaceFrame2.getJankType(),
1852 JankType::AppDeadlineMissed | JankType::BufferStuffing);
1853}
Alec Mouriadebf5c2021-01-05 12:57:36 -08001854
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001855TEST_F(FrameTimelineTest, jankClassification_appDeadlineAdjustedForBufferStuffing) {
1856 // Layer specific increment
1857 EXPECT_CALL(*mTimeStats, incrementJankyFrames(_)).Times(2);
1858 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1859 int64_t surfaceFrameToken1 = mTokenManager->generateTokenForPredictions({10, 20, 30});
1860 int64_t surfaceFrameToken2 = mTokenManager->generateTokenForPredictions({40, 50, 60});
1861
1862 int64_t sfToken1 = mTokenManager->generateTokenForPredictions({52, 60, 60});
1863 int64_t sfToken2 = mTokenManager->generateTokenForPredictions({82, 90, 90});
1864 auto surfaceFrame1 =
1865 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken1, sInputEventId}, sPidOne,
1866 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001867 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001868 surfaceFrame1->setAcquireFenceTime(50);
1869 mFrameTimeline->setSfWakeUp(sfToken1, 52, Fps::fromPeriodNsecs(30));
1870 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1871 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1872 mFrameTimeline->setSfPresent(56, presentFence1);
1873 auto displayFrame1 = getDisplayFrame(0);
1874 auto& presentedSurfaceFrame1 = getSurfaceFrame(0, 0);
1875 presentFence1->signalForTest(60);
1876
1877 // Fences for the first frame haven't been flushed yet, so it should be 0
1878 EXPECT_EQ(displayFrame1->getActuals().presentTime, 0);
1879 auto actuals1 = presentedSurfaceFrame1.getActuals();
1880 EXPECT_EQ(actuals1.presentTime, 0);
1881
1882 // Trigger a flush by finalizing the next DisplayFrame
1883 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1884 auto surfaceFrame2 =
1885 mFrameTimeline->createSurfaceFrameForToken({surfaceFrameToken2, sInputEventId}, sPidOne,
1886 sUidOne, sLayerIdOne, sLayerNameOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001887 sLayerNameOne, /*isBuffer*/ true);
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001888 surfaceFrame2->setAcquireFenceTime(80);
1889 mFrameTimeline->setSfWakeUp(sfToken2, 82, Fps::fromPeriodNsecs(30));
1890 // Setting previous latch time to 54, adjusted deadline will be 54 + vsyncTime(30) = 84
1891 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented, 54);
1892 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
1893 mFrameTimeline->setSfPresent(86, presentFence2);
1894 auto displayFrame2 = getDisplayFrame(1);
1895 auto& presentedSurfaceFrame2 = getSurfaceFrame(1, 0);
1896 presentFence2->signalForTest(90);
1897
1898 // Fences for the first frame have flushed, so the present timestamps should be updated
1899 EXPECT_EQ(displayFrame1->getActuals().presentTime, 60);
1900 actuals1 = presentedSurfaceFrame1.getActuals();
1901 EXPECT_EQ(actuals1.endTime, 50);
1902 EXPECT_EQ(actuals1.presentTime, 60);
1903
1904 EXPECT_EQ(displayFrame1->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1905 EXPECT_EQ(displayFrame1->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1906 EXPECT_EQ(displayFrame1->getJankType(), JankType::None);
1907
1908 EXPECT_EQ(presentedSurfaceFrame1.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1909 EXPECT_EQ(presentedSurfaceFrame1.getFrameReadyMetadata(), FrameReadyMetadata::LateFinish);
1910 EXPECT_EQ(presentedSurfaceFrame1.getJankType(), JankType::AppDeadlineMissed);
1911
1912 // Fences for the second frame haven't been flushed yet, so it should be 0
1913 EXPECT_EQ(displayFrame2->getActuals().presentTime, 0);
1914 auto actuals2 = presentedSurfaceFrame2.getActuals();
1915 EXPECT_EQ(actuals2.presentTime, 0);
1916
1917 addEmptyDisplayFrame();
1918
1919 // Fences for the second frame have flushed, so the present timestamps should be updated
1920 EXPECT_EQ(displayFrame2->getActuals().presentTime, 90);
1921 actuals2 = presentedSurfaceFrame2.getActuals();
1922 EXPECT_EQ(actuals2.presentTime, 90);
1923
1924 EXPECT_EQ(displayFrame2->getFramePresentMetadata(), FramePresentMetadata::OnTimePresent);
1925 EXPECT_EQ(displayFrame2->getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1926 EXPECT_EQ(displayFrame2->getJankType(), JankType::None);
1927
1928 EXPECT_EQ(presentedSurfaceFrame2.getFramePresentMetadata(), FramePresentMetadata::LatePresent);
1929 EXPECT_EQ(presentedSurfaceFrame2.getFrameReadyMetadata(), FrameReadyMetadata::OnTimeFinish);
1930 EXPECT_EQ(presentedSurfaceFrame2.getJankType(), JankType::BufferStuffing);
1931}
1932
Alec Mouriadebf5c2021-01-05 12:57:36 -08001933TEST_F(FrameTimelineTest, computeFps_noLayerIds_returnsZero) {
1934 EXPECT_EQ(mFrameTimeline->computeFps({}), 0.0f);
1935}
1936
1937TEST_F(FrameTimelineTest, computeFps_singleDisplayFrame_returnsZero) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001938 const auto oneHundredMs = std::chrono::nanoseconds(100ms).count();
Alec Mouriadebf5c2021-01-05 12:57:36 -08001939
1940 auto surfaceFrame1 =
1941 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001942 sLayerIdOne, sLayerNameOne, sLayerNameOne,
1943 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08001944 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1945 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1946 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1947 presentFence1->signalForTest(oneHundredMs);
1948 mFrameTimeline->setSfPresent(oneHundredMs, presentFence1);
1949
1950 EXPECT_EQ(mFrameTimeline->computeFps({sLayerIdOne}), 0.0f);
1951}
1952
1953TEST_F(FrameTimelineTest, computeFps_twoDisplayFrames_oneLayer) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001954 const auto oneHundredMs = std::chrono::nanoseconds(100ms).count();
1955 const auto twoHundredMs = std::chrono::nanoseconds(200ms).count();
Alec Mouriadebf5c2021-01-05 12:57:36 -08001956 auto surfaceFrame1 =
1957 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001958 sLayerIdOne, sLayerNameOne, sLayerNameOne,
1959 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08001960 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1961 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1962 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1963 presentFence1->signalForTest(oneHundredMs);
1964 mFrameTimeline->setSfPresent(oneHundredMs, presentFence1);
1965
1966 auto surfaceFrame2 =
1967 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001968 sLayerIdOne, sLayerNameOne, sLayerNameOne,
1969 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08001970 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1971 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
1972 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
1973 presentFence2->signalForTest(twoHundredMs);
1974 mFrameTimeline->setSfPresent(twoHundredMs, presentFence2);
1975
1976 EXPECT_EQ(mFrameTimeline->computeFps({sLayerIdOne}), 10.0);
1977}
1978
1979TEST_F(FrameTimelineTest, computeFps_twoDisplayFrames_twoLayers) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00001980 const auto oneHundredMs = std::chrono::nanoseconds(100ms).count();
1981 const auto twoHundredMs = std::chrono::nanoseconds(200ms).count();
Alec Mouriadebf5c2021-01-05 12:57:36 -08001982 auto surfaceFrame1 =
1983 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001984 sLayerIdOne, sLayerNameOne, sLayerNameOne,
1985 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08001986 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1987 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
1988 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
1989 presentFence1->signalForTest(oneHundredMs);
1990 mFrameTimeline->setSfPresent(oneHundredMs, presentFence1);
1991
1992 auto surfaceFrame2 =
1993 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00001994 sLayerIdTwo, sLayerNameTwo, sLayerNameTwo,
1995 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08001996 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
1997 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
1998 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
1999 presentFence2->signalForTest(twoHundredMs);
2000 mFrameTimeline->setSfPresent(twoHundredMs, presentFence2);
2001
2002 EXPECT_EQ(mFrameTimeline->computeFps({sLayerIdOne, sLayerIdTwo}), 10.0f);
2003}
2004
2005TEST_F(FrameTimelineTest, computeFps_filtersOutLayers) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00002006 const auto oneHundredMs = std::chrono::nanoseconds(100ms).count();
2007 const auto twoHundredMs = std::chrono::nanoseconds(200ms).count();
Alec Mouriadebf5c2021-01-05 12:57:36 -08002008 auto surfaceFrame1 =
2009 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002010 sLayerIdOne, sLayerNameOne, sLayerNameOne,
2011 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002012 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2013 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
2014 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
2015 presentFence1->signalForTest(oneHundredMs);
2016 mFrameTimeline->setSfPresent(oneHundredMs, presentFence1);
2017
2018 auto surfaceFrame2 =
2019 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002020 sLayerIdTwo, sLayerNameTwo, sLayerNameTwo,
2021 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002022 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2023 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
2024 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
2025 presentFence2->signalForTest(twoHundredMs);
2026 mFrameTimeline->setSfPresent(twoHundredMs, presentFence2);
2027
2028 EXPECT_EQ(mFrameTimeline->computeFps({sLayerIdOne}), 0.0f);
2029}
2030
2031TEST_F(FrameTimelineTest, computeFps_averagesOverMultipleFrames) {
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +00002032 const auto oneHundredMs = std::chrono::nanoseconds(100ms).count();
2033 const auto twoHundredMs = std::chrono::nanoseconds(200ms).count();
2034 const auto threeHundredMs = std::chrono::nanoseconds(300ms).count();
2035 const auto fiveHundredMs = std::chrono::nanoseconds(500ms).count();
2036 const auto sixHundredMs = std::chrono::nanoseconds(600ms).count();
Alec Mouriadebf5c2021-01-05 12:57:36 -08002037 auto surfaceFrame1 =
2038 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002039 sLayerIdOne, sLayerNameOne, sLayerNameOne,
2040 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002041 auto presentFence1 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2042 surfaceFrame1->setPresentState(SurfaceFrame::PresentState::Presented);
2043 mFrameTimeline->addSurfaceFrame(surfaceFrame1);
2044 presentFence1->signalForTest(oneHundredMs);
2045 mFrameTimeline->setSfPresent(oneHundredMs, presentFence1);
2046
2047 auto surfaceFrame2 =
2048 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002049 sLayerIdOne, sLayerNameOne, sLayerNameOne,
2050 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002051 auto presentFence2 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2052 surfaceFrame2->setPresentState(SurfaceFrame::PresentState::Presented);
2053 mFrameTimeline->addSurfaceFrame(surfaceFrame2);
2054 presentFence2->signalForTest(twoHundredMs);
2055 mFrameTimeline->setSfPresent(twoHundredMs, presentFence2);
2056
2057 auto surfaceFrame3 =
2058 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002059 sLayerIdTwo, sLayerNameTwo, sLayerNameTwo,
2060 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002061 auto presentFence3 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2062 surfaceFrame3->setPresentState(SurfaceFrame::PresentState::Presented);
2063 mFrameTimeline->addSurfaceFrame(surfaceFrame3);
2064 presentFence3->signalForTest(threeHundredMs);
2065 mFrameTimeline->setSfPresent(threeHundredMs, presentFence3);
2066
2067 auto surfaceFrame4 =
2068 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002069 sLayerIdOne, sLayerNameOne, sLayerNameOne,
2070 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002071 auto presentFence4 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2072 surfaceFrame4->setPresentState(SurfaceFrame::PresentState::Presented);
2073 mFrameTimeline->addSurfaceFrame(surfaceFrame4);
2074 presentFence4->signalForTest(fiveHundredMs);
2075 mFrameTimeline->setSfPresent(fiveHundredMs, presentFence4);
2076
2077 auto surfaceFrame5 =
2078 mFrameTimeline->createSurfaceFrameForToken(FrameTimelineInfo(), sPidOne, sUidOne,
Adithya Srinivasan785addd2021-03-09 00:38:00 +00002079 sLayerIdOne, sLayerNameOne, sLayerNameOne,
2080 /*isBuffer*/ true);
Alec Mouriadebf5c2021-01-05 12:57:36 -08002081 auto presentFence5 = fenceFactory.createFenceTimeForTest(Fence::NO_FENCE);
2082 // Dropped frames will be excluded from fps computation
2083 surfaceFrame5->setPresentState(SurfaceFrame::PresentState::Dropped);
2084 mFrameTimeline->addSurfaceFrame(surfaceFrame5);
2085 presentFence5->signalForTest(sixHundredMs);
2086 mFrameTimeline->setSfPresent(sixHundredMs, presentFence5);
2087
2088 EXPECT_EQ(mFrameTimeline->computeFps({sLayerIdOne}), 5.0f);
2089}
2090
Adithya Srinivasanf279e042020-08-17 14:56:27 -07002091} // namespace android::frametimeline