Merge lp:~alan-griffiths/mir/spike-input-from-the-existing-graphics-module into lp:mir

[Alan Griffiths]

input, config: try loading an input platform from the graphics before probing

input, config: try loading an input platform from the graphics before probing

I'm not yet sure how to write a decent test for this. My best idea so far is a stub graphics module (or two) that allows this support to be switched and can be force loaded in acceptance tests.

Suggestions welcome.

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

PASSED: Continuous integration, rev:3360
https://mir-jenkins.ubuntu.com/job/mir-ci/482/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/310
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/335
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/327
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/327
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/319
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/319/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/319
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/319/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/319
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/319/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/319
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/319/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/319
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/319/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:3361
https://mir-jenkins.ubuntu.com/job/mir-ci/483/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/312
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/337
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/329
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/329
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/321
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/321/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/321
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/321/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/321
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/321/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/321
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/321/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/321
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/321/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Cemil Azizoglu (cemil-azizoglu)]

Ok

review: Approve

[Chris Halse Rogers (raof)]

Would be nice to have some tests, but seems reasonableish :)

review: Approve

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

FAILED: Autolanding.
More details in the following jenkins job:
https://mir-jenkins.ubuntu.com/job/mir-autolanding/61/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/379/console
    None: https://mir-jenkins.ubuntu.com/job/generic-land-mp/67/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-0-fetch/409/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/401/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/401/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/388/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/388/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/388/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/388/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/388/console

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:3362
https://mir-jenkins.ubuntu.com/job/mir-ci/520/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/381
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/411
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/403
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/403
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/390
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/390/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/390
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/390/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/390
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/390/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/390
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/390/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/390
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/390/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

=== modified file 'src/include/server/mir/input/input_probe.h'
--- src/include/server/mir/input/input_probe.h	2016-03-02 14:54:07 +0000
+++ src/include/server/mir/input/input_probe.h	2016-03-08 16:22:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2015 Canonical Ltd.
+ * Copyright © 2015-2016 Canonical Ltd.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 3,
@@ -23,6 +23,7 @@
 
 namespace mir
 {
+namespace graphics { class Platform; }
 namespace options
 {
 class Option;
@@ -41,6 +42,12 @@
     std::shared_ptr<InputDeviceRegistry> const& device_registry, std::shared_ptr<InputReport> const& input_report,
     SharedLibraryProberReport & prober_report);
 
+/// Tries to create an input platform from the graphics module, otherwise returns a null pointer
+auto input_platform_from_graphics_module(
+    graphics::Platform const& graphics_platform,
+    options::Option const& options, std::shared_ptr<EmergencyCleanupRegistry> const& emergency_cleanup,
+    std::shared_ptr<InputDeviceRegistry> const& device_registry, std::shared_ptr<InputReport> const& input_report)
+-> mir::UniqueModulePtr<Platform>;
 }
 }
 

=== modified file 'src/server/input/default_configuration.cpp'
--- src/server/input/default_configuration.cpp	2016-03-02 16:38:13 +0000
+++ src/server/input/default_configuration.cpp	2016-03-08 16:22:46 +0000
@@ -233,15 +233,32 @@
             auto const options = the_options();
             bool input_opt = options->get<bool>(options::enable_input_opt);
 
