Merge lp:~vanvugt/mir/nonprime-server-support into lp:mir

[Daniel van Vugt]

Add server-side support for non-PRIME DRM drivers like VirtualBox.

This is enough to get mir_demo_standalone_render_surfaces working
(very nicely) but more work would be required to support clients
(Mesa patch) and nesting.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3811
https://mir-jenkins.ubuntu.com/job/mir-ci/2124/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/2744/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2807
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2799
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2799
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2799
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2773/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2773
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2773/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2773
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2773/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2773
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2773/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2773
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2773/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2773
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2773/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2124/rebuild

review: Needs Fixing (continuous-integration)

[Daniel van Vugt (vanvugt)]

^^^
Bug 1616312

[lp:~vanvugt/mir/nonprime-server-support]

3812. By Daniel van Vugt on 2016-11-09

Try again

Unmerged revisions

3812. By Daniel van Vugt on 2016-11-09

Try again

3811. By Daniel van Vugt on 2016-11-08

Prototype

=== modified file 'src/platforms/mesa/server/gbm_buffer.cpp'
--- src/platforms/mesa/server/gbm_buffer.cpp	2016-10-11 07:12:33 +0000
+++ src/platforms/mesa/server/gbm_buffer.cpp	2016-11-08 10:32:43 +0000
@@ -41,18 +41,39 @@
     : gbm_handle{handle},
       bo_flags{bo_flags},
       texture_binder{std::move(texture_binder)},
-      prime_fd{-1}
+      prime_fd{-1},
+      gem_flink_name{0}
 {
     auto device = gbm_bo_get_device(gbm_handle.get());
     auto gem_handle = gbm_bo_get_handle(gbm_handle.get()).u32;
     auto drm_fd = gbm_device_get_fd(device);
 
-    auto ret = drmPrimeHandleToFD(drm_fd, gem_handle, DRM_CLOEXEC, &prime_fd);
+    uint64_t has_prime = 0;
+    if (0 != drmGetCap(drm_fd, DRM_CAP_PRIME, &has_prime))
+        has_prime = 0;
+    supports_prime = !!has_prime;
 
-    if (ret)
-    {
-        std::string const msg("Failed to get PRIME fd from gbm bo");
-        BOOST_THROW_EXCEPTION((std::system_error{errno, std::system_category(), msg}));
+    // If we have PRIME support, use it exclusively (greatest security)
+    if (supports_prime)
+    {
+        auto ret = drmPrimeHandleToFD(drm_fd, gem_handle, DRM_CLOEXEC, &prime_fd);
+        if (ret)
+        {
+            std::string const msg("Failed to get PRIME fd from gbm bo");
+            BOOST_THROW_EXCEPTION((std::system_error{errno, std::system_category(), msg}));
+        }
+    }
+    else  // use what works, in the absence of PRIME support
+    {
+        struct drm_gem_flink flink;
+        flink.handle = gem_handle;
+        auto ret = drmIoctl(drm_fd, DRM_IOCTL_GEM_FLINK, &flink);
+        if (ret)
+        {
+            std::string const msg("Failed to get GEM flink name");
+            BOOST_THROW_EXCEPTION((std::system_error{errno, std::system_category(), msg}));
+        }
+        gem_flink_name = flink.name;
     }
 }
 
@@ -86,8 +107,16 @@
 {
     auto temp = std::make_shared<NativeBuffer>();
 
-    temp->fd_items = 1;
-    temp->fd[0] = prime_fd;
+    if (supports_prime)
+    {
+        temp->fd_items = 1;
+        temp->fd[0] = prime_fd;
+    }
+    else
+    {
+        temp->data_items = 1;
+        temp->data[0] = gem_flink_name;
+    }
     temp->stride = stride().as_uint32_t();
     temp->flags = (bo_flags & GBM_BO_USE_SCANOUT) ? mir_buffer_flag_can_scanout : 0;
     temp->bo = gbm_handle.get();

=== modified file 'src/platforms/mesa/server/gbm_buffer.h'
--- src/platforms/mesa/server/gbm_buffer.h	2016-10-12 13:31:04 +0000
+++ src/platforms/mesa/server/gbm_buffer.h	2016-11-08 10:32:43 +0000
@@ -70,7 +70,9 @@
     std::shared_ptr<gbm_bo> const gbm_handle;
     uint32_t bo_flags;
     std::unique_ptr<common::BufferTextureBinder> const texture_binder;
+    bool supports_prime;
     int prime_fd;
+    uint32_t gem_flink_name;
 };
 
 }

=== modified file 'tests/unit-tests/platforms/mesa/kms/test_gbm_buffer.cpp'
--- tests/unit-tests/platforms/mesa/kms/test_gbm_buffer.cpp	2016-10-12 13:31:04 +0000
+++ tests/unit-tests/platforms/mesa/kms/test_gbm_buffer.cpp	2016-11-08 10:32:43 +0000
@@ -61,6 +61,9 @@
         usage = mg::BufferUsage::hardware;
         buffer_properties = mg::BufferProperties{size, pf, usage};
 
+        ON_CALL(mock_drm, drmGetCap(_,DRM_CAP_PRIME,_))
+            .WillByDefault(DoAll(SetArgPointee<2>(1),Return(0)));
+
         ON_CALL(mock_gbm, gbm_bo_get_width(_))
         .WillByDefault(Return(size.width.as_uint32_t()));
 
@@ -144,7 +147,7 @@
     ASSERT_LE(minimum, geom::Stride{native->stride});
 }
 
