Commit d4ba05a2 authored by Martin Flöser's avatar Martin Flöser

[autotests] Add tests for DRM platform plugin

Summary:
The addition of the test infrastructure is motivated by the regressions
caused by adding mode switching and transformation support.
A contributing factor to these regression is the fact that the DRM
platform does not have any tests. It is difficult to test this code as
it needs to work with hardware, thus we cannot use the real DRM library.
Instead we need to use mocking.

This change sets up some first basic tests with the help of a mockDrm
library. In order to better test the code as units the Drm classes are
slightly refactored. Most importantly the dependency to DrmBackend is
removed wherever possible and replaced by a simple int fd which is mostly
the only element used by the classes.

This first test introduces basic testing of a DrmObject. It is intended
to extend this to at least also test DrmPlane as a central piece of our
Drm platform plugin. This will also extend the tests of DrmObject.

Reviewers: #kwin, #plasma

Subscribers: plasma-devel

Tags: #plasma

Differential Revision: https://phabricator.kde.org/D8776
parent 01c1870e
......@@ -6,6 +6,9 @@ add_subdirectory(integration)
if (HAVE_INPUT)
add_subdirectory(libinput)
endif()
if (HAVE_DRM)
add_subdirectory(drm)
endif()
add_subdirectory(tabbox)
########################################################
......
include_directories(${Libdrm_INCLUDE_DIRS})
set(mockDRM_SRCS
mock_drm.cpp
../../plugins/platforms/drm/drm_buffer.cpp
../../plugins/platforms/drm/drm_object.cpp
../../plugins/platforms/drm/drm_object_connector.cpp
../../plugins/platforms/drm/drm_object_plane.cpp
../../plugins/platforms/drm/logging.cpp
)
add_library(mockDrm STATIC ${mockDRM_SRCS})
target_link_libraries(mockDrm Qt5::Gui)
ecm_mark_as_test(mockDrm)
function(drmTest)
set(oneValueArgs NAME)
set(multiValueArgs SRCS )
cmake_parse_arguments(ARGS "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
add_executable(${ARGS_NAME} ${ARGS_SRCS})
target_link_libraries(${ARGS_NAME} mockDrm Qt5::Test)
add_test(kwin-drm-${ARGS_NAME} ${ARGS_NAME})
ecm_mark_as_test(${ARGS_NAME})
endfunction()
drmTest(NAME objecttest SRCS objecttest.cpp)
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2017 Martin Flöser <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "mock_drm.h"
#include <QMap>
#include <QVector>
static QMap<int, QVector<_drmModeProperty>> s_drmProperties{};
namespace MockDrm
{
void addDrmModeProperties(int fd, const QVector<_drmModeProperty> &properties)
{
s_drmProperties.insert(fd, properties);
}
}
int drmModeAtomicAddProperty(drmModeAtomicReqPtr req, uint32_t object_id, uint32_t property_id, uint64_t value)
{
Q_UNUSED(req)
Q_UNUSED(object_id)
Q_UNUSED(property_id)
Q_UNUSED(value)
return 0;
}
drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId)
{
auto it = s_drmProperties.find(fd);
if (it == s_drmProperties.end()) {
return nullptr;
}
auto it2 = std::find_if(it->constBegin(), it->constEnd(),
[propertyId] (const auto &property) {
return property.prop_id == propertyId;
}
);
if (it2 == it->constEnd()) {
return nullptr;
}
auto *property = new _drmModeProperty;
property->prop_id = it2->prop_id;
property->flags = it2->flags;
strcpy(property->name, it2->name);
property->count_values = it2->count_values;
property->values = it2->values;
property->count_enums = it2->count_enums;
property->enums = it2->enums;
property->count_blobs = it2->count_blobs;
property->blob_ids = it2->blob_ids;
return property;
}
void drmModeFreeProperty(drmModePropertyPtr ptr)
{
delete ptr;
}
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2017 Martin Flöser <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#pragma once
#include <stddef.h>
#include <stdint.h>
#include <xf86drmMode.h>
#include <QVector>
namespace MockDrm
{
void addDrmModeProperties(int fd, const QVector<_drmModeProperty> &properties);
}
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2017 Martin Flöser <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "mock_drm.h"
#include "../../plugins/platforms/drm/drm_object.h"
#include <QtTest>
class MockDrmObject : public KWin::DrmObject
{
public:
MockDrmObject(uint32_t id, int fd)
: DrmObject(id, fd)
{
}
~MockDrmObject() override {}
bool atomicInit() override;
bool initProps() override;
void setProperties(uint32_t count, uint32_t *props, uint64_t *values) {
m_count = count;
m_props = props;
m_values = values;
}
QByteArray name(int prop) const {
auto property = DrmObject::m_props.at(prop);
if (!property) {
return QByteArray();
}
return property->name();
}
uint32_t propertyId(int prop) const {
auto property = DrmObject::m_props.at(prop);
if (!property) {
return 0xFFFFFFFFu;
}
return property->propId();
}
private:
uint32_t m_count = 0;
uint32_t *m_props = nullptr;
uint64_t *m_values = nullptr;
};
bool MockDrmObject::atomicInit()
{
return initProps();
}
bool MockDrmObject::initProps()
{
setPropertyNames({"foo", "bar", "baz"});
drmModeObjectProperties properties{m_count, m_props, m_values};
for (int i = 0; i < 3; i++) {
initProp(i, &properties);
}
return false;
}
class ObjectTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void testId_data();
void testId();
void testFd_data();
void testFd();
void testOutput();
void testInitProperties();
};
void ObjectTest::testId_data()
{
QTest::addColumn<quint32>("id");
QTest::newRow("0") << 0u;
QTest::newRow("1") << 1u;
QTest::newRow("10") << 10u;
QTest::newRow("uint max") << 0xFFFFFFFFu;
}
void ObjectTest::testId()
{
QFETCH(quint32, id);
MockDrmObject object{id, -1};
QCOMPARE(object.id(), id);
}
void ObjectTest::testFd_data()
{
QTest::addColumn<int>("fd");
QTest::newRow("-1") << -1;
QTest::newRow("0") << 0;
QTest::newRow("1") << 1;
QTest::newRow("2") << 2;
QTest::newRow("100") << 100;
QTest::newRow("int max") << 0x7FFFFFFF;
}
void ObjectTest::testFd()
{
QFETCH(int, fd);
MockDrmObject object{0, fd};
QCOMPARE(object.fd(), fd);
}
namespace KWin
{
struct DrmOutput {
int foo;
};
}
void ObjectTest::testOutput()
{
MockDrmObject object{0, 1};
QVERIFY(!object.output());
KWin::DrmOutput output{2};
object.setOutput(&output);
QCOMPARE(object.output(), &output);
QCOMPARE(object.output()->foo, 2);
}
void ObjectTest::testInitProperties()
{
MockDrmObject object{0, 20};
uint32_t propertiesIds[] = { 0, 1, 2, 3};
uint64_t values[] = { 0, 2, 10, 20 };
object.setProperties(4, propertiesIds, values);
MockDrm::addDrmModeProperties(20, QVector<_drmModeProperty>{
_drmModeProperty{
0,
0,
"foo\0",
0,
nullptr,
0,
nullptr,
0,
nullptr
},
_drmModeProperty{
1,
0,
"foobar\0",
0,
nullptr,
0,
nullptr,
0,
nullptr
},
_drmModeProperty{
2,
0,
"baz\0",
0,
nullptr,
0,
nullptr,
0,
nullptr
},
_drmModeProperty{
3,
0,
"foobarbaz\0",
0,
nullptr,
0,
nullptr,
0,
nullptr
}
});
object.atomicInit();
// verify the names
QCOMPARE(object.name(0), QByteArrayLiteral("foo"));
QCOMPARE(object.name(1), QByteArray());
QCOMPARE(object.name(2), QByteArrayLiteral("baz"));
// verify the property ids
QCOMPARE(object.propertyId(0), 0u);
QCOMPARE(object.propertyId(1), 0xFFFFFFFFu);
QCOMPARE(object.propertyId(2), 2u);
// doesn't have enums
QCOMPARE(object.propHasEnum(0, 0), false);
QCOMPARE(object.propHasEnum(1, 0), false);
QCOMPARE(object.propHasEnum(2, 0), false);
}
QTEST_GUILESS_MAIN(ObjectTest)
#include "objecttest.moc"
......@@ -111,7 +111,7 @@ if(NOT WIN32)
# compatibility variables
set(Libdrm_LIBRARIES ${Libdrm_LIBRARY})
set(Libdrm_INCLUDE_DIRS ${Libdrm_INCLUDE_DIR})
set(Libdrm_INCLUDE_DIRS ${Libdrm_INCLUDE_DIR} "${Libdrm_INCLUDE_DIR}/libdrm")
set(Libdrm_VERSION_STRING ${Libdrm_VERSION})
else()
......
......@@ -274,7 +274,7 @@ void DrmBackend::openDrm()
// create the plane objects
for (unsigned int i = 0; i < planeResources->count_planes; ++i) {
drmModePlane *kplane = drmModeGetPlane(m_fd, planeResources->planes[i]);
DrmPlane *p = new DrmPlane(kplane->plane_id, this);
DrmPlane *p = new DrmPlane(kplane->plane_id, m_fd);
if (p->atomicInit()) {
m_planes << p;
if (p->type() == DrmPlane::TypeIndex::Overlay) {
......@@ -303,7 +303,7 @@ void DrmBackend::openDrm()
}
for (int i = 0; i < res->count_connectors; ++i) {
m_connectors << new DrmConnector(res->connectors[i], this);
m_connectors << new DrmConnector(res->connectors[i], m_fd);
}
for (int i = 0; i < res->count_crtcs; ++i) {
m_crtcs << new DrmCrtc(res->crtcs[i], this, i);
......@@ -726,14 +726,14 @@ OpenGLBackend *DrmBackend::createOpenGLBackend()
DrmDumbBuffer *DrmBackend::createBuffer(const QSize &size)
{
DrmDumbBuffer *b = new DrmDumbBuffer(this, size);
DrmDumbBuffer *b = new DrmDumbBuffer(m_fd, size);
return b;
}
#if HAVE_GBM
DrmSurfaceBuffer *DrmBackend::createBuffer(const std::shared_ptr<GbmSurface> &surface)
{
DrmSurfaceBuffer *b = new DrmSurfaceBuffer(this, surface);
DrmSurfaceBuffer *b = new DrmSurfaceBuffer(m_fd, surface);
return b;
}
#endif
......
......@@ -18,7 +18,6 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "drm_buffer.h"
#include "drm_backend.h"
#include "logging.h"
......@@ -27,18 +26,19 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <errno.h>
// drm
#include <xf86drm.h>
#include <xf86drmMode.h>
namespace KWin
{
DrmBuffer:: DrmBuffer(DrmBackend *backend)
: m_backend(backend)
DrmBuffer:: DrmBuffer(int fd)
: m_fd(fd)
{
}
// DrmDumbBuffer
DrmDumbBuffer::DrmDumbBuffer(DrmBackend *backend, const QSize &size)
: DrmBuffer(backend)
DrmDumbBuffer::DrmDumbBuffer(int fd, const QSize &size)
: DrmBuffer(fd)
{
m_size = size;
drm_mode_create_dumb createArgs;
......@@ -46,14 +46,14 @@ DrmDumbBuffer::DrmDumbBuffer(DrmBackend *backend, const QSize &size)
createArgs.bpp = 32;
createArgs.width = size.width();
createArgs.height = size.height();
if (drmIoctl(m_backend->fd(), DRM_IOCTL_MODE_CREATE_DUMB, &createArgs) != 0) {
if (drmIoctl(fd, DRM_IOCTL_MODE_CREATE_DUMB, &createArgs) != 0) {
qCWarning(KWIN_DRM) << "DRM_IOCTL_MODE_CREATE_DUMB failed";
return;
}
m_handle = createArgs.handle;
m_bufferSize = createArgs.size;
m_stride = createArgs.pitch;
if (drmModeAddFB(m_backend->fd(), size.width(), size.height(), 24, 32,
if (drmModeAddFB(fd, size.width(), size.height(), 24, 32,
m_stride, createArgs.handle, &m_bufferId) != 0) {
qCWarning(KWIN_DRM) << "drmModeAddFB failed with errno" << errno;
}
......@@ -62,7 +62,7 @@ DrmDumbBuffer::DrmDumbBuffer(DrmBackend *backend, const QSize &size)
DrmDumbBuffer::~DrmDumbBuffer()
{
if (m_bufferId) {
drmModeRmFB(m_backend->fd(), m_bufferId);
drmModeRmFB(fd(), m_bufferId);
}
delete m_image;
......@@ -72,7 +72,7 @@ DrmDumbBuffer::~DrmDumbBuffer()
if (m_handle) {
drm_mode_destroy_dumb destroyArgs;
destroyArgs.handle = m_handle;
drmIoctl(m_backend->fd(), DRM_IOCTL_MODE_DESTROY_DUMB, &destroyArgs);
drmIoctl(fd(), DRM_IOCTL_MODE_DESTROY_DUMB, &destroyArgs);
}
}
......@@ -92,10 +92,10 @@ bool DrmDumbBuffer::map(QImage::Format format)
drm_mode_map_dumb mapArgs;
memset(&mapArgs, 0, sizeof mapArgs);
mapArgs.handle = m_handle;
if (drmIoctl(m_backend->fd(), DRM_IOCTL_MODE_MAP_DUMB, &mapArgs) != 0) {
if (drmIoctl(fd(), DRM_IOCTL_MODE_MAP_DUMB, &mapArgs) != 0) {
return false;
}
void *address = mmap(nullptr, m_bufferSize, PROT_WRITE, MAP_SHARED, m_backend->fd(), mapArgs.offset);
void *address = mmap(nullptr, m_bufferSize, PROT_WRITE, MAP_SHARED, fd(), mapArgs.offset);
if (address == MAP_FAILED) {
return false;
}
......
......@@ -26,12 +26,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
namespace KWin
{
class DrmBackend;
class DrmBuffer
{
public:
DrmBuffer(DrmBackend *backend);
DrmBuffer(int fd);
virtual ~DrmBuffer() = default;
virtual bool needsModeChange(DrmBuffer *b) const {Q_UNUSED(b) return false;}
......@@ -46,16 +44,20 @@ public:
virtual void releaseGbm() {}
int fd() const {
return m_fd;
}
protected:
DrmBackend *m_backend;
quint32 m_bufferId = 0;
QSize m_size;
int m_fd;
};
class DrmDumbBuffer : public DrmBuffer
{
public:
DrmDumbBuffer(DrmBackend *backend, const QSize &size);
DrmDumbBuffer(int fd, const QSize &size);
~DrmDumbBuffer();
bool needsModeChange(DrmBuffer *b) const override;
......
......@@ -18,7 +18,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "drm_backend.h"
#include "drm_buffer_gbm.h"
#include "gbm_surface.h"
......@@ -29,14 +28,15 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <errno.h>
// drm
#include <xf86drm.h>
#include <xf86drmMode.h>
#include <gbm.h>
namespace KWin
{
// DrmSurfaceBuffer
DrmSurfaceBuffer::DrmSurfaceBuffer(DrmBackend *backend, const std::shared_ptr<GbmSurface> &surface)
: DrmBuffer(backend)
DrmSurfaceBuffer::DrmSurfaceBuffer(int fd, const std::shared_ptr<GbmSurface> &surface)
: DrmBuffer(fd)
, m_surface(surface)
{
m_bo = m_surface->lockFrontBuffer();
......@@ -45,7 +45,7 @@ DrmSurfaceBuffer::DrmSurfaceBuffer(DrmBackend *backend, const std::shared_ptr<Gb
return;
}
m_size = QSize(gbm_bo_get_width(m_bo), gbm_bo_get_height(m_bo));
if (drmModeAddFB(m_backend->fd(), m_size.width(), m_size.height(), 24, 32, gbm_bo_get_stride(m_bo), gbm_bo_get_handle(m_bo).u32, &m_bufferId) != 0) {
if (drmModeAddFB(fd, m_size.width(), m_size.height(), 24, 32, gbm_bo_get_stride(m_bo), gbm_bo_get_handle(m_bo).u32, &m_bufferId) != 0) {
qCWarning(KWIN_DRM) << "drmModeAddFB failed";
}
gbm_bo_set_user_data(m_bo, this, nullptr);
......@@ -54,7 +54,7 @@ DrmSurfaceBuffer::DrmSurfaceBuffer(DrmBackend *backend, const std::shared_ptr<Gb
DrmSurfaceBuffer::~DrmSurfaceBuffer()
{
if (m_bufferId) {
drmModeRmFB(m_backend->fd(), m_bufferId);
drmModeRmFB(fd(), m_bufferId);
}
releaseGbm();
}
......
......@@ -30,13 +30,12 @@ struct gbm_bo;
namespace KWin
{
class DrmBackend;
class GbmSurface;
class DrmSurfaceBuffer : public DrmBuffer
{
public:
DrmSurfaceBuffer(DrmBackend *backend, const std::shared_ptr<GbmSurface> &surface);
DrmSurfaceBuffer(int fd, const std::shared_ptr<GbmSurface> &surface);
~DrmSurfaceBuffer();
bool needsModeChange(DrmBuffer *b) const override {
......
......@@ -19,7 +19,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "drm_object.h"
#include "drm_backend.h"
#include "logging.h"
namespace KWin
......@@ -29,8 +28,8 @@ namespace KWin
* Defintions for class DrmObject
*/
DrmObject::DrmObject(uint32_t object_id, DrmBackend *backend)
: m_backend(backend)
DrmObject::DrmObject(uint32_t object_id, int fd)
: m_fd(fd)
, m_id(object_id)
{
}
......@@ -50,7 +49,7 @@ void DrmObject::setPropertyNames(QVector<QByteArray> &&vector)
void DrmObject::initProp(int n, drmModeObjectProperties *properties, QVector<QByteArray> enumNames)
{
for (unsigned int i = 0; i < properties->count_props; ++i) {
drmModePropertyRes *prop = drmModeGetProperty(m_backend->fd(), properties->props[i]);
drmModePropertyRes *prop = drmModeGetProperty(fd(), properties->props[i]);
if (!prop) {
continue;