Merge lp:~afrantzis/mir/platform-operation-auth-fd into lp:mir

[Alexandros Frantzis]

mesa: Add auth_fd platform operation

mesa: Add auth_fd platform operation

This MP adds a new Mesa platform operation needed for resolving bug 1379266.

It's also a nice example of how the new platform operation infrastructure allows adding new operations without affecting the mir core code at all.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2261
http://jenkins.qa.ubuntu.com/job/mir-ci/2828/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/1089
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/1088
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/1050
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/825
        deb: http://jenkins.qa.ubuntu.com/job/mir-vivid-amd64-ci/825/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1050
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/1050/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/4107
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17520

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/2828/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

LGTM

review: Approve

[Cemil Azizoglu (cemil-azizoglu)]

Looks good.

review: Approve

=== modified file 'src/platforms/mesa/include/mir_toolkit/mesa/platform_operation.h'
--- src/platforms/mesa/include/mir_toolkit/mesa/platform_operation.h	2015-01-27 15:14:00 +0000
+++ src/platforms/mesa/include/mir_toolkit/mesa/platform_operation.h	2015-01-27 15:14:00 +0000
@@ -34,7 +34,8 @@
 
 enum MirMesaPlatformOperation
 {
-    auth_magic = 1
+    auth_magic = 1,
+    auth_fd = 2
 };
 
 /*

=== modified file 'src/platforms/mesa/server/ipc_operations.cpp'
--- src/platforms/mesa/server/ipc_operations.cpp	2015-01-27 15:14:00 +0000
+++ src/platforms/mesa/server/ipc_operations.cpp	2015-01-27 15:14:00 +0000
@@ -120,6 +120,16 @@
 
         return response;
     }
+    else if (op == MirMesaPlatformOperation::auth_fd)
+    {
+        if (request.data.size() != 0 || request.fds.size() != 0)
+        {
+            BOOST_THROW_EXCEPTION(
+                std::runtime_error("Invalid request message for auth_fd platform operation"));
+        }
+
+        return mg::PlatformOperationMessage{{},{drm_auth->authenticated_fd()}};
+    }
     else
     {
         BOOST_THROW_EXCEPTION(

=== modified file 'src/platforms/mesa/server/nested_authentication.cpp'
--- src/platforms/mesa/server/nested_authentication.cpp	2015-01-27 15:14:00 +0000
+++ src/platforms/mesa/server/nested_authentication.cpp	2015-01-27 15:14:00 +0000
@@ -88,27 +88,23 @@
 
 mir::Fd mgm::NestedAuthentication::authenticated_fd()
 {
-    auto fds = nested_context->platform_fd_items();
-    if (fds.size() < 1)
-        BOOST_THROW_EXCEPTION(std::runtime_error("Failed to get fd from platform package"));
-    char* busid = drmGetBusid(fds[0]);
-    if (!busid)
-        BOOST_THROW_EXCEPTION(
-            boost::enable_error_info(
-                std::runtime_error("Failed to get BusID of DRM device")) << boost::errinfo_errno(errno));
-    int auth_fd = drmOpen(NULL, busid);
-    free(busid);
-
-    drm_magic_t magic;
-    int ret = -1;
-    if ((ret = drmGetMagic(auth_fd, &magic)) < 0)
-    {
-        close(auth_fd);
-        BOOST_THROW_EXCEPTION(
-            boost::enable_error_info(
-                std::runtime_error("Failed to get DRM device magic cookie")) << boost::errinfo_errno(-ret));
-    }
-
-    auth_magic(magic);
+    mg::PlatformOperationMessage request_msg;
+
+    auto const response_msg = nested_context->platform_operation(
+        MirMesaPlatformOperation::auth_fd, request_msg);
+
+    int auth_fd{-1};
+
+    if (response_msg.fds.size() == 1)
+    {
+        auth_fd = response_msg.fds[0];
+    }
+    else
+    {
+        BOOST_THROW_EXCEPTION(
+            std::runtime_error(
+                "Nested server failed to get authenticated DRM fd"));
+    }
+
     return mir::Fd(IntOwnedFd{auth_fd});
 }

=== modified file 'tests/unit-tests/graphics/mesa/test_guest_platform.cpp'
--- tests/unit-tests/graphics/mesa/test_guest_platform.cpp	2015-01-27 15:14:00 +0000
+++ tests/unit-tests/graphics/mesa/test_guest_platform.cpp	2015-01-27 15:14:00 +0000
@@ -61,20 +61,16 @@
 
 }
 
-TEST_F(MesaGuestPlatformTest, auth_magic_is_delegated_to_nested_context)
+TEST_F(MesaGuestPlatformTest, auth_fd_is_delegated_to_nested_context)
 {
     using namespace testing;
 
-    int const success{0};
-    mg::PlatformOperationMessage auth_magic_success_response;
-    auth_magic_success_response.data.resize(sizeof(MirMesaAuthMagicResponse));
-    *reinterpret_cast<MirMesaAuthMagicResponse*>(
-        auth_magic_success_response.data.data()) =
-            MirMesaAuthMagicResponse{success};
+    int const auth_fd{13};
+    mg::PlatformOperationMessage auth_fd_response{{},{auth_fd}};
 
     EXPECT_CALL(mock_nested_context,
-                platform_operation(MirMesaPlatformOperation::auth_magic, _))
-        .WillOnce(Return(auth_magic_success_response));
+                platform_operation(MirMesaPlatformOperation::auth_fd, _))
+        .WillOnce(Return(auth_fd_response));
 
     mgm::GuestPlatform native(mt::fake_shared(mock_nested_context));
     auto ipc_ops = native.make_ipc_operations();

=== modified file 'tests/unit-tests/graphics/mesa/test_ipc_operations.cpp'
--- tests/unit-tests/graphics/mesa/test_ipc_operations.cpp	2015-01-27 15:14:00 +0000
+++ tests/unit-tests/graphics/mesa/test_ipc_operations.cpp	2015-01-27 15:14:00 +0000
@@ -112,6 +112,23 @@
     EXPECT_THAT(response.status, Eq(0));
 }
 
+TEST_F(IpcOperations, gets_authentication_fd_for_auth_fd_operation)
+{
+    using namespace testing;
+
+    mir::Fd stub_fd(fileno(tmpfile()));
+    EXPECT_CALL(mock_drm_ops, authenticated_fd())
+        .WillOnce(Return(stub_fd));
+
+    mg::PlatformOperationMessage request_msg;
+
+    auto const response_msg = ipc_ops.platform_operation(
+        MirMesaPlatformOperation::auth_fd, request_msg);
+
+    EXPECT_THAT(response_msg.data, IsEmpty());
+    EXPECT_THAT(response_msg.fds, ElementsAre(stub_fd));
+}
+
 TEST_F(IpcOperations, gets_authentication_fd_for_connection_package)
 {
     using namespace testing;

=== modified file 'tests/unit-tests/graphics/mesa/test_nested_authentication.cpp'
--- tests/unit-tests/graphics/mesa/test_nested_authentication.cpp	2015-01-27 15:14:00 +0000
+++ tests/unit-tests/graphics/mesa/test_nested_authentication.cpp	2015-01-27 15:14:00 +0000
@@ -34,19 +34,9 @@
 {
 struct NestedAuthentication : public ::testing::Test
 {
-    NestedAuthentication()
-    {
-        int const success{0};
-        auth_magic_success_response.data.resize(sizeof(MirMesaAuthMagicResponse));
-        *reinterpret_cast<MirMesaAuthMagicResponse*>(
-            auth_magic_success_response.data.data()) =
-                MirMesaAuthMagicResponse{success};
-    }
-
     ::testing::NiceMock<mtd::MockDRM> mock_drm;
     mtd::MockNestedContext mock_nested_context;
     mgm::NestedAuthentication auth{mt::fake_shared(mock_nested_context)};
-    mg::PlatformOperationMessage auth_magic_success_response;
 };
 }
 
@@ -65,7 +55,7 @@
 
 }
 
-TEST_F(NestedAuthentication, uses_nested_context_to_authenticate)
+TEST_F(NestedAuthentication, uses_nested_context_for_auth_magic)
 {
     using namespace testing;
 
@@ -76,6 +66,13 @@
     *reinterpret_cast<MirMesaAuthMagicRequest*>(msg.data.data()) =
         MirMesaAuthMagicRequest{magic};
 
+    int const success{0};
+    mg::PlatformOperationMessage auth_magic_success_response;
+    auth_magic_success_response.data.resize(sizeof(MirMesaAuthMagicResponse));
+    *reinterpret_cast<MirMesaAuthMagicResponse*>(
+        auth_magic_success_response.data.data()) =
+            MirMesaAuthMagicResponse{success};
+
     EXPECT_CALL(mock_nested_context,
                 platform_operation(MirMesaPlatformOperation::auth_magic, msg))
         .WillOnce(Return(auth_magic_success_response));
@@ -83,80 +80,18 @@
     auth.auth_magic(magic);
 }
 
-TEST_F(NestedAuthentication, no_drm_in_platform_package_throws)
-{
-    using namespace testing;
-    EXPECT_CALL(mock_nested_context, platform_fd_items())
-        .WillOnce(Return(std::vector<int>{}));
-    EXPECT_THROW({
-        auth.authenticated_fd();
-    }, std::runtime_error);
-}
-
-TEST_F(NestedAuthentication, failure_in_getbusid_throws)
-{
-    using namespace testing;
-    int stub_fd = 33;
-
-    InSequence seq;
-    EXPECT_CALL(mock_nested_context, platform_fd_items())
-        .WillOnce(Return(std::vector<int>{stub_fd}));
-    EXPECT_CALL(mock_drm, drmGetBusid(stub_fd))
-        .WillOnce(Return(nullptr));
-
-    EXPECT_THROW({
-        auth.authenticated_fd();
-    }, std::runtime_error);
-}
-
-TEST_F(NestedAuthentication, failure_in_getmagic_throws)
-{
-    using namespace testing;
-    int stub_fd = 33;
-    int auth_fd = 34;
-    //this should get freed by the implementation
-    auto fake_busid = static_cast<char*>(malloc(sizeof(char)));
-    *fake_busid = 'a';
-    int magic{332211};
-
-    InSequence seq;
-    EXPECT_CALL(mock_nested_context, platform_fd_items())
-        .WillOnce(Return(std::vector<int>{stub_fd}));
-    EXPECT_CALL(mock_drm, drmGetBusid(stub_fd))
-        .WillOnce(Return(fake_busid));
-    EXPECT_CALL(mock_drm, drmOpen(nullptr, fake_busid))
-        .WillOnce(Return(auth_fd));
-    EXPECT_CALL(mock_drm, drmGetMagic(auth_fd, _))
-        .WillOnce(DoAll(SetArgPointee<1>(magic), Return(-1)));
-
-    EXPECT_THROW({
-        auth.authenticated_fd();
-    }, std::runtime_error);
-}
-
-TEST_F(NestedAuthentication, creates_new_fd)
-{
-    using namespace testing;
-    int stub_fd = 33;
-    int auth_fd = 34;
-    //this should get freed by the implementation
-    auto fake_busid = static_cast<char*>(malloc(sizeof(char)));
-    *fake_busid = 'a';
-    int magic{332211};
-
-    InSequence seq;
-    EXPECT_CALL(mock_nested_context, platform_fd_items())
-        .WillOnce(Return(std::vector<int>{stub_fd}));
-    EXPECT_CALL(mock_drm, drmGetBusid(stub_fd))
-        .WillOnce(Return(fake_busid));
-    EXPECT_CALL(mock_drm, drmOpen(nullptr, fake_busid))
-        .WillOnce(Return(auth_fd));
-    EXPECT_CALL(mock_drm, drmGetMagic(auth_fd, _))
-        .WillOnce(DoAll(SetArgPointee<1>(magic), Return(0)));
+TEST_F(NestedAuthentication, uses_nested_context_for_auth_fd)
+{
+    using namespace testing;
+
+    mg::PlatformOperationMessage msg;
+
+    int const auth_fd{13};
+    mg::PlatformOperationMessage const response{{}, {auth_fd}};
+
     EXPECT_CALL(mock_nested_context,
-                platform_operation(MirMesaPlatformOperation::auth_magic, _))
-        .WillOnce(Return(auth_magic_success_response));
+                platform_operation(MirMesaPlatformOperation::auth_fd, msg))
+        .WillOnce(Return(response));
 
-    auto fd = auth.authenticated_fd();
-    EXPECT_THAT(fd, Eq(auth_fd));
+    EXPECT_THAT(auth.authenticated_fd(), Eq(auth_fd));
 }