blob: 406d2bc550a14561904a6d7ea11858a01866acd9 [file] [log] [blame]
/*
* Copyright 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <log/log.h>
#include <mutex>
#include "FakeDisplayInjector.h"
#include "Scheduler/EventThread.h"
#include "Scheduler/RefreshRateConfigs.h"
#include "TestableScheduler.h"
#include "TestableSurfaceFlinger.h"
#include "mock/DisplayHardware/MockDisplayMode.h"
#include "mock/MockEventThread.h"
#include "mock/MockLayer.h"
#include "mock/MockSchedulerCallback.h"
namespace android::scheduler {
using android::mock::createDisplayMode;
using testing::_;
using testing::Return;
namespace {
using MockEventThread = android::mock::EventThread;
using MockLayer = android::mock::MockLayer;
using FakeDisplayDeviceInjector = TestableSurfaceFlinger::FakeDisplayDeviceInjector;
constexpr PhysicalDisplayId PHYSICAL_DISPLAY_ID = PhysicalDisplayId::fromPort(255u);
class SchedulerTest : public testing::Test {
protected:
class MockEventThreadConnection : public android::EventThreadConnection {
public:
explicit MockEventThreadConnection(EventThread* eventThread)
: EventThreadConnection(eventThread, /*callingUid*/ static_cast<uid_t>(0),
ResyncCallback()) {}
~MockEventThreadConnection() = default;
MOCK_METHOD1(stealReceiveChannel, binder::Status(gui::BitTube* outChannel));
MOCK_METHOD1(setVsyncRate, binder::Status(int count));
MOCK_METHOD0(requestNextVsync, binder::Status());
};
SchedulerTest();
static inline const DisplayModePtr kMode60_1 = createDisplayMode(DisplayModeId(0), 60_Hz);
static inline const DisplayModePtr kMode120_1 = createDisplayMode(DisplayModeId(1), 120_Hz);
static inline const DisplayModePtr kMode60_2 = createDisplayMode(DisplayModeId(2), 60_Hz);
static inline const DisplayModePtr kMode120_2 = createDisplayMode(DisplayModeId(3), 120_Hz);
static inline const DisplayModePtr kMode60_3 = createDisplayMode(DisplayModeId(4), 60_Hz);
std::shared_ptr<RefreshRateConfigs> mConfigs =
std::make_shared<RefreshRateConfigs>(makeModes(kMode60_1), kMode60_1->getId());
mock::SchedulerCallback mSchedulerCallback;
TestableScheduler* mScheduler = new TestableScheduler{mConfigs, mSchedulerCallback};
ConnectionHandle mConnectionHandle;
MockEventThread* mEventThread;
sp<MockEventThreadConnection> mEventThreadConnection;
FakeDisplayInjector mFakeDisplayInjector;
TestableSurfaceFlinger mFlinger;
};
SchedulerTest::SchedulerTest() {
auto eventThread = std::make_unique<MockEventThread>();
mEventThread = eventThread.get();
EXPECT_CALL(*mEventThread, registerDisplayEventConnection(_)).WillOnce(Return(0));
mEventThreadConnection = sp<MockEventThreadConnection>::make(mEventThread);
// createConnection call to scheduler makes a createEventConnection call to EventThread. Make
// sure that call gets executed and returns an EventThread::Connection object.
EXPECT_CALL(*mEventThread, createEventConnection(_, _))
.WillRepeatedly(Return(mEventThreadConnection));
mConnectionHandle = mScheduler->createConnection(std::move(eventThread));
EXPECT_TRUE(mConnectionHandle);
mFlinger.resetScheduler(mScheduler);
}
} // namespace
TEST_F(SchedulerTest, invalidConnectionHandle) {
ConnectionHandle handle;
const sp<IDisplayEventConnection> connection = mScheduler->createDisplayEventConnection(handle);
EXPECT_FALSE(connection);
EXPECT_FALSE(mScheduler->getEventConnection(handle));
// The EXPECT_CALLS make sure we don't call the functions on the subsequent event threads.
EXPECT_CALL(*mEventThread, onHotplugReceived(_, _)).Times(0);
mScheduler->onHotplugReceived(handle, PHYSICAL_DISPLAY_ID, false);
EXPECT_CALL(*mEventThread, onScreenAcquired()).Times(0);
mScheduler->onScreenAcquired(handle);
EXPECT_CALL(*mEventThread, onScreenReleased()).Times(0);
mScheduler->onScreenReleased(handle);
std::string output;
EXPECT_CALL(*mEventThread, dump(_)).Times(0);
mScheduler->dump(handle, output);
EXPECT_TRUE(output.empty());
EXPECT_CALL(*mEventThread, setDuration(10ns, 20ns)).Times(0);
mScheduler->setDuration(handle, 10ns, 20ns);
}
TEST_F(SchedulerTest, validConnectionHandle) {
const sp<IDisplayEventConnection> connection =
mScheduler->createDisplayEventConnection(mConnectionHandle);
ASSERT_EQ(mEventThreadConnection, connection);
EXPECT_TRUE(mScheduler->getEventConnection(mConnectionHandle));
EXPECT_CALL(*mEventThread, onHotplugReceived(PHYSICAL_DISPLAY_ID, false)).Times(1);
mScheduler->onHotplugReceived(mConnectionHandle, PHYSICAL_DISPLAY_ID, false);
EXPECT_CALL(*mEventThread, onScreenAcquired()).Times(1);
mScheduler->onScreenAcquired(mConnectionHandle);
EXPECT_CALL(*mEventThread, onScreenReleased()).Times(1);
mScheduler->onScreenReleased(mConnectionHandle);
std::string output("dump");
EXPECT_CALL(*mEventThread, dump(output)).Times(1);
mScheduler->dump(mConnectionHandle, output);
EXPECT_FALSE(output.empty());
EXPECT_CALL(*mEventThread, setDuration(10ns, 20ns)).Times(1);
mScheduler->setDuration(mConnectionHandle, 10ns, 20ns);
static constexpr size_t kEventConnections = 5;
EXPECT_CALL(*mEventThread, getEventThreadConnectionCount()).WillOnce(Return(kEventConnections));
EXPECT_EQ(kEventConnections, mScheduler->getEventThreadConnectionCount(mConnectionHandle));
}
TEST_F(SchedulerTest, chooseRefreshRateForContentIsNoopWhenModeSwitchingIsNotSupported) {
// The layer is registered at creation time and deregistered at destruction time.
sp<MockLayer> layer = sp<MockLayer>::make(mFlinger.flinger());
// recordLayerHistory should be a noop
ASSERT_EQ(0u, mScheduler->getNumActiveLayers());
mScheduler->recordLayerHistory(layer.get(), 0, LayerHistory::LayerUpdateType::Buffer);
ASSERT_EQ(0u, mScheduler->getNumActiveLayers());
constexpr hal::PowerMode kPowerModeOn = hal::PowerMode::ON;
mScheduler->setDisplayPowerMode(kPowerModeOn);
constexpr uint32_t kDisplayArea = 999'999;
mScheduler->onActiveDisplayAreaChanged(kDisplayArea);
EXPECT_CALL(mSchedulerCallback, requestDisplayModes(_)).Times(0);
mScheduler->chooseRefreshRateForContent();
}
TEST_F(SchedulerTest, updateDisplayModes) {
ASSERT_EQ(0u, mScheduler->layerHistorySize());
sp<MockLayer> layer = sp<MockLayer>::make(mFlinger.flinger());
ASSERT_EQ(1u, mScheduler->layerHistorySize());
mScheduler->setRefreshRateConfigs(
std::make_shared<RefreshRateConfigs>(makeModes(kMode60_1, kMode120_1),
kMode60_1->getId()));
ASSERT_EQ(0u, mScheduler->getNumActiveLayers());
mScheduler->recordLayerHistory(layer.get(), 0, LayerHistory::LayerUpdateType::Buffer);
ASSERT_EQ(1u, mScheduler->getNumActiveLayers());
}
TEST_F(SchedulerTest, dispatchCachedReportedMode) {
mScheduler->clearCachedReportedMode();
EXPECT_CALL(*mEventThread, onModeChanged(_)).Times(0);
EXPECT_NO_FATAL_FAILURE(mScheduler->dispatchCachedReportedMode());
}
TEST_F(SchedulerTest, onNonPrimaryDisplayModeChanged_invalidParameters) {
const auto mode = DisplayMode::Builder(hal::HWConfigId(0))
.setId(DisplayModeId(111))
.setPhysicalDisplayId(PHYSICAL_DISPLAY_ID)
.setVsyncPeriod(111111)
.build();
// If the handle is incorrect, the function should return before
// onModeChange is called.
ConnectionHandle invalidHandle = {.id = 123};
EXPECT_NO_FATAL_FAILURE(mScheduler->onNonPrimaryDisplayModeChanged(invalidHandle, mode));
EXPECT_CALL(*mEventThread, onModeChanged(_)).Times(0);
}
TEST_F(SchedulerTest, calculateMaxAcquiredBufferCount) {
EXPECT_EQ(1, mFlinger.calculateMaxAcquiredBufferCount(60_Hz, 30ms));
EXPECT_EQ(2, mFlinger.calculateMaxAcquiredBufferCount(90_Hz, 30ms));
EXPECT_EQ(3, mFlinger.calculateMaxAcquiredBufferCount(120_Hz, 30ms));
EXPECT_EQ(2, mFlinger.calculateMaxAcquiredBufferCount(60_Hz, 40ms));
EXPECT_EQ(1, mFlinger.calculateMaxAcquiredBufferCount(60_Hz, 10ms));
}
MATCHER(Is120Hz, "") {
return isApproxEqual(arg.front().displayModePtr->getFps(), 120_Hz);
}
TEST_F(SchedulerTest, chooseRefreshRateForContentSelectsMaxRefreshRate) {
auto display = mFakeDisplayInjector.injectDefaultInternalDisplay(
[&](FakeDisplayDeviceInjector& injector) {
injector.setDisplayModes(makeModes(kMode60_1, kMode120_1), kMode60_1->getId());
},
mFlinger);
mScheduler->registerDisplay(display);
mScheduler->setRefreshRateConfigs(display->holdRefreshRateConfigs());
const sp<MockLayer> layer = sp<MockLayer>::make(mFlinger.flinger());
EXPECT_CALL(*layer, isVisible()).WillOnce(Return(true));
mScheduler->recordLayerHistory(layer.get(), 0, LayerHistory::LayerUpdateType::Buffer);
constexpr hal::PowerMode kPowerModeOn = hal::PowerMode::ON;
mScheduler->setDisplayPowerMode(kPowerModeOn);
constexpr uint32_t kDisplayArea = 999'999;
mScheduler->onActiveDisplayAreaChanged(kDisplayArea);
EXPECT_CALL(mSchedulerCallback, requestDisplayModes(Is120Hz())).Times(1);
mScheduler->chooseRefreshRateForContent();
// No-op if layer requirements have not changed.
EXPECT_CALL(mSchedulerCallback, requestDisplayModes(_)).Times(0);
mScheduler->chooseRefreshRateForContent();
}
TEST_F(SchedulerTest, getBestDisplayMode_singleDisplay) {
auto display = mFakeDisplayInjector.injectDefaultInternalDisplay(
[&](FakeDisplayDeviceInjector& injector) {
injector.setDisplayModes(makeModes(kMode60_1, kMode120_1), kMode60_1->getId());
},
mFlinger);
mScheduler->registerDisplay(display);
std::vector<RefreshRateConfigs::LayerRequirement> layers =
std::vector<RefreshRateConfigs::LayerRequirement>({{.weight = 1.f}, {.weight = 1.f}});
mScheduler->setContentRequirements(layers);
GlobalSignals globalSignals = {.idle = true};
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
std::vector<DisplayModeConfig> displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(1ul, displayModeConfigs.size());
EXPECT_EQ(displayModeConfigs.front().displayModePtr, kMode60_1);
EXPECT_EQ(displayModeConfigs.front().signals, globalSignals);
globalSignals = {.idle = false};
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(1ul, displayModeConfigs.size());
EXPECT_EQ(displayModeConfigs.front().displayModePtr, kMode120_1);
EXPECT_EQ(displayModeConfigs.front().signals, globalSignals);
globalSignals = {.touch = true};
mScheduler->replaceTouchTimer(10);
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(1ul, displayModeConfigs.size());
EXPECT_EQ(displayModeConfigs.front().displayModePtr, kMode120_1);
EXPECT_EQ(displayModeConfigs.front().signals, globalSignals);
mScheduler->unregisterDisplay(display->getPhysicalId());
EXPECT_TRUE(mScheduler->mutableDisplays().empty());
}
TEST_F(SchedulerTest, getBestDisplayModes_multipleDisplays) {
auto display1 = mFakeDisplayInjector.injectDefaultInternalDisplay(
[&](FakeDisplayDeviceInjector& injector) {
injector.setDisplayModes(makeModes(kMode60_1, kMode120_1), kMode60_1->getId());
},
mFlinger);
auto display2 = mFakeDisplayInjector.injectDefaultInternalDisplay(
[&](FakeDisplayDeviceInjector& injector) {
injector.setDisplayModes(makeModes(kMode60_2, kMode120_2), kMode60_2->getId());
},
mFlinger, /* port */ 253u);
mScheduler->registerDisplay(display1);
mScheduler->registerDisplay(display2);
std::vector<sp<DisplayDevice>> expectedDisplays = {display1, display2};
std::vector<RefreshRateConfigs::LayerRequirement> layers = {{.weight = 1.f}, {.weight = 1.f}};
GlobalSignals globalSignals = {.idle = true};
std::vector<DisplayModeConfig> expectedConfigs = {DisplayModeConfig{globalSignals, kMode60_1},
DisplayModeConfig{globalSignals, kMode60_2}};
mScheduler->setContentRequirements(layers);
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
std::vector<DisplayModeConfig> displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(displayModeConfigs.size(), expectedConfigs.size());
for (size_t i = 0; i < expectedConfigs.size(); ++i) {
EXPECT_EQ(expectedConfigs.at(i).displayModePtr, displayModeConfigs.at(i).displayModePtr)
<< "Expected fps " << expectedConfigs.at(i).displayModePtr->getFps().getIntValue()
<< " Actual fps "
<< displayModeConfigs.at(i).displayModePtr->getFps().getIntValue();
EXPECT_EQ(globalSignals, displayModeConfigs.at(i).signals);
}
expectedConfigs = std::vector<DisplayModeConfig>{DisplayModeConfig{globalSignals, kMode120_1},
DisplayModeConfig{globalSignals, kMode120_2}};
globalSignals = {.idle = false};
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(expectedConfigs.size(), displayModeConfigs.size());
for (size_t i = 0; i < expectedConfigs.size(); ++i) {
EXPECT_EQ(expectedConfigs.at(i).displayModePtr, displayModeConfigs.at(i).displayModePtr)
<< "Expected fps " << expectedConfigs.at(i).displayModePtr->getFps().getIntValue()
<< " Actual fps "
<< displayModeConfigs.at(i).displayModePtr->getFps().getIntValue();
EXPECT_EQ(globalSignals, displayModeConfigs.at(i).signals);
}
globalSignals = {.touch = true};
mScheduler->replaceTouchTimer(10);
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(expectedConfigs.size(), displayModeConfigs.size());
for (size_t i = 0; i < expectedConfigs.size(); ++i) {
EXPECT_EQ(expectedConfigs.at(i).displayModePtr, displayModeConfigs.at(i).displayModePtr)
<< "Expected fps " << expectedConfigs.at(i).displayModePtr->getFps().getIntValue()
<< " Actual fps "
<< displayModeConfigs.at(i).displayModePtr->getFps().getIntValue();
EXPECT_EQ(globalSignals, displayModeConfigs.at(i).signals);
}
// Filters out the 120Hz as it's not present on the display3, even with touch active
// we select 60Hz here.
auto display3 = mFakeDisplayInjector.injectDefaultInternalDisplay(
[&](FakeDisplayDeviceInjector& injector) {
injector.setDisplayModes(makeModes(kMode60_3), kMode60_3->getId());
},
mFlinger, /* port */ 252u);
mScheduler->registerDisplay(display3);
expectedDisplays = {display1, display2, display3};
globalSignals = {.touch = true};
mScheduler->replaceTouchTimer(10);
expectedConfigs = std::vector<DisplayModeConfig>{DisplayModeConfig{globalSignals, kMode60_1},
DisplayModeConfig{globalSignals, kMode60_2},
DisplayModeConfig{globalSignals, kMode60_3}};
mScheduler->setTouchStateAndIdleTimerPolicy(globalSignals);
displayModeConfigs = mScheduler->getBestDisplayModeConfigs();
ASSERT_EQ(expectedConfigs.size(), displayModeConfigs.size());
for (size_t i = 0; i < expectedConfigs.size(); ++i) {
EXPECT_EQ(expectedConfigs.at(i).displayModePtr, displayModeConfigs.at(i).displayModePtr)
<< "Expected fps " << expectedConfigs.at(i).displayModePtr->getFps().getIntValue()
<< " Actual fps "
<< displayModeConfigs.at(i).displayModePtr->getFps().getIntValue();
EXPECT_EQ(globalSignals, displayModeConfigs.at(i).signals);
}
}
} // namespace android::scheduler