-            // TODO nested input handling (== host_socket) should fold into a platform
-            if (!input_opt || options->is_set(options::host_socket_opt))
-            {
+            if (!input_opt)
+            {
+                return std::make_shared<mi::NullInputManager>();
+            }
+            else if (options->is_set(options::host_socket_opt))
+            {
+                // TODO nested input handling (== host_socket) should fold into a platform
                 return std::make_shared<mi::NullInputManager>();
             }
             else
             {
-                auto platform = probe_input_platforms(*options, the_emergency_cleanup(), the_input_device_registry(),
-                                                       the_input_report(), *the_shared_library_prober_report());
+                auto const emergency_cleanup = the_emergency_cleanup();
+                auto const device_registry = the_input_device_registry();
+                auto const input_report = the_input_report();
+
+                // Maybe the graphics platform also supplies input (e.g. mesa-x11 or nested)
+                // NB this makes the (valid) assumption that graphics initializes before input
+                auto platform = mi::input_platform_from_graphics_module(
+                    *the_graphics_platform(), *options, emergency_cleanup, device_registry, input_report);
+
+                // otherwise (usually) we probe for it
+                if (!platform)
+                {
+                    platform = probe_input_platforms(*options, emergency_cleanup, device_registry,
+                                                     input_report, *the_shared_library_prober_report());
+                }
 
                 return std::make_shared<mi::DefaultInputManager>(the_input_reading_multiplexer(), std::move(platform));
             }

=== modified file 'src/server/input/input_probe.cpp'
--- src/server/input/input_probe.cpp	2016-03-03 09:30:33 +0000
+++ src/server/input/input_probe.cpp	2016-03-08 16:22:46 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2015 Canonical Ltd.
+ * Copyright © 2015-2016 Canonical Ltd.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 3,
@@ -25,7 +25,7 @@
 #include "mir/shared_library_prober.h"
 #include "mir/shared_library.h"
 #include "mir/log.h"
-#include "mir/module_deleter.h"
+#include "mir/libname.h"
 
 #include <stdexcept>
 
@@ -39,10 +39,16 @@
     std::shared_ptr<mir::EmergencyCleanupRegistry> const& cleanup_registry,
     std::shared_ptr<mi::InputDeviceRegistry> const& registry, std::shared_ptr<mi::InputReport> const& report)
 {
-
+    auto desc = lib.load_function<mi::DescribeModule>("describe_input_module", MIR_SERVER_INPUT_PLATFORM_VERSION)();
     auto create = lib.load_function<mi::CreatePlatform>("create_input_platform", MIR_SERVER_INPUT_PLATFORM_VERSION);
 
-    return create(options, cleanup_registry, registry, report);
+    auto result = create(options, cleanup_registry, registry, report);
+
+    mir::log_info(
+        "Selected input driver: %s (version: %d.%d.%d)",
+        desc->name, desc->major_version, desc->minor_version, desc->micro_version);
+
+    return result;
 }
 }
 
@@ -63,12 +69,6 @@
                 auto const probe = module->load_function<mi::ProbePlatform>(
                     "probe_input_platform", MIR_SERVER_INPUT_PLATFORM_VERSION);
 
-                // We process the modules in descending .sonumber order so, luckily, we try mesa-x11 before evdev.
-                // But only because the graphics platform version is currently higher than the input platform version.
-                // Similarly, We only take the first found of duplicate modules, as that will be the most recent.
-                // This is a heuristic that assumes we're always looking for the most up-to-date driver,
-                // TODO find a way to coordinate the selection of mesa-x11 and input platforms
-
                 if (probe(options) > reject_platform_priority)
                 {
                     platform_module = module;
@@ -97,14 +97,28 @@
     if (!platform_module)
         BOOST_THROW_EXCEPTION(std::runtime_error{"No appropriate input platform module found"});
 
-    auto const desc = platform_module->load_function<mi::DescribeModule>(
-        "describe_input_module", MIR_SERVER_INPUT_PLATFORM_VERSION)();
-
-    auto result = create_input_platform(*platform_module, options, emergency_cleanup, device_registry, input_report);
-
-    mir::log_info(
-        "Selected input driver: %s (version: %d.%d.%d)",
-        desc->name, desc->major_version, desc->minor_version, desc->micro_version);
-
-    return result;
+    return create_input_platform(*platform_module, options, emergency_cleanup, device_registry, input_report);
+}
+
+auto mi::input_platform_from_graphics_module(
+    graphics::Platform const& graphics_platform,
+    options::Option const& options,
+    std::shared_ptr<EmergencyCleanupRegistry> const& emergency_cleanup,
+    std::shared_ptr<InputDeviceRegistry> const& device_registry,
+    std::shared_ptr<InputReport> const& input_report)
+-> mir::UniqueModulePtr<Platform>
+{
+    try
+    {
+        // Yes, this is dirty code that assumes the object layout. Sorry!
+        auto* const vtab = (void*&)(graphics_platform);
+        SharedLibrary const platform_module{detail::libname_impl(vtab)};
+
+        return create_input_platform(platform_module, options, emergency_cleanup, device_registry, input_report);
+    }
+    catch (std::runtime_error const&)
+    {
+        // Assume the graphics platform is not also an input module.
+        return {};
+    }
 }