Merge lp:~vanvugt/mir/scanout into lp:~mir-team/mir/trunk

[Daniel van Vugt]

Add a "flags" field to MirBufferPackage so that clients can find out if the
buffer they've been given is scanout-capable. This is normally something a
client should never need to know. However there are two specialized cases
where it's required to fix bugs in the intel and radeon X drivers:
  LP: #1218735, LP: #1218815
The intel fix (already landed) contains a hack which will be updated after
this branch lands.

The weird looking reshuffle in mir_native_buffer.h is necessary to avoid breaking the ABI for Mesa. It seems only Mesa is inflexible enough that we can't extend MirBufferPackage without breaking it. So we avoid growing the size of MirBufferPackage for now.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1067
http://jenkins.qa.ubuntu.com/job/mir-ci/1466/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-saucy-i386-build/1981
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-saucy-amd64-build/1866
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-saucy-amd64-ci/704
        deb: http://jenkins.qa.ubuntu.com/job/mir-saucy-amd64-ci/704/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Looks messy but I guess it is justified in the description

review: Approve

[Kevin DuBois (kdub)]

the abi-preserving changes for the gbm buffer look good. Android has a flag on its 'usage' field in its native type that can indicate scanout surfaces

It would be nice to get rid of the #ifndef ANDROID around the test case... but looks okay otherwise.

review: Approve

[Robert Ancell (robert-ancell)]

The ABI preserving is a little bit unclear, it would be nice to add a big comment saying "we are stealing the last element of data[] and fd[] to use for flags - we can revert this once we bump ABI.

Otherwise makes sense to me

review: Approve

=== modified file 'include/platform/mir/graphics/buffer_ipc_packer.h'
--- include/platform/mir/graphics/buffer_ipc_packer.h	2013-08-28 03:41:48 +0000
+++ include/platform/mir/graphics/buffer_ipc_packer.h	2013-09-11 08:52:46 +0000
@@ -33,6 +33,7 @@
     virtual void pack_fd(int) = 0;
     virtual void pack_data(int) = 0;
     virtual void pack_stride(geometry::Stride) = 0;
+    virtual void pack_flags(unsigned int) = 0;
 
 protected:
     BufferIPCPacker() {}

=== modified file 'include/shared/mir_toolkit/mir_native_buffer.h'
--- include/shared/mir_toolkit/mir_native_buffer.h	2013-05-06 15:38:52 +0000
+++ include/shared/mir_toolkit/mir_native_buffer.h	2013-09-11 08:52:46 +0000
@@ -20,15 +20,24 @@
 #ifndef MIR_CLIENT_MIR_NATIVE_BUFFER_H_
 #define MIR_CLIENT_MIR_NATIVE_BUFFER_H_
 
-enum { mir_buffer_package_max = 32 };
+enum { mir_buffer_package_max = 31 };
+
+typedef enum
+{
+    mir_buffer_flag_can_scanout = 1
+} MirBufferFlag;
+
 typedef struct MirBufferPackage
 {
     int data_items;
     int fd_items;
 
     int data[mir_buffer_package_max];
+    int unused1;  /* Retain ABI compatibility (avoid rebuilding Mesa) */
+
     int fd[mir_buffer_package_max];
 
+    unsigned int flags;  /* MirBufferFlag's */
     int stride;
     int age; /**< Number of frames submitted by the client since the client has rendered to this buffer. */
              /**< This has the same semantics as the EGL_EXT_buffer_age extension */

=== modified file 'include/test/mir_test_doubles/mock_buffer_packer.h'
--- include/test/mir_test_doubles/mock_buffer_packer.h	2013-08-28 03:41:48 +0000
+++ include/test/mir_test_doubles/mock_buffer_packer.h	2013-09-11 08:52:46 +0000
@@ -36,6 +36,7 @@
     MOCK_METHOD1(pack_fd, void(int));
     MOCK_METHOD1(pack_data, void(int));
     MOCK_METHOD1(pack_stride, void(geometry::Stride));
+    MOCK_METHOD1(pack_flags, void(unsigned int));
 };
 
 }

=== modified file 'src/client/mir_surface.cpp'
--- src/client/mir_surface.cpp	2013-08-28 03:41:48 +0000
+++ src/client/mir_surface.cpp	2013-09-11 08:52:46 +0000
@@ -268,6 +268,7 @@
         }
 
         buffer_package.stride = buffer.stride();
