File: SurfaceFlinger_NotifyExpectedPresentTest.cpp

package info (click to toggle)
android-platform-tools 35.0.2-1~exp6
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 211,716 kB
  • sloc: cpp: 995,749; java: 290,495; ansic: 145,647; xml: 58,531; python: 39,608; sh: 14,500; javascript: 5,198; asm: 4,866; makefile: 3,115; yacc: 769; awk: 368; ruby: 183; sql: 140; perl: 88; lex: 67
file content (385 lines) | stat: -rw-r--r-- 20,415 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
/*
 * Copyright 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#undef LOG_TAG
#define LOG_TAG "LibSurfaceFlingerUnittests"

#include <gui/SurfaceComposerClient.h>
#include "DisplayTransactionTestHelpers.h"

namespace android {

using FakeHwcDisplayInjector = TestableSurfaceFlinger::FakeHwcDisplayInjector;
using android::hardware::graphics::composer::V2_1::Error;

class NotifyExpectedPresentTest : public DisplayTransactionTest {
public:
    void SetUp() override {
        const auto display = PrimaryDisplayVariant::makeFakeExistingDisplayInjector(this).inject();
        mPhysicalDisplayId = display->getPhysicalId();
        FakeHwcDisplayInjector(mPhysicalDisplayId, hal::DisplayType::PHYSICAL, /*isPrimary=*/true)
                .setPowerMode(hal::PowerMode::ON)
                .inject(&mFlinger, mComposer);

        ASSERT_NO_FATAL_FAILURE(mFlinger.setNotifyExpectedPresentData(mPhysicalDisplayId,
                                                                      TimePoint::fromNs(0),
                                                                      kFps60Hz));
        mCompositor = std::make_unique<Compositor>(mPhysicalDisplayId, mFlinger);
    }

protected:
    void setTransactionState() {
        ASSERT_TRUE(mFlinger.getTransactionQueue().isEmpty());
        TransactionInfo transaction;
        mFlinger.setTransactionState(FrameTimelineInfo{}, transaction.states, transaction.displays,
                                     transaction.flags, transaction.applyToken,
                                     transaction.inputWindowCommands,
                                     TimePoint::now().ns() + s2ns(1), transaction.isAutoTimestamp,
                                     transaction.unCachedBuffers,
                                     /*HasListenerCallbacks=*/false, transaction.callbacks,
                                     transaction.id, transaction.mergedTransactionIds);
    }

    struct TransactionInfo {
        Vector<ComposerState> states;
        Vector<DisplayState> displays;
        uint32_t flags = 0;
        sp<IBinder> applyToken = IInterface::asBinder(TransactionCompletedListener::getIInstance());
        InputWindowCommands inputWindowCommands;
        int64_t desiredPresentTime = 0;
        bool isAutoTimestamp = false;
        FrameTimelineInfo frameTimelineInfo{};
        std::vector<client_cache_t> unCachedBuffers;
        uint64_t id = static_cast<uint64_t>(-1);
        std::vector<uint64_t> mergedTransactionIds;
        std::vector<ListenerCallbacks> callbacks;
    };

    struct Compositor final : ICompositor {
        explicit Compositor(PhysicalDisplayId displayId, TestableSurfaceFlinger& surfaceFlinger)
              : displayId(displayId), surfaceFlinger(surfaceFlinger) {}

        void sendNotifyExpectedPresentHint(PhysicalDisplayId id) override {
            surfaceFlinger.sendNotifyExpectedPresentHint(id);
        }

        bool commit(PhysicalDisplayId, const scheduler::FrameTargets&) override {
            return committed;
        }

        CompositeResultsPerDisplay composite(PhysicalDisplayId pacesetterId,
                                             const scheduler::FrameTargeters& targeters) override {
            pacesetterIds.composite = pacesetterId;
            CompositeResultsPerDisplay results;

            for (const auto& [id, targeter] : targeters) {
                vsyncIds.composite.emplace_back(id, targeter->target().vsyncId());
                surfaceFlinger.resetNotifyExpectedPresentHintState(pacesetterId);
                results.try_emplace(id,
                                    CompositeResult{.compositionCoverage =
                                                            CompositionCoverage::Hwc});
            }

            return results;
        }

        void sample() override {}
        void configure() override {}

        struct {
            PhysicalDisplayId commit;
            PhysicalDisplayId composite;
        } pacesetterIds;

        using VsyncIds = std::vector<std::pair<PhysicalDisplayId, VsyncId>>;
        struct {
            VsyncIds commit;
            VsyncIds composite;
        } vsyncIds;

        bool committed = true;
        PhysicalDisplayId displayId;
        TestableSurfaceFlinger& surfaceFlinger;
    };

    PhysicalDisplayId mPhysicalDisplayId;
    std::unique_ptr<Compositor> mCompositor;
    static constexpr hal::HWDisplayId kHwcDisplayId =
            FakeHwcDisplayInjector::DEFAULT_HWC_DISPLAY_ID;
    static constexpr Fps kFps60Hz = 60_Hz;
    static constexpr int32_t kFrameInterval5HzNs = static_cast<Fps>(5_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameInterval60HzNs = kFps60Hz.getPeriodNsecs();
    static constexpr int32_t kFrameInterval120HzNs = static_cast<Fps>(120_Hz).getPeriodNsecs();
    static constexpr Period kVsyncPeriod =
            Period::fromNs(static_cast<Fps>(240_Hz).getPeriodNsecs());
    static constexpr Period kTimeoutNs = Period::fromNs(kFrameInterval5HzNs);
};

