Merge lp:~alan-griffiths/mir/fix-1583536-for-0.23.1 into lp:mir

[Alan Griffiths]

Make the mirtest-dev package useful for downstream projects

Backport fix to mirtest-dev

=== modified file 'debian/changelog'
--- debian/changelog	2016-05-03 04:36:33 +0000
+++ debian/changelog	2016-05-20 09:11:49 +0000
@@ -1,25 +1,51 @@
-mir (0.23.0) UNRELEASED; urgency=medium
+mir (0.23.0ubuntu1) UNRELEASED; urgency=medium
 
+  [ Kevin DuBois ]
   * New upstream release 0.23.0 (https://launchpad.net/mir/+milestone/0.23.0)
     - ABI summary:
       . mirclient ABI unchanged at 9
-      . mirserver ABI unchanged at 39
-      . mircommon ABI unchanged at 5
+      . mirserver ABI bumped to 40
+      . mircommon ABI bumped at 6
       . mirplatform ABI unchanged at 11
       . mirprotobuf ABI unchanged at 3
       . mirplatformgraphics ABI unchanged at 9
       . mirclientplatform ABI unchanged at 5
       . mirinputplatform ABI unchanged at 5
     - Enhancements:
+      . Enable internal usage of more flexible graphics buffer submission,
+        precursing client API additions. 
     - Bug fixes:
+      . Potential NBS performance loss after resize (LP: #1579076)
+      . Performance loss with NBS and overlays on (LP: #1578159)
       . Mir crashes with useless backtrace when mg::Platform methods throw
         (LP: #1553549)
       . Virtual output is not removed when screencast client disappears
         (LP: #1573572)
-      . Virtual display output configuration is set to LVDS Edit (LP: #1573782)
-      . Resizing can crash mir_demo_server (LP: #1575211)
-
- -- Alberto Aguirre <[e-mail]>  Thu, 28 Apr 2016 09:24:21 -0500
+      . Can't VT switch from mir_demo_server (any more) (LP: #1576260)
+      . mir_demo_server(_minimal): Window movement/resizing stops responding
+        when the cursor leaves the surface, and can lead to windows 1px wide
+        and unrecoverable. (LP: #1447886)
+      . Virtual display output configuration is set to LVDS (LP: #1573782)
+      . Mir-on-X11 doesn't pass Alt+primary button drag to Mir (LP: #1575765)
+      . Mir-on-X11 breaks mir_proving_server resize logic (LP: #1575192)
+      . Resizing can crash mir_demo_server (LP: #1575211) 
+      . [regression] Cursor stops at phantom edge on M10 and N7 (LP: 1580774)
+
+ -- Kevin DuBois <[e-mail]>  Mon, 09 May 2016 11:59:42 -0400
+
+mir (0.22.1+16.04.20160516.2-0ubuntu1) xenial; urgency=medium
+
+  [ Andreas Pokorny ]
+  * New upstream release 0.22.1 (https://launchpad.net/mir/+milestone/0.22.1)
+    - ABI summary:
+      . No ABI changes in any libraries. Bugfix release only.
+    - Bugs fixed:
+      . [regression] Cursor stops at phantom edge on M10 and N7 (LP: 1580774)
+
+  [ CI Train Bot ]
+  * No-change rebuild.
+
+ -- Michał Sawicz <[e-mail]>  Mon, 16 May 2016 15:36:50 +0000
 
 mir (0.22.0+16.04.20160422.2-0ubuntu1) xenial; urgency=medium
 
 
=== modified file 'debian/control'
--- debian/control	2016-05-20 07:19:12 +0000
+++ debian/control	2016-05-20 09:11:49 +0000
@@ -68,7 +68,7 @@
 
 #TODO: Packaging infrastructure for better dependency generation,
 #      ala pkg-xorg's xviddriver:Provides and ABI detection.
-Package: libmirserver39
+Package: libmirserver40
 Section: libs
 Architecture: linux-any
 Multi-Arch: same
@@ -100,7 +100,7 @@
 Architecture: linux-any
 Multi-Arch: same
 Pre-Depends: ${misc:Pre-Depends}
-Depends: libmircommon5 (= ${binary:Version}), 
+Depends: libmircommon6 (= ${binary:Version}), 
          libprotobuf-dev (>= 2.4.1),
          libxkbcommon-dev,
          ${misc:Depends},
@@ -134,7 +134,7 @@
 Architecture: linux-any
 Multi-Arch: same
 Pre-Depends: ${misc:Pre-Depends}
-Depends: libmirserver39 (= ${binary:Version}),
+Depends: libmirserver40 (= ${binary:Version}),
          libmirplatform-dev (= ${binary:Version}),
          libmircommon-dev (= ${binary:Version}),
          libglm-dev,
@@ -288,7 +288,7 @@
  .
  Contains a tool for checking the graphics components of android devices.
 
-Package: libmircommon5
+Package: libmircommon6
 Section: libs
 Architecture: linux-any
 Multi-Arch: same
 
=== renamed file 'debian/libmircommon5.install' => 'debian/libmircommon6.install'
--- debian/libmircommon5.install	2015-06-17 05:20:42 +0000
+++ debian/libmircommon6.install	2016-05-20 09:11:49 +0000
@@ -1,1 +1,1 @@
-usr/lib/*/libmircommon.so.5
+usr/lib/*/libmircommon.so.6
 
=== renamed file 'debian/libmirserver39.install' => 'debian/libmirserver40.install'
--- debian/libmirserver39.install	2016-03-29 07:30:50 +0000
+++ debian/libmirserver40.install	2016-05-20 09:11:49 +0000
@@ -1,1 +1,1 @@
-usr/lib/*/libmirserver.so.39
+usr/lib/*/libmirserver.so.40
 
=== modified file 'src/client/buffer_vault.cpp'
--- src/client/buffer_vault.cpp	2016-05-09 14:27:58 +0000
+++ src/client/buffer_vault.cpp	2016-05-20 09:11:49 +0000
@@ -122,7 +122,7 @@
 
 mcl::NoTLSFuture<std::shared_ptr<mcl::Buffer>> mcl::BufferVault::withdraw()
 {
-    std::lock_guard<std::mutex> lk(mutex);
+    std::unique_lock<std::mutex> lk(mutex);
     if (disconnected_)
         BOOST_THROW_EXCEPTION(std::logic_error("server_disconnected"));
     mcl::NoTLSPromise<std::shared_ptr<mcl::Buffer>> promise;
@@ -146,6 +146,15 @@
     else
     {
         promises.emplace_back(std::move(promise));
+
+        auto s = size;
+        bool allocate_buffer = (current_buffer_count <  needed_buffer_count);
+        if (allocate_buffer)
+            current_buffer_count++;
+        lk.unlock();
+
+        if (allocate_buffer)
+            alloc_buffer(s, format, usage);
     }
     return future;
 }
@@ -198,12 +207,12 @@
         {
             auto id = it->first;
             buffers.erase(it);
-            lk.unlock();
-
-            free_buffer(id);
             if (should_decrease_count)
                 current_buffer_count--;
-            else
+            lk.unlock();
+
+            free_buffer(id);
+            if (!should_decrease_count)
                 alloc_buffer(size, format, usage);
             return;
         }
@@ -221,15 +230,6 @@
     }
 }
 
-//TODO: the server will currently spam us with a lot of resize messages at once,
-//      and we want to delay the IPC transactions for resize. If we could rate-limit
-//      the incoming messages, we should should consolidate the scale and size functions
-void mcl::BufferVault::set_size(geom::Size sz)
-{
-    std::lock_guard<std::mutex> lk(mutex);
-    size = sz;
-}
-
 void mcl::BufferVault::disconnected()
 {
     std::lock_guard<std::mutex> lk(mutex);
@@ -239,17 +239,28 @@
 
 void mcl::BufferVault::set_scale(float scale)
 {
+    std::unique_lock<std::mutex> lk(mutex);
+    set_size(lk, size * scale);
+}
+
+void mcl::BufferVault::set_size(geom::Size new_size)
+{
+    std::unique_lock<std::mutex> lk(mutex);
+    set_size(lk, new_size);
+}
+
+void mcl::BufferVault::set_size(std::unique_lock<std::mutex>& lk, geometry::Size new_size)
+{
+    if (new_size == size)
+        return;
     std::vector<int> free_ids;
-    std::unique_lock<std::mutex> lk(mutex);
-    auto new_size = size * scale;
-    if (new_size == size)
-        return;
     size = new_size;
     for (auto it = buffers.begin(); it != buffers.end();)
     {
         auto buffer = checked_buffer_from_map(it->first);
         if ((it->second == Owner::Self) && (buffer->size() != size)) 
         {
+            current_buffer_count--;
             free_ids.push_back(it->first);
             it = buffers.erase(it);
         }
@@ -261,7 +272,7 @@
     lk.unlock();
 
     for(auto& id : free_ids)
-        realloc_buffer(id, new_size, format, usage);
+        free_buffer(id);
 }
 
 void mcl::BufferVault::increase_buffer_count()
 
=== modified file 'src/client/buffer_vault.h'
--- src/client/buffer_vault.h	2016-05-09 14:27:58 +0000
+++ src/client/buffer_vault.h	2016-05-20 09:11:49 +0000
@@ -78,6 +78,8 @@
     void alloc_buffer(geometry::Size size, MirPixelFormat format, int usage);
     void free_buffer(int free_id);
     void realloc_buffer(int free_id, geometry::Size size, MirPixelFormat format, int usage);
+    void set_size(std::unique_lock<std::mutex>& lk, geometry::Size new_size);
+
     std::shared_ptr<Buffer> checked_buffer_from_map(int id);
 
     std::shared_ptr<ClientBufferFactory> const platform_factory;
 
=== modified file 'src/common/CMakeLists.txt'
--- src/common/CMakeLists.txt	2016-03-30 08:59:35 +0000
+++ src/common/CMakeLists.txt	2016-05-20 09:11:49 +0000
@@ -36,7 +36,7 @@
   PARENT_SCOPE)
 
 # TODO we need a place to manage ABI and related versioning but use this as placeholder
-set(MIRCOMMON_ABI 5)
+set(MIRCOMMON_ABI 6)
 set(symbol_map ${CMAKE_CURRENT_SOURCE_DIR}/symbols.map)
 
 mir_add_library_with_symbols(mircommon SHARED
 
=== modified file 'src/server/CMakeLists.txt'
--- src/server/CMakeLists.txt	2016-05-12 07:35:07 +0000
+++ src/server/CMakeLists.txt	2016-05-20 09:11:49 +0000
@@ -125,7 +125,7 @@
   ${CMAKE_SOURCE_DIR}/include/server/mir DESTINATION "include/mirserver"
 )
 
-set(MIRSERVER_ABI 39) # Be sure to increment MIR_VERSION_MINOR at the same time
+set(MIRSERVER_ABI 40) # Be sure to increment MIR_VERSION_MINOR at the same time
 set(symbol_map ${CMAKE_CURRENT_SOURCE_DIR}/symbols.map)
 
 set_target_properties(
 
=== modified file 'src/server/symbols.map'
--- src/server/symbols.map	2016-05-03 04:36:33 +0000
+++ src/server/symbols.map	2016-05-20 09:11:49 +0000
@@ -1,4 +1,4 @@
-MIR_SERVER_0.22 {
+MIR_SERVER_0.23 {
  global:
   extern "C++" {
 # Symbols not yet picked up by script
 
=== modified file 'tests/acceptance-tests/test_prompt_session_client_api.cpp'
--- tests/acceptance-tests/test_prompt_session_client_api.cpp	2016-03-29 07:30:50 +0000
+++ tests/acceptance-tests/test_prompt_session_client_api.cpp	2016-05-20 09:11:49 +0000
@@ -383,7 +383,7 @@
     mir_prompt_session_release_sync(prompt_session);
 }
 
-TEST_F(PromptSessionClientAPI, client_pid_is_associated_with_session)
+TEST_F(PromptSessionClientAPI, DISABLED_client_pid_is_associated_with_session)
 {
     connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
 
@@ -624,7 +624,7 @@
 #ifndef TEST
 int main()
 #else
-TEST(LP, 1540731)
+TEST(LP, DISABLED_1540731)
 #endif
 {
     enum { server, client, size };
 
=== modified file 'tests/integration-tests/test_buffer_scheduling.cpp'
=== modified file 'tests/mir_test/CMakeLists.txt'
--- tests/mir_test/CMakeLists.txt	2015-06-23 16:08:35 +0000
+++ tests/mir_test/CMakeLists.txt	2016-05-20 09:11:49 +0000
@@ -1,3 +1,7 @@
+# We don't want LTO objects in a published archive (libmir-test-assist.a)
+string (REPLACE " -flto " " " CMAKE_C_FLAGS ${CMAKE_C_FLAGS})
+string (REPLACE " -flto " " " CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
+
 add_library(mir-public-test OBJECT
   cross_process_action.cpp
   cross_process_sync.cpp
 
=== modified file 'tests/mir_test_doubles/CMakeLists.txt'
--- tests/mir_test_doubles/CMakeLists.txt	2016-05-04 09:06:26 +0000
+++ tests/mir_test_doubles/CMakeLists.txt	2016-05-20 09:11:49 +0000
@@ -16,7 +16,6 @@
   mock_input_device.cpp
   mock_frame_dropping_policy_factory.cpp
   mock_timer.cpp
-  stub_buffer.cpp
   test_protobuf_client.cpp
   test_protobuf_socket_server.cpp
   triggered_main_loop.cpp
@@ -71,11 +70,16 @@
   )
 endif()
 
+# We don't want LTO objects in a published archive (libmir-test-assist.a)
+string (REPLACE " -flto " " " CMAKE_C_FLAGS ${CMAKE_C_FLAGS})
+string (REPLACE " -flto " " " CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
+
 add_library(mir-public-test-doubles OBJECT
   nested_mock_egl.cpp
   null_logger.cpp
   stub_display_configuration.cpp ${CMAKE_SOURCE_DIR}/include/test/mir/test/doubles/stub_display_configuration.h
   fake_display.cpp ${CMAKE_SOURCE_DIR}/include/test/mir/test/doubles/fake_display.h
+  stub_buffer.cpp
 )
 
 add_library(mir-test-doubles-static STATIC
 
=== modified file 'tests/mir_test_framework/CMakeLists.txt'
--- tests/mir_test_framework/CMakeLists.txt	2016-03-29 07:30:50 +0000
+++ tests/mir_test_framework/CMakeLists.txt	2016-05-20 09:11:49 +0000
@@ -21,6 +21,10 @@
     -DMIR_BUILD_PREFIX="${CMAKE_BINARY_DIR}"
     )
 
+# We don't want LTO objects in a published archive (libmir-test-assist.a)
+string (REPLACE " -flto " " " CMAKE_C_FLAGS ${CMAKE_C_FLAGS})
+string (REPLACE " -flto " " " CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
+
 add_library(mir-public-test-framework OBJECT
   any_surface.cpp
   async_server_runner.cpp
 
=== modified file 'tests/mirtest.pc.in'
--- tests/mirtest.pc.in	2015-06-25 16:47:02 +0000
+++ tests/mirtest.pc.in	2016-05-20 09:11:49 +0000
@@ -6,5 +6,5 @@
 Description: Mir test assist library
 Version: @MIR_VERSION@
 Requires: mirserver mirplatform mirclient
-Libs: -L@LIBDIR@ -lmir-test-assist
+Libs: -L@LIBDIR@ -lmir-test-assist -ldl
 Cflags: -I@INCLUDEDIR@
 
=== modified file 'tests/unit-tests/client/test_buffer_vault.cpp'
--- tests/unit-tests/client/test_buffer_vault.cpp	2016-05-09 14:27:58 +0000
+++ tests/unit-tests/client/test_buffer_vault.cpp	2016-05-20 09:11:49 +0000
@@ -326,6 +326,8 @@
 
 TEST_F(StartedBufferVault, reallocates_incoming_buffers_of_incorrect_size_with_immediate_response)
 {
+    vault.set_size(new_size);
+
     EXPECT_CALL(mock_requests, free_buffer(package.buffer_id()));
     EXPECT_CALL(mock_requests, allocate_buffer(new_size,_,_))
         .WillOnce(Invoke(
@@ -334,17 +336,17 @@
             vault.wire_transfer_inbound(package4.buffer_id());
         }));
 
-    vault.set_size(new_size);
     vault.wire_transfer_inbound(package.buffer_id());
     Mock::VerifyAndClearExpectations(&mock_requests);
 }
 
 TEST_F(StartedBufferVault, reallocates_incoming_buffers_of_incorrect_size_with_delayed_response)
 {
+    vault.set_size(new_size);
+
     EXPECT_CALL(mock_requests, free_buffer(package.buffer_id()));
     EXPECT_CALL(mock_requests, allocate_buffer(new_size,_,_));
 
-    vault.set_size(new_size);
     vault.wire_transfer_inbound(package.buffer_id());
     vault.wire_transfer_inbound(package4.buffer_id());
     EXPECT_THAT(vault.withdraw().get()->size(), Eq(new_size));
@@ -361,9 +363,9 @@
     Mock::VerifyAndClearExpectations(&mock_requests);
 }
 
-TEST_F(StartedBufferVault, simply_setting_size_triggers_no_server_interations)
+TEST_F(StartedBufferVault, setting_size_frees_unneeded_buffers_right_away)
 {
-    EXPECT_CALL(mock_requests, free_buffer(_)).Times(0);
+    EXPECT_CALL(mock_requests, free_buffer(_)).Times(3);
     EXPECT_CALL(mock_requests, allocate_buffer(_,_,_)).Times(0);
     auto const cycles = 30u;
     geom::Size new_size(80, 100);
@@ -450,21 +452,14 @@
     EXPECT_CALL(mock_requests, free_buffer(_))
         .Times(initial_nbuffers);
 
-    auto buffer = vault.withdraw().get();
     vault.set_scale(scale);
-    vault.deposit(buffer);
-    vault.wire_transfer_outbound(buffer);
-    vault.wire_transfer_inbound(package.buffer_id());
 
-    for(auto i = 0; i < 100; i++)
+    for(auto i = 0u; i < initial_nbuffers; i++)
     {
         auto b = vault.withdraw().get();
-        EXPECT_THAT(b->size(), Eq(new_size));
         vault.deposit(b);
-        b->received();
-        vault.wire_transfer_outbound(b);
-        vault.wire_transfer_inbound(buffers[(i+1)%3].buffer_id());
     }
+
     Mock::VerifyAndClearExpectations(&mock_requests);
 }
 
@@ -554,24 +549,137 @@
     vault.wire_transfer_inbound(package2.buffer_id());
     Mock::VerifyAndClearExpectations(&mock_requests);
 }
-
-//LP: #1578159
-TEST_F(StartedBufferVault, prefers_buffers_returned_further_in_the_past)
-{
-    auto buffer = vault.withdraw().get();
-    vault.deposit(buffer);
-    vault.wire_transfer_outbound(buffer);
-    auto first_id = buffer->rpc_id();
-
-    buffer = vault.withdraw().get();
-    vault.deposit(buffer);
-    vault.wire_transfer_outbound(buffer);
-    auto second_id = buffer->rpc_id();
-
-    vault.wire_transfer_inbound(second_id);
-    vault.wire_transfer_inbound(first_id);
-
-    EXPECT_THAT(vault.withdraw().get()->rpc_id(), Ne(first_id));
-
-
-}
+<<<<<<< TREE
+
+//LP: #1578159
+TEST_F(StartedBufferVault, prefers_buffers_returned_further_in_the_past)
+{
+    auto buffer = vault.withdraw().get();
+    vault.deposit(buffer);
+    vault.wire_transfer_outbound(buffer);
+    auto first_id = buffer->rpc_id();
+
+    buffer = vault.withdraw().get();
+    vault.deposit(buffer);
+    vault.wire_transfer_outbound(buffer);
+    auto second_id = buffer->rpc_id();
+
+    vault.wire_transfer_inbound(second_id);
+    vault.wire_transfer_inbound(first_id);
+
+    EXPECT_THAT(vault.withdraw().get()->rpc_id(), Ne(first_id));
+
+
+}
+=======
+
+//LP: #1578159
+TEST_F(StartedBufferVault, prefers_buffers_returned_further_in_the_past)
+{
+    auto buffer = vault.withdraw().get();
+    vault.deposit(buffer);
+    vault.wire_transfer_outbound(buffer);
+    auto first_id = buffer->rpc_id();
+
+    buffer = vault.withdraw().get();
+    vault.deposit(buffer);
+    vault.wire_transfer_outbound(buffer);
+    auto second_id = buffer->rpc_id();
+
+    vault.wire_transfer_inbound(second_id);
+    vault.wire_transfer_inbound(first_id);
+
+    EXPECT_THAT(vault.withdraw().get()->rpc_id(), Ne(first_id));
+}
+
+//LP: #1579076
+TEST_F(StartedBufferVault, doesnt_let_buffers_stagnate_after_resize)
+{
+    EXPECT_CALL(mock_requests, free_buffer(_))
+        .Times(3);
+    vault.set_size(new_size);
+
+    EXPECT_CALL(mock_requests, allocate_buffer(new_size,_,_))
+        .Times(1);
+    auto buffer_future = vault.withdraw();
+    vault.wire_transfer_inbound(package4.buffer_id());
+    EXPECT_THAT(buffer_future.get()->size(), Eq(new_size));
+    Mock::VerifyAndClearExpectations(&mock_requests);
+}
+
+TEST_F(StartedBufferVault, doesnt_free_buffers_in_the_driver_after_resize)
+{
+    EXPECT_CALL(mock_requests, free_buffer(_))
+        .Times(2);
+    auto buffer = vault.withdraw().get();
+    vault.set_size(new_size);
+    Mock::VerifyAndClearExpectations(&mock_requests);
+
+    vault.deposit(buffer);
+    vault.wire_transfer_outbound(buffer);
+
+    EXPECT_CALL(mock_requests, free_buffer(_))
+        .Times(1);
+    vault.wire_transfer_inbound(buffer->rpc_id());
+    Mock::VerifyAndClearExpectations(&mock_requests);
+}
+
+TEST_F(StartedBufferVault, doesnt_free_buffers_with_content_after_resize)
+{
+    EXPECT_CALL(mock_requests, free_buffer(_))
+        .Times(2);
+    auto buffer = vault.withdraw().get();
+    vault.deposit(buffer);
+    vault.set_size(new_size);
+    Mock::VerifyAndClearExpectations(&mock_requests);
+
+    vault.wire_transfer_outbound(buffer);
+    EXPECT_CALL(mock_requests, free_buffer(_))
+        .Times(1);
+    vault.wire_transfer_inbound(buffer->rpc_id());
+    Mock::VerifyAndClearExpectations(&mock_requests);
+}
+
+TEST_F(StartedBufferVault, doesnt_free_buffers_if_size_is_the_same)
+{
+    EXPECT_CALL(mock_requests, free_buffer(_))
+        .Times(0);
+    vault.set_size(size);
+    Mock::VerifyAndClearExpectations(&mock_requests);
+}
+
+TEST_F(StartedBufferVault, delays_allocation_if_not_needed)
+{
+    vault.set_size(new_size);
+
+    EXPECT_CALL(mock_requests, allocate_buffer(new_size,_,_))
+        .Times(1)
+        .WillOnce(Invoke(
+        [&, this](geom::Size, MirPixelFormat, int)
+        {
+            vault.wire_transfer_inbound(package4.buffer_id());
+        }));
+
+    for(auto i = 0u; i < 10u; i++)
+    {
+        auto buffer = vault.withdraw().get();
+        vault.deposit(buffer);
+        buffer->received();
+        vault.wire_transfer_outbound(buffer);
+        vault.wire_transfer_inbound(buffer->rpc_id());
+    }
+}
+
+TEST_F(StartedBufferVault, can_increase_count_after_resize)
+{
+    auto num_allocations = 4u;
+    EXPECT_CALL(mock_requests, allocate_buffer(_,_,_))
+        .Times(num_allocations);
+
+    vault.increase_buffer_count();
+    vault.set_size(new_size);
+
+    for(auto i = 0u; i < num_allocations + 1; i++)
+        vault.withdraw();
+}
+>>>>>>> MERGE-SOURCE