+        buffer_package.flags = buffer.flags();
     }
     else
     {

=== modified file 'src/server/frontend/protobuf_buffer_packer.cpp'
--- src/server/frontend/protobuf_buffer_packer.cpp	2013-09-06 03:46:37 +0000
+++ src/server/frontend/protobuf_buffer_packer.cpp	2013-09-11 08:52:46 +0000
@@ -107,3 +107,9 @@
 {
     buffer_response->set_stride(stride.as_uint32_t());
 }
+
+void mfd::ProtobufBufferPacker::pack_flags(unsigned int flags)
+{
+    buffer_response->set_flags(flags);
+}
+

=== modified file 'src/server/frontend/protobuf_buffer_packer.h'
--- src/server/frontend/protobuf_buffer_packer.h	2013-08-28 03:41:48 +0000
+++ src/server/frontend/protobuf_buffer_packer.h	2013-09-11 08:52:46 +0000
@@ -43,6 +43,7 @@
     void pack_fd(int);
     void pack_data(int);
     void pack_stride(geometry::Stride);
+    void pack_flags(unsigned int);
 private:
     protobuf::Buffer* buffer_response;
 };

=== modified file 'src/server/graphics/gbm/gbm_buffer.cpp'
--- src/server/graphics/gbm/gbm_buffer.cpp	2013-08-28 03:41:48 +0000
+++ src/server/graphics/gbm/gbm_buffer.cpp	2013-09-11 08:52:46 +0000
@@ -130,6 +130,7 @@
     temp->fd_items = 1;
     temp->fd[0] = prime_fd;
     temp->stride = stride().as_uint32_t();
+    temp->flags = can_bypass() ? mir_buffer_flag_can_scanout : 0;
     temp->bo = gbm_handle.get();
 
     return temp;

=== modified file 'src/server/graphics/gbm/gbm_platform.cpp'
--- src/server/graphics/gbm/gbm_platform.cpp	2013-08-30 07:47:16 +0000
+++ src/server/graphics/gbm/gbm_platform.cpp	2013-09-11 08:52:46 +0000
@@ -146,6 +146,7 @@
     }
 
     packer->pack_stride(buffer->stride()); 
+    packer->pack_flags(native_handle->flags);
 }
 
 void mgg::GBMPlatform::drm_auth_magic(drm_magic_t magic)

=== modified file 'src/shared/protobuf/mir_protobuf.proto'
--- src/shared/protobuf/mir_protobuf.proto	2013-09-06 03:46:37 +0000
+++ src/shared/protobuf/mir_protobuf.proto	2013-09-11 08:52:46 +0000
@@ -29,7 +29,8 @@
   repeated sint32 fd = 2;
   repeated int32  data = 3;
   optional int32  fds_on_side_channel = 4;
-  optional int32 stride = 5;
+  optional int32  stride = 5;
+  optional uint32 flags = 6;
 
   optional string error = 127;
 }

=== modified file 'tests/acceptance-tests/test_client_library.cpp'
--- tests/acceptance-tests/test_client_library.cpp	2013-09-02 09:54:31 +0000
+++ tests/acceptance-tests/test_client_library.cpp	2013-09-11 08:52:46 +0000
@@ -456,6 +456,77 @@
     launch_client_process(client_config);
 }
 
