|  | /* | 
|  | * Copyright (C) 2018 The Android Open Source Project | 
|  | * | 
|  | * Licensed under the Apache License, Version 2.0 (the "License"); | 
|  | * you may not use this file except in compliance with the License. | 
|  | * You may obtain a copy of the License at | 
|  | * | 
|  | *      http://www.apache.org/licenses/LICENSE-2.0 | 
|  | * | 
|  | * Unless required by applicable law or agreed to in writing, software | 
|  | * distributed under the License is distributed on an "AS IS" BASIS, | 
|  | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 
|  | * See the License for the specific language governing permissions and | 
|  | * limitations under the License. | 
|  | */ | 
|  |  | 
|  | #undef LOG_TAG | 
|  | #define LOG_TAG "LibSurfaceFlingerUnittests" | 
|  |  | 
|  | #include <gmock/gmock.h> | 
|  | #include <gtest/gtest.h> | 
|  |  | 
|  | #include <log/log.h> | 
|  |  | 
|  | #include <utils/Errors.h> | 
|  |  | 
|  | #include "AsyncCallRecorder.h" | 
|  | #include "Scheduler/EventThread.h" | 
|  |  | 
|  | using namespace std::chrono_literals; | 
|  | using namespace std::placeholders; | 
|  |  | 
|  | using testing::_; | 
|  | using testing::Invoke; | 
|  |  | 
|  | namespace android { | 
|  | namespace { | 
|  |  | 
|  | class MockVSyncSource : public VSyncSource { | 
|  | public: | 
|  | MOCK_METHOD1(setVSyncEnabled, void(bool)); | 
|  | MOCK_METHOD1(setCallback, void(VSyncSource::Callback*)); | 
|  | MOCK_METHOD1(setPhaseOffset, void(nsecs_t)); | 
|  | }; | 
|  |  | 
|  | } // namespace | 
|  |  | 
|  | class EventThreadTest : public testing::Test { | 
|  | protected: | 
|  | class MockEventThreadConnection : public EventThreadConnection { | 
|  | public: | 
|  | MockEventThreadConnection(android::impl::EventThread* eventThread, | 
|  | ResyncCallback&& resyncCallback) | 
|  | : EventThreadConnection(eventThread, std::move(resyncCallback)) {} | 
|  | MOCK_METHOD1(postEvent, status_t(const DisplayEventReceiver::Event& event)); | 
|  | }; | 
|  |  | 
|  | using ConnectionEventRecorder = | 
|  | AsyncCallRecorderWithCannedReturn<status_t (*)(const DisplayEventReceiver::Event&)>; | 
|  |  | 
|  | EventThreadTest(); | 
|  | ~EventThreadTest() override; | 
|  |  | 
|  | void createThread(); | 
|  | sp<MockEventThreadConnection> createConnection(ConnectionEventRecorder& recorder); | 
|  |  | 
|  | void expectVSyncSetEnabledCallReceived(bool expectedState); | 
|  | void expectVSyncSetPhaseOffsetCallReceived(nsecs_t expectedPhaseOffset); | 
|  | VSyncSource::Callback* expectVSyncSetCallbackCallReceived(); | 
|  | void expectInterceptCallReceived(nsecs_t expectedTimestamp); | 
|  | void expectVsyncEventReceivedByConnection(const char* name, | 
|  | ConnectionEventRecorder& connectionEventRecorder, | 
|  | nsecs_t expectedTimestamp, unsigned expectedCount); | 
|  | void expectVsyncEventReceivedByConnection(nsecs_t expectedTimestamp, unsigned expectedCount); | 
|  | void expectHotplugEventReceivedByConnection(EventThread::DisplayType expectedDisplayType, | 
|  | bool expectedConnected); | 
|  |  | 
|  | AsyncCallRecorder<void (*)(bool)> mVSyncSetEnabledCallRecorder; | 
|  | AsyncCallRecorder<void (*)(VSyncSource::Callback*)> mVSyncSetCallbackCallRecorder; | 
|  | AsyncCallRecorder<void (*)(nsecs_t)> mVSyncSetPhaseOffsetCallRecorder; | 
|  | AsyncCallRecorder<void (*)()> mResyncCallRecorder; | 
|  | AsyncCallRecorder<void (*)(nsecs_t)> mInterceptVSyncCallRecorder; | 
|  | ConnectionEventRecorder mConnectionEventCallRecorder{0}; | 
|  |  | 
|  | MockVSyncSource mVSyncSource; | 
|  | std::unique_ptr<android::impl::EventThread> mThread; | 
|  | sp<MockEventThreadConnection> mConnection; | 
|  | }; | 
|  |  | 
|  | EventThreadTest::EventThreadTest() { | 
|  | const ::testing::TestInfo* const test_info = | 
|  | ::testing::UnitTest::GetInstance()->current_test_info(); | 
|  | ALOGD("**** Setting up for %s.%s\n", test_info->test_case_name(), test_info->name()); | 
|  |  | 
|  | EXPECT_CALL(mVSyncSource, setVSyncEnabled(_)) | 
|  | .WillRepeatedly(Invoke(mVSyncSetEnabledCallRecorder.getInvocable())); | 
|  |  | 
|  | EXPECT_CALL(mVSyncSource, setCallback(_)) | 
|  | .WillRepeatedly(Invoke(mVSyncSetCallbackCallRecorder.getInvocable())); | 
|  |  | 
|  | EXPECT_CALL(mVSyncSource, setPhaseOffset(_)) | 
|  | .WillRepeatedly(Invoke(mVSyncSetPhaseOffsetCallRecorder.getInvocable())); | 
|  |  | 
|  | createThread(); | 
|  | mConnection = createConnection(mConnectionEventCallRecorder); | 
|  | } | 
|  |  | 
|  | EventThreadTest::~EventThreadTest() { | 
|  | const ::testing::TestInfo* const test_info = | 
|  | ::testing::UnitTest::GetInstance()->current_test_info(); | 
|  | ALOGD("**** Tearing down after %s.%s\n", test_info->test_case_name(), test_info->name()); | 
|  | } | 
|  |  | 
|  | void EventThreadTest::createThread() { | 
|  | mThread = | 
|  | std::make_unique<android::impl::EventThread>(&mVSyncSource, | 
|  | mInterceptVSyncCallRecorder.getInvocable(), | 
|  | "unit-test-event-thread"); | 
|  | } | 
|  |  | 
|  | sp<EventThreadTest::MockEventThreadConnection> EventThreadTest::createConnection( | 
|  | ConnectionEventRecorder& recorder) { | 
|  | sp<MockEventThreadConnection> connection = | 
|  | new MockEventThreadConnection(mThread.get(), mResyncCallRecorder.getInvocable()); | 
|  | EXPECT_CALL(*connection, postEvent(_)).WillRepeatedly(Invoke(recorder.getInvocable())); | 
|  | return connection; | 
|  | } | 
|  |  | 
|  | void EventThreadTest::expectVSyncSetEnabledCallReceived(bool expectedState) { | 
|  | auto args = mVSyncSetEnabledCallRecorder.waitForCall(); | 
|  | ASSERT_TRUE(args.has_value()); | 
|  | EXPECT_EQ(expectedState, std::get<0>(args.value())); | 
|  | } | 
|  |  | 
|  | void EventThreadTest::expectVSyncSetPhaseOffsetCallReceived(nsecs_t expectedPhaseOffset) { | 
|  | auto args = mVSyncSetPhaseOffsetCallRecorder.waitForCall(); | 
|  | ASSERT_TRUE(args.has_value()); | 
|  | EXPECT_EQ(expectedPhaseOffset, std::get<0>(args.value())); | 
|  | } | 
|  |  | 
|  | VSyncSource::Callback* EventThreadTest::expectVSyncSetCallbackCallReceived() { | 
|  | auto callbackSet = mVSyncSetCallbackCallRecorder.waitForCall(); | 
|  | return callbackSet.has_value() ? std::get<0>(callbackSet.value()) : nullptr; | 
|  | } | 
|  |  | 
|  | void EventThreadTest::expectInterceptCallReceived(nsecs_t expectedTimestamp) { | 
|  | auto args = mInterceptVSyncCallRecorder.waitForCall(); | 
|  | ASSERT_TRUE(args.has_value()); | 
|  | EXPECT_EQ(expectedTimestamp, std::get<0>(args.value())); | 
|  | } | 
|  |  | 
|  | void EventThreadTest::expectVsyncEventReceivedByConnection( | 
|  | const char* name, ConnectionEventRecorder& connectionEventRecorder, | 
|  | nsecs_t expectedTimestamp, unsigned expectedCount) { | 
|  | auto args = connectionEventRecorder.waitForCall(); | 
|  | ASSERT_TRUE(args.has_value()) << name << " did not receive an event for timestamp " | 
|  | << expectedTimestamp; | 
|  | const auto& event = std::get<0>(args.value()); | 
|  | EXPECT_EQ(DisplayEventReceiver::DISPLAY_EVENT_VSYNC, event.header.type) | 
|  | << name << " did not get the correct event for timestamp " << expectedTimestamp; | 
|  | EXPECT_EQ(expectedTimestamp, event.header.timestamp) | 
|  | << name << " did not get the expected timestamp for timestamp " << expectedTimestamp; | 
|  | EXPECT_EQ(expectedCount, event.vsync.count) | 
|  | << name << " did not get the expected count for timestamp " << expectedTimestamp; | 
|  | } | 
|  |  | 
|  | void EventThreadTest::expectVsyncEventReceivedByConnection(nsecs_t expectedTimestamp, | 
|  | unsigned expectedCount) { | 
|  | expectVsyncEventReceivedByConnection("mConnectionEventCallRecorder", | 
|  | mConnectionEventCallRecorder, expectedTimestamp, | 
|  | expectedCount); | 
|  | } | 
|  |  | 
|  | void EventThreadTest::expectHotplugEventReceivedByConnection( | 
|  | EventThread::DisplayType expectedDisplayType, bool expectedConnected) { | 
|  | const uint32_t expectedDisplayId = | 
|  | expectedDisplayType == EventThread::DisplayType::Primary ? 0 : 1; | 
|  |  | 
|  | auto args = mConnectionEventCallRecorder.waitForCall(); | 
|  | ASSERT_TRUE(args.has_value()); | 
|  | const auto& event = std::get<0>(args.value()); | 
|  | EXPECT_EQ(DisplayEventReceiver::DISPLAY_EVENT_HOTPLUG, event.header.type); | 
|  | EXPECT_EQ(expectedDisplayId, event.header.id); | 
|  | EXPECT_EQ(expectedConnected, event.hotplug.connected); | 
|  | } | 
|  |  | 
|  | namespace { | 
|  |  | 
|  | /* ------------------------------------------------------------------------ | 
|  | * Test cases | 
|  | */ | 
|  |  | 
|  | TEST_F(EventThreadTest, canCreateAndDestroyThreadWithNoEventsSent) { | 
|  | EXPECT_FALSE(mVSyncSetEnabledCallRecorder.waitForUnexpectedCall().has_value()); | 
|  | EXPECT_FALSE(mVSyncSetCallbackCallRecorder.waitForCall(0us).has_value()); | 
|  | EXPECT_FALSE(mVSyncSetPhaseOffsetCallRecorder.waitForCall(0us).has_value()); | 
|  | EXPECT_FALSE(mResyncCallRecorder.waitForCall(0us).has_value()); | 
|  | EXPECT_FALSE(mInterceptVSyncCallRecorder.waitForCall(0us).has_value()); | 
|  | EXPECT_FALSE(mConnectionEventCallRecorder.waitForCall(0us).has_value()); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, requestNextVsyncPostsASingleVSyncEventToTheConnection) { | 
|  | // Signal that we want the next vsync event to be posted to the connection | 
|  | mThread->requestNextVsync(mConnection, false); | 
|  |  | 
|  | // EventThread should immediately request a resync. | 
|  | EXPECT_TRUE(mResyncCallRecorder.waitForCall().has_value()); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // Use the received callback to signal a first vsync event. | 
|  | // The interceptor should receive the event, as well as the connection. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | expectVsyncEventReceivedByConnection(123, 1u); | 
|  |  | 
|  | // Use the received callback to signal a second vsync event. | 
|  | // The interceptor should receive the event, but the the connection should | 
|  | // not as it was only interested in the first. | 
|  | callback->onVSyncEvent(456); | 
|  | expectInterceptCallReceived(456); | 
|  | EXPECT_FALSE(mConnectionEventCallRecorder.waitForUnexpectedCall().has_value()); | 
|  |  | 
|  | // EventThread should also detect that at this point that it does not need | 
|  | // any more vsync events, and should disable their generation. | 
|  | expectVSyncSetEnabledCallReceived(false); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, setVsyncRateZeroPostsNoVSyncEventsToThatConnection) { | 
|  | // Create a first connection, register it, and request a vsync rate of zero. | 
|  | ConnectionEventRecorder firstConnectionEventRecorder{0}; | 
|  | sp<MockEventThreadConnection> firstConnection = createConnection(firstConnectionEventRecorder); | 
|  | mThread->setVsyncRate(0, firstConnection); | 
|  |  | 
|  | // By itself, this should not enable vsync events | 
|  | EXPECT_FALSE(mVSyncSetEnabledCallRecorder.waitForUnexpectedCall().has_value()); | 
|  | EXPECT_FALSE(mVSyncSetCallbackCallRecorder.waitForCall(0us).has_value()); | 
|  |  | 
|  | // However if there is another connection which wants events at a nonzero rate..... | 
|  | ConnectionEventRecorder secondConnectionEventRecorder{0}; | 
|  | sp<MockEventThreadConnection> secondConnection = | 
|  | createConnection(secondConnectionEventRecorder); | 
|  | mThread->setVsyncRate(1, secondConnection); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // Send a vsync event. EventThread should then make a call to the | 
|  | // interceptor, and the second connection. The first connection should not | 
|  | // get the event. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | EXPECT_FALSE(firstConnectionEventRecorder.waitForUnexpectedCall().has_value()); | 
|  | expectVsyncEventReceivedByConnection("secondConnection", secondConnectionEventRecorder, 123, | 
|  | 1u); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, setVsyncRateOnePostsAllEventsToThatConnection) { | 
|  | mThread->setVsyncRate(1, mConnection); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // Send a vsync event. EventThread should then make a call to the | 
|  | // interceptor, and the connection. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | expectVsyncEventReceivedByConnection(123, 1u); | 
|  |  | 
|  | // A second event should go to the same places. | 
|  | callback->onVSyncEvent(456); | 
|  | expectInterceptCallReceived(456); | 
|  | expectVsyncEventReceivedByConnection(456, 2u); | 
|  |  | 
|  | // A third event should go to the same places. | 
|  | callback->onVSyncEvent(789); | 
|  | expectInterceptCallReceived(789); | 
|  | expectVsyncEventReceivedByConnection(789, 3u); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, setVsyncRateTwoPostsEveryOtherEventToThatConnection) { | 
|  | mThread->setVsyncRate(2, mConnection); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // The first event will be seen by the interceptor, and not the connection. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | EXPECT_FALSE(mConnectionEventCallRecorder.waitForUnexpectedCall().has_value()); | 
|  |  | 
|  | // The second event will be seen by the interceptor and the connection. | 
|  | callback->onVSyncEvent(456); | 
|  | expectInterceptCallReceived(456); | 
|  | expectVsyncEventReceivedByConnection(456, 2u); | 
|  |  | 
|  | // The third event will be seen by the interceptor, and not the connection. | 
|  | callback->onVSyncEvent(789); | 
|  | expectInterceptCallReceived(789); | 
|  | EXPECT_FALSE(mConnectionEventCallRecorder.waitForUnexpectedCall().has_value()); | 
|  |  | 
|  | // The fourth event will be seen by the interceptor and the connection. | 
|  | callback->onVSyncEvent(101112); | 
|  | expectInterceptCallReceived(101112); | 
|  | expectVsyncEventReceivedByConnection(101112, 4u); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, connectionsRemovedIfInstanceDestroyed) { | 
|  | mThread->setVsyncRate(1, mConnection); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // Destroy the only (strong) reference to the connection. | 
|  | mConnection = nullptr; | 
|  |  | 
|  | // The first event will be seen by the interceptor, and not the connection. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | EXPECT_FALSE(mConnectionEventCallRecorder.waitForUnexpectedCall().has_value()); | 
|  |  | 
|  | // EventThread should disable vsync callbacks | 
|  | expectVSyncSetEnabledCallReceived(false); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, connectionsRemovedIfEventDeliveryError) { | 
|  | ConnectionEventRecorder errorConnectionEventRecorder{NO_MEMORY}; | 
|  | sp<MockEventThreadConnection> errorConnection = createConnection(errorConnectionEventRecorder); | 
|  | mThread->setVsyncRate(1, errorConnection); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // The first event will be seen by the interceptor, and by the connection, | 
|  | // which then returns an error. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | expectVsyncEventReceivedByConnection("errorConnection", errorConnectionEventRecorder, 123, 1u); | 
|  |  | 
|  | // A subsequent event will be seen by the interceptor and not by the | 
|  | // connection. | 
|  | callback->onVSyncEvent(456); | 
|  | expectInterceptCallReceived(456); | 
|  | EXPECT_FALSE(errorConnectionEventRecorder.waitForUnexpectedCall().has_value()); | 
|  |  | 
|  | // EventThread should disable vsync callbacks with the second event | 
|  | expectVSyncSetEnabledCallReceived(false); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, eventsDroppedIfNonfatalEventDeliveryError) { | 
|  | ConnectionEventRecorder errorConnectionEventRecorder{WOULD_BLOCK}; | 
|  | sp<MockEventThreadConnection> errorConnection = createConnection(errorConnectionEventRecorder); | 
|  | mThread->setVsyncRate(1, errorConnection); | 
|  |  | 
|  | // EventThread should enable vsync callbacks, and set a callback interface | 
|  | // pointer to use them with the VSync source. | 
|  | expectVSyncSetEnabledCallReceived(true); | 
|  | auto callback = expectVSyncSetCallbackCallReceived(); | 
|  | ASSERT_TRUE(callback); | 
|  |  | 
|  | // The first event will be seen by the interceptor, and by the connection, | 
|  | // which then returns an non-fatal error. | 
|  | callback->onVSyncEvent(123); | 
|  | expectInterceptCallReceived(123); | 
|  | expectVsyncEventReceivedByConnection("errorConnection", errorConnectionEventRecorder, 123, 1u); | 
|  |  | 
|  | // A subsequent event will be seen by the interceptor, and by the connection, | 
|  | // which still then returns an non-fatal error. | 
|  | callback->onVSyncEvent(456); | 
|  | expectInterceptCallReceived(456); | 
|  | expectVsyncEventReceivedByConnection("errorConnection", errorConnectionEventRecorder, 456, 2u); | 
|  |  | 
|  | // EventThread will not disable vsync callbacks as the errors are non-fatal. | 
|  | EXPECT_FALSE(mVSyncSetEnabledCallRecorder.waitForUnexpectedCall().has_value()); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, setPhaseOffsetForwardsToVSyncSource) { | 
|  | mThread->setPhaseOffset(321); | 
|  | expectVSyncSetPhaseOffsetCallReceived(321); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, postHotplugPrimaryDisconnect) { | 
|  | mThread->onHotplugReceived(EventThread::DisplayType::Primary, false); | 
|  | expectHotplugEventReceivedByConnection(EventThread::DisplayType::Primary, false); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, postHotplugPrimaryConnect) { | 
|  | mThread->onHotplugReceived(EventThread::DisplayType::Primary, true); | 
|  | expectHotplugEventReceivedByConnection(EventThread::DisplayType::Primary, true); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, postHotplugExternalDisconnect) { | 
|  | mThread->onHotplugReceived(EventThread::DisplayType::External, false); | 
|  | expectHotplugEventReceivedByConnection(EventThread::DisplayType::External, false); | 
|  | } | 
|  |  | 
|  | TEST_F(EventThreadTest, postHotplugExternalConnect) { | 
|  | mThread->onHotplugReceived(EventThread::DisplayType::External, true); | 
|  | expectHotplugEventReceivedByConnection(EventThread::DisplayType::External, true); | 
|  | } | 
|  |  | 
|  | } // namespace | 
|  | } // namespace android |