Merge lp:~alan-griffiths/mir/fix-intermittent-memory-leak into lp:mir

[Alan Griffiths]

client: fix intermittent leak of pong callback

client: fix intermittent leak of pong callback

While investigating FD leans in the acceptance test I occasionally saw the pong callback being leaked. (Presumably because the call to Done() races with shutdown.)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2791
http://jenkins.qa.ubuntu.com/job/mir-ci/4431/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/3334
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/mir-clang-ts-wily-amd64-build/187
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-wily-amd64-build/859
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/3282
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/580
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/580/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3282
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/3282/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/6078
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/22175

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

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

review: Approve

[Alexandros Frantzis (afrantzis)]

OK.

review: Approve

[Alan Griffiths (alan-griffiths)]

Needs tweaking

[lp:~alan-griffiths/mir/fix-intermittent-memory-leak]

2792. By Alan Griffiths on 2015-07-29

Ensure pong_callback lives until after eventloop destruction (which can touch it)

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

=== modified file 'src/client/mir_connection.cpp'
--- src/client/mir_connection.cpp	2015-07-25 08:10:48 +0000
+++ src/client/mir_connection.cpp	2015-07-29 09:05:52 +0000
@@ -122,6 +122,7 @@
         ping_handler{conf.the_ping_handler()},
         surface_map(conf.the_surface_map()),
         event_handler_register(conf.the_event_handler_register()),
+        pong_callback(google::protobuf::NewPermanentCallback(&google::protobuf::DoNothing)),
         eventloop{new md::ThreadedDispatcher{"RPC Thread", std::dynamic_pointer_cast<md::Dispatchable>(channel)}}
 {
     connect_result->set_error("connect not called");
@@ -552,7 +553,7 @@
 {
     auto pong = mcl::make_protobuf_object<mir::protobuf::PingEvent>();
     pong->set_serial(serial);
-    server.pong(0, pong.get(), void_response.get(), google::protobuf::NewCallback(&google::protobuf::DoNothing));
+    server.pong(0, pong.get(), void_response.get(), pong_callback.get());
 }
 
 void MirConnection::register_display_change_callback(mir_display_config_callback callback, void* context)

=== modified file 'src/client/mir_connection.h'
--- src/client/mir_connection.h	2015-07-25 08:10:48 +0000
+++ src/client/mir_connection.h	2015-07-29 09:05:52 +0000
@@ -215,6 +215,8 @@
 
     std::shared_ptr<mir::client::EventHandlerRegister> const event_handler_register;
 
+    std::unique_ptr<google::protobuf::Closure> const pong_callback;
+
     std::unique_ptr<mir::dispatch::ThreadedDispatcher> const eventloop;
     
     std::shared_ptr<mir::client::ClientBufferStreamFactory> buffer_stream_factory;