+#ifndef ANDROID
+TEST_F(DefaultDisplayServerTestFixture, surface_scanout_flag_toggles)
+{
+    struct ClientConfig : ClientConfigCommon
+    {
+        void exec()
+        {
+            connection = mir_connect_sync(mir_test_socket, __PRETTY_FUNCTION__);
+            ASSERT_TRUE(connection != NULL);
+            EXPECT_TRUE(mir_connection_is_valid(connection));
+            EXPECT_STREQ(mir_connection_get_error_message(connection), "");
+
+            MirSurfaceParameters parm =
+            {
+                __PRETTY_FUNCTION__,
+                1280, 1024,
+                mir_pixel_format_abgr_8888,
+                mir_buffer_usage_hardware,
+                mir_display_output_id_invalid
+            };
+
+            surface = mir_connection_create_surface_sync(connection, &parm);
+            ASSERT_TRUE(mir_surface_is_valid(surface));
+            MirNativeBuffer *native;
+            mir_surface_get_current_buffer(surface, &native);
+            EXPECT_TRUE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_swap_buffers_sync(surface);
+            EXPECT_TRUE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_release_sync(surface);
+
+            parm.width = 100;
+            parm.height = 100;
+
+            surface = mir_connection_create_surface_sync(connection, &parm);
+            ASSERT_TRUE(mir_surface_is_valid(surface));
+            mir_surface_get_current_buffer(surface, &native);
+            EXPECT_FALSE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_swap_buffers_sync(surface);
+            EXPECT_FALSE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_release_sync(surface);
+
+            parm.width = 800;
+            parm.height = 600;
+            parm.buffer_usage = mir_buffer_usage_software;
+
+            surface = mir_connection_create_surface_sync(connection, &parm);
+            ASSERT_TRUE(mir_surface_is_valid(surface));
+            mir_surface_get_current_buffer(surface, &native);
+            EXPECT_FALSE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_swap_buffers_sync(surface);
+            EXPECT_FALSE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_release_sync(surface);
+
+            parm.buffer_usage = mir_buffer_usage_hardware;
+
+            surface = mir_connection_create_surface_sync(connection, &parm);
+            ASSERT_TRUE(mir_surface_is_valid(surface));
+            mir_surface_get_current_buffer(surface, &native);
+            EXPECT_TRUE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_swap_buffers_sync(surface);
+            EXPECT_TRUE(native->flags & mir_buffer_flag_can_scanout);
+            mir_surface_release_sync(surface);
+
+            mir_connection_release(connection);
+        }
+    } client_config;
+
+    launch_client_process(client_config);
+}
+#endif
+
 TEST_F(DefaultDisplayServerTestFixture, client_library_creates_multiple_surfaces)
 {
     int const n_surfaces = 13;

=== modified file 'tests/mir_test_framework/testing_server_options.cpp'
--- tests/mir_test_framework/testing_server_options.cpp	2013-09-06 03:46:37 +0000
+++ tests/mir_test_framework/testing_server_options.cpp	2013-09-11 08:52:46 +0000
@@ -65,7 +65,8 @@
 {
 public:
     StubFDBuffer(mg::BufferProperties const& properties)
-        : StubBuffer(properties)
+        : StubBuffer(properties),
+          properties{properties}
     {
         fd = open("/dev/zero", O_RDONLY);
         if (fd < 0)
@@ -82,6 +83,14 @@
         native_buffer->data[0] = 0xDEADBEEF;
         native_buffer->fd_items = 1;
         native_buffer->fd[0] = fd;
+
+        native_buffer->flags = 0;
+        if (properties.size.width.as_int() >= 800 &&
+            properties.size.height.as_int() >= 600 &&
+            properties.usage == mg::BufferUsage::hardware)
+        {
+            native_buffer->flags |= mir_buffer_flag_can_scanout;
+        }
         return native_buffer;
 #else
         return std::shared_ptr<MirNativeBuffer>();
@@ -94,6 +103,7 @@
     }
 private:
     int fd;
+    const mg::BufferProperties properties;
 };
 
 class StubGraphicBufferAllocator : public mg::GraphicBufferAllocator
@@ -180,6 +190,7 @@
         }
 
         packer->pack_stride(buffer->stride());
+        packer->pack_flags(native_handle->flags);
 #else
         (void)packer;
         (void)buffer;

=== modified file 'tests/unit-tests/frontend/test_protobuf_buffer_packer.cpp'
--- tests/unit-tests/frontend/test_protobuf_buffer_packer.cpp	2013-08-28 03:41:48 +0000
+++ tests/unit-tests/frontend/test_protobuf_buffer_packer.cpp	2013-09-11 08:52:46 +0000
@@ -39,6 +39,7 @@
         packer.pack_data(i);
 
     packer.pack_stride(dummy_stride);
+    packer.pack_flags(123);
 
     EXPECT_EQ(num_fd, response.fd_size());
     EXPECT_EQ(num_int, response.data_size());
@@ -47,4 +48,5 @@
     for (int i = 0; i < response.data_size(); ++i)
         EXPECT_EQ(i, response.data(i));
     EXPECT_EQ(dummy_stride.as_uint32_t(), static_cast<unsigned int>(response.stride()));
+    EXPECT_EQ(123U, response.flags());
 }

=== modified file 'tests/unit-tests/graphics/gbm/test_gbm_platform.cpp'
--- tests/unit-tests/graphics/gbm/test_gbm_platform.cpp	2013-08-28 03:41:48 +0000
+++ tests/unit-tests/graphics/gbm/test_gbm_platform.cpp	2013-09-11 08:52:46 +0000
@@ -171,6 +171,8 @@
     }
     EXPECT_CALL(*mock_packer, pack_stride(dummy_stride))
         .Times(1);
+    EXPECT_CALL(*mock_packer, pack_flags(testing::_))
+        .Times(1);
 
     platform->fill_ipc_package(mock_packer, mock_buffer);
 }