-TEST_F(GBMBufferTest, buffer_native_handle_has_correct_size)
+TEST_F(GBMBufferTest, prime_native_buffer_handle_has_correct_size)
 {
     using namespace testing;
 
@@ -155,6 +158,20 @@
     EXPECT_EQ(0, native_handle->data_items);
 }
 
+TEST_F(GBMBufferTest, nonprime_native_buffer_handle_has_correct_size)
+{
+    using namespace testing;
+
+    EXPECT_CALL(mock_drm, drmGetCap(_,DRM_CAP_PRIME,_))
+        .WillOnce(DoAll(SetArgPointee<2>(0),Return(0)));
+
+    auto buffer = allocator->alloc_buffer(buffer_properties);
+    auto native_handle = std::dynamic_pointer_cast<mgm::NativeBuffer>(buffer->native_buffer_handle());
+    ASSERT_THAT(native_handle, Ne(nullptr));
+    EXPECT_EQ(0, native_handle->fd_items);
+    EXPECT_EQ(1, native_handle->data_items);
+}
+
 MATCHER_P(GEMFlinkHandleIs, value, "")
 {
     auto flink = reinterpret_cast<struct drm_gem_flink*>(arg);
@@ -167,7 +184,7 @@
     flink->name = value;
 }
 
-TEST_F(GBMBufferTest, buffer_native_handle_contains_correct_data)
+TEST_F(GBMBufferTest, prime_native_buffer_handle_contains_correct_data)
 {
     using namespace testing;
 
@@ -190,17 +207,78 @@
     EXPECT_EQ(stride.as_uint32_t(), static_cast<unsigned int>(handle->stride));
 }
 
+TEST_F(GBMBufferTest, nonprime_native_buffer_handle_contains_correct_data)
+{
+    using namespace testing;
+
+    EXPECT_CALL(mock_drm, drmGetCap(_,DRM_CAP_PRIME,_))
+        .WillOnce(DoAll(SetArgPointee<2>(0),Return(0)));
+
+    uint32_t const flink_name{0xf000baaa};
+
+    EXPECT_CALL(mock_drm, drmIoctl(_,DRM_IOCTL_GEM_FLINK,_))
+            .Times(Exactly(1))
+            .WillOnce(DoAll(SetGEMFlinkName(flink_name), Return(0)));
+
+    auto buffer = allocator->alloc_buffer(buffer_properties);
+    auto handle = std::dynamic_pointer_cast<mgm::NativeBuffer>(buffer->native_buffer_handle());
+    ASSERT_THAT(handle, Ne(nullptr));
+    EXPECT_EQ(0, handle->fd_items);
+    EXPECT_EQ(1, handle->data_items);
+    EXPECT_EQ(flink_name, static_cast<uint32_t>(handle->data[0]));
+    EXPECT_EQ(stride.as_uint32_t(), static_cast<unsigned int>(handle->stride));
+}
+
 TEST_F(GBMBufferTest, buffer_creation_throws_on_prime_fd_failure)
 {
     using namespace testing;
 
-    EXPECT_CALL(mock_drm, drmPrimeHandleToFD(_,_,_,_))
-            .Times(Exactly(1))
-            .WillOnce(Return(-1));
-
-    EXPECT_THROW({
-        auto buffer = allocator->alloc_buffer(buffer_properties);
-    }, std::runtime_error);
+    EXPECT_CALL(mock_drm, drmGetCap(_,DRM_CAP_PRIME,_))
+            .Times(Exactly(1))
+            .WillOnce(DoAll(SetArgPointee<2>(1),Return(0)));
+    EXPECT_CALL(mock_drm, drmPrimeHandleToFD(_,_,_,_))
+            .Times(Exactly(1))
+            .WillOnce(Return(-1));
+
+    EXPECT_THROW({
+        auto buffer = allocator->alloc_buffer(buffer_properties);
+    }, std::runtime_error);
+}
+
+TEST_F(GBMBufferTest, buffer_creation_throws_on_flink_failure)
+{
+    using namespace testing;
+
+    EXPECT_CALL(mock_drm, drmGetCap(_,DRM_CAP_PRIME,_))
+            .Times(Exactly(1))
+            .WillOnce(DoAll(SetArgPointee<2>(0),Return(0)));
+    EXPECT_CALL(mock_drm, drmIoctl(_,DRM_IOCTL_GEM_FLINK,_))
+            .Times(Exactly(1))
+            .WillOnce(Return(-1));
+    EXPECT_CALL(mock_drm, drmPrimeHandleToFD(_,_,_,_))
+            .Times(0);
+
+    EXPECT_THROW({
+        auto buffer = allocator->alloc_buffer(buffer_properties);
+    }, std::runtime_error);
+}
+
+TEST_F(GBMBufferTest, buffer_creation_falls_back_without_throwing)
+{
+    using namespace testing;
+
+    EXPECT_CALL(mock_drm, drmGetCap(_,DRM_CAP_PRIME,_))
+            .Times(Exactly(1))
+            .WillOnce(DoAll(SetArgPointee<2>(0),Return(0)));
+    EXPECT_CALL(mock_drm, drmIoctl(_,DRM_IOCTL_GEM_FLINK,_))
+            .Times(Exactly(1))
+            .WillOnce(Return(0));
+    EXPECT_CALL(mock_drm, drmPrimeHandleToFD(_,_,_,_))
+            .Times(0);
+
+    EXPECT_NO_THROW({
+        auto buffer = allocator->alloc_buffer(buffer_properties);
+    });
 }
 
 TEST_F(GBMBufferTest, gl_bind_to_texture_egl_image_creation_failed)