TEST_F(NotifyExpectedPresentTest, noNotifyExpectedPresentHintCall_absentTimeout) {
    auto expectedPresentTime = TimePoint::now().ns() + ms2ns(10);
    ASSERT_NO_FATAL_FAILURE(
            mFlinger.setNotifyExpectedPresentData(mPhysicalDisplayId,
                                                  TimePoint::fromNs(expectedPresentTime),
                                                  kFps60Hz));
    EXPECT_CALL(*mComposer, notifyExpectedPresent(kHwcDisplayId, _, _)).Times(0);
    for (int i = 0; i < 5; i++) {
        expectedPresentTime += 2 * kFrameInterval5HzNs;
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 /*timeoutOpt*/ std::nullopt);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
    }
}

TEST_F(NotifyExpectedPresentTest, notifyExpectedPresentHint_zeroTimeout) {
    auto expectedPresentTime = TimePoint::now().ns() + ms2ns(10);
    {
        // Very first ExpectedPresent after idle, no previous timestamp.
        EXPECT_CALL(*mComposer,
                    notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, kFrameInterval60HzNs))
                .WillOnce(Return(Error::NONE));
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));

        // Present frame
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        // Present happens and NotifyExpectedPresentHintStatus is start.
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
    }
    {
        mCompositor->committed = false;
        expectedPresentTime += kFrameInterval60HzNs;
        EXPECT_CALL(static_cast<mock::VSyncTracker&>(
                            mFlinger.scheduler()->getVsyncSchedule()->getTracker()),
                    nextAnticipatedVSyncTimeFrom(_, _))
                .WillRepeatedly(Return(expectedPresentTime));
        EXPECT_CALL(*mComposer,
                    notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, kFrameInterval60HzNs))
                .WillOnce(Return(Error::NONE));
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 Period::fromNs(0));
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        // Hint sent
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
    }
    {
        expectedPresentTime += kFrameInterval60HzNs;
        EXPECT_CALL(static_cast<mock::VSyncTracker&>(
                            mFlinger.scheduler()->getVsyncSchedule()->getTracker()),
                    nextAnticipatedVSyncTimeFrom(_, _))
                .WillRepeatedly(Return(expectedPresentTime));
        EXPECT_CALL(*mComposer,
                    notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, kFrameInterval60HzNs))
                .WillOnce(Return(Error::NONE));
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 Period::fromNs(0));
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        // Hint is executed
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
    }
}
TEST_F(NotifyExpectedPresentTest, notifyExpectedPresentTimeout) {
    auto expectedPresentTime = TimePoint::now().ns() + ms2ns(10);
    {
        // Very first ExpectedPresent after idle, no previous timestamp
        mCompositor->committed = false;
        EXPECT_CALL(*mComposer,
                    notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, kFrameInterval60HzNs))
                .WillOnce(Return(Error::NONE));
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
    }
    {
        EXPECT_CALL(*mComposer, notifyExpectedPresent(kHwcDisplayId, _, _)).Times(0);
        expectedPresentTime += 2 * kFrameInterval5HzNs;
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintStatusIsScheduledOnTx(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintStatusIsScheduledOnTx(mPhysicalDisplayId));
        {
            EXPECT_CALL(*mComposer,
                        notifyExpectedPresent(kHwcDisplayId, expectedPresentTime,
                                              kFrameInterval60HzNs))
                    .WillOnce(Return(Error::NONE));
            // Hint sent with the setTransactionState
            setTransactionState();
            ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
        }
    }
    {
        // ExpectedPresentTime is after the timeoutNs
        mCompositor->committed = true;
        expectedPresentTime += 2 * kFrameInterval5HzNs;
        EXPECT_CALL(*mComposer, notifyExpectedPresent(kHwcDisplayId, _, _)).Times(0);
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintStatusIsScheduledOnTx(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        // Present happens notifyExpectedPresentHintStatus is Start
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));

        // Another expectedPresent after timeout
        expectedPresentTime += 2 * kFrameInterval5HzNs;
        EXPECT_CALL(*mComposer,
                    notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, kFrameInterval60HzNs))
                .WillOnce(Return(Error::NONE));
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
    }
    {
        // ExpectedPresent has not changed
        EXPECT_CALL(*mComposer, notifyExpectedPresent(kHwcDisplayId, _, _)).Times(0);
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
    }
    {
        // ExpectedPresent is after the last reported ExpectedPresent and within timeout.
        expectedPresentTime += kFrameInterval60HzNs;
        EXPECT_CALL(*mComposer, notifyExpectedPresent(kHwcDisplayId, _, _)).Times(0);
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintStatusIsStart(mPhysicalDisplayId));
    }
    {
        // ExpectedPresent is before the last reported ExpectedPresent but after the timeoutNs,
        // representing we changed our decision and want to present earlier than previously
        // reported.
        mCompositor->committed = false;
        expectedPresentTime -= kFrameInterval120HzNs;
        EXPECT_CALL(*mComposer,
                    notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, kFrameInterval60HzNs))
                .WillOnce(Return(Error::NONE));
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime), kFps60Hz,
                                                 kTimeoutNs);
        EXPECT_TRUE(
                mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime));
        ASSERT_TRUE(mFlinger.verifyHintIsScheduledOnPresent(mPhysicalDisplayId));
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        ASSERT_TRUE(mFlinger.verifyHintIsSent(mPhysicalDisplayId));
    }
}

TEST_F(NotifyExpectedPresentTest, notifyExpectedPresentRenderRateChanged) {
    const auto now = TimePoint::now().ns();
    auto expectedPresentTime = now;
    static constexpr Period kTimeoutNs = Period::fromNs(static_cast<Fps>(1_Hz).getPeriodNsecs());

    ASSERT_NO_FATAL_FAILURE(mFlinger.setNotifyExpectedPresentData(mPhysicalDisplayId,
                                                                  TimePoint::fromNs(now),
                                                                  Fps::fromValue(0)));
    static constexpr int32_t kFrameIntervalNs120Hz = static_cast<Fps>(120_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs96Hz = static_cast<Fps>(96_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs80Hz = static_cast<Fps>(80_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs60Hz = static_cast<Fps>(60_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs40Hz = static_cast<Fps>(40_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs30Hz = static_cast<Fps>(30_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs24Hz = static_cast<Fps>(24_Hz).getPeriodNsecs();
    static constexpr int32_t kFrameIntervalNs20Hz = static_cast<Fps>(20_Hz).getPeriodNsecs();
    static constexpr Period kVsyncPeriod =
            Period::fromNs(static_cast<Fps>(240_Hz).getPeriodNsecs());

    struct FrameRateIntervalTestData {
        int32_t frameIntervalNs;
        bool callNotifyExpectedPresentHint;
    };
    const std::vector<FrameRateIntervalTestData> frameIntervals = {
            {kFrameIntervalNs60Hz, true},  {kFrameIntervalNs96Hz, true},
            {kFrameIntervalNs80Hz, true},  {kFrameIntervalNs120Hz, true},
            {kFrameIntervalNs80Hz, true},  {kFrameIntervalNs60Hz, true},
            {kFrameIntervalNs60Hz, false}, {kFrameIntervalNs30Hz, false},
            {kFrameIntervalNs24Hz, true},  {kFrameIntervalNs40Hz, true},
            {kFrameIntervalNs20Hz, false}, {kFrameIntervalNs60Hz, true},
            {kFrameIntervalNs20Hz, false}, {kFrameIntervalNs120Hz, true},
    };

    for (size_t i = 0; i < frameIntervals.size(); i++) {
        const auto& [frameIntervalNs, callNotifyExpectedPresentHint] = frameIntervals[i];
        expectedPresentTime += frameIntervalNs;
        mFlinger.notifyExpectedPresentIfRequired(mPhysicalDisplayId, kVsyncPeriod,
                                                 TimePoint::fromNs(expectedPresentTime),
                                                 Fps::fromPeriodNsecs(frameIntervalNs), kTimeoutNs);

        EXPECT_CALL(static_cast<mock::VSyncTracker&>(
                            mFlinger.scheduler()->getVsyncSchedule()->getTracker()),
                    nextAnticipatedVSyncTimeFrom(_, _))
                .WillRepeatedly(Return(expectedPresentTime));
        if (callNotifyExpectedPresentHint) {
            mCompositor->committed = false;
            ASSERT_TRUE(mFlinger.verifyHintIsScheduledOnPresent(mPhysicalDisplayId))
                    << "Hint not scheduled for frameInterval " << frameIntervalNs << " at index "
                    << i;
            EXPECT_CALL(*mComposer,
                        notifyExpectedPresent(kHwcDisplayId, expectedPresentTime, frameIntervalNs))
                    .WillOnce(Return(Error::NONE));
        } else {
            // Only lastExpectedPresentTime is updated
            EXPECT_TRUE(
                    mFlinger.verifyLastExpectedPresentTime(mPhysicalDisplayId, expectedPresentTime))
                    << "LastExpectedPresentTime for frameInterval " << frameIntervalNs
                    << "at index " << i << " did not match for frameInterval " << frameIntervalNs;
            EXPECT_CALL(*mComposer, notifyExpectedPresent(kHwcDisplayId, _, _)).Times(0);
        }
        mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});

        if (callNotifyExpectedPresentHint) {
            // Present resumes the calls to the notifyExpectedPresentHint.
            mCompositor->committed = true;
            mFlinger.scheduler()->doFrameSignal(*mCompositor, VsyncId{42});
        }
    }
}
} // namespace android